wxFrame Class Reference

#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.

Styles

This class supports the following 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. Notice that this flag is required by wxMINIMIZE_BOX, wxMAXIMIZE_BOX and wxCLOSE_BOX on most systems as the corresponding buttons cannot be shown if the window has no title bar at all. I.e. if wxCAPTION is not specified those styles would be simply ignored.
• wxMINIMIZE:
  Identical to wxICONIZE. Windows only.
• wxMINIMIZE_BOX:
  Displays a minimize box on the frame.
• wxMAXIMIZE:
  Displays the frame maximized. Windows and GTK+ only.
• wxMAXIMIZE_BOX:
  Displays a maximize box on the frame. Notice that under wxGTK wxRESIZE_BORDER must be used as well or this style is ignored.
• 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 containing the list of various windows commands in the window title bar. Unlike wxMINIMIZE_BOX, wxMAXIMIZE_BOX and wxCLOSE_BOX styles this style can be used without wxCAPTION, at least under Windows, and makes the system menu available without showing it on screen in this case. However it is recommended to only use it together with wxCAPTION for consistent behaviour under all platforms.
• wxRESIZE_BORDER:
  Displays a resizable border around the window.
• wxFRAME_TOOL_WINDOW:
  Causes a frame with a small title bar 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 the window manager supports _NET_WM_STATE_SKIP_TASKBAR hint.
• 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, resizable frames. To create a frame which cannot be resized by user, you may use the following combination of styles:

wxDEFAULT_FRAME_STYLE & ~(wxRESIZE_BORDER | wxMAXIMIZE_BOX)

See also the Window Styles.

---

Extra Styles

This class supports the following extra styles:

• 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_EX_METAL:
  On OS X, frames with this style will be shown with a metallic look. This is an extra style.

Events emitted by this class

Event macros for events emitted by this class:

• EVT_CLOSE(func):
  Process a wxEVT_CLOSE_WINDOW event when the frame is being closed by the user or programmatically (see wxWindow::Close). The user may generate this event clicking the close button (typically the 'X' on the top-right of the title bar) if it's present (see the wxCLOSE_BOX style). See wxCloseEvent.
• EVT_ICONIZE(func):
  Process a wxEVT_ICONIZE event. See wxIconizeEvent.
• EVT_MENU_OPEN(func):
  A menu is about to be opened. See wxMenuEvent.
• EVT_MENU_CLOSE(func):
  A menu has been just closed. See wxMenuEvent.
• EVT_MENU_HIGHLIGHT(id, func):
  The menu item with the specified id has been highlighted: used to show help prompts in the status bar by wxFrame. See wxMenuEvent.
• EVT_MENU_HIGHLIGHT_ALL(func):
  A menu item has been highlighted, i.e. the currently selected menu item has changed. See wxMenuEvent.

Library:  wxCore

Category:  Managed Windows

See also

wxMDIParentFrame, wxMDIChildFrame, wxMiniFrame, wxDialog

Public Member Functions
	wxFrame ()
	Default constructor. More...
	wxFrame (wxWindow *parent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_FRAME_STYLE, const wxString &name=wxFrameNameStr)
	Constructor, creating the window. More...
virtual	~wxFrame ()
	Destructor. More...
void	Centre (int direction=wxBOTH)
	Centres the frame on the display. More...
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=wxFrameNameStr)
	Used in two-step frame construction. More...
virtual wxStatusBar *	CreateStatusBar (int number=1, long style=wxSTB_DEFAULT_STYLE, wxWindowID id=0, const wxString &name=wxStatusBarNameStr)
	Creates a status bar at the bottom of the frame. More...
virtual wxToolBar *	CreateToolBar (long style=wxTB_DEFAULT_STYLE, wxWindowID id=wxID_ANY, const wxString &name=wxToolBarNameStr)
	Creates a toolbar at the top or left of the frame. More...
virtual void	DoGiveHelp (const wxString &text, bool show)
	Method used to show help string of the selected menu toolbar item. More...
virtual wxPoint	GetClientAreaOrigin () const
	Returns the origin of the frame client area (in client coordinates). More...
virtual wxMenuBar *	GetMenuBar () const
	Returns a pointer to the menubar currently associated with the frame (if any). More...
virtual wxStatusBar *	GetStatusBar () const
	Returns a pointer to the status bar currently associated with the frame (if any). More...
int	GetStatusBarPane () const
	Returns the status bar pane used to display menu and toolbar help. More...
virtual wxToolBar *	GetToolBar () const
	Returns a pointer to the toolbar currently associated with the frame (if any). More...
virtual wxStatusBar *	OnCreateStatusBar (int number, long style, wxWindowID id, const wxString &name)
	Virtual function called when a status bar is requested by CreateStatusBar(). More...
virtual wxToolBar *	OnCreateToolBar (long style, wxWindowID id, const wxString &name)
	Virtual function called when a toolbar is requested by CreateToolBar(). More...
bool	ProcessCommand (int id)
	Simulate a menu command. More...
virtual void	SetMenuBar (wxMenuBar *menuBar)
	Tells the frame to show the given menu bar. More...
virtual void	SetStatusBar (wxStatusBar *statusBar)
	Associates a status bar with the frame. More...
void	SetStatusBarPane (int n)
	Set the status bar pane used to display menu and toolbar help. More...
virtual void	SetStatusText (const wxString &text, int number=0)
	Sets the status bar text and redraws the status bar. More...
virtual void	SetStatusWidths (int n, const int *widths_field)
	Sets the widths of the fields in the status bar. More...
virtual void	SetToolBar (wxToolBar *toolBar)
	Associates a toolbar with the frame. More...
wxTaskBarButton *	MSWGetTaskBarButton ()
	MSW-specific function for accessing the taskbar button under Windows 7 or later. More...
void	PushStatusText (const wxString &text, int number=0)
void	PopStatusText (int number=0)
Public Member Functions inherited from wxTopLevelWindow
	wxTopLevelWindow ()
	Default ctor. More...
	wxTopLevelWindow (wxWindow *parent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_FRAME_STYLE, const wxString &name=wxFrameNameStr)
	Constructor creating the top level window. More...
virtual	~wxTopLevelWindow ()
	Destructor. More...
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=wxFrameNameStr)
	Creates the top level window. More...
virtual bool	CanSetTransparent ()
	Returns true if the platform supports making the window translucent. More...
void	CenterOnScreen (int direction=wxBOTH)
	A synonym for CentreOnScreen(). More...
void	CentreOnScreen (int direction=wxBOTH)
	Centres the window on screen. More...
virtual bool	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). More...
virtual bool	EnableMaximizeButton (bool enable=true)
	Enables or disables the Maximize button (in the right or left upper corner of a frame or dialog). More...
virtual bool	EnableMinimizeButton (bool enable=true)
	Enables or disables the Minimize button (in the right or left upper corner of a frame or dialog). More...
wxWindow *	GetDefaultItem () const
	Returns a pointer to the button which is the default for this window, or NULL. More...
wxIcon	GetIcon () const
	Returns the standard icon of the window. More...
const wxIconBundle &	GetIcons () const
	Returns all icons associated with the window, there will be none of them if neither SetIcon() nor SetIcons() had been called before. More...
virtual wxString	GetTitle () const
	Gets a string containing the window title. More...
virtual void	Iconize (bool iconize=true)
	Iconizes or restores the window. More...
virtual bool	IsActive ()
	Returns true if this window is currently active, i.e. if the user is currently working with it. More...
virtual bool	IsAlwaysMaximized () const
	Returns true if this window is expected to be always maximized, either due to platform policy or due to local policy regarding particular class. More...
virtual bool	IsFullScreen () const
	Returns true if the window is in fullscreen mode. More...
virtual bool	IsIconized () const
	Returns true if the window is iconized. More...
virtual bool	IsMaximized () const
	Returns true if the window is maximized. More...
bool	IsUsingNativeDecorations () const
	This method is specific to wxUniversal port. More...
virtual bool	Layout ()
	See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized. More...
virtual void	Maximize (bool maximize=true)
	Maximizes or restores the window. More...
wxMenu *	MSWGetSystemMenu () const
	MSW-specific function for accessing the system menu. More...
virtual void	RequestUserAttention (int flags=wxUSER_ATTENTION_INFO)
	Use a system-dependent way to attract users attention to the window when it is in background. More...
void	Restore ()
	Restore a previously iconized or maximized window to its normal state. More...
wxWindow *	SetDefaultItem (wxWindow *win)
	Changes the default item for the panel, usually win is a button. More...
wxWindow *	SetTmpDefaultItem (wxWindow *win)
wxWindow *	GetTmpDefaultItem () const
void	SetIcon (const wxIcon &icon)
	Sets the icon for this window. More...
virtual void	SetIcons (const wxIconBundle &icons)
	Sets several icons of different sizes for this window: this allows to use different icons for different situations (e.g. More...
virtual void	SetMaxSize (const wxSize &size)
	A simpler interface for setting the size hints than SetSizeHints(). More...
virtual void	SetMinSize (const wxSize &size)
	A simpler interface for setting the size hints than SetSizeHints(). More...
virtual void	SetSizeHints (int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1)
	Allows specification of minimum and maximum window sizes, and window size increments. More...
void	SetSizeHints (const wxSize &minSize, const wxSize &maxSize=wxDefaultSize, const wxSize &incSize=wxDefaultSize)
	Allows specification of minimum and maximum window sizes, and window size increments. More...
virtual void	SetTitle (const wxString &title)
	Sets the window title. More...
virtual bool	SetTransparent (wxByte alpha)
	If the platform supports it will set the window to be translucent. More...
virtual bool	ShouldPreventAppExit () const
	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. More...
virtual void	OSXSetModified (bool modified)
	This function sets the wxTopLevelWindow's modified state on OS X, which currently draws a black dot in the wxTopLevelWindow's close button. More...
virtual bool	OSXIsModified () const
	Returns the current modified state of the wxTopLevelWindow on OS X. More...
virtual void	SetRepresentedFilename (const wxString &filename)
	Sets the file name represented by this wxTopLevelWindow. More...
virtual void	ShowWithoutActivating ()
	Show the wxTopLevelWindow, but do not give it keyboard focus. More...
virtual bool	EnableFullScreenView (bool enable=true)
	Enables the maximize button to toggle full screen mode. More...
virtual bool	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. More...
void	UseNativeDecorations (bool native=true)
	This method is specific to wxUniversal port. More...
void	UseNativeDecorationsByDefault (bool native=true)
	This method is specific to wxUniversal port. More...
Public Member Functions inherited from wxNonOwnedWindow
bool	SetShape (const wxRegion &region)
	If the platform supports it, sets the shape of the window to that depicted by region. More...
bool	SetShape (const wxGraphicsPath &path)
	Set the window shape to the given path. More...
Public Member Functions inherited from wxWindow
	wxWindow ()
	Default constructor. More...
	wxWindow (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
	Constructs a window, which can be a child of a frame, dialog or any other non-control window. More...
virtual	~wxWindow ()
	Destructor. More...
bool	Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
virtual bool	AcceptsFocus () const
	This method may be overridden in the derived classes to return false to indicate that this control doesn't accept input at all (i.e. behaves like e.g. wxStaticText) and so doesn't need focus. More...
virtual bool	AcceptsFocusFromKeyboard () const
	This method may be overridden in the derived classes to return false to indicate that while this control can, in principle, have focus if the user clicks it with the mouse, it shouldn't be included in the TAB traversal chain when using the keyboard. More...
virtual bool	AcceptsFocusRecursively () const
	Overridden to indicate whether this window or one of its children accepts focus. More...
bool	IsFocusable () const
	Can this window itself have focus? More...
bool	CanAcceptFocus () const
	Can this window have focus right now? More...
bool	CanAcceptFocusFromKeyboard () const
	Can this window be assigned focus from keyboard right now? More...
virtual bool	HasFocus () const
	Returns true if the window (or in case of composite controls, its main child window) has focus. More...
virtual void	SetCanFocus (bool canFocus)
	This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0). More...
virtual void	SetFocus ()
	This sets the window to receive keyboard input. More...
virtual void	SetFocusFromKbd ()
	This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g. using TAB key). More...
virtual void	AddChild (wxWindow *child)
	Adds a child window. More...
bool	DestroyChildren ()
	Destroys all children of a window. More...
wxWindow *	FindWindow (long id) const
	Find a child of this window, by id. More...
wxWindow *	FindWindow (const wxString &name) const
	Find a child of this window, by name. More...
wxWindowList &	GetChildren ()
	Returns a reference to the list of the window's children. More...
const wxWindowList &	GetChildren () const
	Returns a const reference to the list of the window's children. More...
virtual void	RemoveChild (wxWindow *child)
	Removes a child window. More...
wxWindow *	GetGrandParent () const
	Returns the grandparent of a window, or NULL if there isn't one. More...
wxWindow *	GetNextSibling () const
	Returns the next window after this one among the parent's children or NULL if this window is the last child. More...
wxWindow *	GetParent () const
	Returns the parent of the window, or NULL if there is no parent. More...
wxWindow *	GetPrevSibling () const
	Returns the previous window before this one among the parent's children or NULL if this window is the first child. More...
bool	IsDescendant (wxWindowBase *win) const
	Check if the specified window is a descendant of this one. More...
virtual bool	Reparent (wxWindow *newParent)
	Reparents the window, i.e. the window will be removed from its current parent window (e.g. More...
virtual void	AlwaysShowScrollbars (bool hflag=true, bool vflag=true)
	Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling. More...
virtual int	GetScrollPos (int orientation) const
	Returns the built-in scrollbar position. More...
virtual int	GetScrollRange (int orientation) const
	Returns the built-in scrollbar range. More...
virtual int	GetScrollThumb (int orientation) const
	Returns the built-in scrollbar thumb size. More...
bool	CanScroll (int orient) const
	Returns true if this window can have a scroll bar in this orientation. More...
bool	HasScrollbar (int orient) const
	Returns true if this window currently has a scroll bar for this orientation. More...
virtual bool	IsScrollbarAlwaysShown (int orient) const
	Return whether a scrollbar is always shown. More...
virtual bool	ScrollLines (int lines)
	Scrolls the window by the given number of lines down (if lines is positive) or up. More...
virtual bool	ScrollPages (int pages)
	Scrolls the window by the given number of pages down (if pages is positive) or up. More...
virtual void	ScrollWindow (int dx, int dy, const wxRect *rect=NULL)
	Physically scrolls the pixels in the window and move child windows accordingly. More...
bool	LineUp ()
	Same as ScrollLines (-1). More...
bool	LineDown ()
	Same as ScrollLines (1). More...
bool	PageUp ()
	Same as ScrollPages (-1). More...
bool	PageDown ()
	Same as ScrollPages (1). More...
virtual void	SetScrollPos (int orientation, int pos, bool refresh=true)
	Sets the position of one of the built-in scrollbars. More...
virtual void	SetScrollbar (int orientation, int position, int thumbSize, int range, bool refresh=true)
	Sets the scrollbar properties of a built-in scrollbar. More...
void	Center (int dir=wxBOTH)
	A synonym for Centre(). More...
void	CenterOnParent (int dir=wxBOTH)
	A synonym for CentreOnParent(). More...
void	Centre (int direction=wxBOTH)
	Centres the window. More...
void	CentreOnParent (int direction=wxBOTH)
	Centres the window on its parent. More...
void	GetPosition (int *x, int *y) const
	This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows. More...
wxPoint	GetPosition () const
	This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows. More...
wxRect	GetRect () const
	Returns the position and size of the window as a wxRect object. More...
void	GetScreenPosition (int *x, int *y) const
	Returns the window position in screen coordinates, whether the window is a child window or a top level one. More...
wxPoint	GetScreenPosition () const
	Returns the window position in screen coordinates, whether the window is a child window or a top level one. More...
wxRect	GetScreenRect () const
	Returns the position and size of the window on the screen as a wxRect object. More...
wxRect	GetClientRect () const
	Get the client rectangle in window (i.e. client) coordinates. More...
void	Move (int x, int y, int flags=wxSIZE_USE_EXISTING)
	Moves the window to the given position. More...
void	Move (const wxPoint &pt, int flags=wxSIZE_USE_EXISTING)
	Moves the window to the given position. More...
void	SetPosition (const wxPoint &pt)
	Moves the window to the specified position. More...
void	ClientToScreen (int *x, int *y) const
	Converts to screen coordinates from coordinates relative to this window. More...
wxPoint	ClientToScreen (const wxPoint &pt) const
	Converts to screen coordinates from coordinates relative to this window. More...
wxPoint	ConvertDialogToPixels (const wxPoint &pt) const
	Converts a point or size from dialog units to pixels. More...
wxSize	ConvertDialogToPixels (const wxSize &sz) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
wxPoint	ConvertPixelsToDialog (const wxPoint &pt) const
	Converts a point or size from pixels to dialog units. More...
wxSize	ConvertPixelsToDialog (const wxSize &sz) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void	ScreenToClient (int *x, int *y) const
	Converts from screen to client window coordinates. More...
wxPoint	ScreenToClient (const wxPoint &pt) const
	Converts from screen to client window coordinates. More...
virtual void	ClearBackground ()
	Clears the window by filling it with the current background colour. More...
void	Freeze ()
	Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. More...
void	Thaw ()
	Re-enables window updating after a previous call to Freeze(). More...
bool	IsFrozen () const
	Returns true if the window is currently frozen by a call to Freeze(). More...
wxColour	GetBackgroundColour () const
	Returns the background colour of the window. More...
virtual wxBackgroundStyle	GetBackgroundStyle () const
	Returns the background style of the window. More...
virtual int	GetCharHeight () const
	Returns the character height for this window. More...
virtual int	GetCharWidth () const
	Returns the average character width for this window. More...
virtual wxVisualAttributes	GetDefaultAttributes () const
	Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()). More...
wxFont	GetFont () const
	Returns the font for this window. More...
wxColour	GetForegroundColour () const
	Returns the foreground colour of the window. More...
void	GetTextExtent (const wxString &string, int *w, int *h, int *descent=NULL, int *externalLeading=NULL, const wxFont *font=NULL) const
	Gets the dimensions of the string as it would be drawn on the window with the currently selected font. More...
wxSize	GetTextExtent (const wxString &string) const
	Gets the dimensions of the string as it would be drawn on the window with the currently selected font. More...
const wxRegion &	GetUpdateRegion () const
	Returns the region specifying which parts of the window have been damaged. More...
wxRect	GetUpdateClientRect () const
	Get the update rectangle bounding box in client coords. More...
virtual bool	HasTransparentBackground ()
	Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background. More...
virtual void	Refresh (bool eraseBackground=true, const wxRect *rect=NULL)
	Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted. More...
void	RefreshRect (const wxRect &rect, bool eraseBackground=true)
	Redraws the contents of the given rectangle: only the area inside it will be repainted. More...
virtual void	Update ()
	Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop). More...
virtual bool	SetBackgroundColour (const wxColour &colour)
	Sets the background colour of the window. More...
virtual bool	SetBackgroundStyle (wxBackgroundStyle style)
	Sets the background style of the window. More...
virtual bool	IsTransparentBackgroundSupported (wxString *reason=NULL) const
	Checks whether using transparent background might work. More...
virtual bool	SetFont (const wxFont &font)
	Sets the font for this window. More...
virtual bool	SetForegroundColour (const wxColour &colour)
	Sets the foreground colour of the window. More...
void	SetOwnBackgroundColour (const wxColour &colour)
	Sets the background colour of the window but prevents it from being inherited by the children of this window. More...
bool	InheritsBackgroundColour () const
	Return true if this window inherits the background colour from its parent. More...
bool	UseBgCol () const
	Return true if a background colour has been set for this window. More...
void	SetOwnFont (const wxFont &font)
	Sets the font of the window but prevents it from being inherited by the children of this window. More...
void	SetOwnForegroundColour (const wxColour &colour)
	Sets the foreground colour of the window but prevents it from being inherited by the children of this window. More...
void	SetPalette (const wxPalette &pal)
virtual bool	ShouldInheritColours () const
	Return true from here to allow the colours of this window to be changed by InheritAttributes(). More...
virtual void	SetThemeEnabled (bool enable)
	This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code. More...
virtual bool	GetThemeEnabled () const
	Clears the window by filling it with the current background colour. More...
wxEvtHandler *	GetEventHandler () const
	Returns the event handler for this window. More...
bool	HandleAsNavigationKey (const wxKeyEvent &event)
	This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case. More...
bool	HandleWindowEvent (wxEvent &event) const
	Shorthand for: More...
bool	ProcessWindowEvent (wxEvent &event)
	Convenient wrapper for ProcessEvent(). More...
bool	ProcessWindowEventLocally (wxEvent &event)
	Wrapper for wxEvtHandler::ProcessEventLocally(). More...
wxEvtHandler *	PopEventHandler (bool deleteHandler=false)
	Removes and returns the top-most event handler on the event handler stack. More...
void	PushEventHandler (wxEvtHandler *handler)
	Pushes this event handler onto the event stack for the window. More...
bool	RemoveEventHandler (wxEvtHandler *handler)
	Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack. More...
void	SetEventHandler (wxEvtHandler *handler)
	Sets the event handler for this window. More...
virtual void	SetNextHandler (wxEvtHandler *handler)
	wxWindows cannot be used to form event handler chains; this function thus will assert when called. More...
virtual void	SetPreviousHandler (wxEvtHandler *handler)
	wxWindows cannot be used to form event handler chains; this function thus will assert when called. More...
long	GetExtraStyle () const
	Returns the extra style bits for the window. More...
virtual long	GetWindowStyleFlag () const
	Gets the window style that was passed to the constructor or Create() method. More...
long	GetWindowStyle () const
	See GetWindowStyleFlag() for more info. More...
bool	HasExtraStyle (int exFlag) const
	Returns true if the window has the given exFlag bit set in its extra styles. More...
bool	HasFlag (int flag) const
	Returns true if the window has the given flag bit set. More...
virtual void	SetExtraStyle (long exStyle)
	Sets the extra style bits for the window. More...
virtual void	SetWindowStyleFlag (long style)
	Sets the style of the window. More...
void	SetWindowStyle (long style)
	See SetWindowStyleFlag() for more info. More...
bool	ToggleWindowStyle (int flag)
	Turns the given flag on if it's currently turned off and vice versa. More...
void	MoveAfterInTabOrder (wxWindow *win)
	Moves this window in the tab navigation order after the specified win. More...
void	MoveBeforeInTabOrder (wxWindow *win)
	Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it. More...
bool	Navigate (int flags=wxNavigationKeyEvent::IsForward)
	Performs a keyboard navigation action starting from this window. More...
bool	NavigateIn (int flags=wxNavigationKeyEvent::IsForward)
	Performs a keyboard navigation action inside this window. More...
virtual void	Lower ()
	Lowers the window to the bottom of the window hierarchy (Z-order). More...
virtual void	Raise ()
	Raises the window to the top of the window hierarchy (Z-order). More...
bool	Hide ()
	Equivalent to calling wxWindow::Show(false). More...
virtual bool	HideWithEffect (wxShowEffect effect, unsigned int timeout=0)
	This function hides a window, like Hide(), but using a special visual effect if possible. More...
bool	IsEnabled () const
	Returns true if the window is enabled, i.e. if it accepts user input, false otherwise. More...
bool	IsExposed (int x, int y) const
	Returns true if the given point or rectangle area has been exposed since the last repaint. More...
bool	IsExposed (wxPoint &pt) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	IsExposed (int x, int y, int w, int h) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	IsExposed (wxRect &rect) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
virtual bool	IsShown () const
	Returns true if the window is shown, false if it has been hidden. More...
virtual bool	IsShownOnScreen () const
	Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well. More...
bool	Disable ()
	Disables the window. More...
virtual bool	Enable (bool enable=true)
	Enable or disable the window for user input. More...
virtual bool	Show (bool show=true)
	Shows or hides the window. More...
virtual bool	ShowWithEffect (wxShowEffect effect, unsigned int timeout=0)
	This function shows a window, like Show(), but using a special visual effect if possible. More...
wxString	GetHelpText () const
	Gets the help text to be used as context-sensitive help for this window. More...
void	SetHelpText (const wxString &helpText)
	Sets the help text to be used as context-sensitive help for this window. More...
virtual wxString	GetHelpTextAtPoint (const wxPoint &point, wxHelpEvent::Origin origin) const
	Gets the help text to be used as context-sensitive help for this window. More...
wxToolTip *	GetToolTip () const
	Get the associated tooltip or NULL if none. More...
wxString	GetToolTipText () const
	Get the text of the associated tooltip or empty string if none. More...
void	SetToolTip (const wxString &tipString)
	Attach a tooltip to the window. More...
void	SetToolTip (wxToolTip *tip)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void	UnsetToolTip ()
	Unset any existing tooltip. More...
int	GetPopupMenuSelectionFromUser (wxMenu &menu, const wxPoint &pos=wxDefaultPosition)
	This function shows a popup menu at the given position in this window and returns the selected id. More...
int	GetPopupMenuSelectionFromUser (wxMenu &menu, int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	PopupMenu (wxMenu *menu, const wxPoint &pos=wxDefaultPosition)
	Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. More...
bool	PopupMenu (wxMenu *menu, int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
virtual wxValidator *	GetValidator ()
	Validator functions. More...
virtual void	SetValidator (const wxValidator &validator)
	Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type. More...
virtual bool	TransferDataFromWindow ()
	Transfers values from child controls to data areas specified by their validators. More...
virtual bool	TransferDataToWindow ()
	Transfers values to child controls from data areas specified by their validators. More...
virtual bool	Validate ()
	Validates the current values of the child controls using their validators. More...
wxWindowID	GetId () const
	Returns the identifier of the window. More...
virtual wxString	GetLabel () const
	Generic way of getting a label from any window, for identification purposes. More...
virtual wxLayoutDirection	GetLayoutDirection () const
	Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported. More...
virtual wxCoord	AdjustForLayoutDirection (wxCoord x, wxCoord width, wxCoord widthTotal) const
	Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32. More...
virtual wxString	GetName () const
	Returns the window's name. More...
wxWindowVariant	GetWindowVariant () const
	Returns the value previously passed to SetWindowVariant(). More...
void	SetId (wxWindowID winid)
	Sets the identifier of the window. More...
virtual void	SetLabel (const wxString &label)
	Sets the window's label. More...
virtual void	SetLayoutDirection (wxLayoutDirection dir)
	Sets the layout direction for this window. More...
virtual void	SetName (const wxString &name)
	Sets the window's name. More...
void	SetWindowVariant (wxWindowVariant variant)
	Chooses a different variant of the window display to use. More...
wxAcceleratorTable *	GetAcceleratorTable ()
	Gets the accelerator table for this window. More...
wxAccessible *	GetAccessible ()
	Returns the accessible object for this window, if any. More...
virtual void	SetAcceleratorTable (const wxAcceleratorTable &accel)
	Sets the accelerator table for this window. More...
void	SetAccessible (wxAccessible *accessible)
	Sets the accessible for this window. More...
bool	Close (bool force=false)
	This function simply generates a wxCloseEvent whose handler usually tries to close the window. More...
virtual bool	Destroy ()
	Destroys the window safely. More...
bool	IsBeingDeleted () const
	Returns true if this window is in process of being destroyed. More...
virtual wxDropTarget *	GetDropTarget () const
	Returns the associated drop target, which may be NULL. More...
virtual void	SetDropTarget (wxDropTarget *target)
	Associates a drop target with this window. More...
virtual void	DragAcceptFiles (bool accept)
	Enables or disables eligibility for drop file events (OnDropFiles). More...
wxSizer *	GetContainingSizer () const
	Returns the sizer of which this window is a member, if any, otherwise NULL. More...
wxSizer *	GetSizer () const
	Returns the sizer associated with the window by a previous call to SetSizer(), or NULL. More...
void	SetSizer (wxSizer *sizer, bool deleteOld=true)
	Sets the window to have the given layout sizer. More...
void	SetSizerAndFit (wxSizer *sizer, bool deleteOld=true)
	This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial window size to the size needed to accommodate all sizer elements and sets the size hints which, if this window is a top level one, prevent the user from resizing it to be less than this minimal size. More...
wxLayoutConstraints *	GetConstraints () const
	Returns a pointer to the window's layout constraints, or NULL if there are none. More...
void	SetConstraints (wxLayoutConstraints *constraints)
	Sets the window to have the given layout constraints. More...
void	SetAutoLayout (bool autoLayout)
	Determines whether the Layout() function will be called automatically when the window is resized. More...
bool	GetAutoLayout () const
	Returns the sizer of which this window is a member, if any, otherwise NULL. More...
void	CaptureMouse ()
	Directs all mouse input to this window. More...
wxCaret *	GetCaret () const
	Returns the caret() associated with the window. More...
const wxCursor &	GetCursor () const
	Return the cursor associated with this window. More...
virtual bool	HasCapture () const
	Returns true if this window has the current mouse capture. More...
void	ReleaseMouse ()
	Releases mouse input captured with CaptureMouse(). More...
void	SetCaret (wxCaret *caret)
	Sets the caret() associated with the window. More...
virtual bool	SetCursor (const wxCursor &cursor)
	Sets the window's cursor. More...
virtual void	WarpPointer (int x, int y)
	Moves the pointer to the given position on the window. More...
wxHitTest	HitTest (wxCoord x, wxCoord y) const
	Return where the given point lies, exactly. More...
wxHitTest	HitTest (const wxPoint &pt) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
wxBorder	GetBorder (long flags) const
	Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable. More...
wxBorder	GetBorder () const
	Get border for the flags of this window. More...
virtual void	DoUpdateWindowUI (wxUpdateUIEvent &event)
	Does the window-specific updating after processing the update event. More...
virtual WXWidget	GetHandle () const
	Returns the platform-specific handle of the physical window. More...
virtual bool	HasMultiplePages () const
	This method should be overridden to return true if this window has multiple pages. More...
virtual void	InheritAttributes ()
	This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours. More...
virtual void	InitDialog ()
	Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators. More...
virtual bool	IsDoubleBuffered () const
	Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later. More...
void	SetDoubleBuffered (bool on)
	Turn on or off double buffering of the window if the system supports it. More...
virtual bool	IsRetained () const
	Returns true if the window is retained, false otherwise. More...
bool	IsThisEnabled () const
	Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called. More...
virtual bool	IsTopLevel () const
	Returns true if the given window is a top-level one. More...
virtual void	OnInternalIdle ()
	This virtual function is normally only used internally, but sometimes an application may need it to implement functionality that should not be disabled by an application defining an OnIdle handler in a derived class. More...
virtual bool	SendIdleEvents (wxIdleEvent &event)
	Send idle event to window and all subwindows. More...
virtual bool	RegisterHotKey (int hotkeyId, int modifiers, int virtualKeyCode)
	Registers a system wide hotkey. More...
virtual bool	UnregisterHotKey (int hotkeyId)
	Unregisters a system wide hotkey. More...
virtual void	UpdateWindowUI (long flags=wxUPDATE_UI_NONE)
	This function sends one or more wxUpdateUIEvent to the window. More...
bool	BeginRepositioningChildren ()
	Prepare for changing positions of multiple child windows. More...
void	EndRepositioningChildren ()
	Fix child window positions after setting all of them at once. More...
void	CacheBestSize (const wxSize &size) const
	Sets the cached best size value. More...
virtual wxSize	ClientToWindowSize (const wxSize &size) const
	Converts client area size size to corresponding window size. More...
virtual wxSize	WindowToClientSize (const wxSize &size) const
	Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size. More...
virtual void	Fit ()
	Sizes the window so that it fits around its subwindows. More...
virtual void	FitInside ()
	Similar to Fit(), but sizes the interior (virtual) size of a window. More...
wxSize	FromDIP (const wxSize &sz) const
	Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit. More...
wxPoint	FromDIP (const wxPoint &pt) const
int	FromDIP (int d) const
	Convert DPI-independent distance in pixels to the value in pixels appropriate for the current toolkit. More...
wxSize	ToDIP (const wxSize &sz) const
	Convert pixel values of the current toolkit to DPI-independent pixel values. More...
wxPoint	ToDIP (const wxPoint &pt) const
int	ToDIP (int d) const
	Convert pixel values of the current toolkit to DPI-independent pixel values. More...
wxSize	GetBestSize () const
	This functions returns the best acceptable minimal size for the window. More...
int	GetBestHeight (int width) const
	Returns the best height needed by this window if it had the given width. More...
int	GetBestWidth (int height) const
	Returns the best width needed by this window if it had the given height. More...
void	GetClientSize (int *width, int *height) const
	Returns the size of the window 'client area' in pixels. More...
wxSize	GetClientSize () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
virtual wxSize	GetEffectiveMinSize () const
	Merges the window's best size into the min size and returns the result. More...
virtual wxSize	GetMaxClientSize () const
	Returns the maximum size of window's client area. More...
virtual wxSize	GetMaxSize () const
	Returns the maximum size of the window. More...
virtual wxSize	GetMinClientSize () const
	Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area. More...
virtual wxSize	GetMinSize () const
	Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size. More...
int	GetMinWidth () const
	Returns the horizontal component of window minimal size. More...
int	GetMinHeight () const
	Returns the vertical component of window minimal size. More...
int	GetMaxWidth () const
	Returns the horizontal component of window maximal size. More...
int	GetMaxHeight () const
	Returns the vertical component of window maximal size. More...
void	GetSize (int *width, int *height) const
	Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc. More...
wxSize	GetSize () const
	See the GetSize(int*,int*) overload for more info. More...
wxSize	GetVirtualSize () const
	This gets the virtual size of the window in pixels. More...
void	GetVirtualSize (int *width, int *height) const
	Like the other GetVirtualSize() overload but uses pointers instead. More...
virtual wxSize	GetBestVirtualSize () const
	Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means) More...
double	GetContentScaleFactor () const
	Returns the magnification of the backing store of this window, eg 2.0 for a window on a retina screen. More...
virtual wxSize	GetWindowBorderSize () const
	Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively. More...
virtual bool	InformFirstDirection (int direction, int size, int availableOtherDir)
	wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known. More...
void	InvalidateBestSize ()
	Resets the cached best size value so it will be recalculated the next time it is needed. More...
void	PostSizeEvent ()
	Posts a size event to the window. More...
void	PostSizeEventToParent ()
	Posts a size event to the parent of this window. More...
virtual void	SendSizeEvent (int flags=0)
	This function sends a dummy size event to the window allowing it to re-layout its children positions. More...
void	SendSizeEventToParent (int flags=0)
	Safe wrapper for GetParent()->SendSizeEvent(). More...
void	SetClientSize (int width, int height)
	This sets the size of the window client area in pixels. More...
void	SetClientSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void	SetClientSize (const wxRect &rect)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void	SetContainingSizer (wxSizer *sizer)
	This normally does not need to be called by user code. More...
void	SetInitialSize (const wxSize &size=wxDefaultSize)
	A smart SetSize that will fill in default size components with the window's best size values. More...
virtual void	SetMaxClientSize (const wxSize &size)
	Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area. More...
virtual void	SetMinClientSize (const wxSize &size)
	Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area. More...
void	SetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO)
	Sets the size of the window in pixels. More...
void	SetSize (const wxRect &rect)
	Sets the size of the window in pixels. More...
void	SetSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void	SetSize (int width, int height)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void	SetVirtualSize (int width, int height)
	Sets the virtual size of the window in pixels. More...
void	SetVirtualSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
Public Member Functions inherited from wxEvtHandler
	wxEvtHandler ()
	Constructor. More...
virtual	~wxEvtHandler ()
	Destructor. More...
template<typename T , typename T1 , ... >
void	CallAfter (void(T::*method)(T1,...), T1 x1,...)
	Asynchronously call the given method. More...
template<typename T >
void	CallAfter (const T &functor)
	Asynchronously call the given functor. More...
bool	ProcessEventLocally (wxEvent &event)
	Try to process the event in this handler and all those chained to it. More...
bool	SafelyProcessEvent (wxEvent &event)
	Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process. More...
void	ProcessPendingEvents ()
	Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail. More...
void	DeletePendingEvents ()
	Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent(). More...
virtual bool	SearchEventTable (wxEventTable &table, wxEvent &event)
	Searches the event table, executing an event handler function if an appropriate one is found. More...
void	Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	Connects the given function dynamically with the event handler, id and event type. More...
void	Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
void	Connect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
bool	Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. More...
bool	Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
bool	Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
template<typename EventTag , typename Functor >
void	Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	Binds the given function, functor or method dynamically with the event. More...
template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
void	Bind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. More...
template<typename EventTag , typename Functor >
bool	Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. More...
template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
bool	Unbind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. More...
void *	GetClientData () const
	Returns user-supplied client data. More...
wxClientData *	GetClientObject () const
	Returns a pointer to the user-supplied client data object. More...
void	SetClientData (void *data)
	Sets user-supplied client data. More...
void	SetClientObject (wxClientData *data)
	Set the client data object. More...
bool	GetEvtHandlerEnabled () const
	Returns true if the event handler is enabled, false otherwise. More...
wxEvtHandler *	GetNextHandler () const
	Returns the pointer to the next handler in the chain. More...
wxEvtHandler *	GetPreviousHandler () const
	Returns the pointer to the previous handler in the chain. More...
void	SetEvtHandlerEnabled (bool enabled)
	Enables or disables the event handler. More...
void	Unlink ()
	Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted). More...
bool	IsUnlinked () const
	Returns true if the next and the previous handler pointers of this event handler instance are NULL. More...
Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to NULL the internal reference data. More...
	wxObject (const wxObject &other)
	Copy ctor. More...
virtual	~wxObject ()
	Destructor. More...
virtual wxClassInfo *	GetClassInfo () const
	This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class. More...
bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj. More...
void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone. More...
void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer. More...
void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
void	UnShare ()
	This is the same of AllocExclusive() but this method is public. More...
void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
void *	operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
	The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...

Additional Inherited Members
Static Public Member Functions inherited from wxTopLevelWindow
static wxSize	GetDefaultSize ()
	Get the default size for a new top level window. More...
Static Public Member Functions inherited from wxWindow
static wxVisualAttributes	GetClassDefaultAttributes (wxWindowVariant variant=wxWINDOW_VARIANT_NORMAL)
	Returns the default font and colours which are used by the control. More...
static wxWindow *	FindFocus ()
	Finds the window or control which currently has the keyboard focus. More...
static wxWindow *	FindWindowById (long id, const wxWindow *parent=0)
	Find the first window with the given id. More...
static wxWindow *	FindWindowByLabel (const wxString &label, const wxWindow *parent=0)
	Find a window by its label. More...
static wxWindow *	FindWindowByName (const wxString &name, const wxWindow *parent=0)
	Find a window by its name (as given in a window constructor or Create() function call). More...
static wxWindow *	GetCapture ()
	Returns the currently captured window. More...
static wxWindowID	NewControlId (int count=1)
	Create a new ID or range of IDs that are not currently in use. More...
static void	UnreserveControlId (wxWindowID id, int count=1)
	Unreserve an ID or range of IDs that was reserved by NewControlId(). More...
static wxSize	FromDIP (const wxSize &sz, const wxWindow *w)
	Non window-specific DPI-independent pixels conversion functions. More...
static wxPoint	FromDIP (const wxPoint &pt, const wxWindow *w)
static wxSize	FromDIP (const wxSize &sz, const wxWindow *w)
static wxSize	ToDIP (const wxSize &sz, const wxWindow *w)
	Non window-specific pixel to DPI-independent pixels conversion functions. More...
static wxPoint	ToDIP (const wxPoint &pt, const wxWindow *w)
static wxSize	ToDIP (const wxSize &sz, const wxWindow *w)
Static Public Member Functions inherited from wxEvtHandler
static void	AddFilter (wxEventFilter *filter)
	Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets. More...
static void	RemoveFilter (wxEventFilter *filter)
	Remove a filter previously installed with AddFilter(). More...
Protected Member Functions inherited from wxWindow
virtual void	DoCentre (int direction)
	Centres the window. More...
virtual wxSize	DoGetBestSize () const
	Implementation of GetBestSize() that can be overridden. More...
virtual wxSize	DoGetBestClientSize () const
	Override this method to return the best size for a custom control. More...
virtual int	DoGetBestClientHeight (int width) const
	Override this method to implement height-for-width best size calculation. More...
virtual int	DoGetBestClientWidth (int height) const
	Override this method to implement width-for-height best size calculation. More...
virtual void	SetInitialBestSize (const wxSize &size)
	Sets the initial window size if none is given (i.e. at least one of the components of the size passed to ctor/Create() is wxDefaultCoord). More...
void	SendDestroyEvent ()
	Generate wxWindowDestroyEvent for this window. More...
virtual bool	ProcessEvent (wxEvent &event)
	This function is public in wxEvtHandler but protected in wxWindow because for wxWindows you should always call ProcessEvent() on the pointer returned by GetEventHandler() and not on the wxWindow object itself. More...
bool	SafelyProcessEvent (wxEvent &event)
	See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More...
virtual void	QueueEvent (wxEvent *event)
	See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More...
virtual void	AddPendingEvent (const wxEvent &event)
	See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More...
void	ProcessPendingEvents ()
	See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More...
bool	ProcessThreadEvent (const wxEvent &event)
	See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More...
Protected Member Functions inherited from wxEvtHandler
virtual bool	TryBefore (wxEvent &event)
	Method called by ProcessEvent() before examining this object event tables. More...
virtual bool	TryAfter (wxEvent &event)
	Method called by ProcessEvent() as last resort. More...
Protected Member Functions inherited from wxObject
void	AllocExclusive ()
	Ensure that this object's data is not shared with any other object. More...
virtual wxObjectRefData *	CreateRefData () const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
virtual wxObjectRefData *	CloneRefData (const wxObjectRefData *data) const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data. More...

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 = wxFrameNameStr
	)

Constructor, creating the window.

Parameters

parent	The window parent. This may be, and often is, NULL. If it is non-NULL, the frame will be minimized when its parent is minimized and restored when it is restored (although it will still be possible to minimize and restore just this frame itself).
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.

See Window Deletion for more info.

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.

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 = wxFrameNameStr
	)

Used in two-step frame construction.

See wxFrame() for further details.

virtual wxStatusBar* wxFrame::CreateStatusBar ( int  number = 1, long  style = wxSTB_DEFAULT_STYLE, wxWindowID  id = 0, const wxString &  name = wxStatusBarNameStr  )

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 = wxTB_DEFAULT_STYLE, wxWindowID  id = wxID_ANY, const wxString &  name = wxToolBarNameStr  )

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. 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 void wxFrame::DoGiveHelp ( const wxString &  text, bool  show  )

virtual

Method used to show help string of the selected menu toolbar item.

This method is called by the default wxEVT_MENU_HIGHLIGHT event handler and also by wxToolBar to show the optional help string associated with the selected menu or toolbar item. It can be overridden if the default behaviour of showing this string in the frame status bar is not appropriate.

Parameters

text	The help string to show, may be empty. The default implementation simply shows this string in the frame status bar (after remembering its previous text to restore it later).
show	Whether the help should be shown or hidden. The default implementation restores the previously saved status bar text when it is false.

See also

SetStatusBarPane()

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.

Reimplemented from wxWindow.

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

wxTaskBarButton* wxFrame::MSWGetTaskBarButton

(

)

MSW-specific function for accessing the taskbar button under Windows 7 or later.

Returns a wxTaskBarButton pointer representing the taskbar button of the window under Windows 7 or later. The returned wxTaskBarButton may be used, if non-NULL, to access the functionality including thumbnail representations, thumbnail toolbars, notification and status overlays, and progress indicators.

The returned pointer must not be deleted, it is owned by the frame and will be only deleted when the frame itself is destroyed.

This function is not available in the other ports by design, any occurrences of it in the portable code must be guarded by

#ifdef __WXMSW__ 

preprocessor guards.

Since

3.1.0

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::PopStatusText

(

int

number = 0

)

bool wxFrame::ProcessCommand

(

int

id

)

Simulate a menu command.

Parameters

id	The identifier for a menu item.

void wxFrame::PushStatusText	(	const wxString &	text,
		int	number = 0
	)

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.

If statusBar is NULL, then the status bar, if present, is detached from the frame, but not deleted.

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, const int *  widths_field  )

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_field	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.

wxPerl Note: In wxPerl this method takes the field widths as parameters.

virtual void wxFrame::SetToolBar ( wxToolBar *  toolBar )

virtual

Associates a toolbar with the frame.