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_Multi_Browser.H | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'FL/Fl_Multi_Browser.H') diff --git a/FL/Fl_Multi_Browser.H b/FL/Fl_Multi_Browser.H index 17b31f3e9..0bd1c1f7c 100644 --- a/FL/Fl_Multi_Browser.H +++ b/FL/Fl_Multi_Browser.H @@ -30,8 +30,24 @@ #include "Fl_Browser.H" +/** + The Fl_Multi_Browser class is a subclass of Fl_Browser + which lets the user select any set of the lines. The user interface + is Macintosh style: clicking an item turns off all the others and + selects that one, dragging selects all the items the mouse moves over, + and shift + click toggles the items. This is different then how forms + did it. Normally the callback is done when the user releases the + mouse, but you can change this with when(). +

See Fl_Browser for methods to add and remove lines from the browser. +*/ class Fl_Multi_Browser : public Fl_Browser { public: + /** + Creates a new Fl_Multi_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_MULTI_BROWSER. + The destructor destroys the widget and frees all memory that has been allocated. + */ Fl_Multi_Browser(int X,int Y,int W,int H,const char *L=0) : Fl_Browser(X,Y,W,H,L) {type(FL_MULTI_BROWSER);} }; -- cgit v1.2.3