summaryrefslogtreecommitdiff
path: root/FL/Fl_Value_Input.H
diff options
context:
space:
mode:
authorManolo Gouy <Manolo>2011-01-30 09:04:59 +0000
committerManolo Gouy <Manolo>2011-01-30 09:04:59 +0000
commit5850cc133407499963d2478cddb60da42978e919 (patch)
tree2be4c5f2bbbb9e52a905c92ba766c64fbce41bcb /FL/Fl_Value_Input.H
parent802aff1785736865957ca7a4870c28ad2e89d9cc (diff)
Minor changes in Doxygen docs of Fl_Value_Input::shortcut() functions.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8337 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Value_Input.H')
-rw-r--r--FL/Fl_Value_Input.H34
1 files changed, 19 insertions, 15 deletions
diff --git a/FL/Fl_Value_Input.H b/FL/Fl_Value_Input.H
index 4759f4e21..a2c3e9a29 100644
--- a/FL/Fl_Value_Input.H
+++ b/FL/Fl_Value_Input.H
@@ -90,23 +90,27 @@ public:
*/
char soft() const {return soft_;}
/**
- The first form returns the current shortcut key for the Input.
- <P>The second form sets the shortcut key to key. 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. </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).
+ Returns the current shortcut key for the Input.
+ \see Fl_Value_Input::shortcut(int)
*/
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);}
/** Gets the typeface of the text in the value box. */