Mirrors_UI_SDK/fltk
1
0
Fork 0
mirror of https://github.com/fltk/fltk.git synced 2026-06-05 08:06:35 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Doxygen documentation: Fl_Widget: correcting some typos, adding a short 'good practice' paragraph in handle method to help the beginners learning curve, inspired by what i read in the general forum. Also starting an effort to normalize the comments a get/set method comment should always use get instead of return to avoid confusion with the return code.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6272 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Fabien Costantini
2008-09-17 07:56:15 +00:00
parent 915d310a70
commit f70e81134b
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
FL/Fl_Widget.H
+10 -7
View File
@@ -173,7 +173,10 @@ public:
* it when the user interacts with the widget. * it when the user interacts with the widget.
* *
* When implemented in a new widget, this function must return 0 if the * When implemented in a new widget, this function must return 0 if the
* widget does not use the event or 1 if it uses the event. * widget does not use the event or 1 otherwise.<BR>
* Most of the time, you want to call the inherited handle() method in
* your overriden method so that you don't short-circuit events that you
* don't handle. In this last case you should return the callee retval.
* *
* \param[in] event the kind of event received * \param[in] event the kind of event received
* \retval 0 if the event was not used or understood * \retval 0 if the event was not used or understood
@@ -192,33 +195,33 @@ public:
/** Internal use only. Use Fl_Group::add(Fl_Widget*) instead. */ /** Internal use only. Use Fl_Group::add(Fl_Widget*) instead. */
void parent(Fl_Group* p) {parent_ = p;} // for hacks only, Fl_Group::add() void parent(Fl_Group* p) {parent_ = p;} // for hacks only, Fl_Group::add()
/** Returns the widget type. /** Gets the widget type.
* Returns the widget type value, which is used for Forms * Returns the widget type value, which is used for Forms
* compatibility and to simulate RTTI. * compatibility and to simulate RTTI.
*/ */
uchar type() const {return type_;} uchar type() const {return type_;}
/** Sets tye widget type. /** Sets the widget type.
* This is used for Forms compatibility. * This is used for Forms compatibility.
*/ */
void type(uchar t) {type_ = t;} void type(uchar t) {type_ = t;}
/** Return the widget position in its window. /** Gets the widget position in its window.
* \return the x position relative to the window * \return the x position relative to the window
*/ */
int x() const {return x_;} int x() const {return x_;}
/** Return the widget position in its window. /** Gets the widget position in its window.
* \return the y position relative to the window * \return the y position relative to the window
*/ */
int y() const {return y_;} int y() const {return y_;}
/** Return the widget width. /** Gets the widget width.
* \return the width of the widget in pixels. * \return the width of the widget in pixels.
*/ */
int w() const {return w_;} int w() const {return w_;}
/** Return the widget height. /** Gets the widget height.
* \return the height of the widget in pixels. * \return the height of the widget in pixels.
*/ */
int h() const {return h_;} int h() const {return h_;}