summaryrefslogtreecommitdiff
path: root/FL/Fl_Button.H
diff options
context:
space:
mode:
authorManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2023-02-05 16:07:14 +0100
committerManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2023-02-05 16:07:14 +0100
commit515680a633078bcde6984258c33d6774413493b9 (patch)
tree951c6cd19d50b25dafbbb1b00641e3d94995716c /FL/Fl_Button.H
parent589c1f31c313e1b9630b63a5cd91de6a1ff8872d (diff)
Remove a bunch of \todo items from documentation
Diffstat (limited to 'FL/Fl_Button.H')
-rw-r--r--FL/Fl_Button.H7
1 files changed, 2 insertions, 5 deletions
diff --git a/FL/Fl_Button.H b/FL/Fl_Button.H
index 14e515d1b..9908b9742 100644
--- a/FL/Fl_Button.H
+++ b/FL/Fl_Button.H
@@ -41,8 +41,8 @@ class Fl_Widget_Tracker;
\class Fl_Button
\brief Buttons generate callbacks when they are clicked by the user.
- You control exactly when and how by changing the values for type() and
- when(). Buttons can also generate callbacks in response to \c FL_SHORTCUT
+ You control exactly when and how by changing the values for type(uchar) and
+ when(uchar). Buttons can also generate callbacks in response to \c FL_SHORTCUT
events. The button can either have an explicit shortcut(int s) value or a
letter shortcut can be indicated in the label() with an '\&' character
before it. For the label shortcut it does not matter if \e Alt is held
@@ -50,7 +50,6 @@ class Fl_Widget_Tracker;
to hold down the \e Alt key so that the input field does not eat the event
first as an \c FL_KEYBOARD event.
\see Fl_Widget::shortcut_label(int)
- \todo Refactor the doxygen comments for Fl_Button type() documentation.
For an Fl_Button object, the type() call returns one of:
\li \c FL_NORMAL_BUTTON (0): value() remains unchanged after button press.
@@ -59,8 +58,6 @@ class Fl_Widget_Tracker;
buttons in the current group with <tt>type() == FL_RADIO_BUTTON</tt>
are set to zero.
- \todo Refactor the doxygen comments for Fl_Button when() documentation.
-
For an Fl_Button object, the following when() values are useful, the default
being \c FL_WHEN_RELEASE:
\li \c 0: The callback is not done, instead changed() is turned on.