From d7b88a3bcc7e76f38ee5799be7722fd5a10781ef Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Wed, 13 Jan 1999 19:28:54 +0000 Subject: Updated all links so they work between files. Revision 1. git-svn-id: file:///fltk/svn/fltk/trunk@219 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Input.html | 431 ++++++++++++++++++-------------------------- 1 file changed, 177 insertions(+), 254 deletions(-) (limited to 'documentation/Fl_Input.html') diff --git a/documentation/Fl_Input.html b/documentation/Fl_Input.html index 89e10d235..98614ffb9 100644 --- a/documentation/Fl_Input.html +++ b/documentation/Fl_Input.html @@ -1,256 +1,179 @@ - - - -
- -

class Fl_Input

- -
- -

Class Hierarchy

- - +

Include Files

+ +

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 1Moves the cursor to this point. + Drag selects characters. Double click selects words. Triple click +selects all text. Shift+click extends the selection.
Mouse button 2Insert 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 3Currently acts like button 1.
BackspaceDeletes one character to the left, or +deletes the selected region.
EnterMay cause the callback, see when().
^A or HomeGo to start of line.
^B or LeftMove left
^CCopy the selection to the clipboard
^D or DeleteDeletes 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 EndGo to the end of line.
^F or RightMove right
^KDelete to the end of line (next \n character) +or deletes a single \n character. These deletions are all concatenated +into the clipboard.
^N or DownMove down (for Fl_Multiline_Input +only, otherwise it moves to the next input field).
^P or UpMove 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.
^UDelete everything.
^V or ^YPaste the clipboard
^X or ^WCopy 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+moveMove the cursor but also extend the +selection.
+

Methods

+
+ + +
+ + + + + + + + + +
+
+

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. +

int Fl_Input::size() const

+ Returns the number of characters in value(). This may be +greater than strlen(value()) if there are nul characters in +it. +

char Fl_Input::index(int) const

+ Same as value()[n], but may be faster in plausible +implementations. No bounds checking is done. +

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

+ Controls when callbacks are done. The following values are useful, +the default value is FL_WHEN_RELEASE: + +

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

+ Gets or sets the color of the text in the input field. +

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

+ Gets or sets the font of the text in the input field. +

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

+ Gets or sets the size of the text in the input field. +

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

+ Get or set the color of the cursor. This is black by default. \ No newline at end of file -- cgit v1.2.3