From 09f3094aef152ece5bf802983d54f1642d803e0d Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Mon, 15 Sep 2008 12:46:49 +0000 Subject: Doxygen documentation WP10 Done. Reserved WP11. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6254 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Output.H | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) (limited to 'FL/Fl_Output.H') diff --git a/FL/Fl_Output.H b/FL/Fl_Output.H index 93d3e6870..59938a87f 100644 --- a/FL/Fl_Output.H +++ b/FL/Fl_Output.H @@ -29,10 +29,30 @@ #define Fl_Output_H #include "Fl_Input.H" - +/** + This widget displays a piece of text. When you set the value() + , Fl_Output does a strcpy() to it's own storage, + which is useful for program-generated values. The user may select + portions of the text using the mouse and paste the contents into other + fields or programs. +
\image html text.gif
+

There is a single subclass, + Fl_Multiline_Output, which allows you to display multiple lines of + text.

+

The text may contain any characters except \0, and will correctly + display anything, using ^X notation for unprintable control characters + and \nnn notation for unprintable characters with the high bit set. It + assumes the font can draw any characters in the ISO-Latin1 character + set. +*/ class Fl_Output : public Fl_Input { public: - Fl_Output(int X,int Y,int W,int H, const char *l = 0) + /** + Creates a new Fl_Output widget using the given position, + size, and label string. The default boxtype is FL_DOWN_BOX. +

Inherited destrucor destroys the widget and any value associated with it. + */ + Fl_Output(int X,int Y,int W,int H, const char *l = 0) : Fl_Input(X, Y, W, H, l) {type(FL_NORMAL_OUTPUT);} }; -- cgit v1.2.3