wxWindow

Implements methods from the following classes

• wxEvtHandler

Methods

• wxWindow
  Constructs a window, which can be a child of a frame, dialog or any other non-control window.
• AcceptsFocus
  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.
• AcceptsFocusFromKeyboard
  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.
• AcceptsFocusRecursively
  Overridden to indicate whether this window or one of its children accepts focus.
• AddChild
  Adds a child window.
• AddPendingEvent
  See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.
• AlwaysShowScrollbars
  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.
• CacheBestSize
  Sets the cached best size value.
• CanScroll
  Returns true if this window can have a scroll bar in this orientation.
• CanSetTransparent
  Returns true if the system supports transparent windows and calling SetTransparent() may succeed.
• CaptureMouse
  Directs all mouse input to this window.
• Center
  A synonym for Centre().
• CenterOnParent
  A synonym for CentreOnParent().
• Centre
  Centres the window.
• CentreOnParent
  Centres the window on its parent.
• ClearBackground
  Clears the window by filling it with the current background colour.
• ClientToScreen
  Converts to screen coordinates from coordinates relative to this window.
• ClientToWindowSize
  Converts client area size size to corresponding window size.
• Close
  This function simply generates a wxCloseEvent whose handler usually tries to close the window.
• ConvertDialogToPixels
  Converts a point or size from dialog units to pixels.
• ConvertPixelsToDialog
  Converts a point or size from pixels to dialog units.
• Create
• Destroy
  Destroys the window safely.
• DestroyChildren
  Destroys all children of a window.
• Disable
  Disables the window.
• DoUpdateWindowUI
  Does the window-specific updating after processing the update event.
• DragAcceptFiles
  Enables or disables eligibility for drop file events (OnDropFiles).
• Enable
  Enable or disable the window for user input.
• FindWindow
  Find a child of this window, by name.
• Fit
  Sizes the window so that it fits around its subwindows.
• FitInside
  Similar to Fit(), but sizes the interior (virtual) size of a window.
• Freeze
  Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.
• GetAutoLayout
  Returns the sizer of which this window is a member, if any, otherwise NULL.
• GetBackgroundColour
  Returns the background colour of the window.
• GetBackgroundStyle
  Returns the background style of the window.
• GetBestSize
  This functions returns the best acceptable minimal size for the window.
• GetBestVirtualSize
  Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
• GetBorder
  Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.
• GetCaret
  Returns the caret() associated with the window.
• GetCharHeight
  Returns the character height for this window.
• GetCharWidth
  Returns the average character width for this window.
• GetClientAreaOrigin
  Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
• GetClientRect
  Get the client rectangle in window (i.e. client) coordinates.
• GetClientSize
  This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
• GetContainingSizer
  Returns the sizer of which this window is a member, if any, otherwise NULL.
• GetCursor
  Return the cursor associated with this window.
• GetEffectiveMinSize
  Merges the window's best size into the min size and returns the result.
• GetEventHandler
  Returns the event handler for this window.
• GetExtraStyle
  Returns the extra style bits for the window.
• GetFont
  Returns the font for this window.
• GetForegroundColour
  Returns the foreground colour of the window.
• GetGrandParent
  Returns the grandparent of a window, or NULL if there isn't one.
• GetHelpText
  Gets the help text to be used as context-sensitive help for this window.
• GetHelpTextAtPoint
  Gets the help text to be used as context-sensitive help for this window.
• GetId
  Returns the identifier of the window.
• GetLabel
  Generic way of getting a label from any window, for identification purposes.
• GetLayoutDirection
  Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.
• GetMaxClientSize
  Returns the maximum size of window's client area.
• GetMaxHeight
  Returns the vertical component of window maximal size.
• GetMaxSize
  Returns the maximum size of the window.
• GetMaxWidth
  Returns the horizontal component of window maximal size.
• GetMinClientSize
  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.
• GetMinHeight
  Returns the vertical component of window minimal size.
• GetMinSize
  Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.
• GetMinWidth
  Returns the horizontal component of window minimal size.
• GetName
  Returns the window's name.
• GetNextSibling
  Returns the next window after this one among the parent's children or NULL if this window is the last child.
• GetParent
  Returns the parent of the window, or NULL if there is no parent.
• GetPopupMenuSelectionFromUser
  This function shows a popup menu at the given position in this window and returns the selected id.
• GetPosition
  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.
• GetPrevSibling
  Returns the previous window before this one among the parent's children or NULL if this window is the first child.
• GetRect
  Returns the position and size of the window as a wxRect object.
• GetScreenPosition
  Returns the window position in screen coordinates, whether the window is a child window or a top level one.
• GetScreenRect
  Returns the position and size of the window on the screen as a wxRect object.
• GetScrollPos
  Returns the built-in scrollbar position.
• GetScrollRange
  Returns the built-in scrollbar range.
• GetScrollThumb
  Returns the built-in scrollbar thumb size.
• GetSize
  See the GetSize(int*,int*) overload for more info.
• GetSizer
  Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.
• GetTextExtent
  Gets the dimensions of the string as it would be drawn on the window with the currently selected font.
• GetToolTip
  Get the associated tooltip or NULL if none.
• GetToolTipText
  Get the text of the associated tooltip or empty string if none.
• GetUpdateClientRect
  Get the update rectangle bounding box in client coords.
• GetUpdateRegion
  Returns the region specifying which parts of the window have been damaged.
• GetValidator
  Validator functions.
• GetVirtualSize
  This gets the virtual size of the window in pixels.
• GetWindowBorderSize
  Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.
• GetWindowStyle
  See GetWindowStyleFlag() for more info.
• GetWindowStyleFlag
  Gets the window style that was passed to the constructor or Create() method.
• GetWindowVariant
  Returns the value previously passed to SetWindowVariant().
• HandleAsNavigationKey
  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.
• HandleWindowEvent
  Shorthand for:
• HasCapture
  Returns true if this window has the current mouse capture.
• HasExtraStyle
  Returns true if the window has the given exFlag bit set in its extra styles.
• HasFlag
  Returns true if the window has the given flag bit set.
• HasFocus
  Returns true if the window (or in case of composite controls, its main child window) has focus.
• HasMultiplePages
  This method should be overridden to return true if this window has multiple pages.
• HasScrollbar
  Returns true if this window currently has a scroll bar for this orientation.
• HasTransparentBackground
  Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background.
• Hide
  Equivalent to calling wxWindow::Show(false).
• HitTest
  Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.
• InformFirstDirection
  wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known.
• 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.
• InitDialog
  Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
• InvalidateBestSize
  Resets the cached best size value so it will be recalculated the next time it is needed.
• IsBeingDeleted
  Returns true if this window is in process of being destroyed.
• IsDoubleBuffered
  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.
• IsEnabled
  Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.
• IsExposed
  Returns true if the given point or rectangle area has been exposed since the last repaint.
• IsFrozen
  Returns true if the window is currently frozen by a call to Freeze().
• IsRetained
  Returns true if the window is retained, false otherwise.
• IsScrollbarAlwaysShown
  Return whether a scrollbar is always shown.
• IsShown
  Returns true if the window is shown, false if it has been hidden.
• IsShownOnScreen
  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.
• IsThisEnabled
  Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.
• IsTopLevel
  Returns true if the given window is a top-level one.
• Layout
  Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window.
• LineDown
  Same as ScrollLines (1).
• LineUp
  Same as ScrollLines (-1).
• Lower
  Lowers the window to the bottom of the window hierarchy (Z-order).
• Move
  Moves the window to the given position.
• MoveAfterInTabOrder
  Moves this window in the tab navigation order after the specified win.
• MoveBeforeInTabOrder
  Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.
• Navigate
  Performs a keyboard navigation action starting from this window.
• NavigateIn
  Performs a keyboard navigation action inside this window.
• 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.
• PageDown
  Same as ScrollPages (1).
• PageUp
  Same as ScrollPages (-1).
• PopupMenu
  Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.
• PostSizeEvent
  Posts a size event to the window.
• PostSizeEventToParent
  Posts a size event to the parent of this window.
• ProcessEvent
  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.
• ProcessWindowEvent
  Convenient wrapper for ProcessEvent().
• ProcessWindowEventLocally
  Wrapper for wxEvtHandler::ProcessEventLocally().
• PushEventHandler
  Pushes this event handler onto the event stack for the window.
• QueueEvent
  See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.
• Raise
  Raises the window to the top of the window hierarchy (Z-order).
• Refresh
  Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.
• RefreshRect
  Redraws the contents of the given rectangle: only the area inside it will be repainted.
• ReleaseMouse
  Releases mouse input captured with CaptureMouse().
• RemoveChild
  Removes a child window.
• RemoveEventHandler
  Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.
• Reparent
  Reparents the window, i.e. the window will be removed from its current parent window (e.g.
• ScreenToClient
  Converts from screen to client window coordinates.
• ScrollLines
  Scrolls the window by the given number of lines down (if lines is positive) or up.
• ScrollPages
  Scrolls the window by the given number of pages down (if pages is positive) or up.
• SendSizeEvent
  This function sends a dummy size event to the window allowing it to re-layout its children positions.
• SendSizeEventToParent
  Safe wrapper for GetParent()->SendSizeEvent().
• SetAutoLayout
  Determines whether the Layout() function will be called automatically when the window is resized.
• SetBackgroundColour
  Sets the background colour of the window.
• SetBackgroundStyle
  Sets the background style of the window.
• SetCanFocus
  This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0).
• SetCaret
  Sets the caret() associated with the window.
• SetClientSize
  This sets the size of the window client area in pixels.
• SetConstraints
  Sets the window to have the given layout constraints.
• SetContainingSizer
  This normally does not need to be called by user code.
• SetCursor
  Sets the window's cursor.
• SetDropTarget
  Associates a drop target with this window.
• SetEventHandler
  Sets the event handler for this window.
• SetExtraStyle
  Sets the extra style bits for the window.
• SetFocus
  This sets the window to receive keyboard input.
• SetFocusFromKbd
  This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.
• SetFont
  Sets the font for this window.
• SetForegroundColour
  Sets the foreground colour of the window.
• SetHelpText
  Sets the help text to be used as context-sensitive help for this window.
• SetId
  Sets the identifier of the window.
• SetInitialBestSize
  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).
• SetInitialSize
  A smart SetSize that will fill in default size components with the window's best size values.
• SetLabel
  Sets the window's label.
• SetLayoutDirection
  Sets the layout direction for this window.
• SetMaxClientSize
  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.
• SetMaxSize
  Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.
• SetMinClientSize
  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.
• SetMinSize
  Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.
• SetName
  Sets the window's name.
• SetNextHandler
  wxWindows cannot be used to form event handler chains; this function thus will assert when called.
• SetOwnBackgroundColour
  Sets the background colour of the window but prevents it from being inherited by the children of this window.
• SetOwnFont
  Sets the font of the window but prevents it from being inherited by the children of this window.
• SetOwnForegroundColour
  Sets the foreground colour of the window but prevents it from being inherited by the children of this window.
• SetPalette
• SetPosition
  A synonym for Centre().
• SetPreviousHandler
  wxWindows cannot be used to form event handler chains; this function thus will assert when called.
• SetScrollPos
  Sets the position of one of the built-in scrollbars.
• SetScrollbar
  Sets the scrollbar properties of a built-in scrollbar.
• SetSize
  This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
• SetSizeHints
  Prepare for changing positions of multiple child windows.
• SetSizer
  Sets the window to have the given layout sizer.
• SetSizerAndFit
  This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial window size to the size needed to accommodate all sizer elements and sets the size hints which, if this window is a top level one, prevent the user from resizing it to be less than this minimal size.
• SetThemeEnabled
  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.
• SetToolTip
  Attach a tooltip to the window.
• SetTransparent
  Set the transparency of the window.
• SetValidator
  Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type.
• SetVirtualSize
  This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
• SetWindowStyle
  See SetWindowStyleFlag() for more info.
• SetWindowStyleFlag
  Sets the style of the window.
• SetWindowVariant
  This function can be called under all platforms but only does anything under Mac OS X 10.3+ currently.
• ShouldInheritColours
  Return true from here to allow the colours of this window to be changed by InheritAttributes().
• Show
  Shows or hides the window.
• Thaw
  Re-enables window updating after a previous call to Freeze().
• ToggleWindowStyle
  Turns the given flag on if it's currently turned off and vice versa.
• TransferDataFromWindow
  Transfers values from child controls to data areas specified by their validators.
• TransferDataToWindow
  Transfers values to child controls from data areas specified by their validators.
• UnsetToolTip
  Unset any existing tooltip.
• 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).
• UpdateWindowUI
  This function sends one or more wxUpdateUIEvent to the window.
• Validate
  Validates the current values of the child controls using their validators.
• WarpPointer
  Moves the pointer to the given position on the window.
• WindowToClientSize
  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.

Static Methods

• FindFocus
  Finds the window or control which currently has the keyboard focus.
• FindWindowById
  Find the first window with the given id.
• FindWindowByLabel
  Find a window by its label.
• FindWindowByName
  Find a window by its name (as given in a window constructor or Create() function call).
• GetCapture
  Returns the currently captured window.
• NewControlId
  Create a new ID or range of IDs that are not currently in use.
• UnreserveControlId
  Unreserve an ID or range of IDs that was reserved by NewControlId().

wxWindow

wxWindow ( wxWindow &$parent, integer $id, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style, string $name=wxPanelNameStr )

Constructs a window, which can be a child of a frame, dialog or any other non-control window.
wxWindow ( )

Default constructor.

AcceptsFocus

bool AcceptsFocus ( )

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.

AcceptsFocusFromKeyboard

bool AcceptsFocusFromKeyboard ( )

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.

AcceptsFocusRecursively

bool AcceptsFocusRecursively ( )

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

AddChild

AddChild ( wxWindow &$child )

Adds a child window.

AddPendingEvent

AddPendingEvent ( 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.

AlwaysShowScrollbars

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.

CacheBestSize

CacheBestSize ( wxSize $size )

Sets the cached best size value.

CanScroll

bool CanScroll ( integer $orient )

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

CanSetTransparent

bool CanSetTransparent ( )

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

CaptureMouse

CaptureMouse ( )

Directs all mouse input to this window.

Center

Center ( integer $dir=wxBOTH )

A synonym for Centre().

CenterOnParent

CenterOnParent ( integer $dir=wxBOTH )

A synonym for CentreOnParent().

Centre

Centre ( integer $direction=wxBOTH )

Centres the window.

CentreOnParent

CentreOnParent ( integer $direction=wxBOTH )

Centres the window on its parent.

ClearBackground

ClearBackground ( )

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

ClientToScreen

wxPoint ClientToScreen ( wxPoint $pt )

Converts to screen coordinates from coordinates relative to this window.

ClientToWindowSize

wxSize ClientToWindowSize ( wxSize $size )

Converts client area size size to corresponding window size.

Close

bool Close ( bool $force=false )

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

ConvertDialogToPixels

wxPoint ConvertDialogToPixels ( wxPoint $pt )

Converts a point or size from dialog units to pixels.
wxSize ConvertDialogToPixels ( wxSize $sz )

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

ConvertPixelsToDialog

wxPoint ConvertPixelsToDialog ( wxPoint $pt )

Converts a point or size from pixels to dialog units.
wxSize ConvertPixelsToDialog ( wxSize $sz )

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

Create

bool Create ( wxWindow &$parent, integer $id, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style, string $name=wxPanelNameStr )

Destroy

bool Destroy ( )

Destroys the window safely.

DestroyChildren

bool DestroyChildren ( )

Destroys all children of a window.

Disable

bool Disable ( )

Disables the window.

DoUpdateWindowUI

DoUpdateWindowUI ( wxUpdateUIEvent &$event )

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

DragAcceptFiles

DragAcceptFiles ( bool $accept )

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

Enable

bool Enable ( bool $enable=true )

Enable or disable the window for user input.

FindFocus

static wxWindow& FindFocus ( )

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

FindWindow

wxWindow& FindWindow ( string $name )

Find a child of this window, by name.
wxWindow& FindWindow ( integer $id )

Find a child of this window, by id.

FindWindowById

static wxWindow& FindWindowById ( integer $id, wxWindow $parent )

Find the first window with the given id.

FindWindowByLabel

static wxWindow& FindWindowByLabel ( string $label, wxWindow $parent )

Find a window by its label.

FindWindowByName

static wxWindow& FindWindowByName ( string $name, wxWindow $parent )

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

Fit

Fit ( )

Sizes the window so that it fits around its subwindows.

FitInside

FitInside ( )

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

Freeze

Freeze ( )

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

GetAutoLayout

bool GetAutoLayout ( )

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

GetBackgroundColour

wxColour GetBackgroundColour ( )

Returns the background colour of the window.

GetBackgroundStyle

wxBackgroundStyle GetBackgroundStyle ( )

Returns the background style of the window.

GetBestSize

wxSize GetBestSize ( )

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

GetBestVirtualSize

wxSize GetBestVirtualSize ( )

Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

GetBorder

wxBorder GetBorder ( integer $flags )

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.
wxBorder GetBorder ( )

Get border for the flags of this window.

GetCapture

static wxWindow& GetCapture ( )

Returns the currently captured window.

GetCaret

wxCaret& GetCaret ( )

Returns the caret() associated with the window.

GetCharHeight

integer GetCharHeight ( )

Returns the character height for this window.

GetCharWidth

integer GetCharWidth ( )

Returns the average character width for this window.

GetClientAreaOrigin

wxPoint GetClientAreaOrigin ( )

Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)

GetClientRect

wxRect GetClientRect ( )

Get the client rectangle in window (i.e. client) coordinates.

GetClientSize

wxSize GetClientSize ( )

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

GetContainingSizer

wxSizer& GetContainingSizer ( )

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

GetCursor

wxCursor GetCursor ( )

Return the cursor associated with this window.

GetEffectiveMinSize

wxSize GetEffectiveMinSize ( )

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

GetEventHandler

wxEvtHandler& GetEventHandler ( )

Returns the event handler for this window.

GetExtraStyle

integer GetExtraStyle ( )

Returns the extra style bits for the window.

GetFont

wxFont GetFont ( )

Returns the font for this window.

GetForegroundColour

wxColour GetForegroundColour ( )

Returns the foreground colour of the window.

GetGrandParent

wxWindow& GetGrandParent ( )

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

GetHelpText

string GetHelpText ( )

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

GetHelpTextAtPoint

string GetHelpTextAtPoint ( wxPoint $point, wxHelpEvent::Origin $origin )

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

GetId

integer GetId ( )

Returns the identifier of the window.

GetLabel

string GetLabel ( )

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

GetLayoutDirection

wxLayoutDirection GetLayoutDirection ( )

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

GetMaxClientSize

wxSize GetMaxClientSize ( )

Returns the maximum size of window's client area.

GetMaxHeight

integer GetMaxHeight ( )

Returns the vertical component of window maximal size.

GetMaxSize

wxSize GetMaxSize ( )

Returns the maximum size of the window.

GetMaxWidth

integer GetMaxWidth ( )

Returns the horizontal component of window maximal size.

GetMinClientSize

wxSize GetMinClientSize ( )

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.

GetMinHeight

integer GetMinHeight ( )

Returns the vertical component of window minimal size.

GetMinSize

wxSize GetMinSize ( )

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

GetMinWidth

integer GetMinWidth ( )

Returns the horizontal component of window minimal size.

GetName

string GetName ( )

Returns the window's name.

GetNextSibling

wxWindow& GetNextSibling ( )

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

GetParent

wxWindow& GetParent ( )

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

GetPopupMenuSelectionFromUser

integer GetPopupMenuSelectionFromUser ( wxMenu &$menu, wxPoint $pos=wxDefaultPosition )

This function shows a popup menu at the given position in this window and returns the selected id.
integer GetPopupMenuSelectionFromUser ( wxMenu &$menu, integer $x, integer $y )

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

GetPosition

wxPoint GetPosition ( )

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.

GetPrevSibling

wxWindow& GetPrevSibling ( )

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

GetRect

wxRect GetRect ( )

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

GetScreenPosition

wxPoint GetScreenPosition ( )

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

GetScreenRect

wxRect GetScreenRect ( )

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

GetScrollPos

integer GetScrollPos ( integer $orientation )

Returns the built-in scrollbar position.

GetScrollRange

integer GetScrollRange ( integer $orientation )

Returns the built-in scrollbar range.

GetScrollThumb

integer GetScrollThumb ( integer $orientation )

Returns the built-in scrollbar thumb size.

GetSize

wxSize GetSize ( )

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

GetSizer

wxSizer& GetSizer ( )

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

GetTextExtent

wxSize GetTextExtent ( string $string )

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

GetToolTip

wxToolTip& GetToolTip ( )

Get the associated tooltip or NULL if none.

GetToolTipText

string GetToolTipText ( )

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

GetUpdateClientRect

wxRect GetUpdateClientRect ( )

Get the update rectangle bounding box in client coords.

GetUpdateRegion

wxRegion GetUpdateRegion ( )

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

GetValidator

wxValidator& GetValidator ( )

Validator functions.

GetVirtualSize

wxSize GetVirtualSize ( )

This gets the virtual size of the window in pixels.

GetWindowBorderSize

wxSize GetWindowBorderSize ( )

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

GetWindowStyle

integer GetWindowStyle ( )

See GetWindowStyleFlag() for more info.

GetWindowStyleFlag

integer GetWindowStyleFlag ( )

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

GetWindowVariant

wxWindowVariant GetWindowVariant ( )

Returns the value previously passed to SetWindowVariant().

HandleAsNavigationKey

bool HandleAsNavigationKey ( 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.

HandleWindowEvent

bool HandleWindowEvent ( wxEvent &$event )

Shorthand for:

HasCapture

bool HasCapture ( )

Returns true if this window has the current mouse capture.

HasExtraStyle

bool HasExtraStyle ( integer $exFlag )

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

HasFlag

bool HasFlag ( integer $flag )

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

HasFocus

bool HasFocus ( )

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

HasMultiplePages

bool HasMultiplePages ( )

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

HasScrollbar

bool HasScrollbar ( integer $orient )

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

HasTransparentBackground

bool HasTransparentBackground ( )

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

Hide

bool Hide ( )

Equivalent to calling wxWindow::Show(false).

HitTest

wxHitTest HitTest ( integer $x, integer $y )

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.
wxHitTest HitTest ( wxPoint $pt )

Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

InformFirstDirection

bool InformFirstDirection ( integer $direction, integer $size, integer $availableOtherDir )

wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known.

InheritAttributes

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.

InitDialog

InitDialog ( )

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

InvalidateBestSize

InvalidateBestSize ( )

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

IsBeingDeleted

bool IsBeingDeleted ( )

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

IsDoubleBuffered

bool IsDoubleBuffered ( )

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.

IsEnabled

bool IsEnabled ( )

Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

IsExposed

bool IsExposed ( integer $x, integer $y )

Returns true if the given point or rectangle area has been exposed since the last repaint.
bool IsExposed ( wxPoint &$pt )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool IsExposed ( integer $x, integer $y, integer $w, integer $h )

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 )

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

IsFrozen

bool IsFrozen ( )

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

IsRetained

bool IsRetained ( )

Returns true if the window is retained, false otherwise.

IsScrollbarAlwaysShown

bool IsScrollbarAlwaysShown ( integer $orient )

Return whether a scrollbar is always shown.

IsShown

bool IsShown ( )

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

IsShownOnScreen

bool IsShownOnScreen ( )

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.

IsThisEnabled

bool IsThisEnabled ( )

Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

IsTopLevel

bool IsTopLevel ( )

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

Layout

bool Layout ( )

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

LineDown

bool LineDown ( )

Same as ScrollLines (1).

LineUp

bool LineUp ( )

Same as ScrollLines (-1).

Lower

Lower ( )

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

Move

Move ( integer $x, integer $y, integer $flags=wxSIZE_USE_EXISTING )

Moves the window to the given position.
Move ( wxPoint $pt, integer $flags=wxSIZE_USE_EXISTING )

Moves the window to the given position.

MoveAfterInTabOrder

MoveAfterInTabOrder ( wxWindow &$win )

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

MoveBeforeInTabOrder

MoveBeforeInTabOrder ( wxWindow &$win )

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

Navigate

bool Navigate ( integer $flags=wxNavigationKeyEvent::IsForward )

Performs a keyboard navigation action starting from this window.

NavigateIn

bool NavigateIn ( integer $flags=wxNavigationKeyEvent::IsForward )

Performs a keyboard navigation action inside this window.

NewControlId

static integer NewControlId ( integer $count=1 )

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

OnInternalIdle

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.

PageDown

bool PageDown ( )

Same as ScrollPages (1).

PageUp

bool PageUp ( )

Same as ScrollPages (-1).

PopupMenu

bool PopupMenu ( wxMenu &$menu, 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, integer $x, integer $y )

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

PostSizeEvent

PostSizeEvent ( )

Posts a size event to the window.

PostSizeEventToParent

PostSizeEventToParent ( )

Posts a size event to the parent of this window.

ProcessEvent

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.

ProcessWindowEvent

bool ProcessWindowEvent ( wxEvent &$event )

Convenient wrapper for ProcessEvent().

ProcessWindowEventLocally

bool ProcessWindowEventLocally ( wxEvent &$event )

Wrapper for wxEvtHandler::ProcessEventLocally().

PushEventHandler

PushEventHandler ( wxEvtHandler &$handler )

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

QueueEvent

QueueEvent ( wxEvent &$event )

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

Raise

Raise ( )

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

Refresh

Refresh ( bool $eraseBackground=true, wxRect $rect=NULL )

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

RefreshRect

RefreshRect ( wxRect $rect, bool $eraseBackground=true )

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

ReleaseMouse

ReleaseMouse ( )

Releases mouse input captured with CaptureMouse().

RemoveChild

RemoveChild ( wxWindow &$child )

Removes a child window.

RemoveEventHandler

bool RemoveEventHandler ( wxEvtHandler &$handler )

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

Reparent

bool Reparent ( wxWindow &$newParent )

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

ScreenToClient

wxPoint ScreenToClient ( wxPoint $pt )

Converts from screen to client window coordinates.

ScrollLines

bool ScrollLines ( integer $lines )

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

ScrollPages

bool ScrollPages ( integer $pages )

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

SendSizeEvent

SendSizeEvent ( integer $flags )

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

SendSizeEventToParent

SendSizeEventToParent ( integer $flags )

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

SetAutoLayout

SetAutoLayout ( bool $autoLayout )

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

SetBackgroundColour

bool SetBackgroundColour ( wxColour $colour )

Sets the background colour of the window.

SetBackgroundStyle

bool SetBackgroundStyle ( wxBackgroundStyle $style )

Sets the background style of the window.

SetCanFocus

SetCanFocus ( bool $canFocus )

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

SetCaret

SetCaret ( wxCaret &$caret )

Sets the caret() associated with the window.

SetClientSize

SetClientSize ( integer $width, integer $height )

This sets the size of the window client area in pixels.
SetClientSize ( wxSize $size )

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

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

SetConstraints

SetConstraints ( wxLayoutConstraints &$constraints )

Sets the window to have the given layout constraints.

SetContainingSizer

SetContainingSizer ( wxSizer &$sizer )

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

SetCursor

bool SetCursor ( wxCursor $cursor )

Sets the window's cursor.

SetDropTarget

SetDropTarget ( wxDropTarget &$target )

Associates a drop target with this window.

SetEventHandler

SetEventHandler ( wxEvtHandler &$handler )

Sets the event handler for this window.

SetExtraStyle

SetExtraStyle ( integer $exStyle )

Sets the extra style bits for the window.

SetFocus

SetFocus ( )

This sets the window to receive keyboard input.

SetFocusFromKbd

SetFocusFromKbd ( )

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

SetFont

bool SetFont ( wxFont $font )

Sets the font for this window.

SetForegroundColour

bool SetForegroundColour ( wxColour $colour )

Sets the foreground colour of the window.

SetHelpText

SetHelpText ( string $helpText )

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

SetId

SetId ( integer $winid )

Sets the identifier of the window.

SetInitialBestSize

SetInitialBestSize ( wxSize $size )

Sets the initial window size if none is given (i.e. at least one of the components of the size passed to ctor/Create() is wxDefaultCoord).

SetInitialSize

SetInitialSize ( wxSize $size=wxDefaultSize )

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

SetLabel

SetLabel ( string $label )

Sets the window's label.

SetLayoutDirection

SetLayoutDirection ( wxLayoutDirection $dir )

Sets the layout direction for this window.

SetMaxClientSize

SetMaxClientSize ( 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.

SetMaxSize

SetMaxSize ( wxSize $size )

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

SetMinClientSize

SetMinClientSize ( 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.

SetMinSize

SetMinSize ( wxSize $size )

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

SetName

SetName ( string $name )

Sets the window's name.

SetNextHandler

SetNextHandler ( wxEvtHandler &$handler )

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

SetOwnBackgroundColour

SetOwnBackgroundColour ( wxColour $colour )

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

SetOwnFont

SetOwnFont ( wxFont $font )

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

SetOwnForegroundColour

SetOwnForegroundColour ( wxColour $colour )

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

SetPalette

SetPalette ( wxPalette $pal )

SetPosition

SetPosition ( wxPoint $pt )

A synonym for Centre().

SetPreviousHandler

SetPreviousHandler ( wxEvtHandler &$handler )

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

SetScrollPos

SetScrollPos ( integer $orientation, integer $pos, bool $refresh=true )

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

SetScrollbar

SetScrollbar ( integer $orientation, integer $position, integer $thumbSize, integer $range, bool $refresh=true )

Sets the scrollbar properties of a built-in scrollbar.

SetSize

SetSize ( integer $width, integer $height )

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

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

Sets the size of the window in pixels.
SetSize ( integer $x, integer $y, integer $width, integer $height, integer $sizeFlags=wxSIZE_AUTO )

Sets the size of the window in pixels.

SetSizeHints

SetSizeHints ( integer $minW, integer $minH, integer $maxW=-1, integer $maxH=-1, integer $incW=-1, integer $incH=-1 )

Prepare for changing positions of multiple child windows.
SetSizeHints ( wxSize $minSize, wxSize $maxSize=wxDefaultSize, wxSize $incSize=wxDefaultSize )

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

SetSizer

SetSizer ( wxSizer &$sizer, bool $deleteOld=true )

Sets the window to have the given layout sizer.

SetSizerAndFit

SetSizerAndFit ( wxSizer &$sizer, bool $deleteOld=true )

This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial window size to the size needed to accommodate all sizer elements and sets the size hints which, if this window is a top level one, prevent the user from resizing it to be less than this minimal size.

SetThemeEnabled

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.

SetToolTip

SetToolTip ( string $tipString )

Attach a tooltip to the window.
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.

SetTransparent

bool SetTransparent ( integer $alpha )

Set the transparency of the window.

SetValidator

SetValidator ( 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.

SetVirtualSize

SetVirtualSize ( wxSize $size )

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

Sets the virtual size of the window in pixels.

SetWindowStyle

SetWindowStyle ( integer $style )

See SetWindowStyleFlag() for more info.

SetWindowStyleFlag

SetWindowStyleFlag ( integer $style )

Sets the style of the window.

SetWindowVariant

SetWindowVariant ( wxWindowVariant $variant )

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

ShouldInheritColours

bool ShouldInheritColours ( )

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

Show

bool Show ( bool $show=true )

Shows or hides the window.

Thaw

Thaw ( )

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

ToggleWindowStyle

bool ToggleWindowStyle ( integer $flag )

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

TransferDataFromWindow

bool TransferDataFromWindow ( )

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

TransferDataToWindow

bool TransferDataToWindow ( )

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

UnreserveControlId

static UnreserveControlId ( integer $id, integer $count=1 )

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

UnsetToolTip

UnsetToolTip ( )

Unset any existing tooltip.

Update

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

UpdateWindowUI

UpdateWindowUI ( integer $flags=wxUPDATE_UI_NONE )

This function sends one or more wxUpdateUIEvent to the window.

Validate

bool Validate ( )

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

WarpPointer

WarpPointer ( integer $x, integer $y )

Moves the pointer to the given position on the window.

WindowToClientSize

wxSize WindowToClientSize ( wxSize $size )

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.