Skip to content

Commit

Permalink
Added docs for undocumented public 'which()' method.
Browse files Browse the repository at this point in the history
Added a \todo marker for undocumented public 'push()' method.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9849 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
  • Loading branch information
erco77 committed Mar 26, 2013
1 parent b2a54c3 commit 2aefc1f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
3 changes: 3 additions & 0 deletions FL/Fl_Tabs.H
Expand Up @@ -68,6 +68,9 @@ public:
int handle(int);
Fl_Widget *value();
int value(Fl_Widget *);
/**
\todo This public method needs to be documented
*/
Fl_Widget *push() const {return push_;}
int push(Fl_Widget *);
Fl_Tabs(int,int,int,int,const char * = 0);
Expand Down
12 changes: 10 additions & 2 deletions src/Fl_Tabs.cxx
Expand Up @@ -114,8 +114,13 @@ int Fl_Tabs::tab_height() {
else return (H <= 0) ? 0 : H;
}

// This is used for event handling (clicks) and by fluid to pick tabs.
// Returns 0, if children() = 0, or if the event is outside of the tabs area.
/**
Return the widget of the tab the user clicked on at \p event_x / \p event_y.
This is used for event handling (clicks) and by fluid to pick tabs.
\returns The child widget of the tab the user clicked on, or<br>
0 if there are no children or if the event is outside of the tabs area.
*/
Fl_Widget *Fl_Tabs::which(int event_x, int event_y) {
if (children() == 0) return 0;
int H = tab_height();
Expand Down Expand Up @@ -257,6 +262,9 @@ int Fl_Tabs::handle(int event) {
}
}

/**
\todo This public method needs to be documented
*/
int Fl_Tabs::push(Fl_Widget *o) {
if (push_ == o) return 0;
if ( (push_ && !push_->visible()) || (o && !o->visible()) )
Expand Down

0 comments on commit 2aefc1f

Please sign in to comment.