diff options
| author | Matthias Melcher <fltk@matthiasm.com> | 2006-03-29 08:09:26 +0000 |
|---|---|---|
| committer | Matthias Melcher <fltk@matthiasm.com> | 2006-03-29 08:09:26 +0000 |
| commit | 4c481a5736a0ed8269758aa81069d2ab46500e09 (patch) | |
| tree | 3c9ccd93ccfb2fadbddd54062ee3ce441ed1ee06 /documentation | |
| parent | d490097eaacbc300dd7f52502636d85f4585fafd (diff) | |
STR 1157: Attempt to make the documentation on Fl_Valuator::format clearer. An native English speaker should check this please.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@4881 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/Fl_Valuator.html | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/documentation/Fl_Valuator.html b/documentation/Fl_Valuator.html index 4903c144c..b2dc188b0 100644 --- a/documentation/Fl_Valuator.html +++ b/documentation/Fl_Valuator.html @@ -95,12 +95,15 @@ turned off by <TT>value(x)</TT> and just before doing a callback <P>Clears the <TT>changed()</TT> flag. -<H4><A name=Fl_Valuator.format>int Fl_Valuator::format(char *)</A></H4> +<H4><A name=Fl_Valuator.format>int Fl_Valuator::format(char *buffer)</A></H4> -<P>Format the passed value to show enough digits so that for the -current step value. If the step has been set to zero then it -does a <TT>%g</TT> format. The characters are written into the -passed buffer. +<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> + +<P>You may override this function to create your own text formatting.</P> <H4><A name=Fl_Valuator.increment>double Fl_Valuator::increment(double,int n)</A></H4> |