diff options
| author | Fabien Costantini <fabien@onepost.net> | 2008-09-15 11:10:51 +0000 |
|---|---|---|
| committer | Fabien Costantini <fabien@onepost.net> | 2008-09-15 11:10:51 +0000 |
| commit | 8701883e54d4e7e842d4cb27c17019c03cd33f55 (patch) | |
| tree | ef86259413498fce96df97ea1decedc7e30515a6 /FL/Fl_Multiline_Input.H | |
| parent | b9ca1333769f87c029430a9d14a7a9937d400f93 (diff) | |
Doxygen documentation WP9 Done.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6251 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Multiline_Input.H')
| -rw-r--r-- | FL/Fl_Multiline_Input.H | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/FL/Fl_Multiline_Input.H b/FL/Fl_Multiline_Input.H index 063d391db..2ab3cea80 100644 --- a/FL/Fl_Multiline_Input.H +++ b/FL/Fl_Multiline_Input.H @@ -25,15 +25,31 @@ // http://www.fltk.org/str.php // + #ifndef Fl_Multiline_Input_H #define Fl_Multiline_Input_H #include "Fl_Input.H" +/** + This input field displays '\n' characters as new lines rather than ^J, + and accepts the Return, Tab, and up and down arrow keys. This is for + editing multiline text. + <P>This is far from the nirvana of text editors, and is probably only + good for small bits of text, 10 lines at most. I think FLTK can be + used to write a powerful text editor, but it is not going to be a + built-in feature. Powerful text editors in a toolkit are a big source + of bloat. +*/ class Fl_Multiline_Input : public Fl_Input { public: - Fl_Multiline_Input(int X,int Y,int W,int H,const char *l = 0) - : Fl_Input(X,Y,W,H,l) {type(FL_MULTILINE_INPUT);} + /** + Creates a new Fl_Multiline_Input 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_Input(int X,int Y,int W,int H,const char *l = 0) + : Fl_Input(X,Y,W,H,l) {type(FL_MULTILINE_INPUT);} }; #endif |
