diff options
| author | Fabien Costantini <fabien@onepost.net> | 2008-10-14 22:12:25 +0000 |
|---|---|---|
| committer | Fabien Costantini <fabien@onepost.net> | 2008-10-14 22:12:25 +0000 |
| commit | 497afccb07164373e0de6639e754d7d691f1926f (patch) | |
| tree | 449d0b92ceb05f39617fe8fc2876d16eecde7460 /documentation/Fl_Value_Input.html | |
| parent | e08fffdfe08bbc9320e39a15d162b6501abd4925 (diff) | |
Doxygen pdf man: First version added in documentation/fltk.pdf, old doc removed, images, dox files moved to a new src directory.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6431 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/Fl_Value_Input.html')
| -rw-r--r-- | documentation/Fl_Value_Input.html | 133 |
1 files changed, 0 insertions, 133 deletions
diff --git a/documentation/Fl_Value_Input.html b/documentation/Fl_Value_Input.html deleted file mode 100644 index aeecc89fe..000000000 --- a/documentation/Fl_Value_Input.html +++ /dev/null @@ -1,133 +0,0 @@ -<HTML> -<HEAD> - <TITLE>Fl_Value_Input</TITLE> -</HEAD> -<BODY> - -<!-- NEW PAGE --> - -<H2><A name=Fl_Value_Input>class Fl_Value_Input</A></H2> - -<HR> - -<H3>Class Hierarchy</H3> - -<UL><PRE> -<A href=Fl_Valuator.html#Fl_Valuator>Fl_Valuator</A> - | - +----<B>Fl_Value_Input</B> -</PRE></UL> - -<H3>Include Files</H3> - -<UL><PRE> -#include <FL/Fl_Value_Input.H> -</PRE></UL> - -<H3>Description</H3> - -<P>The <TT>Fl_Value_Input</TT> widget displays a numeric value. -The user can click in the text field and edit it - there is in -fact a hidden <A -href="Fl_Input.html#Fl_Input"><TT>Fl_Input</TT></A> widget with -<TT>type(FL_FLOAT_INPUT)</TT> or <TT>type(FL_INT_INPUT)</TT> in -there - and when they hit return or tab the value updates to -what they typed and the callback is done. - -<P>If <TT>step()</TT> is non-zero and integral, then the range of numbers -is limited to integers instead of floating point numbers. As -well as displaying the value as an integer, typed input is also -limited to integer values, even if the hidden <TT>Fl_Input</TT> widget -is of <TT>type(FL_FLOAT_INPUT)</TT>.</P> - -<P>If <TT>step()</TT> is non-zero, the user can also drag the -mouse across the object and thus slide the value. The left -button moves one <TT>step()</TT> per pixel, the middle by <TT>10 -* step()</TT>, and the right button by <TT>100 * step()</TT>. It -is therefore impossible to select text by dragging across it, -although clicking can still move the insertion cursor.</P> - -<P>If <TT>step()</TT> is non-zero and integral, then the range -of numbers are limited to integers instead of floating point -values. - -<P ALIGN="CENTER"><IMG src="Fl_Value_Input.gif" -ALT="Fl_Value_Input widget."></P> - -<H3>Methods</H3> -<UL> - <LI><A href="#Fl_Value_Input.Fl_Value_Input">Fl_Value_Input</A></LI> - <LI><A href="#Fl_Value_Input.~Fl_Value_Input">~Fl_Value_Input</A></LI> - <LI><A href="#Fl_Value_Input.cursor_color">cursor_color</A></LI> - <LI><A href="#Fl_Value_Input.shortcut">shortcut</A></LI> - <LI><A href="#Fl_Value_Input.soft">soft</A></LI> - <LI><A href="#Fl_Value_Input.textcolor">textcolor</A></LI> - <LI><A href="#Fl_Value_Input.textfont">textfont</A></LI> - <LI><A href="#Fl_Value_Input.textsize">textsize</A></LI> -</UL> - -<H4><A -name="Fl_Value_Input.Fl_Value_Input">Fl_Value_Input::Fl_Value_Input(int -x, int y, int w, int h, const char *label = 0)</A></H4> - -<P>Creates a new <TT>Fl_Value_Input</TT> widget using the given -position, size, and label string. The default boxtype is -<TT>FL_DOWN_BOX</TT>. - -<H4><A name="Fl_Value_Input.~Fl_Value_Input">virtual -Fl_Value_Input::~Fl_Value_Input()</A></H4> - -<P>Destroys the valuator. - -<H4><A name="Fl_Value_Input.cursor_color">Fl_Color -Fl_Value_Input::cursor_color() const<BR> -void Fl_Value_Input::cursor_color(Fl_Color)</A></H4> - -<P>Get or set the color of the text cursor. The text cursor is -black by default. - -<H4><A name="Fl_Value_Input.shortcut">ulong Fl_Value_Input::shortcut() const -<BR> void Fl_Value_Input::shortcut(ulong key)</A></H4> - The first form returns the current shortcut key for the Input. -<P>The second form sets the shortcut key to <TT>key</TT>. Setting this -overrides the use of '&' in the <TT>label()</TT>. The value is a bitwise -OR of a key and a set of shift flags, for example <CODE>FL_ALT | 'a'</CODE> -, <CODE>FL_ALT | (FL_F + 10)</CODE>, or just <CODE>'a'</CODE>. A value -of 0 disables the shortcut. </P> -<P>The key can be any value returned by <A href="Fl.html#Fl.event_key"> -<TT>Fl::event_key()</TT></A>, but will usually be an ASCII letter. Use -a lower-case letter unless you require the shift key to be held down. </P> -<P>The shift flags can be any set of values accepted by <A href="Fl.html#Fl.event_state"> -<TT>Fl::event_state()</TT></A>. If the bit is on that shift key must -be pushed. Meta, Alt, Ctrl, and Shift must be off if they are not in -the shift flags (zero for the other bits indicates a "don't care" -setting). </P> - -<H4><A name="Fl_Value_Input.soft">uchar Fl_Value_Input::soft() const<BR> -void Fl_Value_Input::soft(uchar)</A></H4> - -<P>If "soft" is turned on, the user is allowed to drag -the value outside the range. If they drag the value to one of -the ends, let go, then grab again and continue to drag, they can -get to any value. The default is true. - -<H4><A name="Fl_Value_Input.textcolor">Fl_Color -Fl_Value_Input::textcolor() const<BR> -void Fl_Value_Input::textcolor(Fl_Color)</A></H4> - -<P>Gets or sets the color of the text in the value box. - -<H4><A name="Fl_Value_Input.textfont">Fl_Font -Fl_Value_Input::textfont() const<BR> -void Fl_Value_Input::textfont(Fl_Font)</A></H4> - -<P>Gets or sets the typeface of the text in the value box. - -<H4><A name="Fl_Value_Input.textsize">uchar -Fl_Value_Input::textsize() const<BR> -void Fl_Value_Input::textsize(uchar)</A></H4> - -<P>Gets or sets the size of the text in the value box. - -</BODY> -</HTML> |