From 09daf20b81cdae78772f07c0af22a571d7cc73eb Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Thu, 29 Nov 2001 19:24:00 +0000 Subject: Documentation updates galore (up to chapter 7, still need to do chapter 8 and 9, tweek the appendices, and recapture the screenshots...) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1786 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Input.html | 122 ++++++++++++++++++++++---------------------- 1 file changed, 61 insertions(+), 61 deletions(-) (limited to 'documentation/Fl_Input.html') diff --git a/documentation/Fl_Input.html b/documentation/Fl_Input.html index a99da8d93..5474d5e37 100644 --- a/documentation/Fl_Input.html +++ b/documentation/Fl_Input.html @@ -20,13 +20,13 @@

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 assumes the font can draw any characters in the -ISO-8859-1 character set. +

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 assumes the font can draw any characters in the +ISO-8859-1 character set.

@@ -43,32 +43,32 @@ clipboard by selecting the region with mouse button 2. - - - - - - - -
Mouse button 3Currently acts like button 1.
BackspaceDeletes one character to the left, or +
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 +
^D or DeleteDeletes one character to the right or deletes the selected region.
^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 +
^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 +
^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, +
^P or UpMove up (for Fl_Multiline_Input only, otherwise it moves to the previous input field).
^UDelete everything.
^V or ^YPaste the clipboard
^X or ^WCopy the region to the clipboard and +
^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 +
^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 +
Shift+moveMove the cursor but also extend the selection.
RightCtrl or @@ -259,76 +259,76 @@ inserted.
-

Fl_Input::Fl_Input(int x, int y, int w, +

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

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. + 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. + 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. + 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: + 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. + 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. + 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() + 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. -- cgit v1.2.3