From b8955a9ced0270ec7aa7052e6e0852cae140ca27 Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Mon, 15 Sep 2008 16:39:05 +0000 Subject: Doxygen documentation WP11 Done! git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6255 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Toggle_Button.H | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'FL/Fl_Toggle_Button.H') 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 "on" state by + drawing a pushed-in button.

+

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. +

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);} }; -- cgit v1.2.3