Remove a bunch of \todo items from documentation
This commit is contained in:
parent
589c1f31c3
commit
515680a633
@ -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.
|
||||
|
@ -63,20 +63,21 @@
|
||||
you pick the item with the mouse. The '\&' character in item names are
|
||||
only looked at when the menu is popped up, however.
|
||||
|
||||
\todo Refactor the doxygen comments for Fl_Choice changed() documentation.
|
||||
|
||||
The inherited Fl_Widget::changed() and related methods can be used as follows:
|
||||
\li <tt>int Fl_Widget::changed() const</tt>
|
||||
This value is true the user picks a different value. <em>It is turned
|
||||
This value is true when the user picks a different value. <em>It is turned
|
||||
off by value() and just before doing a callback (the callback can turn
|
||||
it back on if desired).</em>
|
||||
\li <tt>void Fl_Widget::set_changed()</tt>
|
||||
This method sets the changed() flag.
|
||||
\li <tt>void Fl_Widget::clear_changed()</tt>
|
||||
This method clears the changed() flag.
|
||||
\li <tt>Fl_Boxtype Fl_Choice::down_box() const</tt>
|
||||
|
||||
The inherited Fl_Menu_::down_box() methods can be used as follows:
|
||||
\li <tt>Fl_Boxtype Fl_Menu_::down_box() const</tt>
|
||||
Gets the current down box, which is used when the menu is popped up.
|
||||
The default down box type is \c FL_DOWN_BOX.
|
||||
\li <tt>void Fl_Choice::down_box(Fl_Boxtype b)</tt>
|
||||
\li <tt>void Fl_Menu_::down_box(Fl_Boxtype b)</tt>
|
||||
Sets the current down box type to \p b.
|
||||
|
||||
Simple example:
|
||||
|
@ -37,9 +37,7 @@
|
||||
\image html counter.png
|
||||
\image latex counter.png "Fl_Counter" width=4cm
|
||||
|
||||
\todo Refactor the doxygen comments for Fl_Counter type() documentation.
|
||||
|
||||
The type of an Fl_Counter object can be set using type(uchar t) to:
|
||||
The type of an Fl_Counter object can be set using Fl_Widget::type(uchar) to:
|
||||
\li \c FL_NORMAL_COUNTER: Displays a counter with 4 arrow buttons.
|
||||
\li \c FL_SIMPLE_COUNTER: Displays a counter with only 2 arrow buttons.
|
||||
*/
|
||||
|
@ -191,7 +191,7 @@ public:
|
||||
FL_WHITE, for back compatibility.
|
||||
*/
|
||||
Fl_Boxtype down_box() const {return (Fl_Boxtype)down_box_;}
|
||||
/** See Fl_Boxtype Fl_Menu_::down_box() const */
|
||||
/** Sets the box type used to surround the currently-selected items in the menus. */
|
||||
void down_box(Fl_Boxtype b) {down_box_ = b;}
|
||||
|
||||
/** For back compatibility, same as selection_color() */
|
||||
|
@ -271,17 +271,14 @@ public:
|
||||
void parent(Fl_Group* p) {parent_ = p;} // for hacks only, use Fl_Group::add()
|
||||
|
||||
/** Gets the widget type.
|
||||
Returns the widget type value, which is used for Forms compatibility
|
||||
and to simulate RTTI.
|
||||
|
||||
\todo Explain "simulate RTTI" (currently only used to decide if a widget
|
||||
is a window, i.e. type()>=FL_WINDOW ?). Is type() really used in a way
|
||||
that ensures "Forms compatibility" ?
|
||||
Returns the widget type value, which gives some information about the derived widget class
|
||||
to which the object belongs. Noticeably, the condition <tt>type() >= FL_WINDOW</tt> indicates
|
||||
a widget is an Fl_Window or derived object.
|
||||
*/
|
||||
uchar type() const {return type_;}
|
||||
|
||||
/** Sets the widget type.
|
||||
This is used for Forms compatibility.
|
||||
\see type()
|
||||
*/
|
||||
void type(uchar t) {type_ = t;}
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user