diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/Fl_Window.cxx | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/src/Fl_Window.cxx b/src/Fl_Window.cxx index ffda05a1a..f76615925 100644 --- a/src/Fl_Window.cxx +++ b/src/Fl_Window.cxx @@ -80,11 +80,32 @@ Fl_Window::Fl_Window(int W, int H, const char *l) clear_visible(); } +/** Returns a pointer to the nearest parent window up the widget hierarchy. + This will return sub-windows if there are any, or the parent window if there's no sub-windows. + If this widget IS the top-level window, NULL is returned. + \retval NULL if no window is associated with this widget. + \note for an Fl_Window widget, this returns its <I>parent</I> window + (if any), not <I>this</I> window. + \see top_window() +*/ Fl_Window *Fl_Widget::window() const { for (Fl_Widget *o = parent(); o; o = o->parent()) if (o->type() >= FL_WINDOW) return (Fl_Window*)o; return 0; } + +/** Returns a pointer to the top-level window for the widget. + In other words, the 'window manager window' that contains this widget. + This method differs from window() in that it won't return sub-windows (if there are any). + \returns the top-level window, or NULL if no top-level window is associated with this widget. + \see window() +*/ +Fl_Window *Fl_Widget::top_window() const { + const Fl_Widget *w = this; + while (w->parent()) { w = w->parent(); } // walk up the widget hierarchy to top-level item + return const_cast<Fl_Widget*>(w)->as_window(); // return if window, or NULL if not +} + /** Gets the x position of the window on the screen */ int Fl_Window::x_root() const { Fl_Window *p = window(); |