This widget produces an actual window. More...
#include <Fl_Window.H>
Classes | |
struct | icon_data |
struct | shape_data_type |
Data supporting a non-rectangular window shape. More... | |
Public Member Functions | |
virtual Fl_Window * | as_window () |
Returns an Fl_Window pointer if this widget is an Fl_Window. | |
unsigned int | border () const |
See void Fl_Window::border(int). | |
void | border (int b) |
Sets whether or not the window manager border is around the window. | |
void | clear_border () |
Fast inline function to turn the window manager border off. | |
void | clear_modal_states () |
Clears the "modal" flags and converts a "modal" or "non-modal" window back into a "normal" window. | |
void | copy_label (const char *a) |
Sets the window titlebar label to a copy of a character string. | |
void | cursor (Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE) |
For back compatibility only. | |
void | cursor (const Fl_RGB_Image *, int, int) |
Changes the cursor for this window. | |
void | cursor (Fl_Cursor) |
Changes the cursor for this window. | |
int | decorated_h () |
Returns the window height including any window title bar and any frame added by the window manager. | |
int | decorated_w () |
Returns the window width including any frame added by the window manager. | |
void | default_cursor (Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE) |
For back compatibility only. | |
void | default_cursor (Fl_Cursor) |
Sets the default window cursor. | |
Fl_Window (int x, int y, int w, int h, const char *title=0) | |
Creates a window from the given position, size and title. | |
Fl_Window (int w, int h, const char *title=0) | |
Creates a window from the given size and title. | |
void | free_position () |
Undoes the effect of a previous resize() or show() so that the next time show() is called the window manager is free to position the window. | |
void | fullscreen () |
Makes the window completely fill one or more screens, without any window manager border visible. | |
unsigned int | fullscreen_active () const |
Returns non zero if FULLSCREEN flag is set, 0 otherwise. | |
void | fullscreen_off (int X, int Y, int W, int H) |
Turns off any side effects of fullscreen() and does resize(x,y,w,h). | |
void | fullscreen_off () |
Turns off any side effects of fullscreen(). | |
void | fullscreen_screens (int top, int bottom, int left, int right) |
Sets which screens should be used when this window is in fullscreen mode. | |
virtual int | handle (int) |
Handles the specified event. | |
virtual void | hide () |
Removes the window from the screen. | |
void | hotspot (const Fl_Widget &p, int offscreen=0) |
See void Fl_Window::hotspot(int x, int y, int offscreen = 0). | |
void | hotspot (const Fl_Widget *, int offscreen=0) |
See void Fl_Window::hotspot(int x, int y, int offscreen = 0). | |
void | hotspot (int x, int y, int offscreen=0) |
Positions the window so that the mouse is pointing at the given position, or at the center of the given widget, which may be the window itself. | |
void | icon (const void *ic) |
Sets the current icon window target dependent data. | |
const void * | icon () const |
Gets the current icon window target dependent data. | |
void | icon (const Fl_RGB_Image *) |
Sets or resets a single window icon. | |
void | iconize () |
Iconifies the window. | |
void | iconlabel (const char *) |
Sets the icon label. | |
const char * | iconlabel () const |
See void Fl_Window::iconlabel(const char*). | |
void | icons (const Fl_RGB_Image *[], int) |
Sets the window icons. | |
void | label (const char *label, const char *iconlabel) |
Sets the icon label. | |
void | label (const char *) |
Sets the window title bar label. | |
const char * | label () const |
See void Fl_Window::label(const char*). | |
void | make_current () |
Sets things up so that the drawing functions in <FL/fl_draw.H> will go into this window. | |
unsigned int | menu_window () const |
Returns true if this window is a menu window. | |
unsigned int | modal () const |
Returns true if this window is modal. | |
unsigned int | non_modal () const |
Returns true if this window is modal or non-modal. | |
unsigned int | override () const |
Returns non zero if FL_OVERRIDE flag is set, 0 otherwise. | |
virtual void | resize (int X, int Y, int W, int H) |
Changes the size and position of the window. | |
void | set_menu_window () |
Marks the window as a menu window. | |
void | set_modal () |
A "modal" window, when shown(), will prevent any events from being delivered to other windows in the same program, and will also remain on top of the other windows (if the X window manager supports the "transient for" property). | |
void | set_non_modal () |
A "non-modal" window (terminology borrowed from Microsoft Windows) acts like a modal() one in that it remains on top, but it has no effect on event delivery. | |
void | set_override () |
Activates the flags NOBORDER|FL_OVERRIDE. | |
void | set_tooltip_window () |
Marks the window as a tooltip window. | |
void | shape (const Fl_Image &b) |
Set the window's shape with an Fl_Image. | |
void | shape (const Fl_Image *img) |
Assigns a non-rectangular shape to the window. | |
void | show (int argc, char **argv) |
Puts the window on the screen and parses command-line arguments. | |
virtual void | show () |
Puts the window on the screen. | |
int | shown () |
Returns non-zero if show() has been called (but not hide() ). | |
void | size_range (int minw, int minh, int maxw=0, int maxh=0, int dw=0, int dh=0, int aspect=0) |
Sets the allowable range the user can resize this window to. | |
unsigned int | tooltip_window () const |
Returns true if this window is a tooltip window. | |
void | wait_for_expose () |
Waits for the window to be displayed after calling show(). | |
int | x_root () const |
Gets the x position of the window on the screen. | |
void | xclass (const char *c) |
Sets the xclass for this window. | |
const char * | xclass () const |
Returns the xclass for this window, or a default. | |
int | y_root () const |
Gets the y position of the window on the screen. | |
virtual | ~Fl_Window () |
The destructor also deletes all the children. | |
Static Public Member Functions | |
static Fl_Window * | current () |
Returns the last window that was made current. | |
static void | default_callback (Fl_Window *, void *v) |
Back compatibility: Sets the default callback v for win to call on close event. | |
static void | default_icon (const Fl_RGB_Image *) |
Sets a single default window icon. | |
static void | default_icons (const Fl_RGB_Image *[], int) |
Sets the default window icons. | |
static const char * | default_xclass () |
Returns the default xclass. | |
static void | default_xclass (const char *) |
Sets the default window xclass. | |
Protected Member Functions | |
virtual void | draw () |
Draws the widget. | |
virtual void | flush () |
Forces the window to be drawn, this window is also made current and calls draw(). | |
int | force_position () const |
Returns the internal state of the window's FORCE_POSITION flag. | |
void | force_position (int force) |
Sets an internal flag that tells FLTK and the window manager to honor position requests. | |
void | free_icons () |
Deletes all icons previously attached to the window. | |
Protected Attributes | |
shape_data_type * | shape_data_ |
non-null means the window has a non-rectangular shape | |
Static Protected Attributes | |
static Fl_Window * | current_ |
Stores the last window that was made current. | |
Friends | |
class | Fl_X |
This widget produces an actual window.
This can either be a main window, with a border and title and all the window management controls, or a "subwindow" inside a window. This is controlled by whether or not the window has a parent().
Once you create a window, you usually add children Fl_Widget 's to it by using window->add(child) for each new widget. See Fl_Group for more information on how to add and remove children.
There are several subclasses of Fl_Window that provide double-buffering, overlay, menu, and OpenGL support.
The window's callback is done if the user tries to close a window using the window manager and Fl::modal() is zero or equal to the window. Fl_Window has a default callback that calls Fl_Window::hide().
Fl_Window::Fl_Window | ( | int | w, | |
int | h, | |||
const char * | title = 0 | |||
) |
Creates a window from the given size and title.
If Fl_Group::current() is not NULL, the window is created as a subwindow of the parent window.
The (w,h) form of the constructor creates a top-level window and asks the window manager to position the window. The (x,y,w,h) form of the constructor either creates a subwindow or a top-level window at the specified location (x,y) , subject to window manager configuration. If you do not specify the position of the window, the window manager will pick a place to show the window or allow the user to pick a location. Use position(x,y) or hotspot() before calling show() to request a position on the screen. See Fl_Window::resize() for some more details on positioning windows.
Top-level windows initially have visible() set to 0 and parent() set to NULL. Subwindows initially have visible() set to 1 and parent() set to the parent window pointer.
Fl_Widget::box() defaults to FL_FLAT_BOX. If you plan to completely fill the window with children widgets you should change this to FL_NO_BOX. If you turn the window border off you may want to change this to FL_UP_BOX.
Fl_Window::Fl_Window | ( | int | x, | |
int | y, | |||
int | w, | |||
int | h, | |||
const char * | title = 0 | |||
) |
Creates a window from the given position, size and title.
Fl_Window::~Fl_Window | ( | ) | [virtual] |
The destructor also deletes all the children.
This allows a whole tree to be deleted at once, without having to keep a pointer to all the children in the user code. A kludge has been done so the Fl_Window and all of its children can be automatic (local) variables, but you must declare the Fl_Window first so that it is destroyed last.
virtual Fl_Window* Fl_Window::as_window | ( | ) | [inline, virtual] |
Returns an Fl_Window pointer if this widget is an Fl_Window.
Use this method if you have a widget (pointer) and need to know whether this widget is derived from Fl_Window. If it returns non-NULL, then the widget in question is derived from Fl_Window, and you can use the returned pointer to access its children or other Fl_Window-specific methods.
NULL | if this widget is not derived from Fl_Window. |
Reimplemented from Fl_Widget.
void Fl_Window::border | ( | int | b | ) |
Sets whether or not the window manager border is around the window.
The default value is true. void border(int) can be used to turn the border on and off. Under most X window managers this does not work after show() has been called, although SGI's 4DWM does work.
void Fl_Window::clear_border | ( | ) | [inline] |
Fast inline function to turn the window manager border off.
It only works before show() is called.
void Fl_Window::clear_modal_states | ( | ) | [inline] |
Clears the "modal" flags and converts a "modal" or "non-modal" window back into a "normal" window.
Note that there are three states for a window: modal, non-modal, and normal.
You can not change the "modality" of a window whilst it is shown, so it is necessary to first hide() the window, change its "modality" as required, then re-show the window for the new state to take effect.
This method can also be used to change a "modal" window into a "non-modal" one. On several supported platforms, the "modal" state over-rides the "non-modal" state, so the "modal" state must be cleared before the window can be set into the "non-modal" state. In general, the following sequence should work:
win->hide();
win->clear_modal_states();
//Set win to new state as desired, or leave "normal", e.g...
win->set_non_modal();
win->show();
Fl_Window * Fl_Window::current | ( | ) | [static] |
Returns the last window that was made current.
Reimplemented from Fl_Group.
For back compatibility only.
Same as Fl_Window::cursor(Fl_Cursor)
void Fl_Window::cursor | ( | const Fl_RGB_Image * | image, | |
int | hotx, | |||
int | hoty | |||
) |
Changes the cursor for this window.
This always calls the system, if you are changing the cursor a lot you may want to keep track of how you set it in a static variable and call this only if the new cursor is different.
The default cursor will be used if the provided image cannot be used as a cursor.
void Fl_Window::cursor | ( | Fl_Cursor | c | ) |
Changes the cursor for this window.
This always calls the system, if you are changing the cursor a lot you may want to keep track of how you set it in a static variable and call this only if the new cursor is different.
The type Fl_Cursor is an enumeration defined in <FL/Enumerations.H>.
int Fl_Window::decorated_h | ( | ) |
Returns the window height including any window title bar and any frame added by the window manager.
Same as h() if applied to a subwindow.
int Fl_Window::decorated_w | ( | ) |
Returns the window width including any frame added by the window manager.
Same as w() if applied to a subwindow.
For back compatibility only.
void Fl_Window::default_cursor | ( | Fl_Cursor | c | ) |
Sets the default window cursor.
This is the cursor that will be used after the mouse pointer leaves a widget with a custom cursor set.
void Fl_Window::default_icon | ( | const Fl_RGB_Image * | icon | ) | [static] |
Sets a single default window icon.
If icon
is NULL the current default icons are removed.
[in] | icon | default icon for all windows subsequently created or NULL |
void Fl_Window::default_icons | ( | const Fl_RGB_Image * | icons[], | |
int | count | |||
) | [static] |
Sets the default window icons.
The default icons are used for all windows that don't have their own icons set before show() is called. You can change the default icons whenever you want, but this only affects windows that are created (and shown) after this call.
The given images in icons
are copied. You can use a local variable or free the images immediately after this call.
[in] | icons | default icons for all windows subsequently created |
[in] | count | number of images in icons . Set to 0 to remove the current default icons |
const char * Fl_Window::default_xclass | ( | ) | [static] |
Returns the default xclass.
void Fl_Window::default_xclass | ( | const char * | xc | ) | [static] |
Sets the default window xclass.
The default xclass is used for all windows that don't have their own xclass set before show() is called. You can change the default xclass whenever you want, but this only affects windows that are created (and shown) after this call.
The given string xc
is copied. You can use a local variable or free the string immediately after this call.
If you don't call this, the default xclass for all windows will be "FLTK". You can reset the default xclass by specifying NULL for xc
.
If you call Fl_Window::xclass(const char *) for any window, then this also sets the default xclass, unless it has been set before.
[in] | xc | default xclass for all windows subsequently created |
void Fl_Window::draw | ( | ) | [protected, virtual] |
Draws the widget.
Never call this function directly. FLTK will schedule redrawing whenever needed. If your widget must be redrawn as soon as possible, call redraw() instead.
Override this function to draw your own widgets.
If you ever need to call another widget's draw method from within your own draw() method, e.g. for an embedded scrollbar, you can do it (because draw() is virtual) like this:
Fl_Widget *s = &scroll; // scroll is an embedded Fl_Scrollbar s->draw(); // calls Fl_Scrollbar::draw()
Reimplemented from Fl_Group.
Reimplemented in Fl_Cairo_Window, Fl_Gl_Window, and Fl_Glut_Window.
void Fl_Window::flush | ( | ) | [protected, virtual] |
Forces the window to be drawn, this window is also made current and calls draw().
Reimplemented in Fl_Double_Window, Fl_Gl_Window, Fl_Menu_Window, Fl_Overlay_Window, and Fl_Single_Window.
int Fl_Window::force_position | ( | ) | const [inline, protected] |
Returns the internal state of the window's FORCE_POSITION flag.
1 | if flag is set | |
0 | otherwise |
void Fl_Window::force_position | ( | int | force | ) | [inline, protected] |
Sets an internal flag that tells FLTK and the window manager to honor position requests.
This is used internally and should not be needed by user code.
[in] | force | 1 to set the FORCE_POSITION flag, 0 to clear it |
void Fl_Window::free_icons | ( | ) | [protected] |
Deletes all icons previously attached to the window.
void Fl_Window::free_position | ( | ) | [inline] |
Undoes the effect of a previous resize() or show() so that the next time show() is called the window manager is free to position the window.
This is for Forms compatibility only.
void Fl_Window::fullscreen | ( | ) |
Makes the window completely fill one or more screens, without any window manager border visible.
You must use fullscreen_off() to undo this.
void Fl_Window::fullscreen_screens | ( | int | top, | |
int | bottom, | |||
int | left, | |||
int | right | |||
) |
Sets which screens should be used when this window is in fullscreen mode.
The window will be resized to the top of the screen with index top
, the bottom of the screen with index bottom
, etc.
If this method is never called, or if any argument is < 0, then the window will be resized to fill the screen it is currently on.
int Fl_Window::handle | ( | int | event | ) | [virtual] |
Handles the specified event.
You normally don't call this method directly, but instead let FLTK do it when the user interacts with the widget.
When implemented in a widget, this function must return 0 if the widget does not use the event or 1 otherwise.
Most of the time, you want to call the inherited handle() method in your overridden method so that you don't short-circuit events that you don't handle. In this last case you should return the callee retval.
[in] | event | the kind of event received |
0 | if the event was not used or understood | |
1 | if the event was used and can be deleted |
Reimplemented from Fl_Group.
Reimplemented in Fl_Gl_Window, and Fl_Glut_Window.
void Fl_Window::hide | ( | ) | [virtual] |
Removes the window from the screen.
If the window is already hidden or has not been shown then this does nothing and is harmless.
Reimplemented from Fl_Widget.
Reimplemented in Fl_Double_Window, Fl_Gl_Window, Fl_Menu_Window, and Fl_Overlay_Window.
void Fl_Window::hotspot | ( | int | x, | |
int | y, | |||
int | offscreen = 0 | |||
) |
Positions the window so that the mouse is pointing at the given position, or at the center of the given widget, which may be the window itself.
If the optional offscreen parameter is non-zero, then the window is allowed to extend off the screen (this does not work with some X window managers).
void Fl_Window::icon | ( | const void * | ic | ) |
Sets the current icon window target dependent data.
const void * Fl_Window::icon | ( | ) | const |
Gets the current icon window target dependent data.
void Fl_Window::icon | ( | const Fl_RGB_Image * | icon | ) |
Sets or resets a single window icon.
A window icon can be changed while the window is shown, but this may be platform and/or window manager dependent. To be sure that the window displays the correct window icon you should always set the icon before the window is shown.
If a window icon has not been set for a particular window, then the default window icon (see links below) or the system default icon will be used.
[in] | icon | icon for this window, NULL to reset window icon. |
void Fl_Window::iconize | ( | ) |
Iconifies the window.
If you call this when shown() is false it will show() it as an icon. If the window is already iconified this does nothing.
Call show() to restore the window.
When a window is iconified/restored (either by these calls or by the user) the handle() method is called with FL_HIDE and FL_SHOW events and visible() is turned on and off.
There is no way to control what is drawn in the icon except with the string passed to Fl_Window::xclass(). You should not rely on window managers displaying the icons.
void Fl_Window::iconlabel | ( | const char * | iname | ) |
Sets the icon label.
void Fl_Window::icons | ( | const Fl_RGB_Image * | icons[], | |
int | count | |||
) |
Sets the window icons.
You may set multiple window icons with different sizes. Dependent on the platform and system settings the best (or the first) icon will be chosen.
The given images in icons
are copied. You can use a local variable or free the images immediately after this call.
If count
is zero, current icons are removed. If count
is greater than zero (must not be negative), then icons
[] must contain at least count
valid image pointers (not NULL). Otherwise the behavior is undefined.
[in] | icons | icons for this window |
[in] | count | number of images in icons . Set to 0 to remove the current icons |
void Fl_Window::label | ( | const char * | label, | |
const char * | iconlabel | |||
) |
Sets the icon label.
void Fl_Window::label | ( | const char * | name | ) |
Sets the window title bar label.
Reimplemented from Fl_Widget.
void Fl_Window::make_current | ( | ) |
Sets things up so that the drawing functions in <FL/fl_draw.H> will go into this window.
This is useful for incremental update of windows, such as in an idle callback, which will make your program behave much better if it draws a slow graphic. Danger: incremental update is very hard to debug and maintain!
This method only works for the Fl_Window and Fl_Gl_Window derived classes.
Reimplemented in Fl_Gl_Window, Fl_Single_Window, and Fl_Glut_Window.
unsigned int Fl_Window::menu_window | ( | ) | const [inline] |
Returns true if this window is a menu window.
unsigned int Fl_Window::modal | ( | ) | const [inline] |
Returns true if this window is modal.
unsigned int Fl_Window::non_modal | ( | ) | const [inline] |
Returns true if this window is modal or non-modal.
unsigned int Fl_Window::override | ( | ) | const [inline] |
Returns non zero if FL_OVERRIDE flag is set, 0 otherwise.
virtual void Fl_Window::resize | ( | int | X, | |
int | Y, | |||
int | W, | |||
int | H | |||
) | [virtual] |
Changes the size and position of the window.
If shown() is true, these changes are communicated to the window server (which may refuse that size and cause a further resize). If shown() is false, the size and position are used when show() is called. See Fl_Group for the effect of resizing on the child widgets.
You can also call the Fl_Widget methods size(x,y) and position(w,h), which are inline wrappers for this virtual function.
A top-level window can not force, but merely suggest a position and size to the operating system. The window manager may not be willing or able to display a window at the desired position or with the given dimensions. It is up to the application developer to verify window parameters after the resize request.
Reimplemented from Fl_Group.
Reimplemented in Fl_Double_Window, Fl_Gl_Window, and Fl_Overlay_Window.
void Fl_Window::set_menu_window | ( | ) | [inline] |
Marks the window as a menu window.
This is intended for internal use, but it can also be used if you write your own menu handling. However, this is not recommended.
This flag is used for correct "parenting" of windows in communication with the windowing system. Modern X window managers can use different flags to distinguish menu and tooltip windows from normal windows.
This must be called before the window is shown and cannot be changed later.
void Fl_Window::set_modal | ( | ) | [inline] |
A "modal" window, when shown(), will prevent any events from being delivered to other windows in the same program, and will also remain on top of the other windows (if the X window manager supports the "transient for" property).
Several modal windows may be shown at once, in which case only the last one shown gets events. You can see which window (if any) is modal by calling Fl::modal().
void Fl_Window::set_non_modal | ( | ) | [inline] |
A "non-modal" window (terminology borrowed from Microsoft Windows) acts like a modal() one in that it remains on top, but it has no effect on event delivery.
There are three states for a window: modal, non-modal, and normal.
void Fl_Window::set_tooltip_window | ( | ) | [inline] |
Marks the window as a tooltip window.
This is intended for internal use, but it can also be used if you write your own tooltip handling. However, this is not recommended.
This flag is used for correct "parenting" of windows in communication with the windowing system. Modern X window managers can use different flags to distinguish menu and tooltip windows from normal windows.
This must be called before the window is shown and cannot be changed later.
void Fl_Window::shape | ( | const Fl_Image & | b | ) | [inline] |
Set the window's shape with an Fl_Image.
void Fl_Window::shape | ( | const Fl_Image * | img | ) |
Assigns a non-rectangular shape to the window.
This function gives an arbitrary shape (not just a rectangular region) to an Fl_Window. An Fl_Image of any dimension can be used as mask; it is rescaled to the window's dimension as needed.
The layout and widgets inside are unaware of the mask shape, and most will act as though the window's rectangular bounding box is available to them. It is up to you to make sure they adhere to the bounds of their masking shape.
The img
argument can be an Fl_Bitmap, Fl_Pixmap, Fl_RGB_Image or Fl_Shared_Image:
Platform details:
img
is an Fl_RGB_Image: with depths 2 or 4, the image alpha channel becomes the shape mask such that areas with alpha = 0 are out of the shaped window; with depths 1 or 3, white and black are in and out of the shaped window, respectively, and other colors give intermediate masking scores. This function does nothing with class Fl_Gl_Window.The window borders and caption created by the window system are turned off by default. They can be re-enabled by calling Fl_Window::border(1).
A usage example is found at example/shapedwindow.cxx.
void Fl_Window::show | ( | int | argc, | |
char ** | argv | |||
) |
Puts the window on the screen and parses command-line arguments.
Usually (on X) this has the side effect of opening the display.
This form should be used for top-level windows, at least for the first (main) window. It allows standard arguments to be parsed from the command-line. You can use argc
and argv
from main(int argc, char **argv) for this call.
The first call also sets up some system-specific internal variables like the system colors.
argc | command-line argument count, usually from main() | |
argv | command-line argument vector, usually from main() |
Reimplemented in Fl_Double_Window, Fl_Gl_Window, Fl_Overlay_Window, and Fl_Single_Window.
virtual void Fl_Window::show | ( | ) | [virtual] |
Puts the window on the screen.
Usually (on X) this has the side effect of opening the display.
If the window is already shown then it is restored and raised to the top. This is really convenient because your program can call show() at any time, even if the window is already up. It also means that show() serves the purpose of raise() in other toolkits.
Fl_Window::show(int argc, char **argv) is used for top-level windows and allows standard arguments to be parsed from the command-line.
Reimplemented from Fl_Widget.
Reimplemented in Fl_Double_Window, Fl_Gl_Window, Fl_Menu_Window, Fl_Overlay_Window, and Fl_Single_Window.
int Fl_Window::shown | ( | ) | [inline] |
void Fl_Window::size_range | ( | int | minw, | |
int | minh, | |||
int | maxw = 0 , |
|||
int | maxh = 0 , |
|||
int | dw = 0 , |
|||
int | dh = 0 , |
|||
int | aspect = 0 | |||
) | [inline] |
Sets the allowable range the user can resize this window to.
This only works for top-level windows.
minw
and minh
are the smallest the window can be. Either value must be greater than 0. maxw
and maxh
are the largest the window can be. If either is equal to the minimum then you cannot resize in that direction. If either is zero then FLTK picks a maximum size in that direction such that the window will fill the screen. dw
and dh
are size increments. The window will be constrained to widths of minw + N * dw, where N is any non-negative integer. If these are less or equal to 1 they are ignored (this is ignored on WIN32). aspect
is a flag that indicates that the window should preserve its aspect ratio. This only works if both the maximum and minimum have the same aspect ratio (ignored on WIN32 and by many X window managers). If this function is not called, FLTK tries to figure out the range from the setting of resizable():
It is undefined what happens if the current size does not fit in the constraints passed to size_range().
unsigned int Fl_Window::tooltip_window | ( | ) | const [inline] |
Returns true if this window is a tooltip window.
void Fl_Window::wait_for_expose | ( | ) |
Waits for the window to be displayed after calling show().
Fl_Window::show() is not guaranteed to show and draw the window on all platforms immediately. Instead this is done in the background; particularly on X11 it will take a few messages (client server roundtrips) to display the window. Usually this small delay doesn't matter, but in some cases you may want to have the window instantiated and displayed synchronously.
Currently (as of FLTK 1.3.4) this method has an effect on X11 and Mac OS. On Windows, show() is always synchronous. The effect of show() varies with versions of Mac OS X: early versions have the window appear on the screen when show() returns, later versions don't. If you want to write portable code and need this synchronous show() feature, add win->wait_for_expose() on all platforms, and FLTK will just do the right thing.
This method can be used for displaying splash screens before calling Fl::run() or for having exact control over which window has the focus after calling show().
If the window is not shown(), this method does nothing.
Example code for displaying a window before calling Fl::run()
Fl_Double_Window win = new Fl_Double_Window(...); // do more window initialization here ... win->show(); // show window win->wait_for_expose(); // wait, until displayed Fl::flush(); // make sure everything gets drawn // do more initialization work that needs some time here ... Fl::run(); // start FLTK event loop
Note that the window will not be responsive until the event loop is started with Fl::run().
void Fl_Window::xclass | ( | const char * | xc | ) |
Sets the xclass for this window.
A string used to tell the system what type of window this is. Mostly this identifies the picture to draw in the icon. This only works if called before calling show().
Under X, this is turned into a XA_WM_CLASS pair by truncating at the first non-alphanumeric character and capitalizing the first character, and the second one if the first is 'x'. Thus "foo" turns into "foo, Foo", and "xprog.1" turns into "xprog, XProg".
Under Microsoft Windows, this string is used as the name of the WNDCLASS structure, though it is not clear if this can have any visible effect.
If the default xclass has not yet been set, this also sets the default xclass for all windows created subsequently.
const char * Fl_Window::xclass | ( | ) | const |
Returns the xclass for this window, or a default.
Fl_Window* Fl_Window::current_ [static, protected] |