FLTK 1.3.0
Fl_Window Class Reference

This widget produces an actual window. More...

#include <Fl_Window.H>

Inheritance diagram for Fl_Window:
Fl_Group Fl_Widget Fl_Double_Window Fl_Gl_Window Fl_Single_Window Fl_Cairo_Window Fl_Overlay_Window Fl_Glut_Window Fl_Menu_Window

List of all members.

Public Member Functions

virtual Fl_Windowas_window ()
 Returns an Fl_Window pointer if this widget is an Fl_Window.
void border (int b)
 Sets whether or not the window manager border is around the window.
unsigned int border () const
 See void Fl_Window::border(int)
void clear_border ()
 Fast inline function to turn the window manager border off.
void copy_label (const char *a)
 Sets the current label.
void cursor (Fl_Cursor, Fl_Color=FL_BLACK, Fl_Color=FL_WHITE)
 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, Fl_Color=FL_BLACK, Fl_Color=FL_WHITE)
 Sets the default window cursor as well as its color.
 Fl_Window (int w, int h, const char *title=0)
 Creates a window from the given size and title.
 Fl_Window (int x, int y, int w, int h, const char *title=0)
 Creates a window from the given position, 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 the screen, without any window manager border visible.
void fullscreen_off (int, int, int, int)
 Turns off any side effects of fullscreen() and does resize(x,y,w,h).
virtual int handle (int)
 Handles the specified event.
virtual void hide ()
 Removes the window from the screen.
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 hotspot (const Fl_Widget *, int offscreen=0)
 See void Fl_Window::hotspot(int x, int y, int offscreen = 0)
void hotspot (const Fl_Widget &p, int offscreen=0)
 See void Fl_Window::hotspot(int x, int y, int offscreen = 0)
const void * icon () const
 Gets the current icon window target dependent data.
void icon (const void *ic)
 Sets the current icon window target dependent data.
void iconize ()
 Iconifies the window.
const char * iconlabel () const
 See void Fl_Window::iconlabel(const char*)
void iconlabel (const char *)
 Sets the icon label.
const char * label () const
 See void Fl_Window::label(const char*)
void label (const char *)
 Sets the window title bar label.
void label (const char *label, const char *iconlabel)
 Sets the icon label.
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, int, int, int)
 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.
virtual void show ()
 Puts the window on the screen.
void show (int argc, char **argv)
 Puts the window on the screen and parses command-line arguments.
int shown ()
 Returns non-zero if show() has been called (but not hide() ).
void size_range (int a, int b, int c=0, int d=0, int e=0, int f=0, int g=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.
int x_root () const
 Gets the x position of the window on the screen.
const char * xclass () const
 Returns the xclass for this window, or a default.
void xclass (const char *c)
 Sets the xclass for this window.
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_Windowcurrent ()
 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_xclass (const char *)
 Sets the default window xclass.
static const char * default_xclass ()
 Returns the default 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().
void force_position (int force)
 Sets an internal flag that tells FLTK and the window manager to honor position requests.
int force_position () const
 Returns the internal state of the window's FORCE_POSITION flag.

Static Protected Attributes

static Fl_Windowcurrent_
 Stores the last window that was made current.

Friends

class Fl_X

Detailed Description

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().


Constructor & Destructor Documentation

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.

See also:
Fl_Window(int x, int y, int w, int h, const char* title)
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.

See also:
Fl_Window(int w, int h, const char *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.


Member Function Documentation

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.

Return values:
NULLif this widget is not derived from Fl_Window.
Note:
This method is provided to avoid dynamic_cast.
See also:
Fl_Widget::as_group(), Fl_Widget::as_gl_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::copy_label ( const char *  new_label)

Sets the current label.

Unlike label(), this method allocates a copy of the label string instead of using the original string pointer.

The internal copy will automatically be freed whenever you assign a new label or when the widget is destroyed.

Parameters:
[in]new_labelthe new label text
See also:
label()

Reimplemented from Fl_Widget.

Fl_Window * Fl_Window::current ( ) [static]

Returns the last window that was made current.

See also:
Fl_Window::make_current()

Reimplemented from Fl_Group.

void Fl_Window::cursor ( Fl_Cursor  c,
Fl_Color  fg = FL_BLACK,
Fl_Color  bg = FL_WHITE 
)

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>. (Under X you can get any XC_cursor value by passing Fl_Cursor((XC_foo/2)+1)). The colors only work on X, they are not implemented on WIN32.

For back compatibility only.

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.

Returns the window width including any frame added by the window manager.

Same as w() if applied to a subwindow.

void Fl_Window::default_cursor ( Fl_Cursor  c,
Fl_Color  fg = FL_BLACK,
Fl_Color  bg = FL_WHITE 
)

Sets the default window cursor as well as its color.

For back compatibility only.

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.

Parameters:
[in]xcdefault xclass for all windows subsequently created
See also:
Fl_Window::xclass(const char *)
const char * Fl_Window::default_xclass ( ) [static]

Returns the default xclass.

See also:
Fl_Window::default_xclass(const char *)
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_Gl_Window, Fl_Cairo_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_Gl_Window, Fl_Double_Window, Fl_Overlay_Window, Fl_Single_Window, and Fl_Menu_Window.

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.

Parameters:
[in]force1 to set the FORCE_POSITION flag, 0 to clear it
int Fl_Window::force_position ( ) const [inline, protected]

Returns the internal state of the window's FORCE_POSITION flag.

Return values:
1if flag is set
0otherwise
See also:
force_position(int)
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.

Deprecated:
please use force_position(0) instead

Makes the window completely fill the screen, without any window manager border visible.

You must use fullscreen_off() to undo this. This may not work with all window managers.

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.

Parameters:
[in]eventthe kind of event received
Return values:
0if the event was not used or understood
1if the event was used and can be deleted
See also:
Fl_Event

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_Gl_Window, Fl_Double_Window, Fl_Overlay_Window, and Fl_Menu_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).

See also:
position()
const void * Fl_Window::icon ( ) const

Gets the current icon window target dependent data.

void Fl_Window::icon ( const void *  ic)

Sets the current icon window target dependent data.

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::label ( const char *  name)

Sets the window title bar label.

Reimplemented from Fl_Widget.

void Fl_Window::label ( const char *  label,
const char *  iconlabel 
)

Sets the icon label.

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_Glut_Window, and Fl_Single_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  ,
int  ,
int  ,
int   
) [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_Gl_Window, Fl_Double_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.

Note:
Since Fl_Tooltip_Window is derived from Fl_Menu_Window, this also clears the menu_window() state.
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.

See also:
Fl_Window::show(int argc, char **argv)

Reimplemented from Fl_Widget.

Reimplemented in Fl_Gl_Window, Fl_Double_Window, Fl_Overlay_Window, Fl_Single_Window, and Fl_Menu_Window.

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.

Todo:
explain which system parameters are set up.
Parameters:
argccommand-line argument count, usually from main()
argvcommand-line argument vector, usually from main()
See also:
virtual void Fl_Window::show()

Reimplemented in Fl_Gl_Window, Fl_Overlay_Window, Fl_Double_Window, and Fl_Single_Window.

int Fl_Window::shown ( ) [inline]

Returns non-zero if show() has been called (but not hide() ).

You can tell if a window is iconified with (w->shown() && !w->visible()).

void Fl_Window::size_range ( int  a,
int  b,
int  c = 0,
int  d = 0,
int  e = 0,
int  f = 0,
int  g = 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():

  • If resizable() is NULL (this is the default) then the window cannot be resized and the resize border and max-size control will not be displayed for the window.
  • If either dimension of resizable() is less than 100, then that is considered the minimum size. Otherwise the resizable() has a minimum size of 100.
  • If either dimension of resizable() is zero, then that is also the maximum size (so the window cannot resize in that direction).

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.

const char * Fl_Window::xclass ( ) const

Returns the xclass for this window, or a default.

See also:
Fl_Window::default_xclass(const char *)
Fl_Window::xclass(const char *)
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.

Since:
FLTK 1.3 the passed string is copied. You can use a local variable or free the string immediately after this call. Note that FLTK 1.1 stores the pointer without copying the string.

If the default xclass has not yet been set, this also sets the default xclass for all windows created subsequently.

See also:
Fl_Window::default_xclass(const char *)

Member Data Documentation

Fl_Window* Fl_Window::current_ [static, protected]

Stores the last window that was made current.

See current() const

Reimplemented from Fl_Group.


The documentation for this class was generated from the following files: