diff options
| author | Fabien Costantini <fabien@onepost.net> | 2008-09-18 19:09:34 +0000 |
|---|---|---|
| committer | Fabien Costantini <fabien@onepost.net> | 2008-09-18 19:09:34 +0000 |
| commit | e8478458bf96bb62158a61b39416e515767d94a7 (patch) | |
| tree | 0ba17d2b9ae36dc475c63e1d0499204208a632f7 /FL/Fl_Valuator.H | |
| parent | d75b9717c7c1d607a83d0b9625296a0a3bce25c3 (diff) | |
Doxygen documentation: Fixed most important warnings for the Fl_Widget, Fl_Window, Fl_Valuator classes that should be now a 100% documented. For the rest I drastically reduced the undocumented APIs, but many others (less important) remains.
It looks and feels pretty good now :-)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6299 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Valuator.H')
| -rw-r--r-- | FL/Fl_Valuator.H | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/FL/Fl_Valuator.H b/FL/Fl_Valuator.H index eb2d8a814..89dce8503 100644 --- a/FL/Fl_Valuator.H +++ b/FL/Fl_Valuator.H @@ -36,8 +36,8 @@ #endif // shared type() values for classes that work in both directions: -#define FL_VERTICAL 0 -#define FL_HORIZONTAL 1 +#define FL_VERTICAL 0 ///< The valuator can work vertically +#define FL_HORIZONTAL 1 ///< The valuator can work horizontally /** The Fl_Valuator class controls a single floating-point value @@ -59,16 +59,19 @@ class FL_EXPORT Fl_Valuator : public Fl_Widget { double A; int B; // rounds to multiples of A/B, or no rounding if A is zero protected: - - int horizontal() const {return type()&1;} + /** Tells if the valuator is an FL_HORIZONTAL one */ + int horizontal() const {return type()& FL_HORIZONTAL;} Fl_Valuator(int X, int Y, int W, int H, const char* L); + /** Gets the previous floating point value before an event changed it */ double previous_value() const {return previous_value_;} + /** Stores the current value in the previous value */ void handle_push() {previous_value_ = value_;} double softclamp(double); void handle_drag(double newvalue); void handle_release(); // use drag() value virtual void value_damage(); // cause damage() due to value() changing + /** Sets the current floating point value. */ void set_value(double v) {value_ = v;} public: |