mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor changes in Doxygen docs of Fl_Value_Input::shortcut() functions.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8337 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Manolo Gouy 2011-01-30 09:04:59 +00:00
parent 802aff1785
commit 5850cc1334
1 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
FL/Fl_Value_Input.H
View File

@ -90,23 +90,27 @@ public:
*/ */
char soft() const {return soft_;} char soft() const {return soft_;}
/** /**
The first form returns the current shortcut key for the Input. Returns the current shortcut key for the Input.
<P>The second form sets the shortcut key to key. Setting this \see Fl_Value_Input::shortcut(int)
overrides the use of '&' in the label(). The value is a bitwise
OR of a key and a set of shift flags, for example FL_ALT | 'a'
, FL_ALT | (FL_F + 10), or just 'a'. A value
of 0 disables the shortcut. </P>
<P>The key can be any value returned by
Fl::event_key(), but will usually be an ASCII letter. Use
a lower-case letter unless you require the shift key to be held down. </P>
<P>The shift flags can be any set of values accepted by
Fl::event_state(). If the bit is on that shift key must
be pushed. Meta, Alt, Ctrl, and Shift must be off if they are not in
the shift flags (zero for the other bits indicates a "don't care"
setting).
*/ */
int shortcut() const {return input.shortcut();} int shortcut() const {return input.shortcut();}
/** See int Fl_Value_Input::shortcut() const */ /**
Sets the shortcut key to \p s. Setting this
overrides the use of '&' in the label(). The value is a bitwise
OR of a key and a set of shift flags, for example FL_ALT | 'a'
, FL_ALT | (FL_F + 10), or just 'a'. A value
of 0 disables the shortcut.
The key can be any value returned by
Fl::event_key(), but will usually be an ASCII letter. Use
a lower-case letter unless you require the shift key to be held down.
The shift flags can be any set of values accepted by
Fl::event_state(). If the bit is on that shift key must
be pushed. Meta, Alt, Ctrl, and Shift must be off if they are not in
the shift flags (zero for the other bits indicates a "don't care"
setting).
*/
void shortcut(int s) {input.shortcut(s);} void shortcut(int s) {input.shortcut(s);}
/** Gets the typeface of the text in the value box. */ /** Gets the typeface of the text in the value box. */