Update docos to describe int/float settings.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@2259 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Michael R Sweet
2002-05-25 12:17:18 +00:00
parent d47ed1872c
commit 62424b33c5
+92 -58
View File
@@ -1,72 +1,106 @@
<HTML><BODY> <HTML>
<BODY>
<!-- NEW PAGE --> <!-- NEW PAGE -->
<H2><A name=Fl_Value_Input>class Fl_Value_Input</A></H2> <H2><A name=Fl_Value_Input>class Fl_Value_Input</A></H2>
<HR> <HR>
<H3>Class Hierarchy</H3> <H3>Class Hierarchy</H3>
<UL>
<PRE> <UL><PRE>
<A href=Fl_Valuator.html#Fl_Valuator>Fl_Valuator</A> <A href=Fl_Valuator.html#Fl_Valuator>Fl_Valuator</A>
| |
+----<B>Fl_Value_Input</B> +----<B>Fl_Value_Input</B>
</PRE> </PRE></UL>
</UL>
<H3>Include Files</H3> <H3>Include Files</H3>
<UL>
<PRE> <UL><PRE>
#include &lt;FL/Fl_Value_Input.H&gt; #include &lt;FL/Fl_Value_Input.H&gt;
</PRE> </PRE></UL>
</UL>
<H3>Description</H3> <H3>Description</H3>
The <TT>Fl_Value_Input</TT> widget displays a floating point value.
The user can click in the text field and edit it (there is in fact a <P>The <TT>Fl_Value_Input</TT> widget displays a numeric value.
hidden <A href=Fl_Input.html#Fl_Input><TT>Fl_Input</TT></A> widget with <TT> The user can click in the text field and edit it - there is in
type(FL_FLOAT_INPUT)</TT> in there), and when they hit return or tab fact a hidden <A
the value updates to what they typed and the callback is done. href="Fl_Input.html#Fl_Input"><TT>Fl_Input</TT></A> widget with
<P>If <TT>step()</TT> is not zero, the user can also drag the mouse <TT>type(FL_FLOAT_INPUT)</TT> or <TT>type(FL_INT_INPUT)</TT> in
across the object and thus slide the value. The left button moves one <TT> there - and when they hit return or tab the value updates to
step()</TT> per pixel, the middle by <TT>10 * step()</TT>, and the left what they typed and the callback is done.
button by <TT>100 * step()</TT>. It is then impossible to select text
by dragging across it, although clicking can still move the insertion <P>If <TT>step()</TT> is non-zero, the user can also drag the
cursor. </P> mouse across the object and thus slide the value. The left
<P ALIGN=CENTER><IMG src="Fl_Value_Input.gif" ALT="Fl_Value_Input widget."></P> 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> <H3>Methods</H3>
<UL> <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.~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.cursor_color">cursor_color</A></LI>
<LI><A href=#Fl_Value_Input.soft>soft</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.textcolor">textcolor</A></LI>
<LI><A href=#Fl_Value_Input.textfont>textfont</A></LI> <LI><A href="#Fl_Value_Input.textfont">textfont</A></LI>
<LI><A href=#Fl_Value_Input.textsize>textsize</A></LI> <LI><A href="#Fl_Value_Input.textsize">textsize</A></LI>
</UL> </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 <H4><A
*label = 0)</A></H4> name="Fl_Value_Input.Fl_Value_Input">Fl_Value_Input::Fl_Value_Input(int
Creates a new <TT>Fl_Value_Input</TT> widget using the given position, x, int y, int w, int h, const char *label = 0)</A></H4>
size, and label string. The default boxtype is <TT>FL_DOWN_BOX</TT>.
<H4><A name=Fl_Value_Input.~Fl_Value_Input>virtual <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> Fl_Value_Input::~Fl_Value_Input()</A></H4>
Destroys the valuator.
<H4><A name=Fl_Value_Input.cursor_color>Fl_Color <P>Destroys the valuator.
Fl_Value_Input::cursor_color() const
<BR> void Fl_Value_Input::cursor_color(Fl_Color)</A></H4> <H4><A name="Fl_Value_Input.cursor_color">Fl_Color
Get or set the color of the cursor. This is black by default. Fl_Value_Input::cursor_color() const<BR>
<H4><A name=Fl_Value_Input.soft>uchar Fl_Value_Input::soft() const void Fl_Value_Input::cursor_color(Fl_Color)</A></H4>
<BR> void Fl_Value_Input::soft(uchar)</A></H4>
If &quot;soft&quot; is turned on, the user is allowed to drag the value outside <P>Get or set the color of the text cursor. The text cursor is
the range. If they drag the value to one of the ends, let go, then black by default.
grab again and continue to drag, they can get to any value. Default is
true. <H4><A name="Fl_Value_Input.soft">uchar Fl_Value_Input::soft() const<BR>
<H4><A name=Fl_Value_Input.textcolor>Fl_Color void Fl_Value_Input::soft(uchar)</A></H4>
Fl_Value_Input::textcolor() const
<BR> void Fl_Value_Input::textcolor(Fl_Color)</A></H4> <P>If &quot;soft&quot; is turned on, the user is allowed to drag
Gets or sets the color of the text in the value box. the value outside the range. If they drag the value to one of
<H4><A name=Fl_Value_Input.textfont>Fl_Font Fl_Value_Input::textfont() the ends, let go, then grab again and continue to drag, they can
const get to any value. The default is true.
<BR>
<BR>void Fl_Value_Input::textfont(Fl_Font)</A></H4> <H4><A name="Fl_Value_Input.textcolor">Fl_Color
Gets or sets the typeface of the text in the value box. Fl_Value_Input::textcolor() const<BR>
<H4><A name=Fl_Value_Input.textsize>uchar Fl_Value_Input::textsize() void Fl_Value_Input::textcolor(Fl_Color)</A></H4>
const
<BR> void Fl_Value_Input::textsize(uchar)</A></H4> <P>Gets or sets the color of the text in the value box.
Gets or sets the size of the text in the value box. </BODY></HTML>
<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>