Author: manolo
Date: 2011-01-30 01:04:59 -0800 (Sun, 30 Jan 2011)
New Revision: 8337
Log:
Minor changes in Doxygen docs of Fl_Value_Input::shortcut() functions.
Modified:
branches/branch-1.3/FL/Fl_Value_Input.H
Modified: branches/branch-1.3/FL/Fl_Value_Input.H
===================================================================
--- branches/branch-1.3/FL/Fl_Value_Input.H 2011-01-30 08:55:46 UTC (rev
8336)
+++ branches/branch-1.3/FL/Fl_Value_Input.H 2011-01-30 09:04:59 UTC (rev
8337)
@@ -90,23 +90,27 @@
*/
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. */
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
