wxframe

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.

derived from

wxtoplevelwindow
wxwindow
wxevthandler
wxobject

include files

window styles

wxdefault_frame_style	defined as wxminimize_box \| wxmaximize_box \| wxresize_border \| wxsystem_menu \| wxcaption \| wxclose_box \| wxclip_children.
wxiconize	display the frame iconized (minimized). windows only.
wxcaption	puts a caption on the frame.
wxminimize	identical to wxiconize. windows only.
wxminimize_box	displays a minimize box on the frame.
wxmaximize	displays the frame maximized. windows only.
wxmaximize_box	displays a maximize box on the frame.
wxclose_box	displays a close box on the frame.
wxstay_on_top	stay on top of all other windows, see also wxframe_float_on_parent.
wxsystem_menu	displays a system menu.
wxresize_border	displays a resizeable border around the window.
wxframe_tool_window	causes a frame with a small titlebar to be created; the frame does not appear in the taskbar under windows or gtk+.
wxframe_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 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.
wxframe_float_on_parent	the frame will always be on top of its parent (unlike wxstay_on_top). a frame created with this style must have a non-null parent.
wxframe_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 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 wxmaximize_box or wxminimize_box, so you should use `wxdefault_frame_style & ~ (wxminimize_box \| wxmaximize_box)` for the frames having this style (the dialogs don't have a minimize or a maximize box by default)
wxframe_shaped	windows with this style are allowed to have their shape changed with the setshape method.
wxframe_ex_metal	on mac os x, frames with this style will be shown with a metallic look. this is an extra style.

the default frame style is for normal, resizeable frames. to create a frame which can not be resized by user, you may use the following combination of styles: wxdefault_frame_style & ~ (wxresize_border | wxresize_box | wxmaximize_box). see also window styles overview.

default event processing

wxframe processes the following events:

wxevt_size	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 wxevt_size or using sizers
wxevt_menu_highlight	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 wxcloseevent handler for the frame to respond to system close events, for example so that related data and subwindows can be cleaned up.

members

wxframe::wxframe
wxframe::~wxframe
wxframe::centre
wxframe::create
wxframe::createstatusbar
wxframe::createtoolbar
wxframe::getclientareaorigin
wxframe::getmenubar
wxframe::getstatusbar
wxframe::getstatusbarpane
wxframe::gettoolbar
wxframe::oncreatestatusbar
wxframe::oncreatetoolbar
wxframe::processcommand
wxframe::sendsizeevent
wxframe::setmenubar
wxframe::setstatusbar
wxframe::setstatusbarpane
wxframe::setstatustext
wxframe::setstatuswidths
wxframe::settoolbar

wxframe::wxframe

wxframe()

default constructor.

wxframe(wxwindow* parent, wxwindowid id, const wxstring& title, const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxdefault_frame_style, const wxstring& name = "frame")

constructor, creating the window.

parameters

parent

the window parent. this may be null. if it is non-null, the frame will always be displayed on top of the parent window on windows.

the window identifier. it may take a value of -1 to indicate a default value.

title

the caption to be displayed on the frame's title bar.

pos

the window position. a value of (-1, -1) indicates a default position, chosen by either the windowing system or wxwidgets, depending on platform.

size

the window size. a value of (-1, -1) indicates a default size, chosen by either the windowing system or wxwidgets, depending on platform.

style

wxframe

name

the name of the window. this parameter is used to associate a name with the item, allowing the application user to set motif resource values for individual windows.

remarks

for motif, mwm (the motif window manager) should be running for any window styles to work (otherwise all styles take effect).

see also

wxframe::create

wxframe::~wxframe

void ~wxframe()

destructor. destroys all child windows and menu bar if present.

wxframe::centre

void centre(int direction = wxboth)

centres the frame on the display.

parameters

direction

wxhorizontal

wxvertical

wxboth

wxframe::create

bool create(wxwindow* parent, wxwindowid id, const wxstring& title, const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxdefault_frame_style, const wxstring& name = "frame")

used in two-step frame construction. see wxframe::wxframe for further details.

wxframe::createstatusbar

virtual wxstatusbar* createstatusbar(int number = 1, long style = 0, wxwindowid id = -1, const wxstring& name = "statusbar")

creates a status bar at the bottom of the frame.

parameters

number

the number of fields to create. specify a value greater than 1 to create a multi-field status bar.

style

wxstatusbar

the status bar window identifier. if -1, an identifier will be chosen by wxwidgets.

name

the status bar window name.

return value

a pointer to the status bar if it was created successfully, null otherwise.

remarks

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 wxstatusbar. to use a different class, override wxframe::oncreatestatusbar.

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

wxframe::createtoolbar

virtual wxtoolbar* createtoolbar(long style = wxno_border | wxtb_horizontal, wxwindowid id = -1, const wxstring& name = "toolbar")

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

parameters

style

wxtoolbar

the toolbar window identifier. if -1, an identifier will be chosen by wxwidgets.

name

the toolbar window name.

return value

a pointer to the toolbar if it was created successfully, null otherwise.

remarks

by default, the toolbar is an instance of wxtoolbar (which is defined to be a suitable toolbar class on each platform, such as wxtoolbar95). to use a different class, override wxframe::oncreatetoolbar.

when a toolbar has been created with this function, or made known to the frame with wxframe::settoolbar, the frame will manage the toolbar position and adjust the return value from wxwindow::getclientsize to reflect the available space for application windows.

under pocket pc, you should always use this function for creating the toolbar to be managed by the frame, so that wxwidgets can use a combined menubar and toolbar. where you manage your own toolbars, create a wxtoolbar as usual.

wxframe::getclientareaorigin

wxpoint getclientareaorigin() const

returns the origin of the frame client area (in client coordinates). it may be different from (0, 0) if the frame has a toolbar.

wxframe::getmenubar

wxmenubar* getmenubar() const

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

see also

wxframe::setmenubar, wxmenubar, wxmenu

wxframe::getstatusbar

wxstatusbar* getstatusbar() const

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

see also

wxframe::createstatusbar, wxstatusbar

wxframe::getstatusbarpane

int getstatusbarpane()

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

see also

wxframe::setstatusbarpane

wxframe::gettoolbar

wxtoolbar* gettoolbar() const

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

wxframe::oncreatestatusbar

virtual wxstatusbar* oncreatestatusbar(int number, long style, wxwindowid id, const wxstring& name)

virtual function called when a status bar is requested by wxframe::createstatusbar.

parameters

number

the number of fields to create.

style

wxstatusbar

the window identifier. if -1, an identifier will be chosen by wxwidgets.

name

the window name.

return value

a status bar object.

remarks

an application can override this function to return a different kind of status bar. the default implementation returns an instance of wxstatusbar.

see also

wxframe::createstatusbar, wxstatusbar.

wxframe::oncreatetoolbar

virtual wxtoolbar* oncreatetoolbar(long style, wxwindowid id, const wxstring& name)

virtual function called when a toolbar is requested by wxframe::createtoolbar.

parameters

style

wxtoolbar

the toolbar window identifier. if -1, an identifier will be chosen by wxwidgets.

name

the toolbar window name.

return value

a toolbar object.

remarks

an application can override this function to return a different kind of toolbar. the default implementation returns an instance of wxtoolbar.

see also

wxframe::createtoolbar, wxtoolbar.

wxframe::processcommand

void processcommand(int id)

simulate a menu command.

parameters

the identifier for a menu item.

wxframe::sendsizeevent

void sendsizeevent()

this function sends a dummy size event to the frame forcing it to reevaluate its children positions. it is sometimes useful to call this function after adding or deleting a children after the frame creation or if a child size changes.

note that if the frame is using either sizers or constraints for the children layout, it is enough to call layout() directly and this function should not be used in this case.

wxframe::setmenubar

void setmenubar(wxmenubar* menubar)

tells the frame to show the given menu bar.

parameters

menubar

the menu bar to associate with the frame.

remarks

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.

see also

wxframe::getmenubar, wxmenubar, wxmenu.

wxframe::setstatusbar

void setstatusbar(wxstatusbar* statusbar)

associates a status bar with the frame.

wxframe::setstatusbarpane

void setstatusbarpane(int n)

set the status bar pane used to display menu and toolbar help. using -1 disables help display.

wxframe::setstatustext

virtual void setstatustext(const wxstring& text, int number = 0)

sets the status bar text and redraws the status bar.

parameters

text

the text for the status field.

number

the status field (starting from zero).

remarks

use an empty string to clear the status bar.

see also

wxframe::createstatusbar, wxstatusbar

wxframe::setstatuswidths

virtual void setstatuswidths(int n, int *widths)

sets the widths of the fields in the status bar.

parameters

createstatusbar

widths

setstatuswidths

remarks

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.

wxpython note: only a single parameter is required, a python list of integers.

wxperl note: in wxperl this method takes the field widths as parameters.

wxframe::settoolbar

void settoolbar(wxtoolbar* toolbar)

associates a toolbar with the frame.