wx.Frame Class Reference

Inheritance diagram for wx.Frame:

List of all members.

Public Member Functions
bool	Create (Window parent, int id, string title, Point pos, Size size, wx.WindowStyles style, string name)
StatusBar	CreateStatusBar (int number, wx.WindowStyles style, int id, string name)
StatusBar	CreateStatusBar (int number, wx.WindowStyles style, int id)
StatusBar	CreateStatusBar (int number, wx.WindowStyles style)
StatusBar	CreateStatusBar (int number)
StatusBar	CreateStatusBar ()
ToolBar	CreateToolBar (wx.WindowStyles style, int id, string name)
ToolBar	CreateToolBar (wx.WindowStyles style, int id)
ToolBar	CreateToolBar (wx.WindowStyles style)
ToolBar	CreateToolBar ()
	Frame (string title, Point pos, Size size, wx.WindowStyles style)
	Frame (string title, Point pos, Size size)
	Frame (string title)
	Frame (Window parent, string title, Point pos, Size size, wx.WindowStyles style, string name)
	Frame (Window parent, string title, Point pos, Size size, wx.WindowStyles style)
	Frame (Window parent, string title, Point pos, Size size)
	Frame (Window parent, string title, Point pos)
	Frame (Window parent, string title)
	Frame (Window parent, int id, string title, Point pos, Size size, wx.WindowStyles style, string name)
	Frame (Window parent, int id, string title, Point pos, Size size, wx.WindowStyles style)
	Frame (Window parent, int id, string title, Point pos, Size size)
	Frame (Window parent, int id, string title, Point pos)
	Frame (Window parent, int id, string title)
	Frame ()
	Frame (IntPtr wxObject)
void	Iconize (bool value)
void	Maximize (bool value)
void	SendSizeEvent ()
void	SetStatusText (string text, int number)
void	SetStatusText (string text)
void	SetStatusWidths (int[] widths)
bool	ShowFullScreen (bool show)
bool	ShowFullScreen (bool show, Fullscreen style)
Properties
override Point	ClientAreaOrigin [get]
Window	DefaultItem [get, set]
Icon	Icon [get, set]
bool	Iconized [get, set]
bool	IsFullScreen [get, set]
bool	Maximized [get, set]
MenuBar	MenuBar [get, set]
StatusBar	StatusBar [get, set]
int	StatusBarPane [get, set]
string	StatusText [set]
int[]	StatusWidths [set]
ToolBar	ToolBar [get, set]

---

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

Refer to the styles WindowStyles.DEFAULT_FRAME_STYLE, WindowStyles.MINIMIZE_BOX, WindowStyles.MAXIMIZE_BOX, WindowStyles.RESIZE_BORDER WindowStyles.SYSTEM_MENU, WindowStyles.CAPTION, WindowStyles.CLOSE_BOX, WindowStyles.CLIP_CHILDREN ...

---

Constructor & Destructor Documentation

wx.Frame.Frame

(

IntPtr

wxObject

)

wx.Frame.Frame

(

)

wx.Frame.Frame	(	Window	parent,
		int	id,
		string	title
	)

wx.Frame.Frame	(	Window	parent,
		int	id,
		string	title,
		Point	pos
	)

wx.Frame.Frame	(	Window	parent,
		int	id,
		string	title,
		Point	pos,
		Size	size
	)

wx.Frame.Frame	(	Window	parent,
		int	id,
		string	title,
		Point	pos,
		Size	size,
		wx.WindowStyles	style
	)

wx.Frame.Frame	(	Window	parent,
		int	id,
		string	title,
		Point	pos,
		Size	size,
		wx.WindowStyles	style,
		string	name
	)

wx.Frame.Frame	(	Window	parent,
		string	title
	)

wx.Frame.Frame	(	Window	parent,
		string	title,
		Point	pos
	)

wx.Frame.Frame	(	Window	parent,
		string	title,
		Point	pos,
		Size	size
	)

wx.Frame.Frame	(	Window	parent,
		string	title,
		Point	pos,
		Size	size,
		wx.WindowStyles	style
	)

wx.Frame.Frame	(	Window	parent,
		string	title,
		Point	pos,
		Size	size,
		wx.WindowStyles	style,
		string	name
	)

wx.Frame.Frame

(

string

title

)

wx.Frame.Frame	(	string	title,
		Point	pos,
		Size	size
	)

wx.Frame.Frame	(	string	title,
		Point	pos,
		Size	size,
		wx.WindowStyles	style
	)

---

Member Function Documentation

bool wx.Frame.Create	(	Window	parent,
		int	id,
		string	title,
		Point	pos,
		Size	size,
		wx.WindowStyles	style,
		string	name
	)

Reimplemented in wx.MDIParentFrame, and wx.MiniFrame.

StatusBar wx.Frame.CreateStatusBar	(	int	number,
		wx.WindowStyles	style,
		int	id,
		string	name
	)

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.

See also:

SetStatusText, P:wx.Frame.StatusBar

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.

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

StatusBar wx.Frame.CreateStatusBar	(	int	number,
		wx.WindowStyles	style,
		int	id
	)

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.

Returns:

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

See also:

SetStatusText, P:wx.Frame.StatusBar

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.

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

StatusBar wx.Frame.CreateStatusBar	(	int	number,
		wx.WindowStyles	style
	)

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.

Returns:

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

See also:

SetStatusText, P:wx.Frame.StatusBar

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.

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

StatusBar wx.Frame.CreateStatusBar

(

int

number

)

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.

Returns:

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

See also:

SetStatusText, P:wx.Frame.StatusBar

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.

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

StatusBar wx.Frame.CreateStatusBar

(

)

Creates a status bar at the bottom of the frame.

Returns:

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

See also:

SetStatusText, P:wx.Frame.StatusBar

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.

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

ToolBar wx.Frame.CreateToolBar	(	wx.WindowStyles	style,
		int	id,
		string	name
	)

Create a toolbar.

Parameters:

	style	Window styles to be used. Specific styles have names starting with "TB_".
	id	Window ID of the toolbar.
	name	Name of the window.

Returns:

The created toolbar.

ToolBar wx.Frame.CreateToolBar	(	wx.WindowStyles	style,
		int	id
	)

Create a toolbar with name (of the toolbar control) "toolBar".

Parameters:

	style	Window styles to be used. Specific styles have names starting with "TB_".
	id	Window ID of the toolbar.

Returns:

The created toolbar.

ToolBar wx.Frame.CreateToolBar

(

wx.WindowStyles

style

)

Create a toolbar of undefined ID and name (of the toolbar control) "toolBar"..

Parameters:

style

Window styles to be used. Specific styles have names starting with "TB_".

Returns:

The created toolbar.

ToolBar wx.Frame.CreateToolBar

(

)

Create a toolbar of undefined ID and name (of the toolbar control) "toolBar".

Returns:

The created toolbar.

void wx.Frame.Iconize

(

bool

value

)

Iconizes or restores the window.

Parameters:

value

If true, iconizes the window, otherwise it restores it.

void wx.Frame.Maximize

(

bool

value

)

Maximizes or restores the window.

Parameters:

value

If true, maximizes the window, otherwise it restores it.

void wx.Frame.SendSizeEvent

(

)

void wx.Frame.SetStatusText	(	string	text,
		int	number
	)

Set text for the status bar

Parameters:

	text	Text to be displayed by the status bar-
	number	Index of the field of the status bar that shall display the text.

void wx.Frame.SetStatusText

(

string

text

)

Setting text for the status bar.

Parameters:

text

Text to be displayed by the status bar-

void wx.Frame.SetStatusWidths

(

int[]

widths

)

Sets the widths of the fields in the status bar. 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.

Parameters:

widths

Array of values each representing the width of a status line.

bool wx.Frame.ShowFullScreen

(

bool

show

)

The window is shown full screen. This function has not been tested with MDI frames. Note that showing a window full screen also actually Show()s if it hadn't been shown yet.

bool wx.Frame.ShowFullScreen	(	bool	show,
		Fullscreen	style
	)

Depending on the value of show parameter the window is either shown full screen or restored to its normal state. style is a bit list containing some or all of the following values, which indicate what elements of the window to hide in full-screen mode:

This function has not been tested with MDI frames. Note that showing a window full screen also actually Show()s if it hadn't been shown yet.

---

Property Documentation

override Point wx.Frame.ClientAreaOrigin [get]

Reimplemented from wx.Window.

Window wx.Frame.DefaultItem [get, set]

Get or set the default item. This usually is a button.

Icon wx.Frame.Icon [get, set]

Get or set the icon that will be displayed in the window decorator or when iconifying.

bool wx.Frame.Iconized [get, set]

True iff the frame has been iconized. This is false if the frame has been deallocated.

The setter is a synonym for Iconize().

See also:

Maximized

bool wx.Frame.IsFullScreen [get, set]

The getter returns true iff this frame is in full screen mode. The setter is a synonym for ShowFullScreen() either with Fullscreen.ALL (assigning true) or Fullscreen.NONE.

M:wx.Frame.ShowFullScreen

bool wx.Frame.Maximized [get, set]

True iff the frame has been maximized. This is false if the frame has been deallocated. The setter is a synonym for Maximize().

See also:

Iconized, Maximize

MenuBar wx.Frame.MenuBar [get, set]

The menu bar of this instance. You may get the current instance using this property or set a new menu bar assigning to this property.

StatusBar wx.Frame.StatusBar [get, set]

The setter associates a status bar with the frame.

int wx.Frame.StatusBarPane [get, set]

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

string wx.Frame.StatusText [set]

Set text for the status bar here. Unfortunately, reading the displayed text is not supported.

int [] wx.Frame.StatusWidths [set]

Alternative form of SetStatusWidths(): Only the setter is defined.

SetStatusWidths

ToolBar wx.Frame.ToolBar [get, set]

---