Version: 3.1.0
wxTopLevelWindow Class Reference

#include <wx/toplevel.h>

+ Inheritance diagram for wxTopLevelWindow:

Detailed Description

wxTopLevelWindow is a common base class for wxDialog and wxFrame.

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

Note that the instances of wxTopLevelWindow are managed by wxWidgets in the internal top level window list.

Events emitted by this class

Event macros for events emitted by this class:

  • EVT_MAXIMIZE(id, func):
    Process a wxEVT_MAXIMIZE event. See wxMaximizeEvent.
  • EVT_MOVE(func):
    Process a wxEVT_MOVE event, which is generated when a window is moved. See wxMoveEvent.
  • EVT_MOVE_START(func):
    Process a wxEVT_MOVE_START event, which is generated when the user starts to move or size a window. wxMSW only. See wxMoveEvent.
  • EVT_MOVE_END(func):
    Process a wxEVT_MOVE_END event, which is generated when the user stops moving or sizing a window. wxMSW only. See wxMoveEvent.
  • EVT_SHOW(func):
    Process a wxEVT_SHOW event. See wxShowEvent.

Library:  wxCore
Category:  Managed Windows
See Also
wxDialog, wxFrame

Public Member Functions

 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).
 
wxWindowGetDefaultItem () 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 wxIconBundleGetIcons () 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 void Iconize (bool iconize=true)
 Iconizes or restores the window.
 
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 IsIconized () const
 Returns true if the window is iconized.
 
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.
 
wxMenuMSWGetSystemMenu () 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.
 
void Restore ()
 Restore a previously iconized or maximized window to its normal state.
 
wxWindowSetDefaultItem (wxWindow *win)
 Changes the default item for the panel, usually win is a button.
 
wxWindowSetTmpDefaultItem (wxWindow *win)
 
wxWindowGetTmpDefaultItem () const
 
void SetIcon (const wxIcon &icon)
 Sets the icon for this window.
 
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.
 
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 EnableFullScreenView (bool enable=true)
 Adds or removes a full screen button to the right upper corner of a window's title bar under OS X 10.7 and later.
 
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.
 
wxWindowFindWindow (long id) const
 Find a child of this window, by id.
 
wxWindowFindWindow (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
 Returns a const reference to the list of the window's children.
 
virtual void RemoveChild (wxWindow *child)
 Removes a child window.
 
wxWindowGetGrandParent () const
 Returns the grandparent of a window, or NULL if there isn't one.
 
wxWindowGetNextSibling () const
 Returns the next window after this one among the parent's children or NULL if this window is the last child.
 
wxWindowGetParent () const
 Returns the parent of the window, or NULL if there is no parent.
 
wxWindowGetPrevSibling () 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 wxRegionGetUpdateRegion () 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.
 
wxEvtHandlerGetEventHandler () 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().
 
wxEvtHandlerPopEventHandler (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 Show (bool show=true)
 Shows or hides the window.
 
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.
 
wxToolTipGetToolTip () 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 wxValidatorGetValidator ()
 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.
 
wxAcceleratorTableGetAcceleratorTable ()
 Gets the accelerator table for this window.
 
wxAccessibleGetAccessible ()
 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 wxDropTargetGetDropTarget () 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).
 
wxSizerGetContainingSizer () const
 Returns the sizer of which this window is a member, if any, otherwise NULL.
 
wxSizerGetSizer () 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.
 
wxLayoutConstraintsGetConstraints () 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.
 
wxCaretGetCaret () const
 Returns the caret() associated with the window.
 
const wxCursorGetCursor () 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
 Return where the given point lies, exactly.
 
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.
 
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.
 
wxClientDataGetClientObject () 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.
 
wxEvtHandlerGetNextHandler () const
 Returns the pointer to the next handler in the chain.
 
wxEvtHandlerGetPreviousHandler () 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 wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
 
wxObjectRefDataGetRefData () 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 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
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data.
 

Constructor & Destructor Documentation

wxTopLevelWindow::wxTopLevelWindow ( )

Default ctor.

wxTopLevelWindow::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::~wxTopLevelWindow ( )
virtual

Destructor.

Remember that wxTopLevelWindows do not get immediately destroyed when the user (or the app) closes them; they have a delayed destruction.

See Window Deletion for more info.

Member Function Documentation

virtual bool wxTopLevelWindow::CanSetTransparent ( )
virtual

Returns true if the platform supports making the window translucent.

See Also
SetTransparent()

Reimplemented from wxWindow.

void wxTopLevelWindow::CenterOnScreen ( int  direction = wxBOTH)

A synonym for CentreOnScreen().

void wxTopLevelWindow::CentreOnScreen ( int  direction = wxBOTH)

Centres the window on screen.

Parameters
directionSpecifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL or wxBOTH.
See Also
wxWindow::CentreOnParent()
bool wxTopLevelWindow::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 wxTopLevelWindow::EnableCloseButton ( bool  enable = true)
virtual

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

Currently only implemented for wxMSW and wxGTK.

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

virtual bool wxTopLevelWindow::EnableFullScreenView ( bool  enable = true)
virtual

Adds or removes a full screen button to the right upper corner of a window's title bar under OS X 10.7 and later.

Currently only available for wxOSX/Cocoa.

Parameters
enableIf true (default) adds the full screen button in the title bar; if false the button is removed.
Returns
true if the button was added or removed, false if running under a pre-OS X 10.7 system or another OS.
Note
Having the button is also required to let ShowFullScreen() make use of the full screen API available since OS X 10.7: a full screen window gets its own space and entering and exiting the mode is animated. If the button is not present the old way of switching to full screen is used.
Availability:  only available for the wxOSX port.
See Also
ShowFullScreen()
Since
3.1.0
wxWindow* wxTopLevelWindow::GetDefaultItem ( ) const

Returns a pointer to the button which is the default for this window, or NULL.

The default button is the one activated by pressing the Enter key.

static wxSize wxTopLevelWindow::GetDefaultSize ( )
static

Get the default size for a new top level window.

This is used internally by wxWidgets on some platforms to determine the default size for a window created using wxDefaultSize so it is not necessary to use it when creating a wxTopLevelWindow, however it may be useful if a rough estimation of the window size is needed for some other reason.

Since
2.9.2
wxIcon wxTopLevelWindow::GetIcon ( ) const

Returns the standard icon of the window.

The icon will be invalid if it hadn't been previously set by SetIcon().

See Also
GetIcons()
const wxIconBundle& wxTopLevelWindow::GetIcons ( ) const

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

Use GetIcon() to get the main icon of the window.

See Also
wxIconBundle
virtual wxString wxTopLevelWindow::GetTitle ( ) const
virtual

Gets a string containing the window title.

See Also
SetTitle()
wxWindow* wxTopLevelWindow::GetTmpDefaultItem ( ) const
virtual bool wxTopLevelWindow::HandleSettingChange ( WXWPARAM  wParam,
WXLPARAM  lParam 
)
virtual

Unique to the wxWinCE port.

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

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

Iconizes or restores the window.

Parameters
iconizeIf true, iconizes the window; if false, shows and restores it.
See Also
IsIconized(), Restore()(), wxIconizeEvent.

Reimplemented in wxDialog.

virtual bool wxTopLevelWindow::IsActive ( )
virtual

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

virtual bool wxTopLevelWindow::IsAlwaysMaximized ( ) const
virtual

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

Reimplemented in wxMDIChildFrame.

virtual bool wxTopLevelWindow::IsFullScreen ( ) const
virtual

Returns true if the window is in fullscreen mode.

See Also
ShowFullScreen()
virtual bool wxTopLevelWindow::IsIconized ( ) const
virtual

Returns true if the window is iconized.

Reimplemented in wxDialog.

virtual bool wxTopLevelWindow::IsMaximized ( ) const
virtual

Returns true if the window is maximized.

bool wxTopLevelWindow::IsUsingNativeDecorations ( ) const

This method is specific to wxUniversal port.

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

See Also
UseNativeDecorations(), UseNativeDecorationsByDefault()
virtual bool wxTopLevelWindow::Layout ( )
virtual

See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized.

Reimplemented from wxWindow.

virtual void wxTopLevelWindow::Maximize ( bool  maximize = true)
virtual

Maximizes or restores the window.

Parameters
maximizeIf true, maximizes the window, otherwise it restores it.
See Also
Restore(), Iconize()

Reimplemented in wxMDIChildFrame.

wxMenu* wxTopLevelWindow::MSWGetSystemMenu ( ) const

MSW-specific function for accessing the system menu.

Returns a wxMenu pointer representing the system menu of the window under MSW. The returned wxMenu may be used, if non-NULL, to add extra items to the system menu. The usual wxEVT_MENU events (that can be processed using EVT_MENU event table macro) will then be generated for them. All the other wxMenu methods may be used as well but notice that they won't allow you to access any standard system menu items (e.g. they can't be deleted or modified in any way currently).

Notice that because of the native system limitations the identifiers of the items added to the system menu must be multiples of 16, otherwise no events will be generated for them.

The returned pointer must not be deleted, it is owned by the window and will be only deleted when the window 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
2.9.3
virtual bool wxTopLevelWindow::OSXIsModified ( ) const
virtual

Returns the current modified state of the wxTopLevelWindow on OS X.

On other platforms, this method does nothing.

See Also
OSXSetModified()
virtual void wxTopLevelWindow::OSXSetModified ( bool  modified)
virtual

This function sets the wxTopLevelWindow's modified state on OS X, which currently draws a black dot in the wxTopLevelWindow's close button.

On other platforms, this method does nothing.

See Also
OSXIsModified()
virtual void wxTopLevelWindow::RequestUserAttention ( int  flags = wxUSER_ATTENTION_INFO)
virtual

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

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

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

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

void wxTopLevelWindow::Restore ( )

Restore a previously iconized or maximized window to its normal state.

In wxGTK this method currently doesn't return the maximized window to its normal state and you must use Maximize() with false argument explicitly for this. In the other ports, it both unmaximizes the maximized windows and uniconizes the iconized ones.

See Also
Iconize(), Maximize()
wxWindow* wxTopLevelWindow::SetDefaultItem ( wxWindow win)

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

See Also
GetDefaultItem()
void wxTopLevelWindow::SetIcon ( const wxIcon icon)

Sets the icon for this window.

Parameters
iconThe wxIcon to associate with this window.
Remarks
The window takes a 'copy' of icon, but since it uses reference counting, the copy is very quick. It is safe to delete icon after calling this function.
Note
In wxMSW, icon must be either 16x16 or 32x32 icon.
See Also
wxIcon, SetIcons()
virtual void wxTopLevelWindow::SetIcons ( const wxIconBundle icons)
virtual

Sets several icons of different sizes for this window: this allows to use different icons for different situations (e.g.

task switching bar, taskbar, window title bar) instead of scaling, with possibly bad looking results, the only icon set by SetIcon().

Parameters
iconsThe icons to associate with this window.
Note
In wxMSW, icons must contain a 16x16 or 32x32 icon, preferably both.
See Also
wxIconBundle

Reimplemented in wxDialog.

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

Sets action or menu activated by pressing left hardware button on the smart phones.

Unavailable on full keyboard machines.

Parameters
idIdentifier for this button.
labelText to be displayed on the screen area dedicated to this hardware button.
subMenuThe menu to be opened after pressing this hardware button.
See Also
SetRightMenu().
virtual void wxTopLevelWindow::SetMaxSize ( const wxSize size)
virtual

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

Reimplemented from wxWindow.

virtual void wxTopLevelWindow::SetMinSize ( const wxSize size)
virtual

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

Reimplemented from wxWindow.

virtual void wxTopLevelWindow::SetRepresentedFilename ( const wxString filename)
virtual

Sets the file name represented by this wxTopLevelWindow.

Under OS X, this file name is used to set the "proxy icon", which appears in the window title bar near its title, corresponding to this file name. Under other platforms it currently doesn't do anything but it is harmless to call it now and it might be implemented to do something useful in the future so you're encouraged to use it for any window representing a file-based document.

Since
2.9.4
void wxTopLevelWindow::SetRightMenu ( int  id = wxID_ANY,
const wxString label = wxEmptyString,
wxMenu subMenu = NULL 
)

Sets action or menu activated by pressing right hardware button on the smart phones.

Unavailable on full keyboard machines.

Parameters
idIdentifier for this button.
labelText to be displayed on the screen area dedicated to this hardware button.
subMenuThe menu to be opened after pressing this hardware button.
See Also
SetLeftMenu().
virtual void wxTopLevelWindow::SetSizeHints ( int  minW,
int  minH,
int  maxW = -1,
int  maxH = -1,
int  incW = -1,
int  incH = -1 
)
virtual

Allows specification of minimum and maximum window sizes, and window size increments.

If a pair of values is not set (or set to -1), no constraints will be used.

Parameters
minWThe minimum width.
minHThe minimum height.
maxWThe maximum width.
maxHThe maximum height.
incWSpecifies the increment for sizing the width (GTK/Motif/Xt only).
incHSpecifies the increment for sizing the height (GTK/Motif/Xt only).
Remarks
Notice that this function not only prevents the user from resizing the window outside the given bounds but it also prevents the program itself from doing it using wxWindow::SetSize().

Reimplemented from wxWindow.

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

Allows specification of minimum and maximum window sizes, and window size increments.

If a pair of values is not set (or set to -1), no constraints will be used.

Parameters
minSizeThe minimum size of the window.
maxSizeThe maximum size of the window.
incSizeIncrement size (only taken into account under X11-based ports such as wxGTK/wxMotif/wxX11).
Remarks
Notice that this function not only prevents the user from resizing the window outside the given bounds but it also prevents the program itself from doing it using wxWindow::SetSize().

Reimplemented from wxWindow.

virtual void wxTopLevelWindow::SetTitle ( const wxString title)
virtual

Sets the window title.

Parameters
titleThe window title.
See Also
GetTitle()
wxWindow* wxTopLevelWindow::SetTmpDefaultItem ( wxWindow win)
virtual bool wxTopLevelWindow::SetTransparent ( wxByte  alpha)
virtual

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

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

Reimplemented from wxWindow.

virtual bool wxTopLevelWindow::ShouldPreventAppExit ( ) const
virtual

This virtual function is not meant to be called directly but can be overridden to return false (it returns true by default) to allow the application to close even if this, presumably not very important, window is still opened.

By default, the application stays alive as long as there are any open top level windows.

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

Depending on the value of show parameter the window is either shown full screen or restored to its normal state.

style is a bit list containing some or all of the following values, which indicate what elements of the window to hide in full-screen mode:

This function has not been tested with MDI frames.

Note
Showing a window full screen also actually Show()s the window if it isn't shown.
See Also
EnableFullScreenView(), IsFullScreen()
virtual void wxTopLevelWindow::ShowWithoutActivating ( )
virtual

Show the wxTopLevelWindow, but do not give it keyboard focus.

This can be used for pop up or notification windows that should not steal the current focus.

void wxTopLevelWindow::UseNativeDecorations ( bool  native = true)

This method is specific to wxUniversal port.

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

MyFrame *frame = new MyFrame; // use default ctor
frame->UseNativeDecorations(false); // change from default "true"
frame->Create(parent, title, ...); // really create the frame
See Also
UseNativeDecorationsByDefault(), IsUsingNativeDecorations()
void wxTopLevelWindow::UseNativeDecorationsByDefault ( bool  native = true)

This method is specific to wxUniversal port.

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

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

See Also
UseNativeDecorations()