wxFrame Class Reference
[Managed Windows]

#include <wx/frame.h>

Inheritance diagram for wxFrame:

Detailed 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() and CreateToolBar() functions, manages these windows and adjusts the value returned by GetClientSize() to reflect the remaining size available to application windows.

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.

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.

frame_styles

wxFrame supports the following styles:

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_SHAPED:
Windows with this style are allowed to have their shape changed with the SetShape() method.

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 | wxMAXIMIZE_BOX)

Constructor & Destructor Documentation

wxFrame::wxFrame ( )

Default constructor.

wxFrame::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.
	id	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. The value wxDefaultPosition indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.
	size	The window size. The value wxDefaultSize indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
	style	The window style. See wxFrame class description.
	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:: Create()

virtual wxFrame::~wxFrame ( ) [virtual]

Destructor. Destroys all child windows and menu bar if present.

Member Function Documentation

void wxFrame::Centre ( int direction = wxBOTH )

Centres the frame on the display.

Parameters:

direction

The parameter may be wxHORIZONTAL, wxVERTICAL or wxBOTH.

Reimplemented from wxWindow.

bool wxFrame::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() for further details.

Reimplemented in wxMDIParentFrame, wxMDIChildFrame, and wxMiniFrame.

virtual wxStatusBar* wxFrame::CreateStatusBar	(	int	number = `1`,
		long	style = `0`,
		wxWindowID	id = `-1`,
		const wxString &	name = `"statusBar"`
	)			`[virtual]`

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	The status bar style. See wxStatusBar for a list of valid styles.
	id	The status bar window identifier. If -1, an identifier will be chosen by wxWidgets.
	name	The status bar window name.

Returns:: 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.

See also:: SetStatusText(), OnCreateStatusBar(), GetStatusBar()

virtual wxToolBar* wxFrame::CreateToolBar	(	long	style = `wxBORDER_NONE\|wxTB_HORIZONTAL`,
		wxWindowID	id = `-1`,
		const wxString &	name = `"toolBar"`
	)			`[virtual]`

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

Parameters:

	style	The toolbar style. See wxToolBar for a list of valid styles.
	id	The toolbar window identifier. If -1, an identifier will be chosen by wxWidgets.
	name	The toolbar window name.

Returns:: 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 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.

See also:: CreateStatusBar(), OnCreateToolBar(), SetToolBar(), GetToolBar()

virtual wxPoint wxFrame::GetClientAreaOrigin ( ) const [virtual]

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

virtual wxMenuBar* wxFrame::GetMenuBar ( ) const [virtual]

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

See also:: SetMenuBar(), wxMenuBar, wxMenu

virtual wxStatusBar* wxFrame::GetStatusBar ( ) const [virtual]

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

See also:: CreateStatusBar(), wxStatusBar

int wxFrame::GetStatusBarPane ( ) const

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

See also:: SetStatusBarPane()

virtual wxToolBar* wxFrame::GetToolBar ( ) const [virtual]

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

See also:: CreateToolBar(), wxToolBar, SetToolBar()

Reimplemented in wxMDIParentFrame.

virtual wxStatusBar* wxFrame::OnCreateStatusBar	(	int	number,
		long	style,
		wxWindowID	id,
		const wxString &	name
	)			`[virtual]`

Virtual function called when a status bar is requested by CreateStatusBar().

Parameters:

	number	The number of fields to create.
	style	The window style. See wxStatusBar for a list of valid styles.
	id	The window identifier. If -1, an identifier will be chosen by wxWidgets.
	name	The window name.

Returns:: 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:: CreateStatusBar(), wxStatusBar.

virtual wxToolBar* wxFrame::OnCreateToolBar	(	long	style,
		wxWindowID	id,
		const wxString &	name
	)			`[virtual]`

Virtual function called when a toolbar is requested by CreateToolBar().

Parameters:

	style	The toolbar style. See wxToolBar for a list of valid styles.
	id	The toolbar window identifier. If -1, an identifier will be chosen by wxWidgets.
	name	The toolbar window name.

Returns:: 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:: CreateToolBar(), wxToolBar.

void wxFrame::ProcessCommand ( int id )

Simulate a menu command.

Parameters:

id

The identifier for a menu item.

virtual void wxFrame::SetMenuBar ( wxMenuBar * menuBar ) [virtual]

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:: GetMenuBar(), wxMenuBar, wxMenu.

virtual void wxFrame::SetStatusBar ( wxStatusBar * statusBar ) [virtual]

Associates a status bar with the frame.

See also:: CreateStatusBar(), wxStatusBar, GetStatusBar()

void wxFrame::SetStatusBarPane ( int n )

Set the status bar pane used to display menu and toolbar help. Using -1 disables help display.

virtual void wxFrame::SetStatusText	(	const wxString &	text,
		int	number = `0`
	)			`[virtual]`

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:: CreateStatusBar(), wxStatusBar

virtual void wxFrame::SetStatusWidths	(	int	n,
		int *	widths
	)			`[virtual]`

Sets the widths of the fields in the status bar.

Parameters:

	n	The number of fields in the status bar. It must be the same used in CreateStatusBar.
	widths	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().

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.

virtual void wxFrame::SetToolBar ( wxToolBar * toolBar ) [virtual]

Associates a toolbar with the frame.


Public Member Functions
	wxFrame ()
	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")
virtual	~wxFrame ()
void	Centre (int direction=wxBOTH)
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")
virtual wxStatusBar *	CreateStatusBar (int number=1, long style=0, wxWindowID id=-1, const wxString &name="statusBar")
virtual wxToolBar *	CreateToolBar (long style=wxBORDER_NONE\|wxTB_HORIZONTAL, wxWindowID id=-1, const wxString &name="toolBar")
virtual wxPoint	GetClientAreaOrigin () const
virtual wxMenuBar *	GetMenuBar () const
virtual wxStatusBar *	GetStatusBar () const
int	GetStatusBarPane () const
virtual wxToolBar *	GetToolBar () const
virtual wxStatusBar *	OnCreateStatusBar (int number, long style, wxWindowID id, const wxString &name)
virtual wxToolBar *	OnCreateToolBar (long style, wxWindowID id, const wxString &name)
void	ProcessCommand (int id)
virtual void	SetMenuBar (wxMenuBar *menuBar)
virtual void	SetStatusBar (wxStatusBar *statusBar)
void	SetStatusBarPane (int n)
virtual void	SetStatusText (const wxString &text, int number=0)
virtual void	SetStatusWidths (int n, int *widths)
virtual void	SetToolBar (wxToolBar *toolBar)

wxFrame Class Reference [Managed Windows]

Detailed Description

Default event processing

frame_styles

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

wxFrame Class Reference
[Managed Windows]