wx.Frame

Inheritance diagram for wx.Frame:

Inheritance diagram for wx.Frame:

Description

A frame is a window 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 frame can contain any window that is not a frame or dialog.

A frame that has a status bar and toolbar created via the CreateStatusBar/CreateToolBar functions manages these windows, and adjusts the value returned by GetClientSize to reflect the remaining size available to application windows.

See also

wx.MDIParentFrame, wx.MDIChildFrame, wx.MiniFrame, wx.Dialog

Derived From

• wx.TopLevelWindow
• wx.Window
• wx.EvtHandler
• wx.Object

Known Subclasses

wx.MDIChildFrame, wx.MDIParentFrame, wx.MiniFrame, wx.PreviewFrame, wx.PyPreviewFrame, wx.SplashScreen

Window Styles

Window Style	Description
wx.DEFAULT_FRAME_STYLE	Defined as wx.MINIMIZE_BOX | wx.MAXIMIZE_BOX | wx.RESIZE_BORDER | wx.SYSTEM_MENU | wx.CAPTION | wx.CLOSE_BOX | wx.CLIP_CHILDREN.
wx.ICONIZE	Display the frame iconized (minimized). Windows only.
wx.CAPTION	Puts a caption on the frame.
wx.MINIMIZE	Identical to wx.ICONIZE. Windows only.
wx.MINIMIZE_BOX	Displays a minimize box on the frame.
wx.MAXIMIZE	Displays the frame maximized. Windows only.
wx.MAXIMIZE_BOX	Displays a maximize box on the frame.
wx.CLOSE_BOX	Displays a close box on the frame.
wx.STAY_ON_TOP	Stay on top of all other windows, see also wx.FRAME_FLOAT_ON_PARENT.
wx.SYSTEM_MENU	Displays a system menu.
wx.RESIZE_BORDER	Displays a resizeable border around the window.
wx.FRAME_TOOL_WINDOW	Causes a frame with a small titlebar to be created; the frame does not appear in the taskbar under Windows or GTK+.
wx.FRAME_NO_TASKBAR	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 wx.MINIMIZE_BOX style). In wx.GTK, 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.
wx.FRAME_FLOAT_ON_PARENT	The frame will always be on top of its parent (unlike wx.STAY_ON_TOP). A frame created with this style must have a not None parent.
wx.FRAME_EX_CONTEXTHELP	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.EVT_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 wx.MAXIMIZE_BOX or wx.MINIMIZE_BOX, so you should use wx.DEFAULT_FRAME_STYLE & ~ (wx.MINIMIZE_BOX | wx.MAXIMIZE_BOX) for the frames having this style (the dialogs don’t have a minimize or a maximize box by default)
wx.FRAME_SHAPED	Windows with this style are allowed to have their shape changed with the SetShape method.
wx.FRAME_EX_METAL	On Mac OS X, frames with this style will be shown with a metallic look. This is an extra style.

Event Handling

wx.Frame processes the following events:

Event Name	Description
wx.EVT_SIZE(func)	If the frame has exactly one child window, not counting the status and toolbar, this child is resized to take the entire frame client area. If two or more windows are present, they should be laid out explicitly either by manually handling wx.EVT_SIZE or using sizers.
wx.EVT_MENU_HIGHLIGHT(func)	The default implementation displays the help string associated with the selected item in the first pane of the status bar, if there is one.

Remarks

An application should normally define an wx.CloseEvent handler for the frame to respond to system close events, for example so that related data and subwindows can be cleaned up.

For Motif, MWM (the Motif Window Manager) should be running for any window styles to work (otherwise all styles take effect).

Methods Summary

• __init__
• CreateStatusBar
• CreateToolBar
• DoGiveHelp
• DoMenuUpdates
• GetMenuBar
• GetStatusBar
• GetStatusBarPane
• GetToolBar
• PopStatusText
• ProcessCommand
• PushStatusText
• SetMenuBar
• SetStatusBar
• SetStatusBarPane
• SetStatusText
• SetStatusWidths
• SetToolBar

Properties Summary

• MenuBar
• StatusBar
• StatusBarPane
• ToolBar

Class API

Methods

__init__(parent, id=-1, title="", pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.DEFAULT_FRAME_STYLE, name=wx.FrameNameStr)

Constructor, creating the window.

Parameters:

• parent (wx.Window)
• id (int)
• title (string)
• pos (wx.Point)
• size (wx.Size)
• style (long)
• name (string)

Returns:

wx.Frame

---

CreateStatusBar(number=1, style=wx.ST_SIZEGRIP|wx.FULL_REPAINT_ON_RESIZE, id=0, name="statusBar")

Creates a status bar at the bottom of the frame.

Parameters:

• number (int): The number of fields to create. Specify a value greater than 1 to create a multi-field status bar.
• style (long): The status bar style. See wx.StatusBar for a list of valid styles.
• id (int): The status bar window identifier. If -1, an identifier will be chosen by wxWidgets.
• name (string): The status bar window name.

Returns:

wx.StatusBar

Note

The width of the status bar is the whole width of the frame (adjusted automatically when resizing), and the height and text size are chosen by the host windowing system.

By default, the status bar is an instance of wx.StatusBar. To use a different class, override OnCreateStatusBar.

Note

Note that you can put controls and other windows on the status bar if you wish.

See also

SetStatusText, GetStatusBar

---

CreateToolBar(style=wx.NO_BORDER|wx.TB_HORIZONTAL, id=-1, name="toolBar")

Creates a toolbar at the top or left of the frame.

Parameters:

• style (long): The toolbar style. See wx.ToolBar for a list of valid styles.
• id (int): The toolbar window identifier. If -1, an identifier will be chosen by wxWidgets.
• name (string): The toolbar window name.

Returns:

wx.ToolBar

Note

By default, the toolbar is an instance of wx.ToolBar (which is defined to be a suitable toolbar class on each platform). To use a different class, override OnCreateToolBar. When a toolbar has been created with this function, or made known to the frame with SetToolBar, the frame will manage the toolbar position and adjust the return value from wx.Window.GetClientSize to reflect the available space for application windows.

See also

CreateStatusBar, SetToolBar, GetToolBar

---

DoGiveHelp(text, show)

Parameters:

• text (string)
• show (bool)

---

DoMenuUpdates(menu=None)

Parameters:

• menu (wx.Menu)

---

GetMenuBar()

Returns a pointer to the menubar currently associated with the frame (if any).

Returns:

wx.MenuBar

See also

SetMenuBar, wx.MenuBar, wx.Menu

---

GetStatusBar()

Returns a pointer to the status bar currently associated with the frame (if any).

Returns:

wx.StatusBar

See also

CreateStatusBar, wx.StatusBar

---

GetStatusBarPane()

Returns the status bar pane used to display menu and toolbar help.

Returns:

int

See also

SetStatusBarPane

---

GetToolBar()

Returns a pointer to the toolbar currently associated with the frame (if any).

Returns:

wx.ToolBar

See also

CreateToolBar, SetToolBar, wx.ToolBar

---

PopStatusText(number=0)

Parameters:

• number (int)

---

ProcessCommand(id)

Simulate a menu command.

Parameters:

• id (int): The identifier for a menu item.

---

PushStatusText(text, number=0)

Parameters:

• text (string)
• number (int)

---

SetMenuBar(menuBar)

Tells the frame to show the given menu bar.

Parameters:

• menuBar (wx.MenuBar): The menu bar to associate with the frame.

Note

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 None). Under Windows, a size event is generated, so be sure to initialize data members properly before calling SetMenuBar.

Note

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

See also

GetMenuBar, wx.MenuBar, wx.Menu

---

SetStatusBar(statusBar)

Associates a status bar with the frame.

Parameters:

• statusBar (wx.StatusBar)

See also

CreateStatusBar, GetStatusBar, wx.StatusBar

---

SetStatusBarPane(n)

Set the status bar pane used to display menu and toolbar help.

Using -1 disables help display.

Parameters:

• n (int)

---

SetStatusText(text, number=0)

Sets the status bar text and redraws the status bar.

Parameters:

• text (string): The text for the status field.
• number (int): The status field (starting from zero).

Note

Use an empty string to clear the status bar.

See also

CreateStatusBar, wx.StatusBar

---

SetStatusWidths(widths)

Sets the widths of the fields in the status bar.

Parameters:

• widths (list of integers): Must contain an array of n integers, each of which is a status field width in pixels. A value of -1 indicates that the field is variable width; at least one field must be -1. You should delete this array after calling SetStatusWidths.

Note

The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields.

---

SetToolBar(toolBar)

Associates a toolbar with the frame.

Parameters:

• toolBar (wx.ToolBar)

---

Properties

MenuBar

See GetMenuBar and SetMenuBar

StatusBar

See GetStatusBar and SetStatusBar

StatusBarPane

See GetStatusBarPane and SetStatusBarPane

ToolBar

See GetToolBar and SetToolBar