From c56bb65a9752613a564fac18f0086053edde1ece Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Wed, 8 May 2002 12:44:52 +0000 Subject: Add documentation for readonly() and input_type(). Fix "make distclean" so that it removes all of the library files. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@2204 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Input.html | 206 +++++++++++++++++++++++++++----------------- 1 file changed, 125 insertions(+), 81 deletions(-) (limited to 'documentation/Fl_Input.html') diff --git a/documentation/Fl_Input.html b/documentation/Fl_Input.html index 504bf0697..aba00ad86 100644 --- a/documentation/Fl_Input.html +++ b/documentation/Fl_Input.html @@ -1,10 +1,15 @@ - + + + +

class Fl_Input

Class Hierarchy

+
+ Fl_Input_
    |
    +----Fl_Input
@@ -12,22 +17,23 @@
            +----Fl_File_Input, Fl_Float_Input,
 	        Fl_Int_Input, Fl_Multiline_Input,
 		Fl_Output, 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 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.

@@ -240,6 +246,7 @@ inserted.

index
readonly
size

@@ -260,78 +267,115 @@ 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, + +
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 + +
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 +
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.
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.

Fl_Color Fl_Input::cursor_color() + +
Fl_Color Fl_Input::textcolor() const +
void Fl_Input::textcolor(Fl_Color)
+ +
Gets or sets the color of the text in the input field. + +

class Fl_Input

Class Hierarchy

Include Files

Description

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 + +
virtual Fl_Input::~Fl_Input()
+ +
Destroys the widget and any value associated with it. + +

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

int Fl_Input::size() const

char Fl_Input::index(int) const

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

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() + +
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_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)

Class Hierarchy

Include Files

Description

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, + +Creates a new Fl_Input widget using the given position, size, and label string. The default boxtype is FL_DOWN_BOX. -

int Fl_Input::static_value(const + +virtual Fl_Input::~Fl_Input() + +Destroys the widget and any value associated with it. + +

Fl_Color Fl_Input::cursor_color() + +Fl_Color Fl_Input::textcolor() const +void Fl_Input::textcolor(Fl_Color) + +Gets or sets the color of the text in the input field. + +

int Fl_Input::static_value(const + +
virtual Fl_Input::~Fl_Input()
+ +
Destroys the widget and any value associated with it. + +

Fl_Color Fl_Input::cursor_color() + +
Fl_Color Fl_Input::textcolor() const +
void Fl_Input::textcolor(Fl_Color)
+ +
Gets or sets the color of the text in the input field. + +