summaryrefslogtreecommitdiff
path: root/FL/Fl_Output.H
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-09-15 12:46:49 +0000
committerFabien Costantini <fabien@onepost.net>2008-09-15 12:46:49 +0000
commit09f3094aef152ece5bf802983d54f1642d803e0d (patch)
treee59f10539bf9709ed3a236e05d98605150add316 /FL/Fl_Output.H
parent730dc6367d0970f56b3bd4e0b3bd6842ffa27443 (diff)
Doxygen documentation WP10 Done. Reserved WP11.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6254 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Output.H')
-rw-r--r--FL/Fl_Output.H24
1 files changed, 22 insertions, 2 deletions
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.
+ <CENTER>\image html text.gif</CENTER>
+ <P>There is a single subclass,
+ Fl_Multiline_Output, which allows you to display multiple lines of
+ text. </P>
+ <P>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.
+ <P>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);}
};