summaryrefslogtreecommitdiff
path: root/FL/Fl_Multiline_Input.H
diff options
context:
space:
mode:
Diffstat (limited to 'FL/Fl_Multiline_Input.H')
-rw-r--r--FL/Fl_Multiline_Input.H20
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