wxTopLevelWindow Class Reference
[Managed Windows]

#include <wx/toplevel.h>

Inheritance diagram for wxTopLevelWindow:

Detailed Description

wxTopLevelWindow is a common base class for wxDialog and wxFrame. It is an abstract base class meaning that you never work with objects of this class directly, but all of its methods are also applicable for the two classes above.

Library: wxCore

Category: Managed Windows

See also:: wxDialog, wxFrame


Public Member Functions
virtual bool	CanSetTransparent ()
void	CenterOnScreen (int direction)
void	CentreOnScreen (int direction=wxBOTH)
bool	EnableCloseButton (bool enable=true)
wxWindow *	GetDefaultItem () const
const wxIcon	GetIcon () const
const wxIconBundle	GetIcons () const
wxString	GetTitle () const
virtual bool	HandleSettingChange (WXWPARAM wParam, WXLPARAM lParam)
void	Iconize (bool iconize)
virtual bool	IsActive ()
virtual bool	IsAlwaysMaximized () const
bool	IsFullScreen ()
bool	IsIconized () const
bool	IsMaximized () const
bool	IsUsingNativeDecorations () const
void	Maximize (bool maximize)
virtual void	RequestUserAttention (int flags=wxUSER_ATTENTION_INFO)
void	SetDefaultItem (wxWindow *win)
void	SetIcon (const wxIcon &icon)
virtual void	SetIcons (const wxIconBundle &icons)
void	SetLeftMenu (int id=wxID_ANY, const wxString &label=wxEmptyString, wxMenu *subMenu=NULL)
virtual void	SetMaxSize (const wxSize &size)
virtual void	SetMinSize (const wxSize &size)
void	SetRightMenu (int id=wxID_ANY, const wxString &label=wxEmptyString, wxMenu *subMenu=NULL)
virtual bool	SetShape (const wxRegion &region)
virtual void	SetSizeHints (int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1)
void	SetSizeHints (const wxSize &minSize, const wxSize &maxSize=wxDefaultSize, const wxSize &incSize=wxDefaultSize)
virtual void	SetTitle (const wxString &title)
virtual bool	SetTransparent (int alpha)
virtual bool	ShouldPreventAppExit () const
bool	ShowFullScreen (bool show, long style=wxFULLSCREEN_ALL)
void	UseNativeDecorations (bool native=true)
void	UseNativeDecorationsByDefault (bool native=true)

Member Function Documentation

virtual bool wxTopLevelWindow::CanSetTransparent ( ) [virtual]

Returns true if the platform supports making the window translucent.

See also:: SetTransparent()

Reimplemented from wxWindow.

void wxTopLevelWindow::CenterOnScreen ( int direction )

A synonym for CentreOnScreen().

void wxTopLevelWindow::CentreOnScreen ( int direction = wxBOTH )

Centres the window on screen.

Parameters:

direction Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL or wxBOTH.

See also:: wxWindow::CentreOnParent()

bool wxTopLevelWindow::EnableCloseButton ( bool enable = true )

Enables or disables the Close button (most often in the right upper corner of a dialog) and the Close entry of the system menu (most often in the left upper corner of the dialog).

Currently only implemented for wxMSW and wxGTK.

Returns true if operation was successful. This may be wrong on X11 (including GTK+) where the window manager may not support this operation and there is no way to find out.

wxWindow* wxTopLevelWindow::GetDefaultItem ( ) const

Returns a pointer to the button which is the default for this window, or NULL. The default button is the one activated by pressing the Enter key.

const wxIcon wxTopLevelWindow::GetIcon ( ) const

Returns the standard icon of the window. The icon will be invalid if it hadn't been previously set by SetIcon().

See also:: GetIcons()

const wxIconBundle wxTopLevelWindow::GetIcons ( ) const

Returns all icons associated with the window, there will be none of them if neither SetIcon() nor SetIcons() had been called before. Use GetIcon() to get the main icon of the window.

See also:: wxIconBundle

wxString wxTopLevelWindow::GetTitle ( ) const

Gets a string containing the window title.

See also:: SetTitle()

virtual bool wxTopLevelWindow::HandleSettingChange	(	WXWPARAM	wParam,
		WXLPARAM	lParam
	)			`[virtual]`

Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input panel) area and resize window accordingly. Override this if you want to avoid resizing or do additional operations.

void wxTopLevelWindow::Iconize ( bool iconize )

Iconizes or restores the window.

Parameters:

iconize

If true, iconizes the window; if false, shows and restores it.

See also:: IsIconized(), Maximize(), wxIconizeEvent.

Reimplemented in wxDialog.

virtual bool wxTopLevelWindow::IsActive ( ) [virtual]

Returns true if this window is currently active, i.e. if the user is currently working with it.

virtual bool wxTopLevelWindow::IsAlwaysMaximized ( ) const [virtual]

Returns true if this window is expected to be always maximized, either due to platform policy or due to local policy regarding particular class.

bool wxTopLevelWindow::IsFullScreen ( )

Returns true if the window is in fullscreen mode.

See also:: ShowFullScreen()

bool wxTopLevelWindow::IsIconized ( ) const

Returns true if the window is iconized.

Reimplemented in wxDialog.

bool wxTopLevelWindow::IsMaximized ( ) const

Returns true if the window is maximized.

bool wxTopLevelWindow::IsUsingNativeDecorations ( ) const

This method is specific to wxUniversal port.

Returns true if this window is using native decorations, false if we draw them ourselves.

See also:: UseNativeDecorations(), UseNativeDecorationsByDefault()

void wxTopLevelWindow::Maximize ( bool maximize )

Maximizes or restores the window.

Parameters:

maximize

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

See also:: Iconize()

Reimplemented in wxMDIChildFrame.

virtual void wxTopLevelWindow::RequestUserAttention ( int flags = wxUSER_ATTENTION_INFO ) [virtual]

Use a system-dependent way to attract users attention to the window when it is in background.

flags may have the value of either wxUSER_ATTENTION_INFO (default) or wxUSER_ATTENTION_ERROR which results in a more drastic action. When in doubt, use the default value.

Note:: This function should normally be only used when the application is not already in foreground.

This function is currently implemented for Win32 where it flashes the window icon in the taskbar, and for wxGTK with task bars supporting it.

void wxTopLevelWindow::SetDefaultItem ( wxWindow * win )

Changes the default item for the panel, usually win is a button.

See also:: GetDefaultItem()

void wxTopLevelWindow::SetIcon ( const wxIcon & icon )

Sets the icon for this window.

Parameters:

icon

The wxIcon to associate with this window.

Remarks:: The window takes a 'copy' of icon, but since it uses reference counting, the copy is very quick. It is safe to delete icon after calling this function.

See also:: wxIcon

Reimplemented in wxDialog.

virtual void wxTopLevelWindow::SetIcons ( const wxIconBundle & icons ) [virtual]

Sets several icons of different sizes for this window: this allows to use different icons for different situations (e.g. task switching bar, taskbar, window title bar) instead of scaling, with possibly bad looking results, the only icon set by SetIcon().

Parameters:

icons

The icons to associate with this window.

See also:: wxIconBundle.

Reimplemented in wxDialog.

void wxTopLevelWindow::SetLeftMenu	(	int	id = `wxID_ANY`,
		const wxString &	label = `wxEmptyString`,
		wxMenu *	subMenu = `NULL`
	)

Sets action or menu activated by pressing left hardware button on the smart phones. Unavailable on full keyboard machines.

Parameters:

	id	Identifier for this button.
	label	Text to be displayed on the screen area dedicated to this hardware button.
	subMenu	The menu to be opened after pressing this hardware button.

See also:: SetRightMenu().

virtual void wxTopLevelWindow::SetMaxSize ( const wxSize & size ) [virtual]

A simpler interface for setting the size hints than SetSizeHints().

Reimplemented from wxWindow.

virtual void wxTopLevelWindow::SetMinSize ( const wxSize & size ) [virtual]

A simpler interface for setting the size hints than SetSizeHints().

Reimplemented from wxWindow.

void wxTopLevelWindow::SetRightMenu	(	int	id = `wxID_ANY`,
		const wxString &	label = `wxEmptyString`,
		wxMenu *	subMenu = `NULL`
	)

Sets action or menu activated by pressing right hardware button on the smart phones. Unavailable on full keyboard machines.

Parameters:

	id	Identifier for this button.
	label	Text to be displayed on the screen area dedicated to this hardware button.
	subMenu	The menu to be opened after pressing this hardware button.

See also:: SetLeftMenu().

virtual bool wxTopLevelWindow::SetShape ( const wxRegion & region ) [virtual]

If the platform supports it, sets the shape of the window to that depicted by region. The system will not display or respond to any mouse event for the pixels that lie outside of the region. To reset the window to the normal rectangular shape simply call SetShape() again with an empty wxRegion. Returns true if the operation is successful.

virtual void wxTopLevelWindow::SetSizeHints	(	int	minW,
		int	minH,
		int	maxW = `-1`,
		int	maxH = `-1`,
		int	incW = `-1`,
		int	incH = `-1`
	)			`[virtual]`

Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), no constraints will be used.

Parameters:

	minW	The minimum width.
	minH	The minimum height.
	maxW	The maximum width.
	maxH	The maximum height.
	incW	Specifies the increment for sizing the width (GTK/Motif/Xt only).
	incH	Specifies the increment for sizing the height (GTK/Motif/Xt only).

Remarks:: Notice that this function not only prevents the user from resizing the window outside the given bounds but it also prevents the program itself from doing it using wxWindow::SetSize().

void wxTopLevelWindow::SetSizeHints	(	const wxSize &	minSize,
		const wxSize &	maxSize = `wxDefaultSize`,
		const wxSize &	incSize = `wxDefaultSize`
	)

Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), no constraints will be used.

Parameters:

	minSize	The minimum size of the window.
	maxSize	The maximum size of the window.
	incSize	Increment size (only taken into account under X11-based ports such as wxGTK/wxMotif/wxX11).

Remarks:: Notice that this function not only prevents the user from resizing the window outside the given bounds but it also prevents the program itself from doing it using wxWindow::SetSize().

virtual void wxTopLevelWindow::SetTitle ( const wxString & title ) [virtual]

Sets the window title.

Parameters:

title

The window title.

See also:: GetTitle()

virtual bool wxTopLevelWindow::SetTransparent ( int alpha ) [virtual]

If the platform supports it will set the window to be translucent.

Parameters:

alpha

Determines how opaque or transparent the window will be, if the platform supports the opreration. A value of 0 sets the window to be fully transparent, and a value of 255 sets the window to be fully opaque.

virtual bool wxTopLevelWindow::ShouldPreventAppExit ( ) const [virtual]

This virtual function is not meant to be called directly but can be overridden to return false (it returns true by default) to allow the application to close even if this, presumably not very important, window is still opened. By default, the application stays alive as long as there are any open top level windows.

bool wxTopLevelWindow::ShowFullScreen	(	bool	show,
		long	style = `wxFULLSCREEN_ALL`
	)

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:: Showing a window full screen also actually Show()s the window if it isn't shown.

See also:: IsFullScreen()

void wxTopLevelWindow::UseNativeDecorations ( bool native = true )

This method is specific to wxUniversal port.

Use native or custom-drawn decorations for this window only. Notice that to have any effect this method must be called before really creating the window, i.e. two step creation must be used:

        MyFrame *frame = new MyFrame;       // use default ctor
        frame->UseNativeDecorations(false); // change from default "true"
        frame->Create(parent, title, ...);  // really create the frame

See also:: UseNativeDecorationsByDefault(), IsUsingNativeDecorations()

void wxTopLevelWindow::UseNativeDecorationsByDefault ( bool native = true )

This method is specific to wxUniversal port.

Top level windows in wxUniversal port can use either system-provided window decorations (i.e. title bar and various icons, buttons and menus in it) or draw the decorations themselves. By default the system decorations are used if they are available, but this method can be called with native set to false to change this for all windows created after this point.

Also note that if WXDECOR environment variable is set, then custom decorations are used by default and so it may make sense to call this method with default argument if the application can't use custom decorations at all for some reason.

See also:: UseNativeDecorations()

wxTopLevelWindow Class Reference [Managed Windows]

Detailed Description

Public Member Functions

Member Function Documentation

wxTopLevelWindow Class Reference
[Managed Windows]