mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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)

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6385 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Fabien Costantini 2008-10-05 22:51:56 +00:00
parent d4f47ee97e
commit 908a2b5515
2 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
FL/Fl_Counter.H
View File

@ -42,18 +42,17 @@
#define FL_SIMPLE_COUNTER 1 /**< type() for counter without fast buttons */ #define FL_SIMPLE_COUNTER 1 /**< type() for counter without fast buttons */
/** /**
\class Fl_Counter Controls a single floating point value with button (or keyboard) arrows.
\brief Fl_Counter widget for Forms compatibility. Double arrows buttons achieve larger steps than simple arrows.
\see Fl_Spinner for value input with vertical step arrows.
The Fl_Counter widget is provided for forms compatibility. <P align=center>\image html counter.gif</P>
It controls a single floating point value.
\todo Refactor the doxygen comments for Fl_Counter type() documentation. \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: 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_NORMAL_COUNTER: Displays a counter with 4 arrow buttons.
\li \c FL_SIMPLE_COUNTER: Displays a counter with only 2 arrow buttons. \li \c FL_SIMPLE_COUNTER: Displays a counter with only 2 arrow buttons.
*/ */
class FL_EXPORT Fl_Counter : public Fl_Valuator { class FL_EXPORT Fl_Counter : public Fl_Valuator {
Fl_Font textfont_; Fl_Font textfont_;
@ -77,19 +76,19 @@ public:
~Fl_Counter(); ~Fl_Counter();
/** /**
Set the increment for the large step buttons. Sets the increment for the large step buttons.
The default value is 1.0. The default value is 1.0.
\param[in] a large step increment. \param[in] a large step increment.
*/ */
void lstep(double a) {lstep_ = a;} 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. \param[in] a, b normal and large step increments.
*/ */
void step(double a,double b) {Fl_Valuator::step(a); lstep_ = b;} 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. \param[in] a normal step increment.
*/ */
void step(double a) {Fl_Valuator::step(a);} void step(double a) {Fl_Valuator::step(a);}
@ -106,7 +105,7 @@ public:
/** Gets the font color */ /** Gets the font color */
Fl_Color textcolor() const {return (Fl_Color)textcolor_;} 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;} void textcolor(unsigned s) {textcolor_ = s;}
}; };

5
FL/Fl_Simple_Counter.H
View File

@ -32,7 +32,10 @@
#define Fl_Simple_Counter_H #define Fl_Simple_Counter_H
#include "Fl_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 { class Fl_Simple_Counter : public Fl_Counter {
public: public:
Fl_Simple_Counter(int x,int y,int w,int h, const char *l = 0) Fl_Simple_Counter(int x,int y,int w,int h, const char *l = 0)