diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 2002-04-16 12:14:27 +0000 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 2002-04-16 12:14:27 +0000 |
| commit | 989b0cd372cf00775950c74d5455942671537fe4 (patch) | |
| tree | 48eef5beced9273a5ab8ba1774253e6369e4f7d0 /documentation | |
| parent | 772b36810d5ae09cdbc3271d5cf8eb9db12e48b6 (diff) | |
Update changelog.
Add missing methods to Fl_Valuator docos.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@2091 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/Fl_Valuator.html | 201 |
1 files changed, 123 insertions, 78 deletions
diff --git a/documentation/Fl_Valuator.html b/documentation/Fl_Valuator.html index e72d7cce3..4903c144c 100644 --- a/documentation/Fl_Valuator.html +++ b/documentation/Fl_Valuator.html @@ -36,101 +36,146 @@ defined as zero.</P> <TABLE width=90% summary="Fl_Valuator methods."> <TR><TD align=left valign=top> <UL> -<LI><A href=#Fl_Valuator.Fl_Valuator>Fl_Valuator</A></LI> -<LI><A href=#Fl_Valuator.~Fl_Valuator>~Fl_Valuator</A></LI> -<LI><A href=#Fl_Valuator.changed>changed</A></LI> + <LI><A href="#Fl_Valuator.Fl_Valuator">Fl_Valuator</A></LI> + <LI><A href="#Fl_Valuator.~Fl_Valuator">~Fl_Valuator</A></LI> + <LI><A href="#Fl_Valuator.bounds">bounds</A></LI> + <LI><A href="#Fl_Valuator.changed">changed</A></LI> </UL> </TD><TD align=left valign=top> <UL> -<LI><A href=#Fl_Valuator.clamp>clamp</A></LI> -<LI><A href=#Fl_Valuator.clear_changed>clear_changed</A></LI> -<LI><A href=#Fl_Valuator.format>format</A></LI> + <LI><A href="#Fl_Valuator.clamp">clamp</A></LI> + <LI><A href="#Fl_Valuator.clear_changed">clear_changed</A></LI> + <LI><A href="#Fl_Valuator.format">format</A></LI> + <LI><A href="#Fl_Valuator.increment">increment</A></LI> </UL> </TD><TD align=left valign=top> <UL> -<LI><A href=#Fl_Valuator.increment>increment</A></LI> -<LI><A href=#Fl_Valuator.maximum>maximum</A></LI> -<LI><A href=#Fl_Valuator.minimum>minimum</A></LI> + <LI><A href="#Fl_Valuator.maximum">maximum</A></LI> + <LI><A href="#Fl_Valuator.minimum">minimum</A></LI> + <LI><A href="#Fl_Valuator.precision">precision</A></LI> + <LI><A href="#Fl_Valuator.range">range</A></LI> </UL> </TD><TD align=left valign=top> <UL> -<LI><A href=#Fl_Valuator.range>range</A></LI> -<LI><A href=#Fl_Valuator.round>round</A></LI> -<LI><A href=#Fl_Valuator.set_changed>set_changed</A></LI> -</UL> -</TD><TD align=left valign=top> -<UL> -<LI><A href=#Fl_Valuator.step>step</A></LI> -<LI><A href=#Fl_Valuator.value>value</A></LI> + <LI><A href="#Fl_Valuator.round">round</A></LI> + <LI><A href="#Fl_Valuator.set_changed">set_changed</A></LI> + <LI><A href="#Fl_Valuator.step">step</A></LI> + <LI><A href="#Fl_Valuator.value">value</A></LI> </UL> </TD></TR> </TABLE> </CENTER> + <H4><A name=Fl_Valuator.Fl_Valuator>Fl_Valuator::Fl_Valuator(int x, int y, int w, int h, const char *label = 0)</A></H4> - Creates a new <TT>Fl_Valuator</TT> widget using the given position, + +<P>Creates a new <TT>Fl_Valuator</TT> widget using the given position, size, and label string. The default boxtype is <TT>FL_NO_BOX</TT>. -<H4><A name=Fl_Valuator.~Fl_Valuator>virtual Fl_Valuator::~Fl_Valuator()</A> -</H4> - Destroys the valuator. -<H4><A name=Fl_Valuator.value>double Fl_Valuator::value() const -<BR> int Fl_Valuator::value(double)</A></H4> - Get or set the current value. The new value is <I>not</I> clamped or -otherwise changed before storing it. Use <TT>clamp()</TT> or <TT>round()</TT> - to modify the value before calling this if you want. If the new value -is different than the current one the object is redrawn. The initial -value is zero. -<H4><A name=Fl_Valuator.minimum>double Fl_Valuator::minimum() const -<BR> void Fl_Valuator::minimum(double)</A></H4> - Gets or sets the minimum value for the valuator. + +<H4><A name=Fl_Valuator.~Fl_Valuator>virtual Fl_Valuator::~Fl_Valuator()</A></H4> + +<P>Destroys the valuator. + +<H4><A NAME="Fl_Valuator.bounds">void Fl_Valuator::bounds(double a, double b);</A></H4> + +<P>Sets the minimum (<TT>a</TT>) and maximum (<TT>b</TT>) values for +the valuator widget. + +<H4><A name=Fl_Valuator.changed>int Fl_Valuator::changed() const</A></H4> + +<P>This value is true if the user has moved the slider. It is +turned off by <TT>value(x)</TT> and just before doing a callback +(the callback can turn it back on if desired). + +<H4><A name=Fl_Valuator.clamp>double Fl_Valuator::clamp(double)</A></H4> + +<P>Clamps the passed value to the valuator range. + +<H4><A name=Fl_Valuator.clear_changed>void Fl_Valuator::clear_changed()</A></H4> + +<P>Clears the <TT>changed()</TT> flag. + +<H4><A name=Fl_Valuator.format>int Fl_Valuator::format(char *)</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. + +<H4><A name=Fl_Valuator.increment>double +Fl_Valuator::increment(double,int n)</A></H4> + +<P>Adds <TT>n</TT> times the step value to the passed value. If +step was set to zero it uses <TT>fabs(maximum() - minimum()) / +100</TT>. + <H4><A name=Fl_Valuator.maximum>double Fl_Valuator::maximum() const -<BR> void Fl_Valuator::maximum(double)</A></H4> - Gets or sets the maximum value for the valuator. +<BR>void Fl_Valuator::maximum(double)</A></H4> + +<P>Gets or sets the maximum value for the valuator. + +<H4><A name=Fl_Valuator.minimum>double Fl_Valuator::minimum() const +<BR>void Fl_Valuator::minimum(double)</A></H4> + +<P>Gets or sets the minimum value for the valuator. + +<H4><A NAME="Fl_Valuator.precision">void Fl_Valuator::precision(int digits);</A></H4> + +<P>Sets the step value to 1/10<SUP>digits. + <H4><A name=Fl_Valuator.range>void Fl_Valuator::range(double min, double max);</A></H4> - Sets the minimum and maximum values for the valuator. When the user -manipulates the widget, the value is limited to this range. This -clamping is done <I>after</I> rounding to the step value (this makes a -difference if the range is not a multiple of the step). -<P>The minimum may be greater than the maximum. This has the effect of -"reversing" the object so the larger values are in the opposite -direction. This also switches which end of the filled sliders is -filled. </P> -<P>Some widgets consider this a "soft" range. This means they will -stop at the range, but if the user releases and grabs the control again -and tries to move it further, it is allowed. </P> -<P>The range may affect the display. You must <TT>redraw()</TT> the -widget after changing the range. </P> -<H4><A name=Fl_Valuator.step>double Fl_Valuator::step() const -<BR> void Fl_Valuator::step(double) -<BR> void Fl_Valuator::step(int A, int B)</A></H4> - Get or set the step value. As the user moves the mouse the value is -rounded to the nearest multiple of the step value. This is done <I> -before</I> clamping it to the range. For most objects the default step -is zero. -<P>For precision the step is stored as the ratio of two integers, A/B. - You can set these integers directly. Currently setting a floating -point value sets the nearest A/1 or 1/B value possible. </P> -<H4><A name=Fl_Valuator.format>int Fl_Valuator::format(char *)</A> -</H4> -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>Sets the minimum and maximum values for the valuator. When +the user manipulates the widget, the value is limited to this +range. This clamping is done <I>after</I> rounding to the step +value (this makes a difference if the range is not a multiple of +the step). + +<P>The minimum may be greater than the maximum. This has the +effect of "reversing" the object so the larger values +are in the opposite direction. This also switches which end of +the filled sliders is filled.</P> + +<P>Some widgets consider this a "soft" range. This +means they will stop at the range, but if the user releases and +grabs the control again and tries to move it further, it is +allowed.</P> + +<P>The range may affect the display. You must <TT>redraw()</TT> +the widget after changing the range.</P> + <H4><A name=Fl_Valuator.round>double Fl_Valuator::round(double)</A></H4> -Round the passed value to the nearest step increment. Does nothing if -step is zero. -<H4><A name=Fl_Valuator.clamp>double Fl_Valuator::clamp(double)</A></H4> -Clamp the passed value to the valuator range. -<H4><A name=Fl_Valuator.increment>double -Fl_Valuator::increment(double,int n)</A></H4> - Adds <TT>n</TT> times the step value to the passed value. If step was -set to zero it uses <TT>fabs(maximum() - minimum()) / 100</TT>. -<H4><A name=Fl_Valuator.changed>int Fl_Widget::changed() const</A></H4> - This value is true if the user has moved the slider. It is turned off -by <TT>value(x)</TT> and just before doing a callback (the callback can -turn it back on if desired). -<H4><A name=Fl_Valuator.set_changed>void Fl_Widget::set_changed()</A></H4> -Sets the <TT>changed()</TT> flag. -<H4><A name=Fl_Valuator.clear_changed>void Fl_Widget::clear_changed()</A> -</H4> - Clears the <TT>changed()</TT> flag. </BODY></HTML> + +<P>Round the passed value to the nearest step increment. Does +nothing if step is zero. + +<H4><A name=Fl_Valuator.set_changed>void Fl_Valuator::set_changed()</A></H4> + +<P>Sets the <TT>changed()</TT> flag. + +<H4><A name=Fl_Valuator.step>double Fl_Valuator::step() const +<BR>void Fl_Valuator::step(double) +<BR>void Fl_Valuator::step(int A, int B)</A></H4> + +<P>Gets or sets the step value. As the user moves the mouse the +value is rounded to the nearest multiple of the step value. This +is done <I>before</I> clamping it to the range. For most widgets +the default step is zero. + +<P>For precision the step is stored as the ratio of two +integers, A/B. You can set these integers directly. Currently +setting a floating point value sets the nearest A/1 or 1/B value +possible.</P> + +<H4><A name=Fl_Valuator.value>double Fl_Valuator::value() const +<BR> int Fl_Valuator::value(double)</A></H4> + +<P>Gets or sets the current value. The new value is <I>not</I> +clamped or otherwise changed before storing it. Use +<TT>clamp()</TT> or <TT>round()</TT> to modify the value before +calling <TT>value()</TT>. The widget is redrawn if the new value +is different than the current one. The initial value is zero. + +</BODY> +</HTML> |
