summaryrefslogtreecommitdiff
path: root/FL/Fl_Button.H
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-09-18 19:09:34 +0000
committerFabien Costantini <fabien@onepost.net>2008-09-18 19:09:34 +0000
commite8478458bf96bb62158a61b39416e515767d94a7 (patch)
tree0ba17d2b9ae36dc475c63e1d0499204208a632f7 /FL/Fl_Button.H
parentd75b9717c7c1d607a83d0b9625296a0a3bce25c3 (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_Button.H')
-rw-r--r--FL/Fl_Button.H11
1 files changed, 6 insertions, 5 deletions
diff --git a/FL/Fl_Button.H b/FL/Fl_Button.H
index ded1dfe9e..05b1b7585 100644
--- a/FL/Fl_Button.H
+++ b/FL/Fl_Button.H
@@ -36,10 +36,12 @@
#endif
// values for type()
-#define FL_NORMAL_BUTTON 0
-#define FL_TOGGLE_BUTTON 1
-#define FL_RADIO_BUTTON (FL_RESERVED_TYPE+2)
-#define FL_HIDDEN_BUTTON 3 // for Forms compatibility
+#define FL_NORMAL_BUTTON 0 ///< value() remains unchanged after button press.
+#define FL_TOGGLE_BUTTON 1 ///< value() is inverted after button press.
+#define FL_RADIO_BUTTON (FL_RESERVED_TYPE+2) /**< is set to 1 after button press, and all other
+ buttons in the current group with <tt>type() == FL_RADIO_BUTTON</tt>
+ are set to zero.*/
+#define FL_HIDDEN_BUTTON 3 ///< for Forms compatibility
extern FL_EXPORT int fl_old_shortcut(const char*);
@@ -76,7 +78,6 @@ extern FL_EXPORT int fl_old_shortcut(const char*);
(when the user pushes and releases the button, and as the mouse is
dragged around in and out of the button).
*/
-
class FL_EXPORT Fl_Button : public Fl_Widget {
int shortcut_;