From 6645d3cb6ab0ce5b2dbbeb31ad818cb41e44e10e Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Sun, 14 Sep 2008 20:00:03 +0000 Subject: Doxygen Documentation WP6 Done, Also completed the documentation of Help_View, Help_Dialog and cleaned up Preferences from ugly stars in comments and also removed redundant get/set text from methods doc. In this increment, we don't bother with the old dox format (comments in header). We have better things to do with our time (like about 40 mores files to doxyfy :-). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6243 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Light_Button.H | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'FL/Fl_Light_Button.H') diff --git a/FL/Fl_Light_Button.H b/FL/Fl_Light_Button.H index b9da5b440..41471b681 100644 --- a/FL/Fl_Light_Button.H +++ b/FL/Fl_Light_Button.H @@ -30,6 +30,16 @@ #include "Fl_Button.H" +/** +

This subclass displays the "on" state by turning on a light, + rather than drawing pushed in. The shape of the "light" + is initially set to FL_DOWN_BOX. The color of the light when + on is controlled with selection_color(), which defaults to FL_YELLOW. + + Buttons generate callbacks when they are clicked by the user. You + control exactly when and how by changing the values for type() and when(). +

\image html Fl_Light_Button.gif

+*/ class FL_EXPORT Fl_Light_Button : public Fl_Button { protected: virtual void draw(); -- cgit v1.2.3