class Fl_Input

Class Hierarchy

Fl_Input_
   |
   +----Fl_Input
           |
           +----Fl_Float_Input, Fl_Int_Input,
                Fl_Multiline_Input, Fl_Secret_Input

Include Files

#include <FL/Fl_Input.H>

Description

This is the FLTK text input widget. It displays a single line of text and lets the user edit it. Normally it is drawn with an inset box and a white background. The text may contain any characters (even 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 assummes the font can draw any characters in the ISO8859-1 character set.

Mouse button 1	Moves the cursor to this point. Drag selects characters. Double click selects words. Triple click selects all text. Shift+click extends the selection.
Mouse button 2	Insert the current X selection at the cursor (unlike Motif this does not move the insertion point to the mouse). If the widget does not have the input focus (and thus no cursor) it puts the cursor where clicked and inserts the selection there.
Mouse button 3	Currently acts like button 1.
Backspace	Deletes one character to the left, or deletes the selected region.
Enter	May cause the callback, see when().
^A or Home	Go to start of line.
^B or Left	Move left
^C	Copy the selection to the clipboard
^D or Delete	Deletes one character to the right or deletes the selected region. Due to silly historical X problems, the Delete key will act like Backspace until you type a "real" backspace.
^E or End	Go to the end of line.
^F or Right	Move right
^K	Delete to the end of line (next \n character) or deletes a single \n character. These deletions are all concatenated into the clipboard.
^N or Down	Move down (for Fl_Multiline_Input only, otherwise it moves to the next input field).
^P or Up	Move up (for Fl_Multiline_Input only, otherwise it moves to the previous input field).
^Q or RightCtrl or Compose	Start a compose-character sequence. The next one or two keys typed define the character to insert. This also can be used to "quote" control characters.
^U	Delete everything.
^V or ^Y	Paste the clipboard
^X or ^W	Copy the region to the clipboard and delete it.
^Z or ^_	Undo. This is a single-level undo mechanism, but all adjacent deletions and insertions are concatenated into a single "undo". Often this will undo a lot more than you expected.
Shift+move	Move the cursor but also extend the selection.

index
size

static_value
textcolor

textfont
textsize

value
when

Fl_Input::Fl_Input(int x, int y, int w, int h, const char *label = 0)

Creates a new Fl_Input widget using the given position, size, and label string. The default boxtype is FL_DOWN_BOX.

virtual Fl_Input::~Fl_Input()

Destroys the widget and any value associated with it.

const char Fl_Input::value() const
int Fl_Input::value(const char)
int Fl_Input::value(const char*, int)

The first form returns the current value, which is a pointer to the internal buffer and is valid only until the next event is handled.

The second two forms change the text and set the mark and the point to the end of it. The string is copied to the internal buffer. Passing NULL is the same as "". This returns non-zero if the new value is different than the current one. You can use the second version to directly set the length if you know it already or want to put nul's in the text.

int Fl_Input::static_value(const char)
int Fl_Input::static_value(const char, int)

Change the text and set the mark and the point to the end of it. The string is not copied. If the user edits the string it is copied to the internal buffer then. This can save a great deal of time and memory if your program is rapidly changing the values of text fields, but this will only work if the passed string remains unchanged until either the Fl_Input is destroyed or value() is called again.

0: The callback is not done, but changed() is turned on.
FL_WHEN_CHANGED: The callback is done each time the text is changed by the user.
FL_WHEN_RELEASE: The callback will be done when this widget loses the focus, including when the window is unmapped. This is a useful value for text fields in a panel where doing the callback on every change is wasteful. However the callback will also happen if the mouse is moved out of the window, which means it should not do anything visible (like pop up an error message). You might do better setting this to zero, and scanning all the items for changed() when the OK button on a panel is pressed.
FL_WHEN_ENTER_KEY: If the user types the Enter key, the entire text is selected, and the callback is done if the text has changed. Normally the Enter key will navigate to the next field (or insert a newline for a Fl_Mulitline_Input), this changes the behavior.
FL_WHEN_ENTER_KEY|FL_WHEN_NOT_CHANGED: The Enter key will do the callback even if the text has not changed. Useful for command fields.

class Fl_Input

Class Hierarchy

Include Files

Description

Methods

Fl_Input::Fl_Input(int x, int y, int w, int h, const char *label = 0)

virtual Fl_Input::~Fl_Input()

const char Fl_Input::value() const
int Fl_Input::value(const char)
int Fl_Input::value(const char*, int)

int Fl_Input::static_value(const char)
int Fl_Input::static_value(const char, int)

int Fl_Input::size() const

char Fl_Input::index(int) const

Fl_When Fl_Widget::when() const
void Fl_Widget::when(Fl_When)

Fl_Color Fl_Input::textcolor() const
void Fl_Input::textcolor(Fl_Color)

Fl_Font Fl_Input::textfont() const
void Fl_Input::textfont(Fl_Font)

uchar Fl_Input::textsize() const
void Fl_Input::textsize(uchar)

Fl_Color Fl_Input::cursor_color() const
void Fl_Input::cursor_color(Fl_Color)