wxWindow Class Reference
[Miscellaneous Windows]

#include <wx/window.h>

Inheritance diagram for wxWindow:
Inheritance graph
[legend]

Detailed Description

wxWindow is the base class for all windows and represents any visible object on screen.

All controls, top level windows and so on are windows. Sizers and device contexts are not, however, as they don't appear on screen themselves.

Please note that all children of the window will be deleted automatically by the destructor before the window itself is deleted which means that you don't have to worry about deleting them manually. Please see the window deletion overview for more information.

Also note that in this, and many others, wxWidgets classes some GetXXX() methods may be overloaded (as, for example, wxWindow::GetSize or wxWindow::GetClientSize). In this case, the overloads are non-virtual because having multiple virtual functions with the same name results in a virtual function name hiding at the derived class level (in English, this means that the derived class has to override all overloaded variants if it overrides any of them). To allow overriding them in the derived class, wxWidgets uses a unique protected virtual DoGetXXX() method and all GetXXX() ones are forwarded to it, so overriding the former changes the behaviour of the latter.

Styles

This class supports the following styles:


Extra styles

This class supports the following extra styles:

Events emitted by this class

Event macros for events emitted by this class:

Library:  wxCore
Category:  Miscellaneous Windows
See also:
Events and Event Handling, Window Sizing Overview



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.
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)
 Validator functions.
virtual void AddPendingEvent (const wxEvent &event)
 Validator functions.
void ProcessPendingEvents ()
 Validator functions.
bool ProcessThreadEvent (const wxEvent &event)
 Validator functions.

Public Member Functions

 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.
Focus functions

See also the static function FindFocus().



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.
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.
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.
Child management functions



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
 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.
Sibling and parent management functions



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.
virtual bool Reparent (wxWindow *newParent)
 Reparents the window, i.e the window will be removed from its current parent window (e.g.
Scrolling and scrollbars functions

Note that these methods don't work with native controls which don't use wxWidgets scrolling framework (i.e.

don't derive from wxScrolledWindow).



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.
Sizing functions

See also the protected functions DoGetBestSize() and SetInitialBestSize().



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.
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.
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 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.
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().
virtual void SetClientSize (int width, int height)
 This sets the size of the window client area in pixels.
virtual 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 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 SetMaxSize (const wxSize &size)
 Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.
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.
virtual void SetMinSize (const wxSize &size)
 Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.
void SetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO)
 Sets the size of the window in pixels.
virtual void SetSize (const wxRect &rect)
 Sets the size of the window in pixels.
virtual 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.
virtual 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 SetSizeHints (const wxSize &minSize, const wxSize &maxSize=wxDefaultSize, const wxSize &incSize=wxDefaultSize)
 Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.
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.
Positioning functions



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.
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.
Coordinate conversion functions



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)
 Converts a point or size from dialog units to pixels.
wxSize ConvertDialogToPixels (const wxSize &sz)
 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)
 Converts a point or size from pixels to dialog units.
wxSize ConvertPixelsToDialog (const wxSize &sz)
 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.
Drawing-related functions



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.
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 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.
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 CanSetTransparent ()
 Returns true if the system supports transparent windows and calling SetTransparent() may succeed.
virtual bool SetTransparent (wxByte alpha)
 Set the transparency of the window.
Event-handling functions

wxWindow allows you to build a (sort of) stack of event handlers which can be used to override the window's own event handling.



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().
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.
Window styles functions



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.
Tab order functions



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=IsForward)
 Performs a keyboard navigation action starting from this window.
bool NavigateIn (int flags=IsForward)
 Performs a keyboard navigation action inside this window.
Z order functions



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).
Window status functions



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.
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.
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.
Context-sensitive help functions



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 &tip)
 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.
Popup/context menu functions



int GetPopupMenuSelectionFromUser (wxMenu &menu, const wxPoint &pos)
 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.
wxWindow properties functions



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 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)
 This function can be called under all platforms but only does anything under Mac OS X 10.3+ currently.
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.
Window deletion functions



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.
Drag and drop functions



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).
Constraints, sizers and window layouting functions



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 minimial 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.
virtual bool Layout ()
 Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window.
void SetAutoLayout (bool autoLayout)
 Determines whether the Layout() function will be called automatically when the window is resized.
Mouse functions



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.
Miscellaneous functions



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.
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.
virtual bool IsTopLevel () const
 Returns true if the given window is a top-level one.
virtual void MakeModal (bool modal=true)
 Disables all other windows in the application so that the user can only interact with this window.
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 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.

Static Public Member Functions

Miscellaneous static functions



static wxVisualAttributes GetClassDefaultAttributes (wxWindowVariant variant=wxWINDOW_VARIANT_NORMAL)
 Returns the default font and colours which are used by the control.
static wxWindowFindFocus ()
 Finds the window or control which currently has the keyboard focus.
static wxWindowFindWindowById (long id, const wxWindow *parent=0)
 Find the first window with the given id.
static wxWindowFindWindowByLabel (const wxString &label, const wxWindow *parent=0)
 Find a window by its label.
static wxWindowFindWindowByName (const wxString &name, const wxWindow *parent=0)
 Find a window by its name (as given in a window constructor or Create() function call).
static wxWindowGetCapture ()
 Returns the currently captured window.
static wxWindowID NewControlId (int count=1)
 Create a new ID or range of IDs that are not currently in use.
static void UnreserveControlId (wxWindowID id, int count=1)
 Unreserve an ID or range of IDs that was reserved by NewControlId().

Protected Member Functions

virtual wxSize DoGetBestSize () const
 Gets the size which best suits the window: for a control, it would be the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to Fit().
virtual void SetInitialBestSize (const wxSize &size)
 Sets the initial window size if none is given (i.e.
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.

List of all members.


Constructor & Destructor Documentation

wxWindow::wxWindow (  ) 

Default constructor.

wxWindow::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.

Parameters:
parent Pointer to a parent window.
id Window identifier. If wxID_ANY, will automatically create an identifier.
pos Window position. wxDefaultPosition indicates that wxWidgets should generate a default position for the window. If using the wxWindow class directly, supply an actual position.
size Window size. wxDefaultSize indicates that wxWidgets should generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized.
style Window style. For generic window styles, please see wxWindow.
name Window name.
virtual wxWindow::~wxWindow (  )  [virtual]

Destructor.

Deletes all sub-windows, then deletes itself. Instead of using the delete operator explicitly, you should normally use Destroy() so that wxWidgets can delete a window only when it is safe to do so, in idle time.

See also:
Window Deletion Overview, Destroy(), wxCloseEvent

Member Function Documentation

virtual bool wxWindow::AcceptsFocus (  )  const [virtual]

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.

See also:
AcceptsFocusFromKeyboard()

Reimplemented in wxPanel.

virtual bool wxWindow::AcceptsFocusFromKeyboard (  )  const [virtual]

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 wxWindow::AcceptsFocusRecursively (  )  const [virtual]

Overridden to indicate whether this window or one of its children accepts focus.

Usually it's the same as AcceptsFocus() but is overridden for container windows.

virtual void wxWindow::AddChild ( wxWindow child  )  [virtual]

Adds a child window.

This is called automatically by window creation functions so should not be required by the application programmer. Notice that this function is mostly internal to wxWidgets and shouldn't be called by the user code.

Parameters:
child Child window to add.
virtual void wxWindow::AddPendingEvent ( const wxEvent event  )  [protected, virtual]

Validator functions.

Returns a pointer to the current validator for the window, or NULL if there is none.

Reimplemented from wxEvtHandler.

virtual void wxWindow::AlwaysShowScrollbars ( bool  hflag = true,
bool  vflag = true 
) [virtual]

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.

Since:
2.9.0
Parameters:
hflag Whether the horizontal scroll bar should always be visible.
vflag Whether the vertical scroll bar should always be visible.
Remarks:
This function is currently only implemented under Mac/Carbon.
void wxWindow::CacheBestSize ( const wxSize size  )  const

Sets the cached best size value.

See also:
GetBestSize()
bool wxWindow::CanScroll ( int  orient  )  const

Returns true if this window can have a scroll bar in this orientation.

Parameters:
orient Orientation to check, either wxHORIZONTAL or wxVERTICAL.
Since:
2.9.1
virtual bool wxWindow::CanSetTransparent (  )  [virtual]

Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

If this function returns false, transparent windows are definitely not supported by the current system.

Reimplemented in wxTopLevelWindow.

void wxWindow::CaptureMouse (  ) 

Directs all mouse input to this window.

Call ReleaseMouse() to release the capture.

Note that wxWidgets maintains the stack of windows having captured the mouse and when the mouse is released the capture returns to the window which had had captured it previously and it is only really released if there were no previous window. In particular, this means that you must release the mouse as many times as you capture it, unless the window receives the wxMouseCaptureLostEvent event.

Any application which captures the mouse in the beginning of some operation must handle wxMouseCaptureLostEvent and cancel this operation when it receives the event. The event handler must not recapture mouse.

See also:
ReleaseMouse(), wxMouseCaptureLostEvent
void wxWindow::Center ( int  dir = wxBOTH  ) 

A synonym for Centre().

void wxWindow::CenterOnParent ( int  dir = wxBOTH  ) 

A synonym for CentreOnParent().

void wxWindow::Centre ( int  direction = wxBOTH  ) 

Centres the window.

Parameters:
direction Specifies the direction for the centring. May be wxHORIZONTAL, wxVERTICAL or wxBOTH. It may also include wxCENTRE_ON_SCREEN flag if you want to centre the window on the entire screen and not on its parent window.
Remarks:
If the window is a top level one (i.e. doesn't have a parent), it will be centred relative to the screen anyhow.
See also:
Center()

Reimplemented in wxDialog, and wxFrame.

void wxWindow::CentreOnParent ( int  direction = wxBOTH  ) 

Centres the window on its parent.

This is a more readable synonym for Centre().

Parameters:
direction Specifies the direction for the centring. May be wxHORIZONTAL, wxVERTICAL or wxBOTH.
Remarks:
This methods provides for a way to centre top level windows over their parents instead of the entire screen. If there is no parent or if the window is not a top level window, then behaviour is the same as Centre().
See also:
wxTopLevelWindow::CentreOnScreen
virtual void wxWindow::ClearBackground (  )  [virtual]

Clears the window by filling it with the current background colour.

Does not cause an erase background event to be generated.

wxPoint wxWindow::ClientToScreen ( const wxPoint pt  )  const

Converts to screen coordinates from coordinates relative to this window.

Parameters:
pt The client position for the second form of the function.
void wxWindow::ClientToScreen ( int *  x,
int *  y 
) const

Converts to screen coordinates from coordinates relative to this window.

Parameters:
x A pointer to a integer value for the x coordinate. Pass the client coordinate in, and a screen coordinate will be passed out.
y A pointer to a integer value for the y coordinate. Pass the client coordinate in, and a screen coordinate will be passed out.

wxPython Note: In place of a single overloaded method name, wxPython implements the following methods:

  • ClientToScreen(point): Accepts and returns a wxPoint
  • ClientToScreenXY(x, y): Returns a 2-tuple, (x, y)

wxPerl Note: In wxPerl this method returns a 2-element list instead of modifying its parameters.

virtual wxSize wxWindow::ClientToWindowSize ( const wxSize size  )  const [virtual]

Converts client area size size to corresponding window size.

In other words, the returned value is what would GetSize() return if this window had client area of given size. Components with wxDefaultCoord value are left unchanged. Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars.

Since:
2.8.8
See also:
WindowToClientSize()
bool wxWindow::Close ( bool  force = false  ) 

This function simply generates a wxCloseEvent whose handler usually tries to close the window.

It doesn't close the window itself, however.

Parameters:
force false if the window's close handler should be able to veto the destruction of this window, true if it cannot.
Remarks:
Close calls the close handler for the window, providing an opportunity for the window to choose whether to destroy the window. Usually it is only used with the top level windows (wxFrame and wxDialog classes) as the others are not supposed to have any special OnClose() logic. The close handler should check whether the window is being deleted forcibly, using wxCloseEvent::CanVeto, in which case it should destroy the window using wxWindow::Destroy. Note that calling Close does not guarantee that the window will be destroyed; but it provides a way to simulate a manual close of a window, which may or may not be implemented by destroying the window. The default implementation of wxDialog::OnCloseWindow does not necessarily delete the dialog, since it will simply simulate an wxID_CANCEL event which is handled by the appropriate button event handler and may do anything at all. To guarantee that the window will be destroyed, call wxWindow::Destroy instead
See also:
Window Deletion Overview, Destroy(), wxCloseEvent
wxSize wxWindow::ConvertDialogToPixels ( const wxSize sz  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

wxPoint wxWindow::ConvertDialogToPixels ( const wxPoint pt  ) 

Converts a point or size from dialog units to pixels.

For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

Remarks:
Dialog units are used for maintaining a dialog's proportions even if the font changes. You can also use these functions programmatically. A convenience macro is defined:
                #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
See also:
ConvertPixelsToDialog()
wxSize wxWindow::ConvertPixelsToDialog ( const wxSize sz  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

wxPoint wxWindow::ConvertPixelsToDialog ( const wxPoint pt  ) 

Converts a point or size from pixels to dialog units.

For the x dimension, the pixels are multiplied by 4 and then divided by the average character width. For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.

Remarks:
Dialog units are used for maintaining a dialog's proportions even if the font changes.
See also:
ConvertDialogToPixels()
virtual bool wxWindow::Destroy (  )  [virtual]

Destroys the window safely.

Use this function instead of the delete operator, since different window classes can be destroyed differently. Frames and dialogs are not destroyed immediately when this function is called -- they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows.

Returns:
true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
bool wxWindow::DestroyChildren (  ) 

Destroys all children of a window.

Called automatically by the destructor.

bool wxWindow::Disable (  ) 

Disables the window.

Same as Enable() Enable(false).

Returns:
Returns true if the window has been disabled, false if it had been already disabled before the call to this function.
virtual wxSize wxWindow::DoGetBestSize (  )  const [protected, virtual]

Gets the size which best suits the window: for a control, it would be the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to Fit().

The default implementation of this function is designed for use in container windows, such as wxPanel, and works something like this:

  1. If the window has a sizer then it is used to calculate the best size.
  2. Otherwise if the window has layout constraints then those are used to calculate the best size.
  3. Otherwise if the window has children then the best size is set to be large enough to show all the children.
  4. Otherwise if there are no children then the window's minimal size will be used as its best size.
  5. Otherwise if there is no minimal size set, then the current size is used for the best size.
See also:
Window Sizing Overview
virtual void wxWindow::DoUpdateWindowUI ( wxUpdateUIEvent event  )  [virtual]

Does the window-specific updating after processing the update event.

This function is called by UpdateWindowUI() in order to check return values in the wxUpdateUIEvent and act appropriately. For example, to allow frame and dialog title updating, wxWidgets implements this function as follows:

        // do the window-specific processing after processing the update event
        void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
        {
            if ( event.GetSetEnabled() )
                Enable(event.GetEnabled());

            if ( event.GetSetText() )
            {
                if ( event.GetText() != GetTitle() )
                    SetTitle(event.GetText());
            }
        }
virtual void wxWindow::DragAcceptFiles ( bool  accept  )  [virtual]

Enables or disables eligibility for drop file events (OnDropFiles).

Parameters:
accept If true, the window is eligible for drop file events. If false, the window will not accept drop file events.
Remarks:
Windows only until version 2.8.9, available on all platforms since 2.8.10. Cannot be used together with SetDropTarget() on non-Windows platforms.
See also:
SetDropTarget()
virtual bool wxWindow::Enable ( bool  enable = true  )  [virtual]

Enable or disable the window for user input.

Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is.

Parameters:
enable If true, enables the window for input. If false, disables the window.
Returns:
Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.
See also:
IsEnabled(), Disable(), wxRadioBox::Enable
static wxWindow* wxWindow::FindFocus (  )  [static]

Finds the window or control which currently has the keyboard focus.

Remarks:
Note that this is a static function, so it can be called without needing a wxWindow pointer.
See also:
SetFocus(), HasFocus()
wxWindow* wxWindow::FindWindow ( const wxString name  )  const

Find a child of this window, by name.

May return this if it matches itself.

wxWindow* wxWindow::FindWindow ( long  id  )  const

Find a child of this window, by id.

May return this if it matches itself.

static wxWindow* wxWindow::FindWindowById ( long  id,
const wxWindow parent = 0 
) [static]

Find the first window with the given id.

If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

See also:
FindWindow()
static wxWindow* wxWindow::FindWindowByLabel ( const wxString label,
const wxWindow parent = 0 
) [static]

Find a window by its label.

Depending on the type of window, the label may be a window title or panel item label. If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

See also:
FindWindow()
static wxWindow* wxWindow::FindWindowByName ( const wxString name,
const wxWindow parent = 0 
) [static]

Find a window by its name (as given in a window constructor or Create() function call).

If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.

The search is recursive in both cases. If no window with such name is found, FindWindowByLabel() is called.

See also:
FindWindow()
virtual void wxWindow::Fit (  )  [virtual]

Sizes the window so that it fits around its subwindows.

This function won't do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout.

Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit() adds some margin to account for fuzziness of its calculations) to call:

        window->SetClientSize(child->GetSize());

instead of calling Fit().

See also:
Window Sizing Overview

Reimplemented in wxGrid.

virtual void wxWindow::FitInside (  )  [virtual]

Similar to Fit(), but sizes the interior (virtual) size of a window.

Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows.

void wxWindow::Freeze (  ) 

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

Thaw() must be called to reenable window redrawing. Calls to these two functions may be nested but to ensure that the window is properly repainted again, you must thaw it exactly as many times as you froze it.

If the window has any children, they are recursively frozen too.

This method is useful for visual appearance optimization (for example, it is a good idea to use it before doing many large text insertions in a row into a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWidgets and not a mandatory directive.

See also:
wxWindowUpdateLocker, Thaw(), IsFrozen()
wxAcceleratorTable* wxWindow::GetAcceleratorTable (  ) 

Gets the accelerator table for this window.

See wxAcceleratorTable.

wxAccessible* wxWindow::GetAccessible (  ) 

Returns the accessible object for this window, if any.

See also wxAccessible.

wxColour wxWindow::GetBackgroundColour (  )  const

Returns the background colour of the window.

See also:
SetBackgroundColour(), SetForegroundColour(), GetForegroundColour()
virtual wxBackgroundStyle wxWindow::GetBackgroundStyle (  )  const [virtual]

Returns the background style of the window.

See also:
SetBackgroundColour(), GetForegroundColour(), SetBackgroundStyle(), SetTransparent()
wxSize wxWindow::GetBestSize (  )  const

This functions returns the best acceptable minimal size for the window.

For example, for a static control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (typically wxPanel), the size returned by this function will be the same as the size the window would have had after calling Fit().

Note that when you write your own widget you need to overload the DoGetBestSize() function instead of this (non-virtual!) function.

See also:
CacheBestSize(), Window Sizing Overview

Reimplemented in wxMediaCtrl.

static wxWindow* wxWindow::GetCapture (  )  [static]
wxCaret* wxWindow::GetCaret (  )  const

Returns the caret() associated with the window.

virtual int wxWindow::GetCharHeight (  )  const [virtual]

Returns the character height for this window.

virtual int wxWindow::GetCharWidth (  )  const [virtual]

Returns the average character width for this window.

const wxWindowList& wxWindow::GetChildren (  )  const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

wxWindowList& wxWindow::GetChildren (  ) 

Returns a reference to the list of the window's children.

wxWindowList is a type-safe wxList-like class whose elements are of type wxWindow*.

static wxVisualAttributes wxWindow::GetClassDefaultAttributes ( wxWindowVariant  variant = wxWINDOW_VARIANT_NORMAL  )  [static]

Returns the default font and colours which are used by the control.

This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the users system, especially if it uses themes.

The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of the returned font. See SetWindowVariant() for more about this.

This static method is "overridden" in many derived classes and so calling, for example, wxButton::GetClassDefaultAttributes() will typically return the values appropriate for a button which will be normally different from those returned by, say, wxListCtrl::GetClassDefaultAttributes().

The wxVisualAttributes structure has at least the fields font, colFg and colBg. All of them may be invalid if it was not possible to determine the default control appearance or, especially for the background colour, if the field doesn't make sense as is the case for colBg for the controls with themed background.

See also:
InheritAttributes()
wxSize wxWindow::GetClientSize (  )  const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void wxWindow::GetClientSize ( int *  width,
int *  height 
) const

Returns the size of the window 'client area' in pixels.

The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc. Note that if this window is a top-level one and it is currently minimized, the return size is empty (both width and height are 0).

wxPerl Note: In wxPerl this method takes no parameters and returns a 2-element list (width, height).

See also:
GetSize(), GetVirtualSize()
wxLayoutConstraints* wxWindow::GetConstraints (  )  const

Returns a pointer to the window's layout constraints, or NULL if there are none.

wxSizer* wxWindow::GetContainingSizer (  )  const

Returns the sizer of which this window is a member, if any, otherwise NULL.

const wxCursor& wxWindow::GetCursor (  )  const

Return the cursor associated with this window.

See also:
SetCursor()
virtual wxVisualAttributes wxWindow::GetDefaultAttributes (  )  const [virtual]

Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

One advantage of using this function compared to the static version is that the call is automatically dispatched to the correct class (as usual with virtual functions) and you don't have to specify the class name explicitly.

The other one is that in the future this function could return different results, for example it might return a different font for an "Ok" button than for a generic button if the users GUI is configured to show such buttons in bold font. Of course, the down side is that it is impossible to call this function without actually having an object to apply it to whereas the static version can be used without having to create an object first.

virtual wxDropTarget* wxWindow::GetDropTarget (  )  const [virtual]

Returns the associated drop target, which may be NULL.

See also:
SetDropTarget(), Drag and Drop Overview
virtual wxSize wxWindow::GetEffectiveMinSize (  )  const [virtual]

Merges the window's best size into the min size and returns the result.

This is the value used by sizers to determine the appropriate amount of space to allocate for the widget.

This is the method called by a wxSizer when it queries the size of a window or control.

See also:
GetBestSize(), SetInitialSize(), Window Sizing Overview
wxEvtHandler* wxWindow::GetEventHandler (  )  const

Returns the event handler for this window.

By default, the window is its own event handler.

See also:
SetEventHandler(), PushEventHandler(), PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler
long wxWindow::GetExtraStyle (  )  const

Returns the extra style bits for the window.

wxFont wxWindow::GetFont (  )  const

Returns the font for this window.

See also:
SetFont()
wxColour wxWindow::GetForegroundColour (  )  const

Returns the foreground colour of the window.

Remarks:
The meaning of foreground colour varies according to the window class; it may be the text colour or other colour, or it may not be used at all.
See also:
SetForegroundColour(), SetBackgroundColour(), GetBackgroundColour()
wxWindow* wxWindow::GetGrandParent (  )  const

Returns the grandparent of a window, or NULL if there isn't one.

virtual WXWidget wxWindow::GetHandle (  )  const [virtual]

Returns the platform-specific handle of the physical window.

Cast it to an appropriate handle, such as HWND for Windows, Widget for Motif, GtkWidget for GTK or WinHandle for PalmOS.

wxPerl Note: This method will return an integer in wxPerl.

wxString wxWindow::GetHelpText (  )  const

Gets the help text to be used as context-sensitive help for this window.

Note that the text is actually stored by the current wxHelpProvider implementation, and not in the window object itself.

See also:
SetHelpText(), GetHelpTextAtPoint(), wxHelpProvider
virtual wxString wxWindow::GetHelpTextAtPoint ( const wxPoint point,
wxHelpEvent::Origin  origin 
) const [virtual]

Gets the help text to be used as context-sensitive help for this window.

This method should be overridden if the help message depends on the position inside the window, otherwise GetHelpText() can be used.

Parameters:
point Coordinates of the mouse at the moment of help event emission.
origin Help event origin, see also wxHelpEvent::GetOrigin.
wxWindowID wxWindow::GetId (  )  const

Returns the identifier of the window.

Remarks:
Each window has an integer identifier. If the application has not provided one (or the default wxID_ANY) a unique identifier with a negative value will be generated.
See also:
SetId(), Window IDs
virtual wxString wxWindow::GetLabel (  )  const [virtual]

Generic way of getting a label from any window, for identification purposes.

Remarks:
The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs (such as testing tools or special-needs access programs) which need to identify windows by name.

Reimplemented in wxButton, wxControl, and wxStaticText.

virtual wxLayoutDirection wxWindow::GetLayoutDirection (  )  const [virtual]

Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.

virtual wxSize wxWindow::GetMaxClientSize (  )  const [virtual]

Returns the maximum size of window's client area.

This is an indication to the sizer layout mechanism that this is the maximum possible size as well as the upper bound on window's size settable using SetClientSize().

See also:
GetMaxSize(), Window Sizing Overview
virtual wxSize wxWindow::GetMaxSize (  )  const [virtual]

Returns the maximum size of the window.

This is an indication to the sizer layout mechanism that this is the maximum possible size as well as the upper bound on window's size settable using SetSize().

See also:
GetMaxClientSize(), Window Sizing Overview
virtual wxSize wxWindow::GetMinClientSize (  )  const [virtual]

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.

It normally just returns the value set by SetMinClientSize(), but it can be overridden to do the calculation on demand.

See also:
GetMinSize(), Window Sizing Overview
virtual wxSize wxWindow::GetMinSize (  )  const [virtual]

Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

This method normally just returns the value set by SetMinSize(), but it can be overridden to do the calculation on demand.

See also:
GetMinClientSize(), Window Sizing Overview
virtual wxString wxWindow::GetName (  )  const [virtual]

Returns the window's name.

Remarks:
This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via SetName().
See also:
SetName()
wxWindow* wxWindow::GetNextSibling (  )  const

Returns the next window after this one among the parent's children or NULL if this window is the last child.

Since:
2.8.8
See also:
GetPrevSibling()
wxWindow* wxWindow::GetParent (  )  const

Returns the parent of the window, or NULL if there is no parent.

int wxWindow::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.

int wxWindow::GetPopupMenuSelectionFromUser ( wxMenu menu,
const wxPoint pos 
)

This function shows a popup menu at the given position in this window and returns the selected id.

It can be more convenient than the general purpose PopupMenu() function for simple menus proposing a choice in a list of strings to the user.

Notice that to avoid unexpected conflicts between the (usually consecutive range of) ids used by the menu passed to this function and the existing EVT_UPDATE_UI() handlers, this function temporarily disables UI updates for the window, so you need to manually disable (or toggle or ...) any items which should be disabled in the menu before showing it.

The parameter menu is the menu to show. The parameter pos (or the parameters x and y) is the position at which to show the menu in client coordinates.

Returns:
The selected menu item id or wxID_NONE if none selected or an error occurred.
Since:
2.9.0
wxPoint wxWindow::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.

See also:
GetScreenPosition()
void wxWindow::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.

Parameters:
x Receives the x position of the window if non-NULL.
y Receives the y position of the window if non-NULL.

wxPerl Note: In wxPerl this method is implemented as GetPositionXY() returning a 2-element list (x, y).

See also:
GetScreenPosition()
wxWindow* wxWindow::GetPrevSibling (  )  const

Returns the previous window before this one among the parent's children or NULL if this window is the first child.

Since:
2.8.8
See also:
GetNextSibling()
wxRect wxWindow::GetRect (  )  const

Returns the position and size of the window as a wxRect object.

See also:
GetScreenRect()
wxPoint wxWindow::GetScreenPosition (  )  const

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

See also:
GetPosition()
void wxWindow::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.

Parameters:
x Receives the x position of the window on the screen if non-NULL.
y Receives the y position of the window on the screen if non-NULL.
See also:
GetPosition()
wxRect wxWindow::GetScreenRect (  )  const

Returns the position and size of the window on the screen as a wxRect object.

See also:
GetRect()
virtual int wxWindow::GetScrollPos ( int  orientation  )  const [virtual]

Returns the built-in scrollbar position.

See also:
SetScrollbar()
virtual int wxWindow::GetScrollRange ( int  orientation  )  const [virtual]

Returns the built-in scrollbar range.

See also:
SetScrollbar()
virtual int wxWindow::GetScrollThumb ( int  orientation  )  const [virtual]

Returns the built-in scrollbar thumb size.

See also:
SetScrollbar()
wxSize wxWindow::GetSize (  )  const

See the GetSize(int*,int*) overload for more info.

void wxWindow::GetSize ( int *  width,
int *  height 
) const

Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

Note that if this window is a top-level one and it is currently minimized, the returned size is the restored window size, not the size of the window icon.

Parameters:
width Receives the window width.
height Receives the window height.

wxPerl Note: In wxPerl this method is implemented as GetSizeWH() returning a 2-element list (width, height).

See also:
GetClientSize(), GetVirtualSize(), Window Sizing Overview
wxSizer* wxWindow::GetSizer (  )  const

Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

wxSize wxWindow::GetTextExtent ( const wxString string  )  const

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

void wxWindow::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.

The text extent is returned in the w and h pointers.

Parameters:
string String whose extent is to be measured.
w Return value for width.
h Return value for height.
descent Return value for descent (optional).
externalLeading Return value for external leading (optional).
font Font to use instead of the current window font (optional).

wxPerl Note: In wxPerl this method takes only the string and optionally font parameters, and returns a 4-element list (x, y, descent, externalLeading).

wxToolTip* wxWindow::GetToolTip (  )  const

Get the associated tooltip or NULL if none.

wxString wxWindow::GetToolTipText (  )  const

Get the text of the associated tooltip or empty string if none.

const wxRegion& wxWindow::GetUpdateRegion (  )  const

Returns the region specifying which parts of the window have been damaged.

Should only be called within an wxPaintEvent handler.

See also:
wxRegion, wxRegionIterator
virtual wxValidator* wxWindow::GetValidator (  )  [virtual]

Validator functions.

Returns a pointer to the current validator for the window, or NULL if there is none.

void wxWindow::GetVirtualSize ( int *  width,
int *  height 
) const

Like the other GetVirtualSize() overload but uses pointers instead.

Parameters:
width Receives the window virtual width.
height Receives the window virtual height.

Reimplemented in wxScrolled< wxPanel >.

wxSize wxWindow::GetVirtualSize (  )  const

This gets the virtual size of the window in pixels.

By default it returns the client size of the window, but after a call to SetVirtualSize() it will return the size set with that method.

See also:
Window Sizing Overview
virtual wxSize wxWindow::GetWindowBorderSize (  )  const [virtual]

Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

long wxWindow::GetWindowStyle (  )  const

See GetWindowStyleFlag() for more info.

virtual long wxWindow::GetWindowStyleFlag (  )  const [virtual]

Gets the window style that was passed to the constructor or Create() method.

GetWindowStyle() is another name for the same function.

wxWindowVariant wxWindow::GetWindowVariant (  )  const

Returns the value previously passed to SetWindowVariant().

bool wxWindow::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.

Returns:
Returns true if the key pressed was for navigation and was handled, false otherwise.
See also:
Navigate()
bool wxWindow::HandleWindowEvent ( wxEvent event  )  const

Shorthand for:.

See also:
ProcessWindowEvent()
virtual bool wxWindow::HasCapture (  )  const [virtual]

Returns true if this window has the current mouse capture.

See also:
CaptureMouse(), ReleaseMouse(), wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent
bool wxWindow::HasExtraStyle ( int  exFlag  )  const

Returns true if the window has the given exFlag bit set in its extra styles.

See also:
SetExtraStyle()
bool wxWindow::HasFlag ( int  flag  )  const

Returns true if the window has the given flag bit set.

virtual bool wxWindow::HasFocus (  )  const [virtual]

Returns true if the window (or in case of composite controls, its main child window) has focus.

See also:
FindFocus()
virtual bool wxWindow::HasMultiplePages (  )  const [virtual]

This method should be overridden to return true if this window has multiple pages.

All standard class with multiple pages such as wxNotebook, wxListbook and wxTreebook already override it to return true and user-defined classes with similar behaviour should also do so, to allow the library to handle such windows appropriately.

bool wxWindow::HasScrollbar ( int  orient  )  const

Returns true if this window currently has a scroll bar for this orientation.

This method may return false even when CanScroll() for the same orientation returns true, but if CanScroll() returns false, i.e. scrolling in this direction is not enabled at all, HasScrollbar() always returns false as well.

Parameters:
orient Orientation to check, either wxHORIZONTAL or wxVERTICAL.
virtual bool wxWindow::HasTransparentBackground (  )  [virtual]

Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background.

This method is mostly used internally by the library itself and you normally shouldn't have to call it. You may, however, have to override it in your wxWindow-derived class to ensure that background is painted correctly.

bool wxWindow::Hide (  ) 

Equivalent to calling wxWindow::Show(false).

virtual bool wxWindow::HideWithEffect ( wxShowEffect  effect,
unsigned int  timeout = 0 
) [virtual]

This function hides a window, like Hide(), but using a special visual effect if possible.

The parameters of this function are the same as for ShowWithEffect(), please see their description there.

Since:
2.9.0
virtual void wxWindow::InheritAttributes (  )  [virtual]

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.

By "intelligently" the following is meant: by default, all windows use their own GetClassDefaultAttributes() default attributes. However if some of the parents attributes are explicitly (that is, using SetFont() and not wxWindow::SetOwnFont) changed and if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if the window overrides ShouldInheritColours() to return false, the colours will not be changed no matter what and only the font might.

This rather complicated logic is necessary in order to accommodate the different usage scenarios. The most common one is when all default attributes are used and in this case, nothing should be inherited as in modern GUIs different controls use different fonts (and colours) than their siblings so they can't inherit the same value from the parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes.

virtual void wxWindow::InitDialog (  )  [virtual]

Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.

Reimplemented in wxPanel.

void wxWindow::InvalidateBestSize (  ) 

Resets the cached best size value so it will be recalculated the next time it is needed.

See also:
CacheBestSize()
bool wxWindow::IsBeingDeleted (  )  const

Returns true if this window is in process of being destroyed.

Top level windows are not deleted immediately but are rather scheduled for later destruction to give them time to process any pending messages; see Destroy() description.

This function returns true if this window, or one of its parent windows, is scheduled for destruction and can be useful to avoid manipulating it as it's usually useless to do something with a window which is on the point of disappearing anyhow.

virtual bool wxWindow::IsDoubleBuffered (  )  const [virtual]

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.

See also:
wxBufferedDC
bool wxWindow::IsEnabled (  )  const

Returns true if the window is enabled, i.e.

if it accepts user input, false otherwise.

Notice that this method can return false even if this window itself hadn't been explicitly disabled when one of its parent windows is disabled. To get the intrinsic status of this window, use IsThisEnabled()

See also:
Enable()
bool wxWindow::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.

bool wxWindow::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 wxWindow::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 wxWindow::IsExposed ( int  x,
int  y 
) const

Returns true if the given point or rectangle area has been exposed since the last repaint.

Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.

bool wxWindow::IsFrozen (  )  const

Returns true if the window is currently frozen by a call to Freeze().

See also:
Freeze(), Thaw()

Reimplemented in wxPropertyGridManager, and wxPropertyGrid.

virtual bool wxWindow::IsRetained (  )  const [virtual]

Returns true if the window is retained, false otherwise.

Remarks:
Retained windows are only available on X platforms.

Reimplemented in wxScrolled< wxPanel >.

virtual bool wxWindow::IsScrollbarAlwaysShown ( int  orient  )  const [virtual]

Return whether a scrollbar is always shown.

Parameters:
orient Orientation to check, either wxHORIZONTAL or wxVERTICAL.
See also:
AlwaysShowScrollbars()
virtual bool wxWindow::IsShown (  )  const [virtual]

Returns true if the window is shown, false if it has been hidden.

See also:
IsShownOnScreen()
virtual bool wxWindow::IsShownOnScreen (  )  const [virtual]

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.

See also:
IsShown()
bool wxWindow::IsThisEnabled (  )  const

Returns true if this window is intrinsically enabled, false otherwise, i.e.

if Enable() Enable(false) had been called. This method is mostly used for wxWidgets itself, user code should normally use IsEnabled() instead.

virtual bool wxWindow::IsTopLevel (  )  const [virtual]

Returns true if the given window is a top-level one.

Currently all frames and dialogs are considered to be top-level windows (even if they have a parent window).

virtual bool wxWindow::Layout (  )  [virtual]

Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window.

This function does not get called automatically when the window is resized because lots of windows deriving from wxWindow does not need this functionality. If you want to have Layout() called automatically, you should derive from wxPanel (see wxPanel::Layout).

See also:
Window Sizing Overview

Reimplemented in wxPanel, and wxTopLevelWindow.

bool wxWindow::LineDown (  ) 

Same as ScrollLines (1).

Reimplemented in wxStyledTextCtrl.

bool wxWindow::LineUp (  ) 

Same as ScrollLines (-1).

Reimplemented in wxStyledTextCtrl.

virtual void wxWindow::Lower (  )  [virtual]

Lowers the window to the bottom of the window hierarchy (Z-order).

Remarks:
This function only works for wxTopLevelWindow-derived classes.
See also:
Raise()
virtual void wxWindow::MakeModal ( bool  modal = true  )  [virtual]

Disables all other windows in the application so that the user can only interact with this window.

Parameters:
modal If true, this call disables all other windows in the application so that the user can only interact with this window. If false, the effect is reversed.
void wxWindow::Move ( const wxPoint pt,
int  flags = wxSIZE_USE_EXISTING 
)

Moves the window to the given position.

Parameters:
pt wxPoint object representing the position.
flags See SetSize() for more info about this parameter.
Remarks:
Implementations of SetSize() can also implicitly implement the Move() function, which is defined in the base wxWindow class as the call:
                 SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING);
See also:
SetSize()
void wxWindow::Move ( int  x,
int  y,
int  flags = wxSIZE_USE_EXISTING 
)

Moves the window to the given position.

Parameters:
x Required x position.
y Required y position.
flags See SetSize() for more info about this parameter.
Remarks:
Implementations of SetSize can also implicitly implement the Move() function, which is defined in the base wxWindow class as the call:
                 SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING);
See also:
SetSize()
void wxWindow::MoveAfterInTabOrder ( wxWindow win  ) 

Moves this window in the tab navigation order after the specified win.

This means that when the user presses TAB key on that other window, the focus switches to this window.

Default tab order is the same as creation order, this function and MoveBeforeInTabOrder() allow to change it after creating all the windows.

Parameters:
win A sibling of this window which should precede it in tab order, must not be NULL
void wxWindow::MoveBeforeInTabOrder ( wxWindow win  ) 

Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

bool wxWindow::Navigate ( int  flags = IsForward  ) 

Performs a keyboard navigation action starting from this window.

This method is equivalent to calling NavigateIn() method on the parent window.

Parameters:
flags A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.
Returns:
Returns true if the focus was moved to another window or false if nothing changed.
Remarks:
You may wish to call this from a text control custom keypress handler to do the default navigation behaviour for the tab key, since the standard default behaviour for a multiline text control with the wxTE_PROCESS_TAB style is to insert a tab and not navigate to the next control. See also wxNavigationKeyEvent and HandleAsNavigationKey.
bool wxWindow::NavigateIn ( int  flags = IsForward  ) 

Performs a keyboard navigation action inside this window.

See Navigate() for more information.

static wxWindowID wxWindow::NewControlId ( int  count = 1  )  [static]

Create a new ID or range of IDs that are not currently in use.

The IDs will be reserved until assigned to a wxWindow ID or unreserved with UnreserveControlId().

See Window IDs for more information.

Parameters:
count The number of sequential IDs to reserve.
Returns:
Returns the ID or the first ID of the range (i.e. the most negative), or wxID_NONE if the specified number of identifiers couldn't be allocated.
See also:
UnreserveControlId(), wxIdManager, Window IDs
virtual void wxWindow::OnInternalIdle (  )  [virtual]

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.

This function may be used to do delayed painting, for example, and most implementations call UpdateWindowUI() in order to send update events to the window in idle time.

bool wxWindow::PageDown (  ) 

Same as ScrollPages (1).

Reimplemented in wxStyledTextCtrl.

bool wxWindow::PageUp (  ) 

Same as ScrollPages (-1).

Reimplemented in wxStyledTextCtrl.

wxEvtHandler* wxWindow::PopEventHandler ( bool  deleteHandler = false  ) 

Removes and returns the top-most event handler on the event handler stack.

E.g. in the case of:

overview_events_winstack.png

when calling W->PopEventHandler(), the event handler A will be removed and B will be the first handler of the stack.

Note that it's an error to call this function when no event handlers were pushed on this window (i.e. when the window itself is its only event handler).

Parameters:
deleteHandler If this is true, the handler will be deleted after it is removed (and the returned value will be NULL).
See also:
How Events are Processed
bool wxWindow::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.

bool wxWindow::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.

If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If coordinates are not specified, the current mouse cursor position is used.

menu is the menu to pop up.

The position where the menu will appear can be specified either as a wxPoint pos or by two integers (x and y).

Remarks:
Just before the menu is popped up, wxMenu::UpdateUI is called to ensure that the menu items are in the correct state. The menu does not get deleted by the window. It is recommended to not explicitly specify coordinates when calling PopupMenu in response to mouse click, because some of the ports (namely, wxGTK) can do a better job of positioning the menu in that case.
See also:
wxMenu
void wxWindow::PostSizeEvent (  ) 

Posts a size event to the window.

This is the same as SendSizeEvent() with wxSEND_EVENT_POST argument.

void wxWindow::PostSizeEventToParent (  ) 

Posts a size event to the parent of this window.

This is the same as SendSizeEventToParent() with wxSEND_EVENT_POST argument.

virtual bool wxWindow::ProcessEvent ( wxEvent event  )  [protected, virtual]

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.

For convenience, a ProcessWindowEvent() method is provided as a synonym for

Note that it's still possible to call these functions directly on the wxWindow object (e.g. casting it to wxEvtHandler) but doing that will create subtle bugs when windows with event handlers pushed on them are involved.

This holds also for all other wxEvtHandler functions.

Reimplemented from wxEvtHandler.

void wxWindow::ProcessPendingEvents (  )  [protected]

Validator functions.

Returns a pointer to the current validator for the window, or NULL if there is none.

Reimplemented from wxEvtHandler.

bool wxWindow::ProcessThreadEvent ( const wxEvent event  )  [protected]

Validator functions.

Returns a pointer to the current validator for the window, or NULL if there is none.

bool wxWindow::ProcessWindowEvent ( wxEvent event  ) 

Convenient wrapper for ProcessEvent().

This is the same as writing

but more convenient. Notice that ProcessEvent() itself can't be called for wxWindow objects as it ignores the event handlers associated with the window; use this function instead.

void wxWindow::PushEventHandler ( wxEvtHandler handler  ) 

Pushes this event handler onto the event stack for the window.

An event handler is an object that is capable of processing the events sent to a window. By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes.

wxWindow::PushEventHandler allows an application to set up a stack of event handlers, where an event not handled by one event handler is handed to the next one in the chain.

E.g. if you have two event handlers A and B and a wxWindow instance W and you call:

            W->PushEventHandler(A);
            W->PushEventHandler(B);

you will end up with the following situation:

overview_events_winstack.png

Note that you can use wxWindow::PopEventHandler to remove the event handler.

Parameters:
handler Specifies the handler to be pushed. It must not be part of a wxEvtHandler chain; an assert will fail if it's not unlinked (see wxEvtHandler::IsUnlinked).
See also:
How Events are Processed
virtual void wxWindow::QueueEvent ( wxEvent event  )  [protected, virtual]

Validator functions.

Returns a pointer to the current validator for the window, or NULL if there is none.

Reimplemented from wxEvtHandler.

virtual void wxWindow::Raise (  )  [virtual]

Raises the window to the top of the window hierarchy (Z-order).

Remarks:
This function only works for wxTopLevelWindow-derived classes.
See also:
Lower()
virtual void wxWindow::Refresh ( bool  eraseBackground = true,
const wxRect rect = NULL 
) [virtual]

Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

Note that repainting doesn't happen immediately but only during the next event loop iteration, if you need to update the window immediately you should use Update() instead.

Parameters:
eraseBackground If true, the background will be erased.
rect If non-NULL, only the given rectangle will be treated as damaged.
See also:
RefreshRect()

Reimplemented in wxMenuBar.

void wxWindow::RefreshRect ( const wxRect rect,
bool  eraseBackground = true 
)

Redraws the contents of the given rectangle: only the area inside it will be repainted.

This is the same as Refresh() but has a nicer syntax as it can be called with a temporary wxRect object as argument like this RefreshRect(wxRect(x, y, w, h)).

virtual bool wxWindow::RegisterHotKey ( int  hotkeyId,
int  modifiers,
int  virtualKeyCode 
) [virtual]

Registers a system wide hotkey.

Every time the user presses the hotkey registered here, this window will receive a hotkey event.

It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application.

Parameters:
hotkeyId Numeric identifier of the hotkey. For applications this must be between 0 and 0xBFFF. If this function is called from a shared DLL, it must be a system wide unique identifier between 0xC000 and 0xFFFF. This is a MSW specific detail.
modifiers A bitwise combination of wxMOD_SHIFT, wxMOD_CONTROL, wxMOD_ALT or wxMOD_WIN specifying the modifier keys that have to be pressed along with the key.
virtualKeyCode The virtual key code of the hotkey.
Returns:
true if the hotkey was registered successfully. false if some other application already registered a hotkey with this modifier/virtualKeyCode combination.
Remarks:
Use EVT_HOTKEY(hotkeyId, fnc) in the event table to capture the event. This function is currently only implemented under Windows. It is used in the Windows CE port for detecting hardware button presses.
See also:
UnregisterHotKey()
void wxWindow::ReleaseMouse (  ) 
virtual void wxWindow::RemoveChild ( wxWindow child  )  [virtual]

Removes a child window.

This is called automatically by window deletion functions so should not be required by the application programmer. Notice that this function is mostly internal to wxWidgets and shouldn't be called by the user code.

Parameters:
child Child window to remove.
bool wxWindow::RemoveEventHandler ( wxEvtHandler handler  ) 

Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

See wxEvtHandler::Unlink() for more info.

Parameters:
handler The event handler to remove, must be non-NULL and must be present in this windows event handlers stack.
Returns:
Returns true if it was found and false otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there).
See also:
PushEventHandler(), PopEventHandler()
virtual bool wxWindow::Reparent ( wxWindow newParent  )  [virtual]

Reparents the window, i.e the window will be removed from its current parent window (e.g.

a non-standard toolbar in a wxFrame) and then re-inserted into another.

Parameters:
newParent New parent.
bool wxWindow::SafelyProcessEvent ( wxEvent event  )  [protected]

See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.

Reimplemented from wxEvtHandler.

wxPoint wxWindow::ScreenToClient ( const wxPoint pt  )  const

Converts from screen to client window coordinates.

Parameters:
pt The screen position.
void wxWindow::ScreenToClient ( int *  x,
int *  y 
) const

Converts from screen to client window coordinates.

Parameters:
x Stores the screen x coordinate and receives the client x coordinate.
y Stores the screen x coordinate and receives the client x coordinate.
virtual bool wxWindow::ScrollLines ( int  lines  )  [virtual]

Scrolls the window by the given number of lines down (if lines is positive) or up.

Returns:
Returns true if the window was scrolled, false if it was already on top/bottom and nothing was done.
Remarks:
This function is currently only implemented under MSW and wxTextCtrl under wxGTK (it also works for wxScrolled classes under all platforms).
See also:
ScrollPages()

Reimplemented in wxRibbonGallery, and wxRibbonPage.

virtual bool wxWindow::ScrollPages ( int  pages  )  [virtual]

Scrolls the window by the given number of pages down (if pages is positive) or up.

Returns:
Returns true if the window was scrolled, false if it was already on top/bottom and nothing was done.
Remarks:
This function is currently only implemented under MSW and wxGTK.
See also:
ScrollLines()
virtual void wxWindow::ScrollWindow ( int  dx,
int  dy,
const wxRect rect = NULL 
) [virtual]

Physically scrolls the pixels in the window and move child windows accordingly.

Parameters:
dx Amount to scroll horizontally.
dy Amount to scroll vertically.
rect Rectangle to scroll, if it is NULL, the whole window is scrolled (this is always the case under wxGTK which doesn't support this parameter)
Remarks:
Note that you can often use wxScrolled instead of using this function directly.
void wxWindow::SendDestroyEvent (  )  [protected]

Generate wxWindowDestroyEvent for this window.

This is called by the window itself when it is being destroyed and usually there is no need to call it but see wxWindowDestroyEvent for explanations of when you might want to do it.

virtual void wxWindow::SendSizeEvent ( int  flags = 0  )  [virtual]

This function sends a dummy size event to the window allowing it to re-layout its children positions.

It is sometimes useful to call this function after adding or deleting a children after the frame creation or if a child size changes. Note that if the frame is using either sizers or constraints for the children layout, it is enough to call wxWindow::Layout() directly and this function should not be used in this case.

If flags includes wxSEND_EVENT_POST value, this function posts the event, i.e. schedules it for later processing, instead of dispatching it directly. You can also use PostSizeEvent() as a more readable equivalent of calling this function with this flag.

Parameters:
flags May include wxSEND_EVENT_POST. Default value is 0.
void wxWindow::SendSizeEventToParent ( int  flags = 0  ) 

Safe wrapper for GetParent()->SendSizeEvent().

This function simply checks that the window has a valid parent which is not in process of being deleted and calls SendSizeEvent() on it. It is used internally by windows such as toolbars changes to whose state should result in parent re-layout (e.g. when a toolbar is added to the top of the window, all the other windows must be shifted down).

See also:
PostSizeEventToParent()
Parameters:
flags See description of this parameter in SendSizeEvent() documentation.
virtual void wxWindow::SetAcceleratorTable ( const wxAcceleratorTable accel  )  [virtual]

Sets the accelerator table for this window.

See wxAcceleratorTable.

void wxWindow::SetAccessible ( wxAccessible accessible  ) 

Sets the accessible for this window.

Any existing accessible for this window will be deleted first, if not identical to accessible. See also wxAccessible.

void wxWindow::SetAutoLayout ( bool  autoLayout  ) 

Determines whether the Layout() function will be called automatically when the window is resized.

This method is called implicitly by SetSizer() but if you use SetConstraints() you should call it manually or otherwise the window layout won't be correctly updated when its size changes.

Parameters:
autoLayout Set this to true if you wish the Layout() function to be called automatically when the window is resized.
See also:
SetSizer(), SetConstraints()
virtual bool wxWindow::SetBackgroundColour ( const wxColour colour  )  [virtual]

Sets the background colour of the window.

Please see InheritAttributes() for explanation of the difference between this method and SetOwnBackgroundColour().

Parameters:
colour The colour to be used as the background colour; pass wxNullColour to reset to the default colour.
Remarks:
The background colour is usually painted by the default wxEraseEvent event handler function under Windows and automatically under GTK. Note that setting the background colour does not cause an immediate refresh, so you may wish to call wxWindow::ClearBackground or wxWindow::Refresh after calling this function. Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system.
Returns:
true if the colour was really changed, false if it was already set to this colour and nothing was done.
See also:
GetBackgroundColour(), SetForegroundColour(), GetForegroundColour(), ClearBackground(), Refresh(), wxEraseEvent

Reimplemented in wxListCtrl.

virtual bool wxWindow::SetBackgroundStyle ( wxBackgroundStyle  style  )  [virtual]

Sets the background style of the window.

The default background style is wxBG_STYLE_ERASE which indicates that the window background may be erased in EVT_ERASE_BACKGROUND handler. This is a safe, compatibility default; however you may want to change it to wxBG_STYLE_SYSTEM if you don't define any erase background event handlers at all, to avoid unnecessary generation of erase background events and always let system erase the background. And you should change the background style to wxBG_STYLE_PAINT if you define an EVT_PAINT handler which completely overwrites the window background as in this case erasing it previously, either in EVT_ERASE_BACKGROUND handler or in the system default handler, would result in flicker as the background pixels will be repainted twice every time the window is redrawn. Do ensure that the background is entirely erased by your EVT_PAINT handler in this case however as otherwise garbage may be left on screen.

Notice that in previous versions of wxWidgets a common way to work around the above mentioned flickering problem was to define an empty EVT_ERASE_BACKGROUND handler. Setting background style to wxBG_STYLE_PAINT is a simpler and more efficient solution to the same problem.

See also:
SetBackgroundColour(), GetForegroundColour(), SetTransparent()
virtual void wxWindow::SetCanFocus ( bool  canFocus  )  [virtual]

This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0).

It is called by wxWidgets' container control code to give the native system a hint when doing TAB traversal. A call to this does not disable or change the effect of programmatically calling SetFocus().

See also:
wxFocusEvent, wxPanel::SetFocus, wxPanel::SetFocusIgnoringChildren
void wxWindow::SetCaret ( wxCaret caret  ) 

Sets the caret() associated with the window.

virtual void wxWindow::SetClientSize ( const wxSize size  )  [virtual]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual void wxWindow::SetClientSize ( int  width,
int  height 
) [virtual]

This sets the size of the window client area in pixels.

Using this function to size a window tends to be more device-independent than SetSize(), since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.

See also:
Window Sizing Overview
void wxWindow::SetConstraints ( wxLayoutConstraints *  constraints  ) 

Sets the window to have the given layout constraints.

The window will then own the object, and will take care of its deletion. If an existing layout constraints object is already owned by the window, it will be deleted.

Parameters:
constraints The constraints to set. Pass NULL to disassociate and delete the window's constraints.
Remarks:
You must call SetAutoLayout() to tell a window to use the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout() explicitly. When setting both a wxLayoutConstraints and a wxSizer, only the sizer will have effect.
void wxWindow::SetContainingSizer ( wxSizer sizer  ) 

This normally does not need to be called by user code.

It is called when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed.

virtual bool wxWindow::SetCursor ( const wxCursor cursor  )  [virtual]

Sets the window's cursor.

Notice that the window cursor also sets it for the children of the window implicitly.

The cursor may be wxNullCursor in which case the window cursor will be reset back to default.

Parameters:
cursor Specifies the cursor that the window should normally display.
See also:
wxSetCursor, wxCursor
virtual void wxWindow::SetDropTarget ( wxDropTarget target  )  [virtual]

Associates a drop target with this window.

If the window already has a drop target, it is deleted.

See also:
GetDropTarget(), Drag and Drop Overview
void wxWindow::SetEventHandler ( wxEvtHandler handler  ) 

Sets the event handler for this window.

Note that if you use this function you may want to use as the "next" handler of handler the window itself; in this way when handler doesn't process an event, the window itself will have a chance to do it.

Parameters:
handler Specifies the handler to be set. Cannot be NULL.
See also:
How Events are Processed
virtual void wxWindow::SetExtraStyle ( long  exStyle  )  [virtual]

Sets the extra style bits for the window.

The currently defined extra style bits are reported in the class description.

virtual void wxWindow::SetFocus (  )  [virtual]

This sets the window to receive keyboard input.

See also:
HasFocus(), wxFocusEvent, wxPanel::SetFocus, wxPanel::SetFocusIgnoringChildren

Reimplemented in wxPanel.

virtual void wxWindow::SetFocusFromKbd (  )  [virtual]

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

using TAB key).

By default this method simply calls SetFocus() but can be overridden to do something in addition to this in the derived classes.

virtual bool wxWindow::SetFont ( const wxFont font  )  [virtual]

Sets the font for this window.

This function should not be called for the parent window if you don't want its font to be inherited by its children, use SetOwnFont() instead in this case and see InheritAttributes() for more explanations.

Please notice that the given font is not automatically used for wxPaintDC objects associated with this window, you need to call wxDC::SetFont too. However this font is used by any standard controls for drawing their text as well as by GetTextExtent().

Parameters:
font Font to associate with this window, pass wxNullFont to reset to the default font.
Returns:
true if the font was really changed, false if it was already set to this font and nothing was done.
See also:
GetFont(), InheritAttributes()

Reimplemented in wxAuiNotebook, and wxInfoBar.

virtual bool wxWindow::SetForegroundColour ( const wxColour colour  )  [virtual]

Sets the foreground colour of the window.

Please see InheritAttributes() for explanation of the difference between this method and SetOwnForegroundColour().

Parameters:
colour The colour to be used as the foreground colour; pass wxNullColour to reset to the default colour.
Remarks:
The meaning of foreground colour varies according to the window class; it may be the text colour or other colour, or it may not be used at all.
Returns:
true if the colour was really changed, false if it was already set to this colour and nothing was done.
See also:
GetForegroundColour(), SetBackgroundColour(), GetBackgroundColour(), ShouldInheritColours()
void wxWindow::SetHelpText ( const wxString helpText  ) 

Sets the help text to be used as context-sensitive help for this window.

Note that the text is actually stored by the current wxHelpProvider implementation, and not in the window object itself.

See also:
GetHelpText(), wxHelpProvider::AddHelp()
void wxWindow::SetId ( wxWindowID  winid  ) 

Sets the identifier of the window.

Remarks:
Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
See also:
GetId(), Window IDs
virtual void wxWindow::SetInitialBestSize ( const wxSize size  )  [protected, virtual]

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

Deprecated:
Todo:
provide deprecation description
void wxWindow::SetInitialSize ( const wxSize size = wxDefaultSize  ) 

A smart SetSize that will fill in default size components with the window's best size values.

Also sets the window's minsize to the value passed in for use with sizers. This means that if a full or partial size is passed to this function then the sizers will use that size instead of the results of GetBestSize() to determine the minimum needs of the window for layout.

Most controls will use this to set their initial size, and their min size to the passed in value (if any.)

See also:
SetSize(), GetBestSize(), GetEffectiveMinSize(), Window Sizing Overview
virtual void wxWindow::SetLabel ( const wxString label  )  [virtual]

Sets the window's label.

Parameters:
label The window label.
See also:
GetLabel()

Reimplemented in wxButton, wxControl, and wxStaticText.

virtual void wxWindow::SetLayoutDirection ( wxLayoutDirection  dir  )  [virtual]

Sets the layout direction for this window.

virtual void wxWindow::SetMaxClientSize ( const wxSize size  )  [virtual]

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.

Note that this method is just a shortcut for:

See also:
SetMaxSize(), Window Sizing Overview
virtual void wxWindow::SetMaxSize ( const wxSize size  )  [virtual]

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

See also:
SetMaxClientSize(), Window Sizing Overview

Reimplemented in wxTopLevelWindow.

virtual void wxWindow::SetMinClientSize ( const wxSize size  )  [virtual]

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.

You may need to call this if you change the window size after construction and before adding to its parent sizer.

Note, that just as with SetMinSize(), calling this method doesn't prevent the program from explicitly making the window smaller than the specified size.

Note that this method is just a shortcut for:

See also:
SetMinSize(), Window Sizing Overview
virtual void wxWindow::SetMinSize ( const wxSize size  )  [virtual]

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

You may need to call this if you change the window size after construction and before adding to its parent sizer.

Notice that calling this method doesn't prevent the program from making the window explicitly smaller than the specified size by calling SetSize(), it just ensures that it won't become smaller than this size during the automatic layout.

See also:
SetMinClientSize(), Window Sizing Overview

Reimplemented in wxTopLevelWindow.

virtual void wxWindow::SetName ( const wxString name  )  [virtual]

Sets the window's name.

Parameters:
name A name to set for the window.
See also:
GetName()
virtual void wxWindow::SetNextHandler ( wxEvtHandler handler  )  [virtual]

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

Note that instead you can use PushEventHandler() or SetEventHandler() to implement a stack of event handlers to override wxWindow's own event handling mechanism.

void wxWindow::SetOwnBackgroundColour ( const wxColour colour  ) 

Sets the background colour of the window but prevents it from being inherited by the children of this window.

See also:
SetBackgroundColour(), InheritAttributes()
void wxWindow::SetOwnFont ( const wxFont font  ) 

Sets the font of the window but prevents it from being inherited by the children of this window.

See also:
SetFont(), InheritAttributes()
void wxWindow::SetOwnForegroundColour ( const wxColour colour  ) 

Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

See also:
SetForegroundColour(), InheritAttributes()
void wxWindow::SetPalette ( const wxPalette pal  ) 
virtual void wxWindow::SetPreviousHandler ( wxEvtHandler handler  )  [virtual]

wxWindows cannot be used to form event handler chains; this function thus will assert when called.

Note that instead you can use PushEventHandler() or SetEventHandler() to implement a stack of event handlers to override wxWindow's own event handling mechanism.

virtual void wxWindow::SetScrollbar ( int  orientation,
int  position,
int  thumbSize,
int  range,
bool  refresh = true 
) [virtual]

Sets the scrollbar properties of a built-in scrollbar.

Parameters:
orientation Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
position The position of the scrollbar in scroll units.
thumbSize The size of the thumb, or visible portion of the scrollbar, in scroll units.
range The maximum position of the scrollbar. Value of -1 can be used to ask for the scrollbar to be shown but in the disabled state: this can be used to avoid removing the scrollbar even when it is not needed (currently this is only implemented in wxMSW port).
refresh true to redraw the scrollbar, false otherwise.
Remarks:
Let's say you wish to display 50 lines of text, using the same font. The window is sized so that you can only see 16 lines at a time. You would use:
            SetScrollbar(wxVERTICAL, 0, 16, 50);
Note that with the window at this size, the thumb position can never go above 50 minus 16, or 34. You can determine how many lines are currently visible by dividing the current view size by the character height in pixels. When defining your own scrollbar behaviour, you will always need to recalculate the scrollbar settings when the window size changes. You could therefore put your scrollbar calculations and SetScrollbar call into a function named AdjustScrollbars, which can be called initially and also from your wxSizeEvent handler function.
See also:
Scrolled Windows, wxScrollBar, wxScrolled, wxScrollWinEvent

Reimplemented in wxScrollBar.

virtual void wxWindow::SetScrollPos ( int  orientation,
int  pos,
bool  refresh = true 
) [virtual]

Sets the position of one of the built-in scrollbars.

Parameters:
orientation Determines the scrollbar whose position is to be set. May be wxHORIZONTAL or wxVERTICAL.
pos Position in scroll units.
refresh true to redraw the scrollbar, false otherwise.
Remarks:
This function does not directly affect the contents of the window: it is up to the application to take note of scrollbar attributes and redraw contents accordingly.
See also:
SetScrollbar(), GetScrollPos(), GetScrollThumb(), wxScrollBar, wxScrolled
virtual void wxWindow::SetSize ( int  width,
int  height 
) [virtual]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual void wxWindow::SetSize ( const wxSize size  )  [virtual]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual void wxWindow::SetSize ( const wxRect rect  )  [virtual]

Sets the size of the window in pixels.

The size is specified using a wxRect, wxSize or by a couple of int objects.

Remarks:
This form must be used with non-default width and height values.
See also:
Move(), Window Sizing Overview
void wxWindow::SetSize ( int  x,
int  y,
int  width,
int  height,
int  sizeFlags = wxSIZE_AUTO 
)

Sets the size of the window in pixels.

Parameters:
x Required x position in pixels, or wxDefaultCoord to indicate that the existing value should be used.
y Required y position in pixels, or wxDefaultCoord to indicate that the existing value should be used.
width Required width in pixels, or wxDefaultCoord to indicate that the existing value should be used.
height Required height position in pixels, or wxDefaultCoord to indicate that the existing value should be used.
sizeFlags Indicates the interpretation of other parameters. It is a bit list of the following:

  • wxSIZE_AUTO_WIDTH: a wxDefaultCoord width value is taken to indicate a wxWidgets-supplied default width.
  • wxSIZE_AUTO_HEIGHT: a wxDefaultCoord height value is taken to indicate a wxWidgets-supplied default height.
  • wxSIZE_AUTO: wxDefaultCoord size values are taken to indicate a wxWidgets-supplied default size.
  • wxSIZE_USE_EXISTING: existing dimensions should be used if wxDefaultCoord values are supplied.
  • wxSIZE_ALLOW_MINUS_ONE: allow negative dimensions (i.e. value of wxDefaultCoord) to be interpreted as real dimensions, not default values.
  • wxSIZE_FORCE: normally, if the position and the size of the window are already the same as the parameters of this function, nothing is done. but with this flag a window resize may be forced even in this case (supported in wx 2.6.2 and later and only implemented for MSW and ignored elsewhere currently).
Remarks:
This overload sets the position and optionally size, of the window. Parameters may be wxDefaultCoord to indicate either that a default should be supplied by wxWidgets, or that the current value of the dimension should be used.
See also:
Move(), Window Sizing Overview
void wxWindow::SetSizeHints ( const wxSize minSize,
const wxSize maxSize = wxDefaultSize,
const wxSize incSize = wxDefaultSize 
)

Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

Please use SetMinSize() and SetMaxSize() instead.

See also:
wxTopLevelWindow::SetSizeHints, Window Sizing Overview

Reimplemented in wxTopLevelWindow.

void wxWindow::SetSizer ( wxSizer sizer,
bool  deleteOld = true 
)

Sets the window to have the given layout sizer.

The window will then own the object, and will take care of its deletion. If an existing layout constraints object is already owned by the window, it will be deleted if the deleteOld parameter is true.

Note that this function will also call SetAutoLayout() implicitly with true parameter if the sizer is non-NULL and false otherwise so that the sizer will be effectively used to layout the window children whenever it is resized.

Parameters:
sizer The sizer to set. Pass NULL to disassociate and conditionally delete the window's sizer. See below.
deleteOld If true (the default), this will delete any pre-existing sizer. Pass false if you wish to handle deleting the old sizer yourself but remember to do it yourself in this case to avoid memory leaks.
Remarks:
SetSizer enables and disables Layout automatically.
void wxWindow::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 minimial size.

virtual void wxWindow::SetThemeEnabled ( bool  enable  )  [virtual]

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.

This does not always have any effect since the underlying platform obviously needs to support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme.

Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best.

void wxWindow::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 wxWindow::SetToolTip ( const wxString tip  ) 

Attach a tooltip to the window.

wxToolTip pointer can be NULL in the overload taking the pointer, meaning to unset any existing tooltips; however UnsetToolTip() provides a more readable alternative to this operation.

Notice that these methods are always available, even if wxWidgets was compiled with wxUSE_TOOLTIPS set to 0, but don't do anything in this case.

See also:
GetToolTip(), wxToolTip
virtual bool wxWindow::SetTransparent ( wxByte  alpha  )  [virtual]

Set the transparency of the window.

If the system supports transparent windows, returns true, otherwise returns false and the window remains fully opaque. See also CanSetTransparent().

The parameter alpha is in the range 0..255 where 0 corresponds to a fully transparent window and 255 to the fully opaque one. The constants wxIMAGE_ALPHA_TRANSPARENT and wxIMAGE_ALPHA_OPAQUE can be used.

Reimplemented in wxTopLevelWindow.

virtual void wxWindow::SetValidator ( const wxValidator validator  )  [virtual]

Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type.

void wxWindow::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 wxWindow::SetVirtualSize ( int  width,
int  height 
)

Sets the virtual size of the window in pixels.

See also:
Window Sizing Overview
void wxWindow::SetWindowStyle ( long  style  ) 

See SetWindowStyleFlag() for more info.

Reimplemented in wxTreeCtrl.

virtual void wxWindow::SetWindowStyleFlag ( long  style  )  [virtual]

Sets the style of the window.

Please note that some styles cannot be changed after the window creation and that Refresh() might need to be be called after changing the others for the change to take place immediately.

See Window styles for more information about flags.

See also:
GetWindowStyleFlag()

Reimplemented in wxListCtrl.

void wxWindow::SetWindowVariant ( wxWindowVariant  variant  ) 

This function can be called under all platforms but only does anything under Mac OS X 10.3+ currently.

Under this system, each of the standard control can exist in several sizes which correspond to the elements of wxWindowVariant enum.

By default the controls use the normal size, of course, but this function can be used to change this.

virtual bool wxWindow::ShouldInheritColours (  )  const [virtual]

Return true from here to allow the colours of this window to be changed by InheritAttributes().

Returning false forbids inheriting them from the parent window.

The base class version returns false, but this method is overridden in wxControl where it returns true.

virtual bool wxWindow::Show ( bool  show = true  )  [virtual]

Shows or hides the window.

You may need to call Raise() for a top level window if you want to bring it to top, although this is not needed if Show() is called immediately after the frame creation.

Parameters:
show If true displays the window. Otherwise, hides it.
Returns:
true if the window has been shown or hidden or false if nothing was done because it already was in the requested state.
See also:
IsShown(), Hide(), wxRadioBox::Show, wxShowEvent.

Reimplemented in wxDialog.

virtual bool wxWindow::ShowWithEffect ( wxShowEffect  effect,
unsigned int  timeout = 0 
) [virtual]

This function shows a window, like Show(), but using a special visual effect if possible.

Parameters:
effect The effect to use.
timeout The timeout parameter specifies the time of the animation, in milliseconds. If the default value of 0 is used, the default animation time for the current platform is used.
Note:
Currently this function is only implemented in wxMSW and wxOSX (for wxTopLevelWindows only in Carbon version and for any kind of windows in Cocoa) and does the same thing as Show() in the other ports.
Since:
2.9.0
See also:
HideWithEffect()
void wxWindow::Thaw (  ) 

Re-enables window updating after a previous call to Freeze().

To really thaw the control, it must be called exactly the same number of times as Freeze().

If the window has any children, they are recursively thawed too.

See also:
wxWindowUpdateLocker, Freeze(), IsFrozen()
bool wxWindow::ToggleWindowStyle ( int  flag  ) 

Turns the given flag on if it's currently turned off and vice versa.

This function cannot be used if the value of the flag is 0 (which is often the case for default flags).

Also, please notice that not all styles can be changed after the control creation.

Returns:
Returns true if the style was turned on by this function, false if it was switched off.
See also:
SetWindowStyleFlag(), HasFlag()
virtual bool wxWindow::TransferDataFromWindow (  )  [virtual]

Transfers values from child controls to data areas specified by their validators.

Returns false if a transfer failed.

If the window has wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows.

See also:
TransferDataToWindow(), wxValidator, Validate()
virtual bool wxWindow::TransferDataToWindow (  )  [virtual]

Transfers values to child controls from data areas specified by their validators.

If the window has wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows.

Returns:
Returns false if a transfer failed.
See also:
TransferDataFromWindow(), wxValidator, Validate()
virtual bool wxWindow::UnregisterHotKey ( int  hotkeyId  )  [virtual]

Unregisters a system wide hotkey.

Parameters:
hotkeyId Numeric identifier of the hotkey. Must be the same id that was passed to RegisterHotKey().
Returns:
true if the hotkey was unregistered successfully, false if the id was invalid.
Remarks:
This function is currently only implemented under MSW.
See also:
RegisterHotKey()
static void wxWindow::UnreserveControlId ( wxWindowID  id,
int  count = 1 
) [static]

Unreserve an ID or range of IDs that was reserved by NewControlId().

See Window IDs for more information.

Parameters:
id The starting ID of the range of IDs to unreserve.
count The number of sequential IDs to unreserve.
See also:
NewControlId(), wxIdManager, Window IDs
void wxWindow::UnsetToolTip (  ) 

Unset any existing tooltip.

Since:
2.9.0
See also:
SetToolTip()
virtual void wxWindow::Update (  )  [virtual]

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

Notice that this function doesn't invalidate any area of the window so nothing happens if nothing has been invalidated (i.e. marked as requiring a redraw). Use Refresh() first if you want to immediately redraw the window unconditionally.

virtual void wxWindow::UpdateWindowUI ( long  flags = wxUPDATE_UI_NONE  )  [virtual]

This function sends one or more wxUpdateUIEvent to the window.

The particular implementation depends on the window; for example a wxToolBar will send an update UI event for each toolbar button, and a wxFrame will send an update UI event for each menubar menu item.

You can call this function from your application to ensure that your UI is up-to-date at this point (as far as your wxUpdateUIEvent handlers are concerned). This may be necessary if you have called wxUpdateUIEvent::SetMode() or wxUpdateUIEvent::SetUpdateInterval() to limit the overhead that wxWidgets incurs by sending update UI events in idle time. flags should be a bitlist of one or more of the wxUpdateUI enumeration.

If you are calling this function from an OnInternalIdle or OnIdle function, make sure you pass the wxUPDATE_UI_FROMIDLE flag, since this tells the window to only update the UI elements that need to be updated in idle time. Some windows update their elements only when necessary, for example when a menu is about to be shown. The following is an example of how to call UpdateWindowUI from an idle function.

See also:
wxUpdateUIEvent, DoUpdateWindowUI(), OnInternalIdle()
virtual bool wxWindow::Validate (  )  [virtual]

Validates the current values of the child controls using their validators.

If the window has wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows.

Returns:
Returns false if any of the validations failed.
See also:
TransferDataFromWindow(), TransferDataToWindow(), wxValidator
virtual void wxWindow::WarpPointer ( int  x,
int  y 
) [virtual]

Moves the pointer to the given position on the window.

Note:
Apple Human Interface Guidelines forbid moving the mouse cursor programmatically so you should avoid using this function in Mac applications (and probably avoid using it under the other platforms without good reason as well).
Parameters:
x The new x position for the cursor.
y The new y position for the cursor.
virtual wxSize wxWindow::WindowToClientSize ( const wxSize size  )  const [virtual]

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.

Components with wxDefaultCoord value are left unchanged.

Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars.

Since:
2.8.8
See also:
ClientToWindowSize()
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]