summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2013-03-23 21:24:18 +0000
committerGreg Ercolano <erco@seriss.com>2013-03-23 21:24:18 +0000
commit65aefad242ac93eb3c64b163818ccd100eeb3c62 (patch)
tree745e24e5806616204a2da218a9222b1cd6c5f917
parent5979afb5bf8bd7fc2f730c31106570b8d5bc3e14 (diff)
Expanded docs for Fl_Browser_ to define the supported
keyboard navigation behavior. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9846 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
-rw-r--r--FL/Fl_Browser_.H19
1 files changed, 19 insertions, 0 deletions
diff --git a/FL/Fl_Browser_.H b/FL/Fl_Browser_.H
index 1e303edf2..c33973465 100644
--- a/FL/Fl_Browser_.H
+++ b/FL/Fl_Browser_.H
@@ -54,6 +54,25 @@
useful if actually figuring out the size of an object requires
accessing image data or doing stat() on a file or doing some
other slow operation.
+
+ Keyboard navigation of browser items
+ ------------------------------------
+ The keyboard navigation of browser items is only possible if
+ visible_focus() is enabled. If disabled, the widget rejects keyboard focus;
+ Tab and Shift-Tab focus navigation will skip the widget.
+
+ In 'Select' and 'Normal' mode, the widget rejects keyboard focus;
+ no navigation keys are supported (other than scrollbar positioning).
+
+ In 'Hold' mode, the widget accepts keyboard focus, and Up/Down arrow
+ keys can navigate the selected item.
+
+ In 'Multi' mode, the widget accepts keyboard focus, and Up/Down arrow
+ keys navigate the focus box; Space toggles the current item's selection,
+ Enter selects only the current item (deselects all others). If Shift
+ (or Ctrl) is combined with Up/Down arrow keys, the current item's
+ selection state is extended to the next item. In this way one can
+ extend a selection or de-selection.
*/
class FL_EXPORT Fl_Browser_ : public Fl_Group {
int position_; // where user wants it scrolled to