mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documenting the public methods Fl_Tabs::push()

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9853 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Greg Ercolano 2013-03-29 03:37:04 +00:00
parent 85c1464715
commit ee0af8c6a7
2 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
FL/Fl_Tabs.H
View File

@ -69,7 +69,14 @@ public:
Fl_Widget *value();
int value(Fl_Widget *);
/**
\todo This public method needs to be documented
Returns the tab group for the tab the user has currently down-clicked on
and remains over until FL_RELEASE. Otherwise, returns NULL.
While the user is down-clicked on a tab, the return value is the tab group
for that tab. But as soon as the user releases, or drags off the tab with
the button still down, the return value will be NULL.
\see push(Fl_Widget*).
*/
Fl_Widget *push() const {return push_;}
int push(Fl_Widget *);

10
src/Fl_Tabs.cxx
View File

@ -263,7 +263,15 @@ int Fl_Tabs::handle(int event) {
}
/**
\todo This public method needs to be documented
This is called by the tab widget's handle() method to set the
tab group widget the user last FL_PUSH'ed on. Set back to zero
on FL_RELEASE.
As of this writing, the value is mainly used by draw_tab()
to determine whether or not to draw a 'down' box for the tab
when it's clicked, and to turn it off if the user drags off it.
\see push().
*/
int Fl_Tabs::push(Fl_Widget *o) {
if (push_ == o) return 0;