Window¶

Note

Window is derived from Widget class.

A Window is an object whose size and position can (usually) be changed by the user. It usually has thick borders and a title bar, and can optionally contain a menu bar, toolbar and status bar. A Window contains any control or other windows sometimes.

Constructor¶

Window class has a complex constructor:

Window:new {
   number ID, string Name,

   number PosX  , number PosY,
   number Width , number Height,

   string Title,
}

Arguments¶

These arguments are received by class constructor.

Argument	Description
ID	The object identificator
Name	The object’s name
PosX	Position related to X
PosY	Position related to Y
Width	Width of the widget
Height	Height of the widget
Title	The caption of the window.

Constructor flags¶

These are the flags received by class constructor.

Flags	Value	Description
`WIN_DEFAULT_STYLE`	`541072960`	Defined as `WIN_MINIMIZE_BOX` \| `WIN_MAXIMIZE_BOX` \| `WIN_RESIZE_BORDER` \| `WIN_SYSTEM_MENU` \| `WIN_CAPTION` \| `WIN_CLOSE_BOX` \| `WIN_CLIP_CHILDREN`.
`WIN_ICONIZE`	`16384`	Display the frame iconized (minimized). Windows only.
`WIN_CAPTION`	`536870912`	Puts a caption on the frame.
`WIN_MINIMIZE`	`16384`	Identical to `WIN_ICONIZE`. Windows only.
`WIN_MINIMIZE_BOX`	`1024`	Displays a minimize box on the frame.
`WIN_MAXIMIZE`	`8192`	Displays the frame maximized. Windows and GTK+ only.
`WIN_MAXIMIZE_BOX`	`512`	Displays a maximize box on the frame.
`WIN_CLOSE_BOX`	`4096`	Displays a close box on the frame.
`WIN_STAY_ON_TOP`	`32768`	Stay on top of all other windows, see also `WIN_FLOAT_ON_PARENT`.
`WIN_SYSTEM_MENU`	`2048`	Displays a system menu.
`WIN_RESIZE_BORDER`	`64`	Displays a resizeable border around the window.
`WIN_TOOL_WINDOW`	`4`	Causes a frame with a small titlebar to be created; the frame does not appear in the taskbar under Windows or GTK+.
`WIN_NO_TASKBAR`	`2`	Creates an otherwise normal frame but it does not appear in the taskbar under Windows or GTK+ (note that it will minimize to the desktop window under Windows which may seem strange to the users and thus it might be better to use this style only without wxMINIMIZE_BOX style). In wxGTK, the flag is respected only if GTK+ is at least version 2.2 and the window manager supports _NET_WM_STATE_SKIP_TASKBAR hint. Has no effect under other platforms.
`WIN_FLOAT_ON_PARENT`	`8`	The frame will always be on top of its parent (unlike `WIN_STAY_ON_TOP`). A frame created with this style must have a non-NULL parent.
`WIN_EX_CONTEXTHELP`	128`	Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send a `wx.wxEVT_HELP` event if the user `clicked on` an application window. Note that this is an extended style and must be set by calling SetExtraStyle before Create is called (two-step construction). You cannot use this style together with `WIN_MAXIMIZE_BOX` or `WIN_MINIMIZE_BOX`, so you should use `WIN_DEFAULT_STYLE` & ~ (`WIN_MINIMIZE_BOX` \| `WIN_MAXIMIZE_BOX`) for the frames having this style (the dialogs don’t have a minimize or a maximize box by default)
`WIN_SHAPED`	`16`	Windows with this style are allowed to have their shape changed with the SetShape method.
`WIN_EX_METAL`	`64`	On Mac OS X, frames with this style will be shown with a metallic look. This is an extra style.

Events¶

The following events are emitted by this class:

Event name	Description
Window.onShow	When the window is shown.

Inherited Methods¶

These methods are inherited from its super classes:

Class Method	Description
Object:getID	Returns widget’s identifier.
Object:setID	Sets the widget identifier.
Object:getName	Returns widget’s name.
Object:setName	Sets the widget name.
Widget:getParent	Returns control’s parent.
Widget:setParent	Sets the control parent.
Widget:getPosX	Returns control’s position related to X.
Widget:setPosX	Sets the control position related to X.
Widget:getPosY	Returns control’s position related to Y.
Widget:setPosY	Sets the control position related to Y.
Widget:getWidth	Returns control’s width.
Widget:setWidth	Sets the control width.
Widget:getHeight	Returns control’s height.
Widget:setHeight	Sets the control height.
Widget:getwxObj_	Returns a reference to the C++ control.
Widget:getEnabled	Returns true if is enabled.
Widget:setEnabled	Set control enabled or disabled.
Widget:getVisible	Returns the control visibility.
Widget:setVisible	Returns the control visibility.

Class Methods¶

These methods are defined by this class.

Window:centre¶

Centers the window on the display.

nil	Window:centre( )

Window:show¶

Shows the Window. Returns true if the window has been shown or hidden or false if nothing was done because it already was in the requested state.

bool	Window:show( bool bShow = true )

Window:getMinSize¶

Gets the minimum size of the window.

Returns two numbers: Width, Height

number, number

Window:getMinSize( )

Window:setMinSize¶

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

nil	Window:setMinSize( number Width, number Height )

Window:getMaxSize¶

Gets the maximum size of the window.

Returns two numbers: Width, Height

number, number

Window:getMaxSize( )

Window:setMaxSize¶

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

nil	Window:setMaxSize( number Width, number Height )

Window:maximize¶

Maximize or restore the Window.

nil	Window:maximize( bool Maximize )

Window:isMaximized¶

Returns true if the window is maximized.

bool	Window:isMaximized( )

Window:iconize¶

Iconizes (Minimize) or restore the Window.

nil	Window:iconize( bool Iconize )

Window:isIconized¶

Returns true if the window is iconized.

bool	Window:isIconized( )

Window:getTitle¶

Gets a string containing the window caption.

string

Window:getTitle( )

Window:setTitle¶

Sets the window caption.

nil	Window:setTitle( string Title )

Window:setMenubar¶

Tells the window to show the given menu objects at menu bar.

If the frame is destroyed, the menu bar and its menus will be destroyed also, so do not delete the menu bar explicitly (except by resetting the frame’s menu bar to another frame or NULL).

Under Windows, a size event is generated, so be sure to initialize data members properly before calling SetMenuBar.

Note that on some platforms, it is not possible to call this function twice for the same frame object.

nil	Window:setMenubar( table tMenus )

Window:createStatusbar¶

Creates a status bar at the bottom of the frame. “nFields” are the number of fields to create. Specify a value greater than 1 to create a multi-field status bar.

Statusbar Styles:

SB_NORMAL = (Default) The field appears sunken with a standard 3D border. SB_FLAT = No border is painted around the field so that it appears flat. SB_RAISED = A raised 3D border is painted around the field.

nil	Window:createStatusBar( number nFields , number nStyle = SB_NORMAL )

Window:setStatusWidths¶

Sets the widths of the fields in the status bar. You must be send many widths as fields exists.

nil	Window:createStatusBar( number … )

Window:setStatusText¶

Sets the status bar text and redraws the status bar.

nil	Window:setStatusText( string sText, number nField )

Window:setStatusBarPane¶

Set the status bar pane used to display menu and toolbar help. Use -1 for disable help text.

nil	Window:setStatusBarPane( number nField )

Window:raise¶

Raises the window to the top of the window hierarchy (z-order).

In current version of wxWidgets this works both for managed and child windows.

See also: Window:Lower_.

nil	Window:raise( )

Window:setIcon¶

Set iconfile for this window.

nil	Window:setIcon( string sIconFile )

Window:getIcon¶

Get the path of iconfile for this window.

nil	Window:getIcon( )

Example¶

In this example we create a new window …

 myWnd = Window:new {
     ID = 100, Name = "MyWindow",

     -- PosX = 30, PosY = 70, Width , Height, >> Here we don't send the size, for using default sizes

     Title  = "YOUR NEW WINDOW",
 }