From ee0af8c6a76d99d45a96acfca591a1aef8e251a2 Mon Sep 17 00:00:00 2001 From: Greg Ercolano Date: Fri, 29 Mar 2013 03:37:04 +0000 Subject: Documenting the public methods Fl_Tabs::push() git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9853 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Tabs.H | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'FL') diff --git a/FL/Fl_Tabs.H b/FL/Fl_Tabs.H index 009e07be3..15fe27674 100644 --- a/FL/Fl_Tabs.H +++ b/FL/Fl_Tabs.H @@ -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 *); -- cgit v1.2.3