wxDialog Class Reference

#include <wx/dialog.h>

Inheritance diagram for wxDialog:

Detailed Description

A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen.

It can contain controls and other windows and is often used to allow the user to make some choice or to answer a question.

Dialogs can be made scrollable, automatically, for computers with low resolution screens: please see Automatic Scrolled Dialogs for further details.

Dialogs usually contain either a single button allowing to close the dialog or two buttons, one accepting the changes and the other one discarding them (such button, if present, is automatically activated if the user presses the "Esc" key). By default, buttons with the standard wxID_OK and wxID_CANCEL identifiers behave as expected. Starting with wxWidgets 2.7 it is also possible to use a button with a different identifier instead, see SetAffirmativeId() and SetEscapeId().

Also notice that the CreateButtonSizer() should be used to create the buttons appropriate for the current platform and positioned correctly (including their order which is platform-dependent).

Modal and Modeless

There are two kinds of dialog, modal and modeless. A modal dialog blocks program flow and user input on other windows until it is dismissed, whereas a modeless dialog behaves more like a frame in that program flow continues, and input in other windows is still possible. To show a modal dialog you should use the ShowModal() method while to show a dialog modelessly you simply use Show(), just as with frames.

Note that the modal dialog is one of the very few examples of wxWindow-derived objects which may be created on the stack and not on the heap. In other words, while most windows would be created like this:

void AskUser()
{
    MyAskDialog *dlg = new MyAskDialog(...);
    if ( dlg->ShowModal() == wxID_OK )
        // ...
    //else: dialog was cancelled or some another button pressed

    dlg->Destroy();
}

You can achieve the same result with dialogs by using simpler code:

void AskUser()
{
    MyAskDialog dlg(...);
    if ( dlg.ShowModal() == wxID_OK )
        // ...

    // no need to call Destroy() here
}

An application can define a wxCloseEvent handler for the dialog to respond to system close events.

Styles

This class supports the following styles:

• wxCAPTION:
  Puts a caption on the dialog box.
• wxDEFAULT_DIALOG_STYLE:
  Equivalent to a combination of wxCAPTION, wxCLOSE_BOX and wxSYSTEM_MENU (the last one is not used under Unix).
• wxRESIZE_BORDER:
  Display a resizable frame around the window.
• wxSYSTEM_MENU:
  Display a system menu.
• wxCLOSE_BOX:
  Displays a close box on the frame.
• wxMAXIMIZE_BOX:
  Displays a maximize box on the dialog.
• wxMINIMIZE_BOX:
  Displays a minimize box on the dialog.
• wxTHICK_FRAME:
  Display a thick frame around the window.
• wxSTAY_ON_TOP:
  The dialog stays on top of all other windows.
• wxNO_3D:
  This style is obsolete and doesn't do anything any more, don't use it in any new code.
• wxDIALOG_NO_PARENT:
  By default, a dialog created with a NULL parent window will be given the application's top level window as parent. Use this style to prevent this from happening and create an orphan dialog. This is not recommended for modal dialogs.
• wxDIALOG_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).
• wxDIALOG_EX_METAL:
  On Mac OS X, frames with this style will be shown with a metallic look. This is an extra style.

Under Unix or Linux, MWM (the Motif Window Manager) or other window managers recognizing the MHM hints should be running for any of these styles to have an effect.

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxCloseEvent& event)

Event macros for events emitted by this class:

• EVT_CLOSE(func):
  The dialog 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) or by clicking a button with the wxID_CANCEL or wxID_OK ids.
• EVT_INIT_DIALOG(func):
  Process a wxEVT_INIT_DIALOG event. See wxInitDialogEvent.

Library:  wxCore

Category:  Common Dialogs

See Also

wxDialog Overview, wxFrame, wxValidator Overview

Public Member Functions
	wxDialog ()
	Default constructor.
	wxDialog (wxWindow *parent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const wxString &name=wxDialogNameStr)
	Constructor.
virtual	~wxDialog ()
	Destructor.
void	AddMainButtonId (wxWindowID id)
	Adds an identifier to be regarded as a main button for the non-scrolling area of a dialog.
virtual bool	CanDoLayoutAdaptation ()
	Returns true if this dialog can and should perform layout adaptation using DoLayoutAdaptation(), usually if the dialog is too large to fit on the display.
void	Centre (int direction=wxBOTH)
	Centres the dialog box on the display.
bool	Create (wxWindow *parent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const wxString &name=wxDialogNameStr)
	Used for two-step dialog box construction.
wxSizer *	CreateButtonSizer (long flags)
	Creates a sizer with standard buttons.
wxSizer *	CreateSeparatedButtonSizer (long flags)
	Creates a sizer with standard buttons using CreateButtonSizer() separated from the rest of the dialog contents by a horizontal wxStaticLine.
wxSizer *	CreateSeparatedSizer (wxSizer *sizer)
	Returns the sizer containing the given one with a separating wxStaticLine if necessarily.
wxStdDialogButtonSizer *	CreateStdDialogButtonSizer (long flags)
	Creates a wxStdDialogButtonSizer with standard buttons.
wxSizer *	CreateTextSizer (const wxString &message)
	Splits text up at newlines and places the lines into wxStaticText objects in a vertical wxBoxSizer.
virtual bool	DoLayoutAdaptation ()
	Performs layout adaptation, usually if the dialog is too large to fit on the display.
virtual bool	DoOK ()
	This function is called when the titlebar OK button is pressed (PocketPC only).
virtual void	EndModal (int retCode)
	Ends a modal dialog, passing a value to be returned from the ShowModal() invocation.
int	GetAffirmativeId () const
	Gets the identifier of the button which works like standard OK button in this dialog.
virtual wxWindow *	GetContentWindow () const
	Override this to return a window containing the main content of the dialog.
int	GetEscapeId () const
	Gets the identifier of the button to map presses of ESC button to.
bool	GetLayoutAdaptationDone () const
	Returns true if the dialog has been adapted, usually by making it scrollable to work with a small display.
int	GetLayoutAdaptationLevel () const
	Gets a value representing the aggressiveness of search for buttons and sizers to be in the non-scrolling part of a layout-adapted dialog.
wxDialogLayoutAdaptationMode	GetLayoutAdaptationMode () const
	Gets the adaptation mode, overriding the global adaptation flag.
wxArrayInt &	GetMainButtonIds ()
	Returns an array of identifiers to be regarded as the main buttons for the non-scrolling area of a dialog.
int	GetReturnCode () const
	Gets the return code for this window.
wxToolBar *	GetToolBar () const
	On PocketPC, a dialog is automatically provided with an empty toolbar.
virtual void	Iconize (bool iconize=true)
	Iconizes or restores the dialog.
virtual bool	IsIconized () const
	Returns true if the dialog box is iconized.
bool	IsMainButtonId (wxWindowID id) const
	Returns true if id is in the array of identifiers to be regarded as the main buttons for the non-scrolling area of a dialog.
virtual bool	IsModal () const
	Returns true if the dialog box is modal, false otherwise.
void	SetAffirmativeId (int id)
	Sets the identifier to be used as OK button.
void	SetEscapeId (int id)
	Sets the identifier of the button which should work like the standard "Cancel" button in this dialog.
void	SetIcon (const wxIcon &icon)
	Sets the icon for this dialog.
void	SetIcons (const wxIconBundle &icons)
	Sets the icons for this dialog.
void	SetLayoutAdaptationDone (bool done)
	Marks the dialog as having been adapted, usually by making it scrollable to work with a small display.
void	SetLayoutAdaptationLevel (int level)
	Sets the aggressiveness of search for buttons and sizers to be in the non-scrolling part of a layout-adapted dialog.
void	SetLayoutAdaptationMode (wxDialogLayoutAdaptationMode mode)
	Sets the adaptation mode, overriding the global adaptation flag.
void	SetReturnCode (int retCode)
	Sets the return code for this window.
virtual bool	Show (bool show=1)
	Hides or shows the dialog.
virtual int	ShowModal ()
	Shows an application-modal dialog.
void	ShowWindowModal ()
	Shows a dialog modal to the parent top level window only.
template<typename Functor >
void	ShowWindowModalThenDo (const Functor &onEndModal)
	Shows a dialog modal to the parent top level window only and call a functor after the dialog is closed.
Public Member Functions inherited from wxTopLevelWindow
	wxTopLevelWindow ()
	Default ctor.
	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.
virtual	~wxTopLevelWindow ()
	Destructor.
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.
virtual bool	CanSetTransparent ()
	Returns true if the platform supports making the window translucent.
void	CenterOnScreen (int direction=wxBOTH)
	A synonym for CentreOnScreen().
void	CentreOnScreen (int direction=wxBOTH)
	Centres the window on screen.
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).
wxWindow *	GetDefaultItem () const
	Returns a pointer to the button which is the default for this window, or NULL.
wxIcon	GetIcon () const
	Returns the standard icon of the window.
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.
virtual wxString	GetTitle () const
	Gets a string containing the window title.
virtual bool	HandleSettingChange (WXWPARAM wParam, WXLPARAM lParam)
	Unique to the wxWinCE port.
virtual bool	IsActive ()
	Returns true if this window is currently active, i.e. if the user is currently working with it.
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.
virtual bool	IsFullScreen () const
	Returns true if the window is in fullscreen mode.
virtual bool	IsMaximized () const
	Returns true if the window is maximized.
bool	IsUsingNativeDecorations () const
	This method is specific to wxUniversal port.
virtual bool	Layout ()
	See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.
virtual void	Maximize (bool maximize=true)
	Maximizes or restores the window.
wxMenu *	MSWGetSystemMenu () const
	MSW-specific function for accessing the system menu.
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.
wxWindow *	SetDefaultItem (wxWindow *win)
	Changes the default item for the panel, usually win is a button.
wxWindow *	SetTmpDefaultItem (wxWindow *win)
wxWindow *	GetTmpDefaultItem () const
void	SetIcon (const wxIcon &icon)
	Sets the icon for this window.
void	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.
virtual void	SetMaxSize (const wxSize &size)
	A simpler interface for setting the size hints than SetSizeHints().
virtual void	SetMinSize (const wxSize &size)
	A simpler interface for setting the size hints than SetSizeHints().
void	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.
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.
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.
virtual void	SetTitle (const wxString &title)
	Sets the window title.
virtual bool	SetTransparent (wxByte alpha)
	If the platform supports it will set the window to be translucent.
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.
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.
virtual bool	OSXIsModified () const
	Returns the current modified state of the wxTopLevelWindow on OS X.
virtual void	SetRepresentedFilename (const wxString &filename)
	Sets the file name represented by this wxTopLevelWindow.
virtual void	ShowWithoutActivating ()
	Show the wxTopLevelWindow, but do not give it keyboard focus.
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.
void	UseNativeDecorations (bool native=true)
	This method is specific to wxUniversal port.
void	UseNativeDecorationsByDefault (bool native=true)
	This method is specific to wxUniversal port.
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.
bool	SetShape (const wxGraphicsPath &path)
	Set the window shape to the given path.
Public Member Functions inherited from wxWindow
	wxWindow ()
	Default constructor.
	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.
virtual	~wxWindow ()
	Destructor.
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.
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.
virtual bool	AcceptsFocusRecursively () const
	Overridden to indicate whether this window or one of its children accepts focus.
bool	IsFocusable () const
	Can this window itself have focus?
bool	CanAcceptFocus () const
	Can this window have focus right now?
bool	CanAcceptFocusFromKeyboard () const
	Can this window be assigned focus from keyboard right now?
virtual bool	HasFocus () const
	Returns true if the window (or in case of composite controls, its main child window) has focus.
virtual void	SetCanFocus (bool canFocus)
	This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0).
virtual void	SetFocus ()
	This sets the window to receive keyboard input.
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.
virtual void	AddChild (wxWindow *child)
	Adds a child window.
bool	DestroyChildren ()
	Destroys all children of a window.
wxWindow *	FindWindow (long id) const
	Find a child of this window, by id.
wxWindow *	FindWindow (const wxString &name) const
	Find a child of this window, by name.
wxWindowList &	GetChildren ()
	Returns a reference to the list of the window's children.
const wxWindowList &	GetChildren () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual void	RemoveChild (wxWindow *child)
	Removes a child window.
wxWindow *	GetGrandParent () const
	Returns the grandparent of a window, or NULL if there isn't one.
wxWindow *	GetNextSibling () const
	Returns the next window after this one among the parent's children or NULL if this window is the last child.
wxWindow *	GetParent () const
	Returns the parent of the window, or NULL if there is no parent.
wxWindow *	GetPrevSibling () const
	Returns the previous window before this one among the parent's children or NULL if this window is the first child.
bool	IsDescendant (wxWindowBase *win) const
	Check if the specified window is a descendant of this one.
virtual bool	Reparent (wxWindow *newParent)
	Reparents the window, i.e. the window will be removed from its current parent window (e.g.
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.
virtual int	GetScrollPos (int orientation) const
	Returns the built-in scrollbar position.
virtual int	GetScrollRange (int orientation) const
	Returns the built-in scrollbar range.
virtual int	GetScrollThumb (int orientation) const
	Returns the built-in scrollbar thumb size.
bool	CanScroll (int orient) const
	Returns true if this window can have a scroll bar in this orientation.
bool	HasScrollbar (int orient) const
	Returns true if this window currently has a scroll bar for this orientation.
virtual bool	IsScrollbarAlwaysShown (int orient) const
	Return whether a scrollbar is always shown.
virtual bool	ScrollLines (int lines)
	Scrolls the window by the given number of lines down (if lines is positive) or up.
virtual bool	ScrollPages (int pages)
	Scrolls the window by the given number of pages down (if pages is positive) or up.
virtual void	ScrollWindow (int dx, int dy, const wxRect *rect=NULL)
	Physically scrolls the pixels in the window and move child windows accordingly.
bool	LineUp ()
	Same as ScrollLines (-1).
bool	LineDown ()
	Same as ScrollLines (1).
bool	PageUp ()
	Same as ScrollPages (-1).
bool	PageDown ()
	Same as ScrollPages (1).
virtual void	SetScrollPos (int orientation, int pos, bool refresh=true)
	Sets the position of one of the built-in scrollbars.
virtual void	SetScrollbar (int orientation, int position, int thumbSize, int range, bool refresh=true)
	Sets the scrollbar properties of a built-in scrollbar.
bool	BeginRepositioningChildren ()
	Prepare for changing positions of multiple child windows.
void	EndRepositioningChildren ()
	Fix child window positions after setting all of them at once.
void	CacheBestSize (const wxSize &size) const
	Sets the cached best size value.
virtual wxSize	ClientToWindowSize (const wxSize &size) const
	Converts client area size size to corresponding window size.
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.
virtual void	Fit ()
	Sizes the window so that it fits around its subwindows.
virtual void	FitInside ()
	Similar to Fit(), but sizes the interior (virtual) size of a window.
wxSize	GetBestSize () const
	This functions returns the best acceptable minimal size for the window.
int	GetBestHeight (int width) const
	Returns the best height needed by this window if it had the given width.
int	GetBestWidth (int height) const
	Returns the best width needed by this window if it had the given height.
void	GetClientSize (int *width, int *height) const
	Returns the size of the window 'client area' in pixels.
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.
virtual wxSize	GetEffectiveMinSize () const
	Merges the window's best size into the min size and returns the result.
virtual wxSize	GetMaxClientSize () const
	Returns the maximum size of window's client area.
virtual wxSize	GetMaxSize () const
	Returns the maximum size of the window.
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.
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.
int	GetMinWidth () const
	Returns the horizontal component of window minimal size.
int	GetMinHeight () const
	Returns the vertical component of window minimal size.
int	GetMaxWidth () const
	Returns the horizontal component of window maximal size.
int	GetMaxHeight () const
	Returns the vertical component of window maximal size.
void	GetSize (int *width, int *height) const
	Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.
wxSize	GetSize () const
	See the GetSize(int*,int*) overload for more info.
wxSize	GetVirtualSize () const
	This gets the virtual size of the window in pixels.
void	GetVirtualSize (int *width, int *height) const
	Like the other GetVirtualSize() overload but uses pointers instead.
virtual wxSize	GetBestVirtualSize () const
	Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
virtual double	GetContentScaleFactor () const
	Returns the magnification of the backing store of this window, eg 2.0 for a window on a retina screen.
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.
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.
void	InvalidateBestSize ()
	Resets the cached best size value so it will be recalculated the next time it is needed.
void	PostSizeEvent ()
	Posts a size event to the window.
void	PostSizeEventToParent ()
	Posts a size event to the parent of this window.
virtual void	SendSizeEvent (int flags=0)
	This function sends a dummy size event to the window allowing it to re-layout its children positions.
void	SendSizeEventToParent (int flags=0)
	Safe wrapper for GetParent()->SendSizeEvent().
void	SetClientSize (int width, int height)
	This sets the size of the window client area in pixels.
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.
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.
void	SetContainingSizer (wxSizer *sizer)
	This normally does not need to be called by user code.
void	SetInitialSize (const wxSize &size=wxDefaultSize)
	A smart SetSize that will fill in default size components with the window's best size values.
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.
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.
void	SetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO)
	Sets the size of the window in pixels.
void	SetSize (const wxRect &rect)
	Sets the size of the window in pixels.
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.
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.
void	SetVirtualSize (int width, int height)
	Sets the virtual size of the window in pixels.
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.
void	Center (int dir=wxBOTH)
	A synonym for Centre().
void	CenterOnParent (int dir=wxBOTH)
	A synonym for CentreOnParent().
void	Centre (int direction=wxBOTH)
	Centres the window.
void	CentreOnParent (int direction=wxBOTH)
	Centres the window on its parent.
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.
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.
wxRect	GetRect () const
	Returns the position and size of the window as a wxRect object.
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.
wxPoint	GetScreenPosition () const
	Returns the window position in screen coordinates, whether the window is a child window or a top level one.
wxRect	GetScreenRect () const
	Returns the position and size of the window on the screen as a wxRect object.
virtual wxPoint	GetClientAreaOrigin () const
	Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
wxRect	GetClientRect () const
	Get the client rectangle in window (i.e. client) coordinates.
void	Move (int x, int y, int flags=wxSIZE_USE_EXISTING)
	Moves the window to the given position.
void	Move (const wxPoint &pt, int flags=wxSIZE_USE_EXISTING)
	Moves the window to the given position.
void	SetPosition (const wxPoint &pt)
	A synonym for Centre().
void	ClientToScreen (int *x, int *y) const
	Converts to screen coordinates from coordinates relative to this window.
wxPoint	ClientToScreen (const wxPoint &pt) const
	Converts to screen coordinates from coordinates relative to this window.
wxPoint	ConvertDialogToPixels (const wxPoint &pt) const
	Converts a point or size from dialog units to pixels.
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.
wxPoint	ConvertPixelsToDialog (const wxPoint &pt) const
	Converts a point or size from pixels to dialog units.
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.
void	ScreenToClient (int *x, int *y) const
	Converts from screen to client window coordinates.
wxPoint	ScreenToClient (const wxPoint &pt) const
	Converts from screen to client window coordinates.
virtual void	ClearBackground ()
	Clears the window by filling it with the current background colour.
void	Freeze ()
	Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.
void	Thaw ()
	Re-enables window updating after a previous call to Freeze().
bool	IsFrozen () const
	Returns true if the window is currently frozen by a call to Freeze().
wxColour	GetBackgroundColour () const
	Returns the background colour of the window.
virtual wxBackgroundStyle	GetBackgroundStyle () const
	Returns the background style of the window.
virtual int	GetCharHeight () const
	Returns the character height for this window.
virtual int	GetCharWidth () const
	Returns the average character width for this window.
virtual wxVisualAttributes	GetDefaultAttributes () const
	Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).
wxFont	GetFont () const
	Returns the font for this window.
wxColour	GetForegroundColour () const
	Returns the foreground colour of the window.
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.
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.
const wxRegion &	GetUpdateRegion () const
	Returns the region specifying which parts of the window have been damaged.
wxRect	GetUpdateClientRect () const
	Get the update rectangle bounding box in client coords.
virtual bool	HasTransparentBackground ()
	Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background.
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.
void	RefreshRect (const wxRect &rect, bool eraseBackground=true)
	Redraws the contents of the given rectangle: only the area inside it will be repainted.
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).
virtual bool	SetBackgroundColour (const wxColour &colour)
	Sets the background colour of the window.
virtual bool	SetBackgroundStyle (wxBackgroundStyle style)
	Sets the background style of the window.
virtual bool	IsTransparentBackgroundSupported (wxString *reason=NULL) const
	Checks whether using transparent background might work.
virtual bool	SetFont (const wxFont &font)
	Sets the font for this window.
virtual bool	SetForegroundColour (const wxColour &colour)
	Sets the foreground colour of the window.
void	SetOwnBackgroundColour (const wxColour &colour)
	Sets the background colour of the window but prevents it from being inherited by the children of this window.
bool	InheritsBackgroundColour () const
	Return true if this window inherits the background colour from its parent.
bool	UseBgCol () const
	Return true if a background colour has been set for this window.
void	SetOwnFont (const wxFont &font)
	Sets the font of the window but prevents it from being inherited by the children of this window.
void	SetOwnForegroundColour (const wxColour &colour)
	Sets the foreground colour of the window but prevents it from being inherited by the children of this window.
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().
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.
virtual bool	GetThemeEnabled () const
	Clears the window by filling it with the current background colour.
wxEvtHandler *	GetEventHandler () const
	Returns the event handler for this window.
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.
bool	HandleWindowEvent (wxEvent &event) const
	Shorthand for:
bool	ProcessWindowEvent (wxEvent &event)
	Convenient wrapper for ProcessEvent().
bool	ProcessWindowEventLocally (wxEvent &event)
	Wrapper for wxEvtHandler::ProcessEventLocally().
wxEvtHandler *	PopEventHandler (bool deleteHandler=false)
	Removes and returns the top-most event handler on the event handler stack.
void	PushEventHandler (wxEvtHandler *handler)
	Pushes this event handler onto the event stack for the window.
bool	RemoveEventHandler (wxEvtHandler *handler)
	Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.
void	SetEventHandler (wxEvtHandler *handler)
	Sets the event handler for this window.
virtual void	SetNextHandler (wxEvtHandler *handler)
	wxWindows cannot be used to form event handler chains; this function thus will assert when called.
virtual void	SetPreviousHandler (wxEvtHandler *handler)
	wxWindows cannot be used to form event handler chains; this function thus will assert when called.
long	GetExtraStyle () const
	Returns the extra style bits for the window.
virtual long	GetWindowStyleFlag () const
	Gets the window style that was passed to the constructor or Create() method.
long	GetWindowStyle () const
	See GetWindowStyleFlag() for more info.
bool	HasExtraStyle (int exFlag) const
	Returns true if the window has the given exFlag bit set in its extra styles.
bool	HasFlag (int flag) const
	Returns true if the window has the given flag bit set.
virtual void	SetExtraStyle (long exStyle)
	Sets the extra style bits for the window.
virtual void	SetWindowStyleFlag (long style)
	Sets the style of the window.
void	SetWindowStyle (long style)
	See SetWindowStyleFlag() for more info.
bool	ToggleWindowStyle (int flag)
	Turns the given flag on if it's currently turned off and vice versa.
void	MoveAfterInTabOrder (wxWindow *win)
	Moves this window in the tab navigation order after the specified win.
void	MoveBeforeInTabOrder (wxWindow *win)
	Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.
bool	Navigate (int flags=wxNavigationKeyEvent::IsForward)
	Performs a keyboard navigation action starting from this window.
bool	NavigateIn (int flags=wxNavigationKeyEvent::IsForward)
	Performs a keyboard navigation action inside this window.
virtual void	Lower ()
	Lowers the window to the bottom of the window hierarchy (Z-order).
virtual void	Raise ()
	Raises the window to the top of the window hierarchy (Z-order).
bool	Hide ()
	Equivalent to calling wxWindow::Show(false).
virtual bool	HideWithEffect (wxShowEffect effect, unsigned int timeout=0)
	This function hides a window, like Hide(), but using a special visual effect if possible.
bool	IsEnabled () const
	Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.
bool	IsExposed (int x, int y) const
	Returns true if the given point or rectangle area has been exposed since the last repaint.
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.
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.
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.
virtual bool	IsShown () const
	Returns true if the window is shown, false if it has been hidden.
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.
bool	Disable ()
	Disables the window.
virtual bool	Enable (bool enable=true)
	Enable or disable the window for user input.
virtual bool	ShowWithEffect (wxShowEffect effect, unsigned int timeout=0)
	This function shows a window, like Show(), but using a special visual effect if possible.
wxString	GetHelpText () const
	Gets the help text to be used as context-sensitive help for this window.
void	SetHelpText (const wxString &helpText)
	Sets the help text to be used as context-sensitive help for this window.
virtual wxString	GetHelpTextAtPoint (const wxPoint &point, wxHelpEvent::Origin origin) const
	Gets the help text to be used as context-sensitive help for this window.
wxToolTip *	GetToolTip () const
	Get the associated tooltip or NULL if none.
wxString	GetToolTipText () const
	Get the text of the associated tooltip or empty string if none.
void	SetToolTip (const wxString &tipString)
	Attach a tooltip to the window.
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.
void	UnsetToolTip ()
	Unset any existing tooltip.
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.
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.
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.
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.
virtual wxValidator *	GetValidator ()
	Validator functions.
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.
virtual bool	TransferDataFromWindow ()
	Transfers values from child controls to data areas specified by their validators.
virtual bool	TransferDataToWindow ()
	Transfers values to child controls from data areas specified by their validators.
virtual bool	Validate ()
	Validates the current values of the child controls using their validators.
wxWindowID	GetId () const
	Returns the identifier of the window.
virtual wxString	GetLabel () const
	Generic way of getting a label from any window, for identification purposes.
virtual wxLayoutDirection	GetLayoutDirection () const
	Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.
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.
virtual wxString	GetName () const
	Returns the window's name.
wxWindowVariant	GetWindowVariant () const
	Returns the value previously passed to SetWindowVariant().
void	SetId (wxWindowID winid)
	Sets the identifier of the window.
virtual void	SetLabel (const wxString &label)
	Sets the window's label.
virtual void	SetLayoutDirection (wxLayoutDirection dir)
	Sets the layout direction for this window.
virtual void	SetName (const wxString &name)
	Sets the window's name.
void	SetWindowVariant (wxWindowVariant variant)
	Chooses a different variant of the window display to use.
wxAcceleratorTable *	GetAcceleratorTable ()
	Gets the accelerator table for this window.
wxAccessible *	GetAccessible ()
	Returns the accessible object for this window, if any.
virtual void	SetAcceleratorTable (const wxAcceleratorTable &accel)
	Sets the accelerator table for this window.
void	SetAccessible (wxAccessible *accessible)
	Sets the accessible for this window.
bool	Close (bool force=false)
	This function simply generates a wxCloseEvent whose handler usually tries to close the window.
virtual bool	Destroy ()
	Destroys the window safely.
bool	IsBeingDeleted () const
	Returns true if this window is in process of being destroyed.
virtual wxDropTarget *	GetDropTarget () const
	Returns the associated drop target, which may be NULL.
virtual void	SetDropTarget (wxDropTarget *target)
	Associates a drop target with this window.
virtual void	DragAcceptFiles (bool accept)
	Enables or disables eligibility for drop file events (OnDropFiles).
wxSizer *	GetContainingSizer () const
	Returns the sizer of which this window is a member, if any, otherwise NULL.
wxSizer *	GetSizer () const
	Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.
void	SetSizer (wxSizer *sizer, bool deleteOld=true)
	Sets the window to have the given layout sizer.
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.
wxLayoutConstraints *	GetConstraints () const
	Returns a pointer to the window's layout constraints, or NULL if there are none.
void	SetConstraints (wxLayoutConstraints *constraints)
	Sets the window to have the given layout constraints.
void	SetAutoLayout (bool autoLayout)
	Determines whether the Layout() function will be called automatically when the window is resized.
bool	GetAutoLayout () const
	Returns the sizer of which this window is a member, if any, otherwise NULL.
void	CaptureMouse ()
	Directs all mouse input to this window.
wxCaret *	GetCaret () const
	Returns the caret() associated with the window.
const wxCursor &	GetCursor () const
	Return the cursor associated with this window.
virtual bool	HasCapture () const
	Returns true if this window has the current mouse capture.
void	ReleaseMouse ()
	Releases mouse input captured with CaptureMouse().
void	SetCaret (wxCaret *caret)
	Sets the caret() associated with the window.
virtual bool	SetCursor (const wxCursor &cursor)
	Sets the window's cursor.
virtual void	WarpPointer (int x, int y)
	Moves the pointer to the given position on the window.
wxHitTest	HitTest (wxCoord x, wxCoord y) 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.
wxHitTest	HitTest (const wxPoint &pt) 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.
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.
wxBorder	GetBorder () const
	Get border for the flags of this window.
virtual void	DoUpdateWindowUI (wxUpdateUIEvent &event)
	Does the window-specific updating after processing the update event.
virtual WXWidget	GetHandle () const
	Returns the platform-specific handle of the physical window.
virtual bool	HasMultiplePages () const
	This method should be overridden to return true if this window has multiple pages.
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.
virtual void	InitDialog ()
	Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
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.
void	SetDoubleBuffered (bool on)
	Turn on or off double buffering of the window if the system supports it.
virtual bool	IsRetained () const
	Returns true if the window is retained, false otherwise.
bool	IsThisEnabled () const
	Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.
virtual bool	IsTopLevel () const
	Returns true if the given window is a top-level one.
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.
virtual bool	SendIdleEvents (wxIdleEvent &event)
	Send idle event to window and all subwindows.
virtual bool	RegisterHotKey (int hotkeyId, int modifiers, int virtualKeyCode)
	Registers a system wide hotkey.
virtual bool	UnregisterHotKey (int hotkeyId)
	Unregisters a system wide hotkey.
virtual void	UpdateWindowUI (long flags=wxUPDATE_UI_NONE)
	This function sends one or more wxUpdateUIEvent to the window.
Public Member Functions inherited from wxEvtHandler
	wxEvtHandler ()
	Constructor.
virtual	~wxEvtHandler ()
	Destructor.
template<typename T , typename T1 , ... >
void	CallAfter (void(T::*method)(T1,...), T1 x1,...)
	Asynchronously call the given method.
template<typename T >
void	CallAfter (const T &functor)
	Asynchronously call the given functor.
bool	ProcessEventLocally (wxEvent &event)
	Try to process the event in this handler and all those chained to it.
bool	SafelyProcessEvent (wxEvent &event)
	Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.
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.
void	DeletePendingEvents ()
	Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().
virtual bool	SearchEventTable (wxEventTable &table, wxEvent &event)
	Searches the event table, executing an event handler function if an appropriate one is found.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
void *	GetClientData () const
	Returns user-supplied client data.
wxClientData *	GetClientObject () const
	Returns a pointer to the user-supplied client data object.
void	SetClientData (void *data)
	Sets user-supplied client data.
void	SetClientObject (wxClientData *data)
	Set the client data object.
bool	GetEvtHandlerEnabled () const
	Returns true if the event handler is enabled, false otherwise.
wxEvtHandler *	GetNextHandler () const
	Returns the pointer to the next handler in the chain.
wxEvtHandler *	GetPreviousHandler () const
	Returns the pointer to the previous handler in the chain.
void	SetEvtHandlerEnabled (bool enabled)
	Enables or disables the event handler.
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).
bool	IsUnlinked () const
	Returns true if the next and the previous handler pointers of this event handler instance are NULL.
Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to NULL the internal reference data.
	wxObject (const wxObject &other)
	Copy ctor.
virtual	~wxObject ()
	Destructor.
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).
wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class.
bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj.
void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone.
void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer.
void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data.
void	UnShare ()
	This is the same of AllocExclusive() but this method is public.
void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.
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.

Static Public Member Functions
static void	EnableLayoutAdaptation (bool enable)
	A static function enabling or disabling layout adaptation for all dialogs.
static wxDialogLayoutAdapter *	GetLayoutAdapter ()
	A static function getting the current layout adapter object.
static bool	IsLayoutAdaptationEnabled ()
	A static function returning true if layout adaptation is enabled for all dialogs.
static wxDialogLayoutAdapter *	SetLayoutAdapter (wxDialogLayoutAdapter *adapter)
	A static function for setting the current layout adapter object, returning the old adapter.
Static Public Member Functions inherited from wxTopLevelWindow
static wxSize	GetDefaultSize ()
	Get the default size for a new top level window.

Additional Inherited Members
Protected Member Functions inherited from wxWindow
virtual void	DoCentre (int direction)
	Centres the window.
virtual wxSize	DoGetBestSize () const
	Implementation of GetBestSize() that can be overridden.
virtual wxSize	DoGetBestClientSize () const
	Override this method to return the best size for a custom control.
virtual int	DoGetBestClientHeight (int width) const
	Override this method to implement height-for-width best size calculation.
virtual int	DoGetBestClientWidth (int height) const
	Override this method to implement width-for-height best size calculation.
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).
void	SendDestroyEvent ()
	Generate wxWindowDestroyEvent for this window.
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.
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.
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.
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.
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.
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.
Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data.

Constructor & Destructor Documentation

wxDialog::wxDialog

(

)

Default constructor.

wxDialog::wxDialog	(	wxWindow *	parent,
		wxWindowID	id,
		const wxString &	title,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxDEFAULT_DIALOG_STYLE,
		const wxString &	name = wxDialogNameStr
	)

Constructor.

Parameters

parent	Can be NULL, a frame or another dialog box.
id	An identifier for the dialog. A value of -1 is taken to mean a default.
title	The title of the dialog.
pos	The dialog position. The value wxDefaultPosition indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.
size	The dialog size. The value wxDefaultSize indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
style	The window style.
name	Used to associate a name with the window, allowing the application user to set Motif resource values for individual dialog boxes.

See Also

Create()

virtual wxDialog::~wxDialog ( )

virtual

Destructor.

Deletes any child windows before deleting the physical window.

See Window Deletion for more info.

Member Function Documentation

void wxDialog::AddMainButtonId

(

wxWindowID

id

)

Adds an identifier to be regarded as a main button for the non-scrolling area of a dialog.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

virtual bool wxDialog::CanDoLayoutAdaptation ( )

virtual

Returns true if this dialog can and should perform layout adaptation using DoLayoutAdaptation(), usually if the dialog is too large to fit on the display.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

void wxDialog::Centre

(

int

direction = wxBOTH

)

Centres the dialog box on the display.

Parameters

direction

May be wxHORIZONTAL, wxVERTICAL or wxBOTH.

bool wxDialog::Create	(	wxWindow *	parent,
		wxWindowID	id,
		const wxString &	title,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxDEFAULT_DIALOG_STYLE,
		const wxString &	name = wxDialogNameStr
	)

Used for two-step dialog box construction.

See Also

wxDialog()

wxSizer* wxDialog::CreateButtonSizer

(

long

flags

)

Creates a sizer with standard buttons.

flags is a bit list of the following flags: wxOK, wxCANCEL, wxYES, wxNO, wxAPPLY, wxCLOSE, wxHELP, wxNO_DEFAULT.

The sizer lays out the buttons in a manner appropriate to the platform.

This function uses CreateStdDialogButtonSizer() internally for most platforms but doesn't create the sizer at all for the platforms with hardware buttons (such as smartphones) for which it sets up the hardware buttons appropriately and returns NULL, so don't forget to test that the return value is valid before using it.

wxSizer* wxDialog::CreateSeparatedButtonSizer

(

long

flags

)

Creates a sizer with standard buttons using CreateButtonSizer() separated from the rest of the dialog contents by a horizontal wxStaticLine.

Note

Just like CreateButtonSizer(), this function may return NULL if no buttons were created.

This is a combination of CreateButtonSizer() and CreateSeparatedSizer().

wxSizer* wxDialog::CreateSeparatedSizer

(

wxSizer *

sizer

)

Returns the sizer containing the given one with a separating wxStaticLine if necessarily.

This function is useful for creating the sizer containing footer-like contents in dialog boxes. It will add a separating static line only if it conforms to the current platform convention (currently it is not added under Mac where the use of static lines for grouping is discouraged and is added elsewhere).

Since

2.9.2

Parameters

sizer

The sizer to wrap, must be non-NULL.

Returns

The sizer wrapping the input one or possibly the input sizer itself if no wrapping is necessary.

wxStdDialogButtonSizer* wxDialog::CreateStdDialogButtonSizer

(

long

flags

)

Creates a wxStdDialogButtonSizer with standard buttons.

flags is a bit list of the following flags: wxOK, wxCANCEL, wxYES, wxNO, wxAPPLY, wxCLOSE, wxHELP, wxNO_DEFAULT.

The sizer lays out the buttons in a manner appropriate to the platform.

wxSizer* wxDialog::CreateTextSizer

(

const wxString &

message

)

Splits text up at newlines and places the lines into wxStaticText objects in a vertical wxBoxSizer.

virtual bool wxDialog::DoLayoutAdaptation ( )

virtual

Performs layout adaptation, usually if the dialog is too large to fit on the display.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

virtual bool wxDialog::DoOK ( )

virtual

This function is called when the titlebar OK button is pressed (PocketPC only).

A command event for the identifier returned by GetAffirmativeId() is sent by default. You can override this function. If the function returns false, wxWidgets will call Close() for the dialog.

Availability:  only available for the wxMSW port.

static void wxDialog::EnableLayoutAdaptation ( bool  enable )

static

A static function enabling or disabling layout adaptation for all dialogs.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

virtual void wxDialog::EndModal ( int  retCode )

virtual

Ends a modal dialog, passing a value to be returned from the ShowModal() invocation.

Parameters

retCode

The value that should be returned by ShowModal.

See Also

ShowModal(), GetReturnCode(), SetReturnCode()

int wxDialog::GetAffirmativeId

(

)

const

Gets the identifier of the button which works like standard OK button in this dialog.

See Also

SetAffirmativeId()

virtual wxWindow* wxDialog::GetContentWindow ( ) const

virtual

Override this to return a window containing the main content of the dialog.

This is particularly useful when the dialog implements pages, such as wxPropertySheetDialog, and allows the layout adaptation code to know that only the pages need to be made scrollable.

int wxDialog::GetEscapeId

(

)

const

Gets the identifier of the button to map presses of ESC button to.

See Also

SetEscapeId()

bool wxDialog::GetLayoutAdaptationDone

(

)

const

Returns true if the dialog has been adapted, usually by making it scrollable to work with a small display.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

int wxDialog::GetLayoutAdaptationLevel

(

)

const

Gets a value representing the aggressiveness of search for buttons and sizers to be in the non-scrolling part of a layout-adapted dialog.

Zero switches off adaptation, and 3 allows search for standard buttons anywhere in the dialog.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

wxDialogLayoutAdaptationMode wxDialog::GetLayoutAdaptationMode

(

)

const

Gets the adaptation mode, overriding the global adaptation flag.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

static wxDialogLayoutAdapter* wxDialog::GetLayoutAdapter ( )

static

A static function getting the current layout adapter object.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

wxArrayInt& wxDialog::GetMainButtonIds

(

)

Returns an array of identifiers to be regarded as the main buttons for the non-scrolling area of a dialog.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

int wxDialog::GetReturnCode

(

)

const

Gets the return code for this window.

Remarks

A return code is normally associated with a modal dialog, where ShowModal() returns a code to the application.

See Also

SetReturnCode(), ShowModal(), EndModal()

wxToolBar* wxDialog::GetToolBar

(

)

const

On PocketPC, a dialog is automatically provided with an empty toolbar.

This function allows you to access the toolbar and add tools to it. Removing tools and adding arbitrary controls are not currently supported.

This function is not available on any other platform.

Availability:  only available for the wxMSW port.

virtual void wxDialog::Iconize ( bool  iconize = true )

virtual

Iconizes or restores the dialog.

Windows only.

Parameters

iconize

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

Remarks

Note that in Windows, iconization has no effect since dialog boxes cannot be iconized. However, applications may need to explicitly restore dialog boxes under Motif which have user-iconizable frames, and under Windows calling Iconize(false) will bring the window to the front, as does Show(true).

Reimplemented from wxTopLevelWindow.

virtual bool wxDialog::IsIconized ( ) const

virtual

Returns true if the dialog box is iconized.

Windows only.

Remarks

Always returns false under Windows since dialogs cannot be iconized.

Reimplemented from wxTopLevelWindow.

static bool wxDialog::IsLayoutAdaptationEnabled ( )

static

A static function returning true if layout adaptation is enabled for all dialogs.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

bool wxDialog::IsMainButtonId

(

wxWindowID

id

)

const

Returns true if id is in the array of identifiers to be regarded as the main buttons for the non-scrolling area of a dialog.

Availability:  only available for the wxMSW port.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

virtual bool wxDialog::IsModal ( ) const

virtual

Returns true if the dialog box is modal, false otherwise.

void wxDialog::SetAffirmativeId

(

int

id

)

Sets the identifier to be used as OK button.

When the button with this identifier is pressed, the dialog calls wxWindow::Validate() and wxWindow::TransferDataFromWindow() and, if they both return true, closes the dialog with the affirmative id return code.

Also, when the user presses a hardware OK button on the devices having one or the special OK button in the PocketPC title bar, an event with this id is generated.

By default, the affirmative id is wxID_OK.

See Also

GetAffirmativeId(), SetEscapeId()

void wxDialog::SetEscapeId

(

int

id

)

Sets the identifier of the button which should work like the standard "Cancel" button in this dialog.

When the button with this id is clicked, the dialog is closed. Also, when the user presses ESC key in the dialog or closes the dialog using the close button in the title bar, this is mapped to the click of the button with the specified id.

By default, the escape id is the special value wxID_ANY meaning that wxID_CANCEL button is used if it's present in the dialog and otherwise the button with GetAffirmativeId() is used. Another special value for id is wxID_NONE meaning that ESC presses should be ignored. If any other value is given, it is interpreted as the id of the button to map the escape key to.

Note

This method should be used for custom modal dialog implemented in wxWidgets itself, native dialogs such as wxMessageDialog or wxFileDialog, handle ESC presses in their own way which cannot be customized.

void wxDialog::SetIcon

(

const wxIcon &

icon

)

Sets the icon for this dialog.

Parameters

icon	The icon to associate with this dialog.

See Also

wxIcon

void wxDialog::SetIcons ( const wxIconBundle &  icons )

virtual

Sets the icons for this dialog.

Parameters

icons

The icons to associate with this dialog.

See Also

wxIconBundle

Reimplemented from wxTopLevelWindow.

void wxDialog::SetLayoutAdaptationDone

(

bool

done

)

Marks the dialog as having been adapted, usually by making it scrollable to work with a small display.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

void wxDialog::SetLayoutAdaptationLevel

(

int

level

)

Sets the aggressiveness of search for buttons and sizers to be in the non-scrolling part of a layout-adapted dialog.

Zero switches off adaptation, and 3 allows search for standard buttons anywhere in the dialog.

See Also

Automatic Scrolled Dialogs (for more on layout adaptation)

void wxDialog::SetLayoutAdaptationMode

(

wxDialogLayoutAdaptationMode

mode

)

Sets the adaptation mode, overriding the global adaptation flag.

See Also

wxDialogLayoutAdaptationMode, Automatic Scrolled Dialogs (for more on layout adaptation)

static wxDialogLayoutAdapter* wxDialog::SetLayoutAdapter ( wxDialogLayoutAdapter *  adapter )

static

A static function for setting the current layout adapter object, returning the old adapter.

If you call this, you should delete the old adapter object.

See Also

wxDialogLayoutAdapter, Automatic Scrolled Dialogs

void wxDialog::SetReturnCode

(

int

retCode

)

Sets the return code for this window.

A return code is normally associated with a modal dialog, where ShowModal() returns a code to the application. The function EndModal() calls SetReturnCode().

Parameters

retCode

The integer return code, usually a control identifier.

See Also

GetReturnCode(), ShowModal(), EndModal()

virtual bool wxDialog::Show ( bool  show = 1 )

virtual

Hides or shows the dialog.

The preferred way of dismissing a modal dialog is to use EndModal().

Parameters

show	If true, the dialog box is shown and brought to the front, otherwise the box is hidden. If false and the dialog is modal, control is returned to the calling program.

Reimplemented from wxWindow.

virtual int wxDialog::ShowModal ( )

virtual

Shows an application-modal dialog.

Program flow does not return until the dialog has been dismissed with EndModal().

Notice that it is possible to call ShowModal() for a dialog which had been previously shown with Show(), this allows to make an existing modeless dialog modal. However ShowModal() can't be called twice without intervening EndModal() calls.

Note that this function creates a temporary event loop which takes precedence over the application's main event loop (see wxEventLoopBase) and which is destroyed when the dialog is dismissed. This also results in a call to wxApp::ProcessPendingEvents().

Returns

The value set with SetReturnCode().

See Also

ShowWindowModal(), ShowWindowModalThenDo(), EndModal(), GetReturnCode(), SetReturnCode()

Reimplemented in wxFileDialog, wxMessageDialog, wxSingleChoiceDialog, wxTextEntryDialog, wxMultiChoiceDialog, wxDirDialog, wxFontDialog, and wxColourDialog.

void wxDialog::ShowWindowModal

(

)

Shows a dialog modal to the parent top level window only.

Unlike ShowModal(), dialogs shown with this function only prevent the user from interacting with their parent frame only but not with the rest of the application. They also don't block the program execution but instead return immediately, as Show(), and generate a wxEVT_WINDOW_MODAL_DIALOG_CLOSED event (wxWindowModalDialogEvent) later when the dialog is closed.

Currently this function is only fully implemented in wxOSX ports, under the other platforms it behaves like ShowModal() (but also sends the above mentioned event).

See Also

wxWindowModalDialogEvent, ShowWindowModalThenDo()

Since

2.9.0

template<typename Functor >

void wxDialog::ShowWindowModalThenDo

(

const Functor &

onEndModal

)

Shows a dialog modal to the parent top level window only and call a functor after the dialog is closed.

Same as the other ShowWindowModal() overload, but calls the functor passed as the argument upon completion, instead of generating the wxEVT_WINDOW_MODAL_DIALOG_CLOSED event.

This form is particularly useful in combination with C++11 lambdas, when it allows writing window-modal very similarly to how ShowModal() is used (with the notable exception of not being able to create the dialog on stack):

wxWindowPtr<wxDialog> dlg(new wxMessageDialog(this, "Hello!"));

dlg->ShowWindowModalThenDo([this,dlg](int retcode){
    if ( retcode == wxID_OK )
        DoSomething();
    // dlg is implicitly destroyed here, because the pointer was
    // explicitly captured by the lambda
});

Parameters

onEndModal

Function object to call when the dialog is closed. The functor is called with a single integer argument, dialog's return code.

Note

The dialog instance must not be destroyed until onEndModal is called. The best way to ensure that is to use wxWindowPtr to hold a pointer and include it in the lambda's capture, by value (not reference!), as shown in the example above.

Since

3.0

See Also

wxWindowPtr<T>