From 58548b781d7c3f0fa6c8c72c63dece888a02ea43 Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Sun, 14 Sep 2008 12:45:42 +0000 Subject: Doxygen Documentation WP2 done. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6235 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Select_Browser.H | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'FL/Fl_Select_Browser.H') diff --git a/FL/Fl_Select_Browser.H b/FL/Fl_Select_Browser.H index c055e76d2..304fac9be 100644 --- a/FL/Fl_Select_Browser.H +++ b/FL/Fl_Select_Browser.H @@ -30,9 +30,23 @@ #include "Fl_Browser.H" +/** + The class is a subclass of Fl_Browser + which lets the user select a single item, or no items by clicking on + the empty space. As long as the mouse button is held down on an + unselected item it is highlighted. Normally the callback is done when the + user presses the mouse, but you can change this with when(). +

See Fl_Browser for methods to add and remove lines from the browser. +*/ class Fl_Select_Browser : public Fl_Browser { public: - Fl_Select_Browser(int X,int Y,int W,int H,const char *l=0) + /** + Creates a new Fl_Select_Browser widget using the given + position, size, and label string. The default boxtype is FL_DOWN_BOX. + The constructor specializes Fl_Browser() by setting the type to FL_SELECT_BROWSER. + The destructor destroys the widget and frees all memory that has been allocated. + */ + Fl_Select_Browser(int X,int Y,int W,int H,const char *l=0) : Fl_Browser(X,Y,W,H,l) {type(FL_SELECT_BROWSER);} }; -- cgit v1.2.3