diff options
Diffstat (limited to 'FL/Fl_Menu_Window.H')
| -rw-r--r-- | FL/Fl_Menu_Window.H | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/FL/Fl_Menu_Window.H b/FL/Fl_Menu_Window.H index b2fea05d0..7337ac1d2 100644 --- a/FL/Fl_Menu_Window.H +++ b/FL/Fl_Menu_Window.H @@ -30,6 +30,12 @@ #include "Fl_Single_Window.H" +/** + The Fl_Menu_Window widget is a window type used for menus. By + default the window is drawn in the hardware overlay planes if they are + available so that the menu don't force the rest of the window to + redraw. +*/ class FL_EXPORT Fl_Menu_Window : public Fl_Single_Window { enum {NO_OVERLAY = 128}; public: @@ -37,12 +43,18 @@ public: void erase(); void flush(); void hide(); + /** Tells if hardware overlay mode is set */ int overlay() {return !(flags()&NO_OVERLAY);} + /** Tells FLTK to use hardware overlay planes if they are available. */ void set_overlay() {clear_flag(NO_OVERLAY);} + /** Tells FLTK to use normal drawing planes instead of overlay planes. + This is usually necessary if your menu contains multi-color pixmaps. */ void clear_overlay() {set_flag(NO_OVERLAY);} ~Fl_Menu_Window(); + /** Creates a new Fl_Menu_Window widget using the given size, and label string. */ Fl_Menu_Window(int W, int H, const char *l = 0) : Fl_Single_Window(W,H,l) { image(0); } + /** Creates a new Fl_Menu_Window widget using the given position, size, and label string. */ Fl_Menu_Window(int X, int Y, int W, int H, const char *l = 0) : Fl_Single_Window(X,Y,W,H,l) { image(0); } }; |