Small doc modifications to clarify Fl::OPTION_ARROW_FOCUS

and interrelate docs for Fl_Input_::tab_nav().



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10134 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Greg Ercolano 2014-04-29 02:56:34 +00:00
parent 9e079f63b8
commit 3a14af20b3
2 changed files with 15 additions and 5 deletions

15
FL/Fl.H
View File

@ -165,10 +165,17 @@ public:
\see Fl::option(Fl_Option)
*/
typedef enum {
/// When switched on, moving the text cursor beyond the start or end of
/// a text in a text widget will change focus to the next text widget.
/// When switched off, the cursor will stop at the end of the text.
/// Pressing Tab or Ctrl-Tab will advance the keyboard focus.
/// When switched on, arrow keys will navigate focus between widgets.
/// Also, left/right arrow keys in text widgets will change widget focus
/// if the cursor is moved off the start or end of text.
///
/// When switched off, arrow keys will not navigate focus, and in text
/// widgets left/right arrows will not move off the widget when the
/// start or end of text is reached. Pressing Tab or Ctrl-Tab will
/// advance the keyboard focus.
///
/// See also: Fl_Input_::tab_nav()
///
OPTION_ARROW_FOCUS = 0,
// When switched on, FLTK will use the file chooser dialog that comes
// with your operating system whenever possible. When switched off, FLTK

View File

@ -468,6 +468,8 @@ public:
\param [in] val If \p val is 1, Tab advances focus (default).<BR>
If \p val is 0, Tab inserts a tab character (old FLTK behavior).
\see tab_nav(), Fl::OPTION_ARROW_FOCUS.
*/
void tab_nav(int val) {
tab_nav_ = val;
@ -480,7 +482,8 @@ public:
If disabled, hitting Tab inserts a tab character into the text field.
\returns 1 if Tab advances focus (default), 0 if Tab inserts tab characters.
\see tab_nav(int)
\see tab_nav(int), Fl::OPTION_ARROW_FOCUS.
*/
int tab_nav() const {
return tab_nav_;