From 9e4c207e27505f183e940804668a678cd68888c8 Mon Sep 17 00:00:00 2001 From: Greg Ercolano Date: Fri, 26 Jul 2019 13:32:18 -0700 Subject: Added example images for Fl_[Hold/Multi]_Browser --- FL/Fl_Browser.H | 8 ++++++++ FL/Fl_Hold_Browser.H | 10 +++++++--- FL/Fl_Multi_Browser.H | 10 +++++++--- documentation/src/fl_hold_browser.png | Bin 0 -> 661 bytes documentation/src/fl_multi_browser.png | Bin 0 -> 683 bytes 5 files changed, 22 insertions(+), 6 deletions(-) create mode 100644 documentation/src/fl_hold_browser.png create mode 100644 documentation/src/fl_multi_browser.png diff --git a/FL/Fl_Browser.H b/FL/Fl_Browser.H index 191d98271..323076362 100644 --- a/FL/Fl_Browser.H +++ b/FL/Fl_Browser.H @@ -37,6 +37,14 @@ struct FL_BLINE; editor or spreadsheet! But it is useful for showing a vertical list of named objects to the user. + \image html fl_hold_browser.png "Fl_Hold_Browser" + \image latex fl_hold_browser.png "Fl_Hold_Browser" width=4cm + + \par + + \image html fl_multi_browser.png "Fl_Multi_Browser" + \image latex fl_multi_browser.png "Fl_Multi_Browser" width=4cm + Each line in the browser is identified by number. The numbers start at one (this is so that zero can be reserved for "no line" in the selective browsers). Unless otherwise noted, the methods do not diff --git a/FL/Fl_Hold_Browser.H b/FL/Fl_Hold_Browser.H index 7922b6cad..79113b496 100644 --- a/FL/Fl_Hold_Browser.H +++ b/FL/Fl_Hold_Browser.H @@ -25,9 +25,13 @@ #include "Fl_Browser.H" /** - The Fl_Hold_Browser 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 the item + The Fl_Hold_Browser is a subclass of Fl_Browser which lets the user + select a single item, or no items by clicking on the empty space. + + \image html fl_hold_browser.png "Fl_Hold_Browser" + \image latex fl_hold_browser.png "Fl_Hold_Browser" width=4cm + + As long as the mouse button is held down the item pointed to by it is highlighted, and this highlighting remains on when the mouse button is released. Normally the callback is done when the user releases the mouse, but you can change this with when(). diff --git a/FL/Fl_Multi_Browser.H b/FL/Fl_Multi_Browser.H index 8774fd713..39bd446b3 100644 --- a/FL/Fl_Multi_Browser.H +++ b/FL/Fl_Multi_Browser.H @@ -26,8 +26,12 @@ /** 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 + which lets the user select any set of the lines. + + \image html fl_multi_browser.png "Fl_Multi_Browser" + \image latex fl_multi_browser.png "Fl_Multi_Browser" width=4cm + + 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 ctrl + click (Cmd+click on the Mac OS platform) toggles the items. Shift + click extends the selection until the clicked item. @@ -39,7 +43,7 @@ class FL_EXPORT Fl_Multi_Browser : public Fl_Browser { public: /** - Creates a new Fl_Multi_Browser widget using the given + 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. diff --git a/documentation/src/fl_hold_browser.png b/documentation/src/fl_hold_browser.png new file mode 100644 index 000000000..45a8b8e41 Binary files /dev/null and b/documentation/src/fl_hold_browser.png differ diff --git a/documentation/src/fl_multi_browser.png b/documentation/src/fl_multi_browser.png new file mode 100644 index 000000000..1237b6e7c Binary files /dev/null and b/documentation/src/fl_multi_browser.png differ -- cgit v1.2.3