diff options
| author | ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com> | 2023-02-05 11:45:23 +0100 |
|---|---|---|
| committer | ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com> | 2023-02-05 11:45:23 +0100 |
| commit | 589c1f31c313e1b9630b63a5cd91de6a1ff8872d (patch) | |
| tree | a4db6c4e283b9c4348600ee482eb119135e13378 | |
| parent | b4b7166b85aeb976c6abe0c019234713292635d5 (diff) | |
Improve doc of Fl_Widget::test_shortcut() methods
This removes a \todo item.
| -rw-r--r-- | documentation/src/subclassing.dox | 3 | ||||
| -rw-r--r-- | src/fl_shortcut.cxx | 4 |
2 files changed, 2 insertions, 5 deletions
diff --git a/documentation/src/subclassing.dox b/documentation/src/subclassing.dox index 483473181..1fa8da9f3 100644 --- a/documentation/src/subclassing.dox +++ b/documentation/src/subclassing.dox @@ -211,9 +211,6 @@ keypress does not match the character. \par The second version lets you do this test against an arbitrary string. -\todo Clarify Fl_Widget::test_shortcut() explanations. Fl_Widget.h - says Internal Use only, but subclassing chapter gives details! - \anchor subclassing_type uchar Fl_Widget::type() const <br> void Fl_Widget::type(uchar t) diff --git a/src/fl_shortcut.cxx b/src/fl_shortcut.cxx index d0e95bf38..014fd2637 100644 --- a/src/fl_shortcut.cxx +++ b/src/fl_shortcut.cxx @@ -329,7 +329,7 @@ unsigned int Fl_Widget::label_shortcut(const char *t) { \return true, if the entered text matches the '&x' shortcut in \p t false (0) otherwise. - \note Internal use only. + \note Useful when a widget's handle(int) method needs dedicated processing of FL_SHORTCUT. */ int Fl_Widget::test_shortcut(const char *t, const bool require_alt) { static int extra_test = Fl::system_driver()->need_test_shortcut_extra(); @@ -363,7 +363,7 @@ int Fl_Widget::test_shortcut(const char *t, const bool require_alt) { \return true, if the entered text matches the widget's'&x' shortcut, false (0) otherwise. - \note Internal use only. + \note Useful when a widget's handle(int) method needs dedicated processing of FL_SHORTCUT. */ int Fl_Widget::test_shortcut() { |