summaryrefslogtreecommitdiff
path: root/FL/Fl_Toggle_Button.H
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-09-15 16:39:05 +0000
committerFabien Costantini <fabien@onepost.net>2008-09-15 16:39:05 +0000
commitb8955a9ced0270ec7aa7052e6e0852cae140ca27 (patch)
tree2432866aeda02a7c0cfa93e04a2d0c3b802a6033 /FL/Fl_Toggle_Button.H
parent09f3094aef152ece5bf802983d54f1642d803e0d (diff)
Doxygen documentation WP11 Done!
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6255 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Toggle_Button.H')
-rw-r--r--FL/Fl_Toggle_Button.H14
1 files changed, 14 insertions, 0 deletions
diff --git a/FL/Fl_Toggle_Button.H b/FL/Fl_Toggle_Button.H
index 755c1cec3..790d7361b 100644
--- a/FL/Fl_Toggle_Button.H
+++ b/FL/Fl_Toggle_Button.H
@@ -30,8 +30,22 @@
#include "Fl_Button.H"
+/**
+ The toggle button is a push button that needs to be clicked once
+ to toggle on, and one more time to toggle off.
+ The Fl_Toggle_Button subclass displays the &quot;on&quot; state by
+ drawing a pushed-in button.</P>
+ <P>Buttons generate callbacks when they are clicked by the user. You
+ control exactly when and how by changing the values for type()
+ and when().
+*/
class Fl_Toggle_Button : public Fl_Button {
public:
+ /**
+ Creates a new Fl_Toggle_Button widget using the given
+ position, size, and label string.
+ <P>The inherited destructor deletes the toggle button.
+ */
Fl_Toggle_Button(int X,int Y,int W,int H,const char *l=0)
: Fl_Button(X,Y,W,H,l) {type(FL_TOGGLE_BUTTON);}
};