summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-10-05 22:51:56 +0000
committerFabien Costantini <fabien@onepost.net>2008-10-05 22:51:56 +0000
commit908a2b5515a36778053187db0da60335c0361cde (patch)
tree3efd82127d1d149ab0b5398116b56aaac5df1e79
parentd4f47ee97e92f0ff0a7380607be26532db75ae36 (diff)
Doxygen documentation: added missing counter.gif image in Fl_Counter,Fl_Simple_Counter doc, also corrected some typos. Fl_Spinner is missing a gif file in class doc., would be nice to add a little one (could be extracted from valuators.gif)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6385 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
-rw-r--r--FL/Fl_Counter.H21
-rw-r--r--FL/Fl_Simple_Counter.H5
2 files changed, 14 insertions, 12 deletions
diff --git a/FL/Fl_Counter.H b/FL/Fl_Counter.H
index 36d788807..acdaa2e81 100644
--- a/FL/Fl_Counter.H
+++ b/FL/Fl_Counter.H
@@ -42,18 +42,17 @@
#define FL_SIMPLE_COUNTER 1 /**< type() for counter without fast buttons */
/**
- \class Fl_Counter
- \brief Fl_Counter widget for Forms compatibility.
-
- The Fl_Counter widget is provided for forms compatibility.
- It controls a single floating point value.
+ Controls a single floating point value with button (or keyboard) arrows.
+ Double arrows buttons achieve larger steps than simple arrows.
+ \see Fl_Spinner for value input with vertical step arrows.
+ <P align=center>\image html counter.gif</P>
\todo Refactor the doxygen comments for Fl_Counter type() documentation.
The type of an Fl_Counter object can be set using type(uchar t) to:
\li \c FL_NORMAL_COUNTER: Displays a counter with 4 arrow buttons.
\li \c FL_SIMPLE_COUNTER: Displays a counter with only 2 arrow buttons.
- */
+*/
class FL_EXPORT Fl_Counter : public Fl_Valuator {
Fl_Font textfont_;
@@ -77,19 +76,19 @@ public:
~Fl_Counter();
/**
- Set the increment for the large step buttons.
+ Sets the increment for the large step buttons.
The default value is 1.0.
\param[in] a large step increment.
- */
+ */
void lstep(double a) {lstep_ = a;}
/**
- Set the increments for the normal and large step buttons.
+ Sets the increments for the normal and large step buttons.
\param[in] a, b normal and large step increments.
*/
void step(double a,double b) {Fl_Valuator::step(a); lstep_ = b;}
/**
- Set the increment for the normal step buttons.
+ Sets the increment for the normal step buttons.
\param[in] a normal step increment.
*/
void step(double a) {Fl_Valuator::step(a);}
@@ -106,7 +105,7 @@ public:
/** Gets the font color */
Fl_Color textcolor() const {return (Fl_Color)textcolor_;}
- /** Sets the font color to \p a */
+ /** Sets the font color to \a s */
void textcolor(unsigned s) {textcolor_ = s;}
};
diff --git a/FL/Fl_Simple_Counter.H b/FL/Fl_Simple_Counter.H
index 0e1e1a4ef..3cf559fae 100644
--- a/FL/Fl_Simple_Counter.H
+++ b/FL/Fl_Simple_Counter.H
@@ -32,7 +32,10 @@
#define Fl_Simple_Counter_H
#include "Fl_Counter.H"
-/** This widget creates a counter with only 2 arrow buttons */
+/**
+ This widget creates a counter with only 2 arrow buttons
+ <P align=center>\image html counter.gif</P>
+*/
class Fl_Simple_Counter : public Fl_Counter {
public:
Fl_Simple_Counter(int x,int y,int w,int h, const char *l = 0)