mirrors
/
fltk
mirror of https://github.com/fltk/fltk
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

STR 1167: updated documentation for Fl_Valuator and Fl_Value_Input 

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@4885 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Matthias Melcher 2006-03-29 14:54:39 +00:00
parent 668f127024
commit a33f1f7b35
2 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
documentation/Fl_Valuator.html
View File

@ -97,11 +97,22 @@ turned off by <TT>value(x)</TT> and just before doing a callback
<H4><A name=Fl_Valuator.format>int Fl_Valuator::format(char *buffer)</A></H4>
<P>Uses internal rules to format the fields numerical value into
the character array pointed to by the passed parameter.</P>
<P>The actual format used depends on the current step value. If
the step value has been set to zero then a %g format is used.
If the step value is non-zero, then a %.*f format is used,
where the precision is calculated to show sufficient digits
for the current step value. An integer step value, such as 1
or 1.0, gives a precision of 0, so the formatted value will
appear as an integer.</P>
<P>This method is used by the <TT>Fl_Value_...</TT> group of widgets to
format the current value into a text string.
The return value is the length of the formatted text.
The text itself is returned in <i>buffer</i>.
<i>buffer</i> should have space for up to 128 bytes.</P>
The formatted value is written into in <i>buffer</i>.
<i>buffer</i> should have space for at least 128 bytes.</P>
<P>You may override this function to create your own text formatting.</P>

6
documentation/Fl_Value_Input.html
View File

@ -31,6 +31,12 @@ href="Fl_Input.html#Fl_Input"><TT>Fl_Input</TT></A> widget with
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