Author: greg.ercolano
Date: 2013-03-28 20:37:04 -0700 (Thu, 28 Mar 2013)
New Revision: 9853
Log:
Documenting the public methods Fl_Tabs::push()
Modified:
branches/branch-1.3/FL/Fl_Tabs.H
branches/branch-1.3/src/Fl_Tabs.cxx
Modified: branches/branch-1.3/FL/Fl_Tabs.H
===================================================================
--- branches/branch-1.3/FL/Fl_Tabs.H 2013-03-27 19:21:22 UTC (rev 9852)
+++ branches/branch-1.3/FL/Fl_Tabs.H 2013-03-29 03:37:04 UTC (rev 9853)
@@ -69,7 +69,14 @@
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 *);
Modified: branches/branch-1.3/src/Fl_Tabs.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Tabs.cxx 2013-03-27 19:21:22 UTC (rev 9852)
+++ branches/branch-1.3/src/Fl_Tabs.cxx 2013-03-29 03:37:04 UTC (rev 9853)
@@ -263,7 +263,15 @@
}
/**
- \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;
_______________________________________________
fltk-commit mailing list
fltk-commit@easysw.com
http://lists.easysw.com/mailman/listinfo/fltk-commit
