summaryrefslogtreecommitdiff
path: root/FL/Fl_Multiline_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_Multiline_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_Multiline_Output.H')
-rw-r--r--FL/Fl_Multiline_Output.H15
1 files changed, 13 insertions, 2 deletions
diff --git a/FL/Fl_Multiline_Output.H b/FL/Fl_Multiline_Output.H
index 7aac4b9a4..c9566e252 100644
--- a/FL/Fl_Multiline_Output.H
+++ b/FL/Fl_Multiline_Output.H
@@ -25,15 +25,26 @@
// http://www.fltk.org/str.php
//
+
#ifndef Fl_Multiline_Output_H
#define Fl_Multiline_Output_H
#include "Fl_Output.H"
+/**
+ This widget is a subclass of Fl_Output that displays multiple
+ lines of text. It also displays tab characters as whitespace to the
+ next column.
+*/
class Fl_Multiline_Output : public Fl_Output {
public:
- Fl_Multiline_Output(int X,int Y,int W,int H,const char *l = 0)
- : Fl_Output(X,Y,W,H,l) {type(FL_MULTILINE_OUTPUT);}
+ /**
+ Creates a new Fl_Multiline_Output widget using the given
+ position, size, and label string. The default boxtype is FL_DOWN_BOX
+ <P> Inherited destructor destroys the widget and any value associated with it.
+ */
+ Fl_Multiline_Output(int X,int Y,int W,int H,const char *l = 0)
+ : Fl_Output(X,Y,W,H,l) {type(FL_MULTILINE_OUTPUT);}
};
#endif