summaryrefslogtreecommitdiff
path: root/src/Fl_Valuator.cxx
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-09-17 22:25:45 +0000
committerFabien Costantini <fabien@onepost.net>2008-09-17 22:25:45 +0000
commit2be88792b3746c72d82448f8373bc7d6b322d38a (patch)
tree15ef46c26f31448bbcd48d13b9f8788ddeb16e8f /src/Fl_Valuator.cxx
parent74cbd55745e7c55a62be524279c707a572f6c688 (diff)
Doxygen documentation: fixed all ambiguous methods signatures, fixed erroneous path test into ../test since the doxyfile move, fixed all intro dl,dt,dd related tags warnings in intro.dox .
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6289 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/Fl_Valuator.cxx')
-rw-r--r--src/Fl_Valuator.cxx18
1 files changed, 11 insertions, 7 deletions
diff --git a/src/Fl_Valuator.cxx b/src/Fl_Valuator.cxx
index 8e552ba78..7a76220df 100644
--- a/src/Fl_Valuator.cxx
+++ b/src/Fl_Valuator.cxx
@@ -25,11 +25,6 @@
// http://www.fltk.org/str.php
//
-/** \fn int Fl_Valuator::changed() const
- This value is true if the user has moved the slider. It is
- turned off by value(x) and just before doing a callback
- (the callback can turn it back on if desired).
-*/
// Base class for sliders and all other one-value "knobs"
@@ -65,7 +60,7 @@ void Fl_Valuator::step(double s) {
while (fabs(s-A/B) > epsilon && B<=(0x7fffffff/10)) {B *= 10; A = rint(s*B);}
}
-/** Sets the step value to 1/10<SUP>digits.*/
+/** Sets the step value to 1/10<SUP>digits</SUP>.*/
void Fl_Valuator::precision(int p) {
A = 1.0;
for (B = 1; p--;) B *= 10;
@@ -73,7 +68,16 @@ void Fl_Valuator::precision(int p) {
/** Asks for partial redraw */
void Fl_Valuator::value_damage() {damage(FL_DAMAGE_EXPOSE);} // by default do partial-redraw
-/** See double Fl_Valuator::value() const */
+/**
+ Sets the current value. The new value is <I>not</I>
+ clamped or otherwise changed before storing it. Use
+ clamp() or round() to modify the value before
+ calling value(). The widget is redrawn if the new value
+ is different than the current one. The initial value is zero.
+ <P>changed() will return true if the user has moved the slider,
+ but it will be turned off by value(x) and just before doing a callback
+ (the callback can turn it back on if desired).
+*/
int Fl_Valuator::value(double v) {
clear_changed();
if (v == value_) return 0;