#include <wx/window.h>
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.
This class supports the following styles:
This class supports the following extra styles:
wxEVT_HELP
event if the user clicked on an application window. This style cannot be used (because of the underlying native behaviour) together with wxMAXIMIZE_BOX
or wxMINIMIZE_BOX
, so these two styles are automatically turned off if this one is used. wxIDLE_PROCESS_SPECIFIED
. wxUPDATE_UI_PROCESS_SPECIFIED
. Event macros for events emitted by this class:
wxEVT_ACTIVATE
event. See wxActivateEvent. wxEVT_CHILD_FOCUS
event. See wxChildFocusEvent. wxEVT_HELP
event. See wxHelpEvent. wxEVT_HELP
event for a range of ids. See wxHelpEvent. wxEVT_DROP_FILES
event. See wxDropFilesEvent. wxEVT_ERASE_BACKGROUND
event. See wxEraseEvent. wxEVT_SET_FOCUS
event. See wxFocusEvent. wxEVT_KILL_FOCUS
event. See wxFocusEvent. wxEVT_IDLE
event. See wxIdleEvent. wxEVT_KEY_DOWN
event (any key has been pressed). See wxKeyEvent. wxEVT_KEY_UP
event (any key has been released). See wxKeyEvent. wxEVT_CHAR
event. See wxKeyEvent. wxEVT_CHAR_HOOK
event. See wxKeyEvent. wxEVT_MOUSE_CAPTURE_LOST
event. See wxMouseCaptureLostEvent. wxEVT_MOUSE_CAPTURE_CHANGED
event. See wxMouseCaptureChangedEvent. wxEVT_PAINT
event. See wxPaintEvent. wxEVT_SET_CURSOR
event. See wxSetCursorEvent. wxEVT_SIZE
event. See wxSizeEvent. wxEVT_SYS_COLOUR_CHANGED
event. See wxSysColourChangedEvent. Sizing functions | |
See also the protected functions DoGetBestSize() and DoGetBestClientSize(). | |
bool | BeginRepositioningChildren () |
Prepare for changing positions of multiple child windows. More... | |
void | EndRepositioningChildren () |
Fix child window positions after setting all of them at once. More... | |
void | CacheBestSize (const wxSize &size) const |
Sets the cached best size value. More... | |
virtual wxSize | ClientToWindowSize (const wxSize &size) const |
Converts client area size size to corresponding window size. More... | |
virtual wxSize | WindowToClientSize (const wxSize &size) const |
Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size. More... | |
virtual void | Fit () |
Sizes the window to fit its best size. More... | |
virtual void | FitInside () |
Similar to Fit(), but sizes the interior (virtual) size of a window. More... | |
wxSize | FromDIP (const wxSize &sz) const |
Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit. More... | |
wxPoint | FromDIP (const wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
int | FromDIP (int d) const |
Convert DPI-independent distance in pixels to the value in pixels appropriate for the current toolkit. More... | |
wxSize | ToDIP (const wxSize &sz) const |
Convert pixel values of the current toolkit to DPI-independent pixel values. More... | |
wxPoint | ToDIP (const wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
int | ToDIP (int d) const |
Convert pixel values of the current toolkit to DPI-independent pixel values. More... | |
wxSize | FromPhys (const wxSize &sz) const |
Convert from physical pixels to logical pixels. More... | |
wxPoint | FromPhys (const wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
int | FromPhys (int d) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
wxSize | ToPhys (const wxSize &sz) const |
Convert from logical pixels to physical pixels. More... | |
wxPoint | ToPhys (const wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
int | ToPhys (int d) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
wxSize | GetBestSize () const |
This functions returns the best acceptable minimal size for the window. More... | |
int | GetBestHeight (int width) const |
Returns the best height needed by this window if it had the given width. More... | |
int | GetBestWidth (int height) const |
Returns the best width needed by this window if it had the given height. More... | |
void | GetClientSize (int *width, int *height) const |
Returns the size of the window 'client area' in pixels. More... | |
wxSize | GetClientSize () const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
virtual wxSize | GetEffectiveMinSize () const |
Merges the window's best size into the min size and returns the result. More... | |
virtual wxSize | GetMaxClientSize () const |
Returns the maximum size of window's client area. More... | |
virtual wxSize | GetMaxSize () const |
Returns the maximum size of the window. More... | |
virtual wxSize | GetMinClientSize () const |
Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area. More... | |
virtual wxSize | GetMinSize () const |
Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size. More... | |
int | GetMinWidth () const |
Returns the horizontal component of window minimal size. More... | |
int | GetMinHeight () const |
Returns the vertical component of window minimal size. More... | |
int | GetMaxWidth () const |
Returns the horizontal component of window maximal size. More... | |
int | GetMaxHeight () const |
Returns the vertical component of window maximal size. More... | |
void | GetSize (int *width, int *height) const |
Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc. More... | |
wxSize | GetSize () const |
See the GetSize(int*,int*) overload for more info. More... | |
wxSize | GetVirtualSize () const |
This gets the virtual size of the window in pixels. More... | |
void | GetVirtualSize (int *width, int *height) const |
Like the other GetVirtualSize() overload but uses pointers instead. More... | |
virtual wxSize | GetBestVirtualSize () const |
Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means) More... | |
double | GetContentScaleFactor () const |
Returns the factor mapping logical pixels of this window to physical pixels. More... | |
double | GetDPIScaleFactor () const |
Returns the ratio of the DPI used by this window to the standard DPI. More... | |
virtual wxSize | GetWindowBorderSize () const |
Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively. More... | |
virtual bool | InformFirstDirection (int direction, int size, int availableOtherDir) |
wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known. More... | |
void | InvalidateBestSize () |
Resets the cached best size value so it will be recalculated the next time it is needed. More... | |
void | PostSizeEvent () |
Posts a size event to the window. More... | |
void | PostSizeEventToParent () |
Posts a size event to the parent of this window. More... | |
virtual void | SendSizeEvent (int flags=0) |
This function sends a dummy size event to the window allowing it to re-layout its children positions. More... | |
void | SendSizeEventToParent (int flags=0) |
Safe wrapper for GetParent()->SendSizeEvent(). More... | |
void | SetClientSize (int width, int height) |
This sets the size of the window client area in pixels. More... | |
void | SetClientSize (const wxSize &size) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
void | SetClientSize (const wxRect &rect) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
void | SetContainingSizer (wxSizer *sizer) |
Used by wxSizer internally to notify the window about being managed by the given sizer. More... | |
void | SetInitialSize (const wxSize &size=wxDefaultSize) |
A smart SetSize that will fill in default size components with the window's best size values. More... | |
virtual void | SetMaxClientSize (const wxSize &size) |
Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area. More... | |
virtual void | 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. More... | |
virtual void | SetMinClientSize (const wxSize &size) |
Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area. More... | |
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. More... | |
void | SetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO) |
Sets the size of the window in pixels. More... | |
void | SetSize (const wxRect &rect) |
Sets the size of the window in pixels. More... | |
void | SetSize (const wxSize &size) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
void | SetSize (int width, int height) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
virtual 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. More... | |
virtual void | SetSizeHints (int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
void | SetVirtualSize (int width, int height) |
Sets the virtual size of the window in pixels. More... | |
void | SetVirtualSize (const wxSize &size) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
static wxSize | FromDIP (const wxSize &sz, const wxWindow *w) |
Non window-specific DPI-independent pixels conversion functions. More... | |
static wxPoint | FromDIP (const wxPoint &pt, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
static int | FromDIP (int d, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
static wxSize | ToDIP (const wxSize &sz, const wxWindow *w) |
Non window-specific pixel to DPI-independent pixels conversion functions. More... | |
static wxPoint | ToDIP (const wxPoint &pt, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
static int | ToDIP (int d, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
static wxSize | FromPhys (const wxSize &sz, const wxWindow *w) |
Convert from physical pixels to logical pixels for any window. More... | |
static wxPoint | FromPhys (const wxPoint &pt, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
static int | FromPhys (int d, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
static wxSize | ToPhys (const wxSize &sz, const wxWindow *w) |
Convert from logical pixels to physical pixels for any window. More... | |
static wxPoint | ToPhys (const wxPoint &pt, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
static int | ToPhys (int d, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
Classes | |
class | ChildrenRepositioningGuard |
Helper for ensuring EndRepositioningChildren() is called correctly. More... | |
Public Member Functions | |
wxWindow () | |
Default constructor. More... | |
wxWindow (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr) | |
Constructs a window, which can be a child of a frame, dialog or any other non-control window. More... | |
virtual | ~wxWindow () |
Destructor. More... | |
bool | Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr) |
Construct the actual window object after creating the C++ object. More... | |
void | MSWDisableComposited () |
Disable the use native double buffering in wxMSW. More... | |
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. behaves like e.g. wxStaticText) and so doesn't need focus. More... | |
virtual bool | AcceptsFocusFromKeyboard () const |
This method may be overridden in the derived classes to return false to indicate that while this control can, in principle, have focus if the user clicks it with the mouse, it shouldn't be included in the TAB traversal chain when using the keyboard. More... | |
virtual bool | AcceptsFocusRecursively () const |
Overridden to indicate whether this window or one of its children accepts focus. More... | |
void | DisableFocusFromKeyboard () |
Disable giving focus to this window using the keyboard navigation keys. More... | |
bool | IsFocusable () const |
Can this window itself have focus? More... | |
bool | CanAcceptFocus () const |
Can this window have focus right now? More... | |
bool | CanAcceptFocusFromKeyboard () const |
Can this window be assigned focus from keyboard right now? More... | |
virtual bool | HasFocus () const |
Returns true if the window (or in case of composite controls, its main child window) has focus. More... | |
virtual void | SetCanFocus (bool canFocus) |
This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0). More... | |
virtual void | EnableVisibleFocus (bool enable) |
Enables or disables visible indication of keyboard focus. More... | |
virtual void | SetFocus () |
This sets the window to receive keyboard input. More... | |
virtual void | SetFocusFromKbd () |
This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g. using TAB key). More... | |
Child management functions | |
virtual void | AddChild (wxWindow *child) |
Adds a child window. More... | |
template<typename T > | |
void | CallForEachChild (const T &functor) |
Invoke the given functor for all children of the given window recursively. More... | |
bool | DestroyChildren () |
Destroys all children of a window. More... | |
wxWindow * | FindWindow (long id) const |
Find a child of this window, by id. More... | |
wxWindow * | FindWindow (const wxString &name) const |
Find a child of this window, by name. More... | |
wxWindowList & | GetChildren () |
Returns a reference to the list of the window's children. More... | |
const wxWindowList & | GetChildren () const |
Returns a const reference to the list of the window's children. More... | |
virtual void | RemoveChild (wxWindow *child) |
Removes a child window. More... | |
Sibling and parent management functions | |
wxWindow * | GetGrandParent () const |
Returns the grandparent of a window, or nullptr if there isn't one. More... | |
wxWindow * | GetNextSibling () const |
Returns the next window after this one among the parent's children or nullptr if this window is the last child. More... | |
wxWindow * | GetParent () const |
Returns the parent of the window, or nullptr if there is no parent. More... | |
wxWindow * | GetPrevSibling () const |
Returns the previous window before this one among the parent's children or nullptr if this window is the first child. More... | |
bool | IsDescendant (wxWindow *win) const |
Check if the specified window is a descendant of this one. More... | |
virtual bool | Reparent (wxWindow *newParent) |
Reparents the window, i.e. the window will be removed from its current parent window (e.g. More... | |
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. More... | |
virtual int | GetScrollPos (int orientation) const |
Returns the built-in scrollbar position. More... | |
virtual int | GetScrollRange (int orientation) const |
Returns the built-in scrollbar range. More... | |
virtual int | GetScrollThumb (int orientation) const |
Returns the built-in scrollbar thumb size. More... | |
bool | CanScroll (int orient) const |
Returns true if this window can have a scroll bar in this orientation. More... | |
bool | HasScrollbar (int orient) const |
Returns true if this window currently has a scroll bar for this orientation. More... | |
virtual bool | IsScrollbarAlwaysShown (int orient) const |
Return whether a scrollbar is always shown. More... | |
virtual bool | ScrollLines (int lines) |
Scrolls the window by the given number of lines down (if lines is positive) or up. More... | |
virtual bool | ScrollPages (int pages) |
Scrolls the window by the given number of pages down (if pages is positive) or up. More... | |
virtual void | ScrollWindow (int dx, int dy, const wxRect *rect=nullptr) |
Physically scrolls the pixels in the window and move child windows accordingly. More... | |
bool | LineUp () |
Same as ScrollLines (-1). More... | |
bool | LineDown () |
Same as ScrollLines (1). More... | |
bool | PageUp () |
Same as ScrollPages (-1). More... | |
bool | PageDown () |
Same as ScrollPages (1). More... | |
virtual void | SetScrollPos (int orientation, int pos, bool refresh=true) |
Sets the position of one of the built-in scrollbars. More... | |
virtual void | SetScrollbar (int orientation, int position, int thumbSize, int range, bool refresh=true) |
Sets the scrollbar properties of a built-in scrollbar. More... | |
Positioning functions | |
void | Center (int dir=wxBOTH) |
A synonym for Centre(). More... | |
void | CenterOnParent (int dir=wxBOTH) |
A synonym for CentreOnParent(). More... | |
void | Centre (int direction=wxBOTH) |
Centres the window. More... | |
void | CentreOnParent (int direction=wxBOTH) |
Centres the window on its parent. More... | |
void | GetPosition (int *x, int *y) const |
This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows. More... | |
wxPoint | GetPosition () const |
This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows. More... | |
wxRect | GetRect () const |
Returns the position and size of the window as a wxRect object. More... | |
void | GetScreenPosition (int *x, int *y) const |
Returns the window position in screen coordinates, whether the window is a child window or a top level one. More... | |
wxPoint | GetScreenPosition () const |
Returns the window position in screen coordinates, whether the window is a child window or a top level one. More... | |
wxRect | GetScreenRect () const |
Returns the position and size of the window on the screen as a wxRect object. More... | |
virtual wxPoint | GetClientAreaOrigin () const |
Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...) More... | |
wxRect | GetClientRect () const |
Get the client rectangle in window (i.e. client) coordinates. More... | |
void | Move (int x, int y, int flags=wxSIZE_USE_EXISTING) |
Moves the window to the given position. More... | |
void | Move (const wxPoint &pt, int flags=wxSIZE_USE_EXISTING) |
Moves the window to the given position. More... | |
void | SetPosition (const wxPoint &pt) |
Moves the window to the specified position. More... | |
Coordinate conversion functions | |
void | ClientToScreen (int *x, int *y) const |
Converts to screen coordinates from coordinates relative to this window. More... | |
wxPoint | ClientToScreen (const wxPoint &pt) const |
Converts to screen coordinates from coordinates relative to this window. More... | |
wxPoint | ConvertDialogToPixels (const wxPoint &pt) const |
Converts a point or size from dialog units to pixels. More... | |
wxSize | ConvertDialogToPixels (const wxSize &sz) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
wxPoint | ConvertPixelsToDialog (const wxPoint &pt) const |
Converts a point or size from pixels to dialog units. More... | |
wxSize | ConvertPixelsToDialog (const wxSize &sz) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
void | ScreenToClient (int *x, int *y) const |
Converts from screen to client window coordinates. More... | |
wxPoint | ScreenToClient (const wxPoint &pt) const |
Converts from screen to client window coordinates. More... | |
Drawing-related functions | |
virtual void | ClearBackground () |
Clears the window by filling it with the current background colour. More... | |
void | Freeze () |
Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. More... | |
void | Thaw () |
Re-enables window updating after a previous call to Freeze(). More... | |
bool | IsFrozen () const |
Returns true if the window is currently frozen by a call to Freeze(). More... | |
wxColour | GetBackgroundColour () const |
Returns the background colour of the window. More... | |
virtual wxBackgroundStyle | GetBackgroundStyle () const |
Returns the background style of the window. More... | |
virtual int | GetCharHeight () const |
Returns the character height for this window. More... | |
virtual int | GetCharWidth () const |
Returns the average character width for this window. More... | |
virtual wxVisualAttributes | GetDefaultAttributes () const |
Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()). More... | |
virtual wxSize | GetDPI () const |
Return the DPI of the display used by this window. More... | |
wxFont | GetFont () const |
Returns the font for this window. More... | |
wxColour | GetForegroundColour () const |
Returns the foreground colour of the window. More... | |
void | GetTextExtent (const wxString &string, int *w, int *h, int *descent=nullptr, int *externalLeading=nullptr, const wxFont *font=nullptr) const |
Gets the dimensions of the string as it would be drawn on the window with the currently selected font. More... | |
wxSize | GetTextExtent (const wxString &string) const |
Gets the dimensions of the string as it would be drawn on the window with the currently selected font. More... | |
const wxRegion & | GetUpdateRegion () const |
Returns the region specifying which parts of the window have been damaged. More... | |
wxRect | GetUpdateClientRect () const |
Get the update rectangle bounding box in client coords. More... | |
virtual bool | HasTransparentBackground () |
Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background. More... | |
virtual void | Refresh (bool eraseBackground=true, const wxRect *rect=nullptr) |
Causes this window, and all of its children recursively, to be repainted. More... | |
void | RefreshRect (const wxRect &rect, bool eraseBackground=true) |
Redraws the contents of the given rectangle: only the area inside it will be repainted. More... | |
virtual void | Update () |
Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop). More... | |
virtual bool | SetBackgroundColour (const wxColour &colour) |
Sets the background colour of the window. More... | |
virtual bool | SetBackgroundStyle (wxBackgroundStyle style) |
Sets the background style of the window. More... | |
virtual bool | IsTransparentBackgroundSupported (wxString *reason=nullptr) const |
Checks whether using transparent background might work. More... | |
virtual bool | SetFont (const wxFont &font) |
Sets the font for this window. More... | |
virtual bool | SetForegroundColour (const wxColour &colour) |
Sets the foreground colour of the window. More... | |
void | SetOwnBackgroundColour (const wxColour &colour) |
Sets the background colour of the window but prevents it from being inherited by the children of this window. More... | |
bool | InheritsBackgroundColour () const |
Return true if this window inherits the background colour from its parent. More... | |
bool | UseBgCol () const |
Return true if a background colour has been set for this window. More... | |
bool | UseBackgroundColour () const |
Return true if a background colour has been set for this window. More... | |
void | SetOwnFont (const wxFont &font) |
Sets the font of the window but prevents it from being inherited by the children of this window. More... | |
void | SetOwnForegroundColour (const wxColour &colour) |
Sets the foreground colour of the window but prevents it from being inherited by the children of this window. More... | |
bool | UseForegroundColour () const |
Return true if a foreground colour has been set for this window. More... | |
bool | InheritsForegroundColour () const |
Return true if this window inherits the foreground colour from its parent. More... | |
void | SetPalette (const wxPalette &pal) |
virtual bool | ShouldInheritColours () const |
Return true from here to allow the colours of this window to be changed by InheritAttributes(). More... | |
virtual void | SetThemeEnabled (bool enable) |
This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code. More... | |
virtual bool | GetThemeEnabled () const |
Returns true if the window uses the system theme for drawing its background. More... | |
virtual bool | CanSetTransparent () |
Returns true if the system supports transparent windows and calling SetTransparent() may succeed. More... | |
virtual bool | SetTransparent (wxByte alpha) |
Set the transparency of the window. More... | |
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. | |
wxEvtHandler * | GetEventHandler () const |
Returns the event handler for this window. More... | |
bool | HandleAsNavigationKey (const wxKeyEvent &event) |
This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case. More... | |
bool | HandleWindowEvent (wxEvent &event) const |
Shorthand for: More... | |
bool | ProcessWindowEvent (wxEvent &event) |
Convenient wrapper for ProcessEvent(). More... | |
bool | ProcessWindowEventLocally (wxEvent &event) |
Wrapper for wxEvtHandler::ProcessEventLocally(). More... | |
wxEvtHandler * | PopEventHandler (bool deleteHandler=false) |
Removes and returns the top-most event handler on the event handler stack. More... | |
void | PushEventHandler (wxEvtHandler *handler) |
Pushes this event handler onto the event stack for the window. More... | |
bool | RemoveEventHandler (wxEvtHandler *handler) |
Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack. More... | |
void | SetEventHandler (wxEvtHandler *handler) |
Sets the event handler for this window. More... | |
virtual void | SetNextHandler (wxEvtHandler *handler) |
wxWindows cannot be used to form event handler chains; this function thus will assert when called. More... | |
virtual void | SetPreviousHandler (wxEvtHandler *handler) |
wxWindows cannot be used to form event handler chains; this function thus will assert when called. More... | |
Window styles functions | |
long | GetExtraStyle () const |
Returns the extra style bits for the window. More... | |
virtual long | GetWindowStyleFlag () const |
Gets the window style that was passed to the constructor or Create() method. More... | |
long | GetWindowStyle () const |
See GetWindowStyleFlag() for more info. More... | |
bool | HasExtraStyle (int exFlag) const |
Returns true if the window has the given exFlag bit set in its extra styles. More... | |
bool | HasFlag (int flag) const |
Returns true if the window has the given flag bit set. More... | |
virtual void | SetExtraStyle (long exStyle) |
Sets the extra style bits for the window. More... | |
virtual void | SetWindowStyleFlag (long style) |
Sets the style of the window. More... | |
void | SetWindowStyle (long style) |
See SetWindowStyleFlag() for more info. More... | |
bool | ToggleWindowStyle (int flag) |
Turns the given flag on if it's currently turned off and vice versa. More... | |
Tab order functions | |
void | MoveAfterInTabOrder (wxWindow *win) |
Moves this window in the tab navigation order after the specified win. More... | |
void | MoveBeforeInTabOrder (wxWindow *win) |
Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it. More... | |
bool | Navigate (int flags=wxNavigationKeyEvent::IsForward) |
Performs a keyboard navigation action starting from this window. More... | |
bool | NavigateIn (int flags=wxNavigationKeyEvent::IsForward) |
Performs a keyboard navigation action inside this window. More... | |
Z order functions | |
virtual void | Lower () |
Lowers the window to the bottom of the window hierarchy (Z-order). More... | |
virtual void | Raise () |
Raises the window to the top of the window hierarchy (Z-order). More... | |
Window status functions | |
bool | Hide () |
Equivalent to calling wxWindow::Show(false). More... | |
virtual bool | HideWithEffect (wxShowEffect effect, unsigned int timeout=0) |
This function hides a window, like Hide(), but using a special visual effect if possible. More... | |
bool | IsEnabled () const |
Returns true if the window is enabled, i.e. if it accepts user input, false otherwise. More... | |
bool | IsExposed (int x, int y) const |
Returns true if the given point or rectangle area has been exposed since the last repaint. More... | |
bool | IsExposed (wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
bool | IsExposed (int x, int y, int w, int h) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
bool | IsExposed (wxRect &rect) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
virtual bool | IsShown () const |
Returns true if the window is shown, false if it has been hidden. More... | |
virtual bool | IsShownOnScreen () const |
Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well. More... | |
bool | Disable () |
Disables the window. More... | |
virtual bool | Enable (bool enable=true) |
Enable or disable the window for user input. More... | |
virtual bool | Show (bool show=true) |
Shows or hides the window. More... | |
virtual bool | ShowWithEffect (wxShowEffect effect, unsigned int timeout=0) |
This function shows a window, like Show(), but using a special visual effect if possible. More... | |
Context-sensitive help functions | |
wxString | GetHelpText () const |
Gets the help text to be used as context-sensitive help for this window. More... | |
void | SetHelpText (const wxString &helpText) |
Sets the help text to be used as context-sensitive help for this window. More... | |
virtual wxString | GetHelpTextAtPoint (const wxPoint &point, wxHelpEvent::Origin origin) const |
Gets the help text to be used as context-sensitive help for this window. More... | |
wxToolTip * | GetToolTip () const |
Get the associated tooltip or nullptr if none. More... | |
wxString | GetToolTipText () const |
Get the text of the associated tooltip or empty string if none. More... | |
void | SetToolTip (const wxString &tipString) |
Attach a tooltip to the window. More... | |
void | SetToolTip (wxToolTip *tip) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
void | UnsetToolTip () |
Unset any existing tooltip. More... | |
Popup/context menu functions | |
int | GetPopupMenuSelectionFromUser (wxMenu &menu, const wxPoint &pos=wxDefaultPosition) |
This function shows a popup menu at the given position in this window and returns the selected id. More... | |
int | GetPopupMenuSelectionFromUser (wxMenu &menu, int x, int y) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
bool | PopupMenu (wxMenu *menu, const wxPoint &pos=wxDefaultPosition) |
Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. More... | |
bool | PopupMenu (wxMenu *menu, int x, int y) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
virtual wxValidator * | GetValidator () |
Validator functions. More... | |
virtual void | SetValidator (const wxValidator &validator) |
Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type. More... | |
virtual bool | TransferDataFromWindow () |
Transfers values from child controls to data areas specified by their validators. More... | |
virtual bool | TransferDataToWindow () |
Transfers values to child controls from data areas specified by their validators. More... | |
virtual bool | Validate () |
Validates the current values of the child controls using their validators. More... | |
wxWindow properties functions | |
wxWindowID | GetId () const |
Returns the identifier of the window. More... | |
virtual wxString | GetLabel () const |
Generic way of getting a label from any window, for identification purposes. More... | |
virtual wxLayoutDirection | GetLayoutDirection () const |
Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported. More... | |
virtual wxCoord | AdjustForLayoutDirection (wxCoord x, wxCoord width, wxCoord widthTotal) const |
Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32. More... | |
virtual wxString | GetName () const |
Returns the window's name. More... | |
wxWindowVariant | GetWindowVariant () const |
Returns the value previously passed to SetWindowVariant(). More... | |
void | SetId (wxWindowID winid) |
Sets the identifier of the window. More... | |
virtual void | SetLabel (const wxString &label) |
Sets the window's label. More... | |
virtual void | SetLayoutDirection (wxLayoutDirection dir) |
Sets the layout direction for this window. More... | |
virtual void | SetName (const wxString &name) |
Sets the window's name. More... | |
void | SetWindowVariant (wxWindowVariant variant) |
Chooses a different variant of the window display to use. More... | |
wxAcceleratorTable * | GetAcceleratorTable () |
Gets the accelerator table for this window. More... | |
wxAccessible * | GetAccessible () |
Returns the accessible object for this window, if any. More... | |
virtual void | SetAcceleratorTable (const wxAcceleratorTable &accel) |
Sets the accelerator table for this window. More... | |
void | SetAccessible (wxAccessible *accessible) |
Sets the accessible for this window. More... | |
virtual wxAccessible * | CreateAccessible () |
Override to create a specific accessible object. More... | |
wxAccessible * | GetOrCreateAccessible () |
Returns the accessible object, calling CreateAccessible if necessary. More... | |
Window deletion functions | |
bool | Close (bool force=false) |
This function simply generates a wxCloseEvent whose handler usually tries to close the window. More... | |
virtual bool | Destroy () |
Destroys the window safely. More... | |
bool | IsBeingDeleted () const |
Returns true if this window is in process of being destroyed. More... | |
Drag and drop functions | |
virtual wxDropTarget * | GetDropTarget () const |
Returns the associated drop target, which may be nullptr. More... | |
virtual void | SetDropTarget (wxDropTarget *target) |
Associates a drop target with this window. More... | |
virtual void | DragAcceptFiles (bool accept) |
Enables or disables eligibility for drop file events (OnDropFiles). More... | |
Constraints, sizers and window layout functions | |
wxSizer * | GetContainingSizer () const |
Returns the sizer of which this window is a member, if any, otherwise nullptr. More... | |
wxSizer * | GetSizer () const |
Returns the sizer associated with the window by a previous call to SetSizer(), or nullptr. More... | |
void | SetSizer (wxSizer *sizer, bool deleteOld=true) |
Sets the window to have the given layout sizer. More... | |
void | SetSizerAndFit (wxSizer *sizer, bool deleteOld=true) |
Associate the sizer with the window and set the window size and minimal size accordingly. More... | |
wxLayoutConstraints * | GetConstraints () const |
Returns a pointer to the window's layout constraints, or nullptr if there are none. More... | |
void | SetConstraints (wxLayoutConstraints *constraints) |
Sets the window to have the given layout constraints. More... | |
virtual bool | Layout () |
Lays out the children of this window using the associated sizer. More... | |
void | SetAutoLayout (bool autoLayout) |
Determines whether the Layout() function will be called automatically when the window is resized. More... | |
bool | GetAutoLayout () const |
Returns true if Layout() is called automatically when the window is resized. More... | |
Mouse functions | |
void | CaptureMouse () |
Directs all mouse input to this window. More... | |
wxCaret * | GetCaret () const |
Returns the caret() associated with the window. More... | |
const wxCursor & | GetCursor () const |
Return the cursor associated with this window. More... | |
virtual bool | HasCapture () const |
Returns true if this window has the current mouse capture. More... | |
void | ReleaseMouse () |
Releases mouse input captured with CaptureMouse(). More... | |
void | SetCaret (wxCaret *caret) |
Sets the caret() associated with the window. More... | |
virtual bool | SetCursor (const wxCursor &cursor) |
Sets the window's cursor. More... | |
virtual void | WarpPointer (int x, int y) |
Moves the pointer to the given position on the window. More... | |
virtual bool | EnableTouchEvents (int eventsMask) |
Request generation of touch events for this window. More... | |
Miscellaneous functions | |
wxHitTest | HitTest (wxCoord x, wxCoord y) const |
Return where the given point lies, exactly. More... | |
wxHitTest | HitTest (const wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
wxBorder | GetBorder (long flags) const |
Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable. More... | |
wxBorder | GetBorder () const |
Get border for the flags of this window. More... | |
virtual void | DoUpdateWindowUI (wxUpdateUIEvent &event) |
Does the window-specific updating after processing the update event. More... | |
virtual WXWidget | GetHandle () const |
Returns the platform-specific handle of the physical window. More... | |
WXHWND | GTKGetWin32Handle () const |
This function is used only with wxGTK when running on Windows, to receive a wxWindow's underlying HWND. More... | |
virtual bool | HasMultiplePages () const |
This method should be overridden to return true if this window has multiple pages. More... | |
virtual void | InheritAttributes () |
This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours. More... | |
virtual void | InitDialog () |
Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators. More... | |
virtual bool | IsDoubleBuffered () const |
Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later. More... | |
void | SetDoubleBuffered (bool on) |
Turn on or off double buffering of the window if the system supports it. More... | |
virtual bool | IsRetained () const |
Returns true if the window is retained, false otherwise. More... | |
bool | IsThisEnabled () const |
Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called. More... | |
virtual bool | IsTopLevel () const |
Returns true if the given window is a top-level one. More... | |
virtual void | OnInternalIdle () |
This virtual function is normally only used internally, but sometimes an application may need it to implement functionality that should not be disabled by an application defining an OnIdle handler in a derived class. More... | |
virtual bool | SendIdleEvents (wxIdleEvent &event) |
Send idle event to window and all subwindows. More... | |
virtual bool | RegisterHotKey (int hotkeyId, int modifiers, int virtualKeyCode) |
Registers a system wide hotkey. More... | |
virtual bool | UnregisterHotKey (int hotkeyId) |
Unregisters a system wide hotkey. More... | |
virtual void | UpdateWindowUI (long flags=wxUPDATE_UI_NONE) |
This function sends one or more wxUpdateUIEvent to the window. More... | |
virtual void | DoPrepareUpdateWindowUI (wxUpdateUIEvent &event) const |
When UpdateWindowUI() runs, it creates instances of wxUpdateUIEvent. More... | |
Public Member Functions inherited from wxEvtHandler | |
wxEvtHandler () | |
Constructor. More... | |
virtual | ~wxEvtHandler () |
Destructor. More... | |
template<typename T , typename T1 , ... > | |
void | CallAfter (void(T::*method)(T1,...), T1 x1,...) |
Asynchronously call the given method. More... | |
template<typename T > | |
void | CallAfter (const T &functor) |
Asynchronously call the given functor. More... | |
bool | ProcessEventLocally (wxEvent &event) |
Try to process the event in this handler and all those chained to it. More... | |
bool | SafelyProcessEvent (wxEvent &event) |
Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process. More... | |
void | ProcessPendingEvents () |
Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail. More... | |
void | DeletePendingEvents () |
Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent(). More... | |
void | Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
Connects the given function dynamically with the event handler, id and event type. More... | |
void | Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More... | |
void | Connect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More... | |
bool | Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. More... | |
bool | Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=nullptr, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More... | |
bool | Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=nullptr, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More... | |
template<typename EventTag , typename Functor > | |
void | Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=nullptr) |
Binds the given function, functor or method dynamically with the event. More... | |
template<typename EventTag , typename Class , typename EventArg , typename EventHandler > | |
void | Bind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=nullptr) |
See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. More... | |
template<typename EventTag , typename Functor > | |
bool | Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=nullptr) |
Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. More... | |
template<typename EventTag , typename Class , typename EventArg , typename EventHandler > | |
bool | Unbind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=nullptr) |
See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. More... | |
void * | GetClientData () const |
Returns user-supplied client data. More... | |
wxClientData * | GetClientObject () const |
Returns a pointer to the user-supplied client data object. More... | |
void | SetClientData (void *data) |
Sets user-supplied client data. More... | |
void | SetClientObject (wxClientData *data) |
Set the client data object. More... | |
bool | GetEvtHandlerEnabled () const |
Returns true if the event handler is enabled, false otherwise. More... | |
wxEvtHandler * | GetNextHandler () const |
Returns the pointer to the next handler in the chain. More... | |
wxEvtHandler * | GetPreviousHandler () const |
Returns the pointer to the previous handler in the chain. More... | |
void | SetEvtHandlerEnabled (bool enabled) |
Enables or disables the event handler. More... | |
void | Unlink () |
Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted). More... | |
bool | IsUnlinked () const |
Returns true if the next and the previous handler pointers of this event handler instance are nullptr. More... | |
Public Member Functions inherited from wxObject | |
wxObject () | |
Default ctor; initializes to nullptr the internal reference data. More... | |
wxObject (const wxObject &other) | |
Copy ctor. More... | |
virtual | ~wxObject () |
Destructor. More... | |
virtual wxClassInfo * | GetClassInfo () const |
This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More... | |
wxObjectRefData * | GetRefData () const |
Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More... | |
bool | IsKindOf (const wxClassInfo *info) const |
Determines whether this class is a subclass of (or the same class as) the given class. More... | |
bool | IsSameAs (const wxObject &obj) const |
Returns true if this object has the same data pointer as obj. More... | |
void | Ref (const wxObject &clone) |
Makes this object refer to the data in clone. More... | |
void | SetRefData (wxObjectRefData *data) |
Sets the wxObject::m_refData pointer. More... | |
void | UnRef () |
Decrements the reference count in the associated data, and if it is zero, deletes the data. More... | |
void | UnShare () |
This is the same of AllocExclusive() but this method is public. More... | |
void | operator delete (void *buf) |
The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More... | |
void * | operator new (size_t size, const wxString &filename=nullptr, int lineNum=0) |
The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More... | |
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. More... | |
static wxWindow * | FindFocus () |
Finds the window or control which currently has the keyboard focus. More... | |
static wxWindow * | FindWindowById (long id, const wxWindow *parent=0) |
Find the first window with the given id. More... | |
static wxWindow * | FindWindowByLabel (const wxString &label, const wxWindow *parent=0) |
Find a window by its label. More... | |
static wxWindow * | FindWindowByName (const wxString &name, const wxWindow *parent=0) |
Find a window by its name (as given in a window constructor or Create() function call). More... | |
static wxWindow * | GetCapture () |
Returns the currently captured window. More... | |
static wxWindowID | NewControlId (int count=1) |
Create a new ID or range of IDs that are not currently in use. More... | |
static void | UnreserveControlId (wxWindowID id, int count=1) |
Unreserve an ID or range of IDs that was reserved by NewControlId(). More... | |
Static Public Member Functions inherited from wxEvtHandler | |
static void | AddFilter (wxEventFilter *filter) |
Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets. More... | |
static void | RemoveFilter (wxEventFilter *filter) |
Remove a filter previously installed with AddFilter(). More... | |
Protected Member Functions | |
virtual void | DoCentre (int direction) |
Centres the window. More... | |
virtual wxSize | DoGetBestSize () const |
Implementation of GetBestSize() that can be overridden. More... | |
virtual wxSize | DoGetBestClientSize () const |
Override this method to return the best size for a custom control. More... | |
virtual int | DoGetBestClientHeight (int width) const |
Override this method to implement height-for-width best size calculation. More... | |
virtual int | DoGetBestClientWidth (int height) const |
Override this method to implement width-for-height best size calculation. More... | |
virtual void | SetInitialBestSize (const wxSize &size) |
Sets the initial window size if none is given (i.e. at least one of the components of the size passed to ctor/Create() is wxDefaultCoord). More... | |
void | SendDestroyEvent () |
Generate wxWindowDestroyEvent for this window. More... | |
virtual bool | ProcessEvent (wxEvent &event) |
This function is public in wxEvtHandler but protected in wxWindow because for wxWindows you should always call ProcessEvent() on the pointer returned by GetEventHandler() and not on the wxWindow object itself. More... | |
bool | SafelyProcessEvent (wxEvent &event) |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More... | |
virtual void | QueueEvent (wxEvent *event) |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More... | |
virtual void | AddPendingEvent (const wxEvent &event) |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More... | |
void | ProcessPendingEvents () |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More... | |
bool | ProcessThreadEvent (const wxEvent &event) |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More... | |
Protected Member Functions inherited from wxEvtHandler | |
virtual bool | TryBefore (wxEvent &event) |
Method called by ProcessEvent() before examining this object event tables. More... | |
virtual bool | TryAfter (wxEvent &event) |
Method called by ProcessEvent() as last resort. More... | |
Protected Member Functions inherited from wxObject | |
void | AllocExclusive () |
Ensure that this object's data is not shared with any other object. More... | |
virtual wxObjectRefData * | CreateRefData () const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More... | |
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More... | |
Additional Inherited Members | |
Protected Attributes inherited from wxObject | |
wxObjectRefData * | m_refData |
Pointer to an object which is the object's reference-counted data. More... | |
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.
parent | Pointer to a parent window. |
id | Window identifier. If wxID_ANY, will automatically create an identifier. See Window IDs for more information about IDs. |
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 |
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.
|
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.
Reimplemented in wxPanel.
|
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 |
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 |
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.
child | Child window to add. |
|
protectedvirtual |
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.
|
virtual |
Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.
|
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.
hflag | Whether the horizontal scroll bar should always be visible. |
vflag | Whether the vertical scroll bar should always be visible. |
bool wxWindow::BeginRepositioningChildren | ( | ) |
Prepare for changing positions of multiple child windows.
This method should be called before changing positions of multiple child windows to reduce flicker and, in MSW case, even avoid display corruption in some cases. It is used internally by wxWidgets and called automatically when the window size changes but it can also be useful to call it from outside of the library if a repositioning involving multiple children is done without changing the window size.
If this method returns true, then EndRepositioningChildren() must be called after setting all children positions. Use ChildrenRepositioningGuard class to ensure that this requirement is satisfied.
void wxWindow::CacheBestSize | ( | const wxSize & | size | ) | const |
Sets the cached best size value.
void wxWindow::CallForEachChild | ( | const T & | functor | ) |
Invoke the given functor for all children of the given window recursively.
This function calls functor for the window itself and then for all of its children, recursively.
Example of using it for implementing a not very smart translation function:
bool wxWindow::CanAcceptFocus | ( | ) | const |
Can this window have focus right now?
If this method returns true, it means that calling SetFocus() will put focus either to this window or one of its children, if you need to know whether this window accepts focus itself, use IsFocusable()
bool wxWindow::CanAcceptFocusFromKeyboard | ( | ) | const |
Can this window be assigned focus from keyboard right now?
bool wxWindow::CanScroll | ( | int | orient | ) | const |
Returns true if this window can have a scroll bar in this orientation.
orient | Orientation to check, either wxHORIZONTAL or wxVERTICAL. |
|
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.
void wxWindow::CenterOnParent | ( | int | dir = wxBOTH | ) |
A synonym for CentreOnParent().
void wxWindow::Centre | ( | int | direction = wxBOTH | ) |
Centres the window.
direction | Specifies the direction for the centring. May be wxHORIZONTAL, wxVERTICAL or wxBOTH. It may also include the wxCENTRE_ON_SCREEN flag if you want to centre the window on the entire screen and not on its parent window. |
void wxWindow::CentreOnParent | ( | int | direction = wxBOTH | ) |
Centres the window on its parent.
This is a more readable synonym for Centre().
direction | Specifies the direction for the centring. May be wxHORIZONTAL, wxVERTICAL or wxBOTH. |
|
virtual |
Clears the window by filling it with the current background colour.
Does not cause an erase background event to be generated.
Notice that this uses wxClientDC to draw on the window and the results of doing it while also drawing on wxPaintDC for this window are undefined. Hence this method shouldn't be used from EVT_PAINT handlers, just use wxDC::Clear() on the wxPaintDC you already use there instead.
Converts to screen coordinates from coordinates relative to this window.
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.
x | A pointer to an integer value for the x coordinate. Pass the client coordinate in, and a screen coordinate will be passed out. |
y | A pointer to an integer value for the y coordinate. Pass the client coordinate in, and a screen coordinate will be passed out. |
wxPerl Note: In wxPerl this method returns a 2-element list instead of modifying its parameters.
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.
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.
force | false if the window's close handler should be able to veto the destruction of this window, true if it cannot. |
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.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
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.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool wxWindow::Create | ( | wxWindow * | parent, |
wxWindowID | id, | ||
const wxPoint & | pos = wxDefaultPosition , |
||
const wxSize & | size = wxDefaultSize , |
||
long | style = 0 , |
||
const wxString & | name = wxPanelNameStr |
||
) |
Construct the actual window object after creating the C++ object.
The non-default constructor of wxWindow class does two things: it initializes the C++ object and it also creates the window object in the underlying graphical toolkit. The Create() method can be used to perform the second part later, while the default constructor can be used to perform the first part only.
Please note that the underlying window must be created exactly once, i.e. if you use the default constructor, which doesn't do this, you must call Create() before using the window and if you use the non-default constructor, you can not call Create(), as the underlying window is already created.
Note that it is possible and, in fact, useful, to call some methods on the object between creating the C++ object itself and calling Create() on it, e.g. a common pattern to avoid showing the contents of a window before it is fully initialized is:
Also note that it is possible to create an object of a derived type and then call Create() on it:
This is notably used by XML Based Resource System (XRC).
The parameters of this method have exactly the same meaning as the non-default constructor parameters, please refer to them for their description.
|
virtual |
Override to create a specific accessible object.
|
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.
Reimplemented in wxAuiMDIChildFrame.
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).
void wxWindow::DisableFocusFromKeyboard | ( | ) |
Disable giving focus to this window using the keyboard navigation keys.
Pressing TAB
key will skip this window if this function was called on it, but it will still be possible to focus it by clicking on it with a pointing device.
|
protectedvirtual |
Centres the window.
direction | Specifies the direction for the centring. May be wxHORIZONTAL, wxVERTICAL or wxBOTH. It may also include the wxCENTRE_ON_SCREEN flag. |
|
protectedvirtual |
Override this method to implement height-for-width best size calculation.
Return the height needed to fully display the control contents if its width is fixed to the given value. Custom classes implementing wrapping should override this method and return the height corresponding to the number of lines needed to lay out the control contents at this width.
Currently this method is not used by wxWidgets yet, however it is planned that it will be used by the new sizer classes implementing height-for-width layout strategy in the future.
Notice that implementing this method or even implementing both it and DoGetBestClientWidth() doesn't replace overriding DoGetBestClientSize(), i.e. you still need to implement the latter as well in order to provide the best size when neither width nor height are constrained.
By default returns wxDefaultCoord meaning that the vertical component of DoGetBestClientSize() return value should be used.
|
protectedvirtual |
Override this method to return the best size for a custom control.
A typical implementation of this method should compute the minimal size needed to fully display the control contents taking into account the current font size.
The default implementation simply returns wxDefaultSize and GetBestSize() returns an arbitrary hardcoded size for the window, so you must override it when implementing a custom window class.
Notice that the best size returned by this function is cached internally, so if anything that results in the best size changing (e.g. change to the control contents) happens, you need to call InvalidateBestSize() to notify wxWidgets about it.
|
protectedvirtual |
Override this method to implement width-for-height best size calculation.
This method is exactly the same as DoGetBestClientHeight() except that it determines the width assuming the height is fixed instead of vice versa.
|
protectedvirtual |
Implementation of GetBestSize() that can be overridden.
Notice that it is usually more convenient to override DoGetBestClientSize() rather than this method itself as you need to explicitly account for the window borders size if you do the latter.
The default implementation of this function is designed for use in container windows, such as wxPanel, and works something like this:
Reimplemented in wxRichTextCtrl.
|
virtual |
When UpdateWindowUI() runs, it creates instances of wxUpdateUIEvent.
Those instances may vary depending on the window that the wxUpdateUIEvent will control. For example, a wxCheckBox with wxCHK_3STATE should enable wxUpdateUIEvent::Is3State(), but most other windows should not. This function can be overridden to perform the window-specific initializations, such as enabling setting the checkable state.
|
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:
|
virtual |
Enables or disables eligibility for drop file events (OnDropFiles).
accept | If true, the window is eligible for drop file events. If false, the window will not accept drop file events. |
|
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 re-enabled again when the parent is.
A window can be created initially disabled by calling this method on it before calling Create() to create the actual underlying window, e.g.
enable | If true, enables the window for input. If false, disables the window. |
Reimplemented in wxStaticBox.
|
virtual |
Request generation of touch events for this window.
Each call to this function supersedes the previous ones, i.e. if you want to receive events for both zoom and rotate gestures, you need to call
instead of calling it twice in a row as the second call would disable the first gesture.
eventsMask | Either wxTOUCH_NONE or wxTOUCH_ALL_GESTURES to disable or enable gesture events for this window. |
|
virtual |
Enables or disables visible indication of keyboard focus.
By default, controls behave in platform-appropriate way and show focus in the same way native applications do. In some very rare circumstances it may be desirable to change the default (notably multiline text controls don't normally have a focus indicator on Mac), which this method allows. It should only be used if you have a good understanding of the native platform's guidelines and user expectations.
This method is only implemented on Mac.
void wxWindow::EndRepositioningChildren | ( | ) |
Fix child window positions after setting all of them at once.
This method must be called if and only if the previous call to BeginRepositioningChildren() returned true.
|
static |
Finds the window or control which currently has the keyboard focus.
Find a child of this window, by name.
May return this if it matches itself.
Notice that only real children, not top level windows using this window as parent, are searched by this function.
wxWindow* wxWindow::FindWindow | ( | long | id | ) | const |
Find a child of this window, by id.
May return this if it matches itself.
Notice that only real children, not top level windows using this window as parent, are searched by this function.
Find the first window with the given id.
If parent is nullptr, 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.
|
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 nullptr, 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 and, unlike with FindWindow(), recurses into top level child windows too.
|
static |
Find a window by its name (as given in a window constructor or Create() function call).
If parent is nullptr, 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 and, unlike FindWindow(), recurses into top level child windows too.
If no window with such name is found, FindWindowByLabel() is called, i.e. the name is interpreted as (internal) name first but if this fails, it's internal as (user-visible) label. As this behaviour may be confusing, it is usually better to use either the FindWindow() overload taking the name or FindWindowByLabel() directly.
|
virtual |
Sizes the window to fit its best size.
Using this function is equivalent to setting window size to the return value of GetBestSize().
Note that, unlike SetSizerAndFit(), this function only changes the current window size and doesn't change its minimal size.
|
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 re-enable 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.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.
A DPI-independent pixel is just a pixel at the standard 96 DPI resolution. To keep the same physical size at higher resolution, the physical pixel value must be scaled by GetDPIScaleFactor() but this scaling may be already done by the underlying toolkit (GTK+, Cocoa, ...) automatically. This method performs the conversion only if it is not already done by the lower level toolkit and so by using it with pixel values you can guarantee that the physical size of the corresponding elements will remain the same in all resolutions under all platforms. For example, instead of creating a bitmap of the hard coded size of 32 pixels you should use
to avoid using tiny bitmaps on high DPI screens.
Notice that this function is only needed when using hard coded pixel values. It is not necessary if the sizes are already based on the DPI-independent units such as dialog units or if you are relying on the controls automatic best size determination and using sizers to lay out them.
Also note that if either component of sz has the special value of -1, it is returned unchanged independently of the current DPI, to preserve the special value of -1 in wxWidgets API (it is often used to mean "unspecified").
Non window-specific DPI-independent pixels conversion functions.
The display resolution depends on the window in general as different windows can appear on different monitors using different resolutions, however sometimes no window is available for converting the resolution independent pixels to the physical values and in this case these static overloads can be used with nullptr value for w argument.
Using these methods is discouraged as passing nullptr will prevent your application from correctly supporting monitors with different resolutions even in the future wxWidgets versions which will add support for them, and passing non-null window is just a less convenient way of calling the non-static FromDIP() method.
int wxWindow::FromDIP | ( | int | d | ) | const |
Convert DPI-independent distance in pixels to the value in pixels appropriate for the current toolkit.
This is the same as FromDIP(const wxSize& sz) overload, but assumes that the resolution is the same in horizontal and vertical directions.
If d has the special value of -1, it is returned unchanged independently of the current DPI.
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convert from physical pixels to logical pixels.
All window coordinates in wxWidgets API are always expressed in logical pixels, but the meaning of logical pixels depends on the platform. Physical pixels always mean the same thing and refer to the actual display pixels or, also, sizes of the bitmaps. Under some platforms logical pixels are actually the same as physical ones (this is the case for MSW), but under other platforms (e.g. GTK or macOS) this is not the case and GetContentScaleFactor() defines the ratio between one logical and one physical pixel.
This function can be used to convert a value in physical pixels to logical pixels independently of the platform used. It simply does nothing under MSW, but divides the input value by the content scale factor under the other platforms.
Note that dividing an integer value by scale factor doesn't always yield an integer value. This function rounds the resulting value to the closest integer, e.g. 15 physical pixels are translated to 8, not 7, logical pixels in 200% DPI scaling. This ensures that a physical bitmap of size 15 is not truncated if the result of this function is used to create a window to show it, but it does mean that there will be one extra pixel, not covered by this bitmap, left.
Convert from physical pixels to logical pixels for any window.
This function can be used without any window pointer, i.e. w can be nullptr. In this case, it uses the content scale factor of the main screen if supported or just does nothing (i.e. uses scale factor of 1) otherwise.
Using member overloads is always preferable, if possible, as they always use the actually appropriate content scale factor.
int wxWindow::FromPhys | ( | int | d | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
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.
bool wxWindow::GetAutoLayout | ( | ) | const |
Returns true if Layout() is called automatically when the window is resized.
This function is mostly useful for wxWidgets itself and is rarely needed in the application code.
wxColour wxWindow::GetBackgroundColour | ( | ) | const |
Returns the background colour of the window.
|
virtual |
Returns the background style of the window.
int wxWindow::GetBestHeight | ( | int | width | ) | const |
Returns the best height needed by this window if it had the given width.
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().
Override virtual DoGetBestSize() or, better, because it's usually more convenient, DoGetBestClientSize() when writing your own custom window class to change the value returned by this public non-virtual method.
Notice that the best size respects the minimal and maximal size explicitly set for the window, if any. So even if some window believes that it needs 200 pixels horizontally, calling SetMaxSize() with a width of 100 would ensure that GetBestSize() returns the width of at most 100 pixels.
|
virtual |
Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
int wxWindow::GetBestWidth | ( | int | height | ) | const |
Returns the best width needed by this window if it had the given height.
wxBorder wxWindow::GetBorder | ( | ) | const |
Get border for the flags of this window.
wxBorder wxWindow::GetBorder | ( | long | flags | ) | const |
Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.
|
static |
Returns the currently captured window.
wxCaret* wxWindow::GetCaret | ( | ) | const |
Returns the caret() associated with the window.
|
virtual |
Returns the character height for this window.
|
virtual |
Returns the average character width for this window.
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*
.
const wxWindowList& wxWindow::GetChildren | ( | ) | const |
Returns a const reference to the list of the window's children.
wxWindowList
is a type-safe wxList-like class whose elements are of type wxWindow*
.
|
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.
|
virtual |
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...)
Reimplemented in wxFrame.
wxRect wxWindow::GetClientRect | ( | ) | const |
Get the client rectangle in window (i.e. client) coordinates.
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).
wxLayoutConstraints* wxWindow::GetConstraints | ( | ) | const |
Returns a pointer to the window's layout constraints, or nullptr if there are none.
wxSizer* wxWindow::GetContainingSizer | ( | ) | const |
Returns the sizer of which this window is a member, if any, otherwise nullptr.
double wxWindow::GetContentScaleFactor | ( | ) | const |
Returns the factor mapping logical pixels of this window to physical pixels.
This function can be used to portably determine the number of physical pixels in a window of the given size, by multiplying the window size by the value returned from it. I.e. it returns the factor converting window coordinates to "content view" coordinates, where the view can be just a simple window displaying a wxBitmap or wxGLCanvas or any other kind of window rendering arbitrary "content" on screen.
For the platforms not doing any pixel mapping, i.e. where logical and physical pixels are one and the same, this function always returns 1.0 and so using it is, in principle, unnecessary and could be avoided by using preprocessor check for wxHAS_DPI_INDEPENDENT_PIXELS
not being defined, however using this function unconditionally under all platforms is usually simpler and so preferable.
wxHAS_DPI_INDEPENDENT_PIXELS
, such as wxMSW.const wxCursor& wxWindow::GetCursor | ( | ) | const |
Return the cursor associated with this window.
|
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 |
Return the DPI of the display used by this window.
The returned value can be different for different windows on systems with support for per-monitor DPI values, such as Microsoft Windows 10.
If the DPI is not available, returns wxSize(0,0)
object.
double wxWindow::GetDPIScaleFactor | ( | ) | const |
Returns the ratio of the DPI used by this window to the standard DPI.
The returned value is 1 for standard DPI screens or 2 for "200% scaling" and, unlike for GetContentScaleFactor(), is the same under all platforms.
This factor should be used to increase the size of icons and similar windows whose best size is not based on text metrics when using DPI scaling.
E.g. the program may load a 32px bitmap if the content scale factor is 1.0 or 64px version of the same bitmap if it is 2.0 or bigger.
Notice that this method should not be used for window sizes expressed in pixels, as they are already scaled by this factor by the underlying toolkit under some platforms. Use FromDIP() for anything window-related instead.
|
virtual |
Returns the associated drop target, which may be nullptr.
|
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.
wxEvtHandler* wxWindow::GetEventHandler | ( | ) | const |
Returns the event handler for this window.
By default, the window is its own event handler.
long wxWindow::GetExtraStyle | ( | ) | const |
Returns the extra style bits for the window.
wxColour wxWindow::GetForegroundColour | ( | ) | const |
Returns the foreground colour of the window.
wxWindow* wxWindow::GetGrandParent | ( | ) | const |
Returns the grandparent of a window, or nullptr if there isn't one.
|
virtual |
Returns the platform-specific handle of the physical window.
Cast it to an appropriate handle, such as HWND for Windows, or GtkWidget for GTK.
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.
|
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.
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.
|
virtual |
Generic way of getting a label from any window, for identification purposes.
Reimplemented in wxControl, wxCommandLinkButton, and wxButton.
|
virtual |
Returns the layout direction for this window, Note that wxLayout_Default
is returned if layout direction is not supported.
|
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().
int wxWindow::GetMaxHeight | ( | ) | const |
Returns the vertical component of window maximal size.
The returned value is wxDefaultCoord if the maximal width was not set.
|
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().
int wxWindow::GetMaxWidth | ( | ) | const |
Returns the horizontal component of window maximal size.
The returned value is wxDefaultCoord if the maximal width was not set.
|
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.
int wxWindow::GetMinHeight | ( | ) | const |
Returns the vertical component of window minimal size.
The returned value is wxDefaultCoord if the minimal height was not set.
|
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.
int wxWindow::GetMinWidth | ( | ) | const |
Returns the horizontal component of window minimal size.
The returned value is wxDefaultCoord if the minimal width was not set.
|
virtual |
wxWindow* wxWindow::GetNextSibling | ( | ) | const |
Returns the next window after this one among the parent's children or nullptr if this window is the last child.
wxAccessible* wxWindow::GetOrCreateAccessible | ( | ) |
Returns the accessible object, calling CreateAccessible if necessary.
May return nullptr, in which case system-provide accessible is used.
wxWindow* wxWindow::GetParent | ( | ) | const |
Returns the parent of the window, or nullptr if there is no parent.
int wxWindow::GetPopupMenuSelectionFromUser | ( | wxMenu & | menu, |
const wxPoint & | pos = wxDefaultPosition |
||
) |
This function shows a popup menu at the given position in this window and returns the selected id.
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. It is recommended to not explicitly specify coordinates when calling this method in response to mouse click, because some of the ports (namely, wxGTK) can do a better job of positioning the menu in that case.
wxID_NONE
if none selected or an error occurred.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.
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.
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.
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).
wxWindow* wxWindow::GetPrevSibling | ( | ) | const |
Returns the previous window before this one among the parent's children or nullptr if this window is the first child.
wxRect wxWindow::GetRect | ( | ) | const |
Returns the position and size of the window as a wxRect object.
wxPoint wxWindow::GetScreenPosition | ( | ) | const |
Returns the window position in screen coordinates, whether the window is a child window or a top level one.
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.
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. |
wxRect wxWindow::GetScreenRect | ( | ) | const |
|
virtual |
Returns the built-in scrollbar position.
|
virtual |
Returns the built-in scrollbar range.
|
virtual |
Returns the built-in scrollbar thumb size.
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.
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).
wxSizer* wxWindow::GetSizer | ( | ) | const |
Returns the sizer associated with the window by a previous call to SetSizer(), or nullptr.
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 = nullptr , |
||
int * | externalLeading = nullptr , |
||
const wxFont * | font = nullptr |
||
) | 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.
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).
|
virtual |
Returns true if the window uses the system theme for drawing its background.
wxToolTip* wxWindow::GetToolTip | ( | ) | const |
Get the associated tooltip or nullptr if none.
wxString wxWindow::GetToolTipText | ( | ) | const |
Get the text of the associated tooltip or empty string if none.
wxRect wxWindow::GetUpdateClientRect | ( | ) | const |
Get the update rectangle bounding box in client coords.
const wxRegion& wxWindow::GetUpdateRegion | ( | ) | const |
Returns the region specifying which parts of the window have been damaged.
Should only be called within a wxPaintEvent handler.
|
virtual |
Validator functions.
Returns a pointer to the current validator for the window, or nullptr if there is none.
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.
void wxWindow::GetVirtualSize | ( | int * | width, |
int * | height | ||
) | const |
Like the other GetVirtualSize() overload but uses pointers instead.
width | Receives the window virtual width. |
height | Receives the window virtual height. |
|
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 |
Gets the window style that was passed to the constructor or Create() method.
GetWindowStyle() is another name for the same function.
Reimplemented in wxAuiToolBar.
wxWindowVariant wxWindow::GetWindowVariant | ( | ) | const |
Returns the value previously passed to SetWindowVariant().
WXHWND wxWindow::GTKGetWin32Handle | ( | ) | const |
This function is used only with wxGTK when running on Windows, to receive a wxWindow's underlying HWND.
Whereas GetHandle() returns a port-specific handle (a GtkWidget on wxGTK), this function returns the handle which underlies the GtkWidget itself.
If you do need to use it, please note that this function doesn't exist anywhere besides wxGTK on Windows, and so any code using it must be conditionally guarded against using, for example:
Note that this function will return nullptr if the Window has not yet been initialized ("realized" in GTK terms) or is otherwise invalid.
A Window is generally realized once it has been shown, and code which needs to run as soon as the Window is realized should hook wxWindowCreateEvent to do so.
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.
bool wxWindow::HandleWindowEvent | ( | wxEvent & | event | ) | const |
Shorthand for:
|
virtual |
Returns true if this window has the current mouse capture.
bool wxWindow::HasExtraStyle | ( | int | exFlag | ) | const |
Returns true if the window has the given exFlag bit set in its extra styles.
bool wxWindow::HasFlag | ( | int | flag | ) | const |
Returns true if the window has the given flag bit set.
|
virtual |
Returns true if the window (or in case of composite controls, its main child window) has focus.
|
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.
orient | Orientation to check, either wxHORIZONTAL or wxVERTICAL. |
|
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 |
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.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Return where the given point lies, exactly.
This method is used to test whether the point lies inside the client window area or on one of its scrollbars.
The point coordinates are specified in client window coordinates.
|
virtual |
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.
Override this function when that is useful (such as for wxStaticText which can stretch over several lines). Parameter availableOtherDir tells the item how much more space there is available in the opposite direction (-1 if unknown).
|
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.
bool wxWindow::InheritsBackgroundColour | ( | ) | const |
Return true if this window inherits the background colour from its parent.
bool wxWindow::InheritsForegroundColour | ( | ) | const |
Return true if this window inherits the foreground colour from its parent.
|
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.
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 at the point of disappearing anyhow.
bool wxWindow::IsDescendant | ( | wxWindow * | win | ) | const |
Check if the specified window is a descendant of this one.
Returns true if the window is a descendant (i.e. a child or grand-child or grand-grand-child or ...) of this one.
Notice that a window can never be a descendant of another one if they are in different top level windows, i.e. a child of a wxDialog is not considered to be a descendant of dialogs parent wxFrame.
win | Any window, possible nullptr (false is always returned then). |
|
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.
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()
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 a paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
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 | ( | 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::IsFocusable | ( | ) | const |
Can this window itself have focus?
bool wxWindow::IsFrozen | ( | ) | const |
|
virtual |
Returns true if the window is retained, false otherwise.
|
virtual |
Return whether a scrollbar is always shown.
orient | Orientation to check, either wxHORIZONTAL or wxVERTICAL. |
|
virtual |
Returns true if the window is shown, false if it has been hidden.
|
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.
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 |
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).
Reimplemented in wxAuiMDIChildFrame.
|
virtual |
Checks whether using transparent background might work.
If this function returns false, calling SetBackgroundStyle() with wxBG_STYLE_TRANSPARENT is not going to work. If it returns true, setting transparent style should normally succeed.
Notice that this function would typically be called on the parent of a window you want to set transparent background style for as the window for which this method is called must be fully created.
reason | If not nullptr, a reason message is provided if transparency is not supported. |
|
virtual |
Lays out the children of this window using the associated sizer.
If a sizer hadn't been associated with this window (see SetSizer()), this function doesn't do anything, unless this is a top level window (see wxTopLevelWindow::Layout()).
Note that this method is called automatically when the window size changes if it has the associated sizer (or if SetAutoLayout() with true argument had been explicitly called), ensuring that it is always laid out correctly.
Reimplemented in wxTopLevelWindow, and wxPanel.
bool wxWindow::LineDown | ( | ) |
Same as ScrollLines (1).
bool wxWindow::LineUp | ( | ) |
Same as ScrollLines (-1).
|
virtual |
Lowers the window to the bottom of the window hierarchy (Z-order).
void wxWindow::Move | ( | const wxPoint & | pt, |
int | flags = wxSIZE_USE_EXISTING |
||
) |
Moves the window to the given position.
pt | wxPoint object representing the position. |
flags | See SetSize() for more info about this parameter. |
void wxWindow::Move | ( | int | x, |
int | y, | ||
int | flags = wxSIZE_USE_EXISTING |
||
) |
Moves the window to the given position.
x | Required x position. |
y | Required y position. |
flags | See SetSize() for more info about this parameter. |
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.
win | A sibling of this window which should precede it in tab order, must not be nullptr |
void wxWindow::MoveBeforeInTabOrder | ( | wxWindow * | win | ) |
Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.
void wxWindow::MSWDisableComposited | ( | ) |
Disable the use native double buffering in wxMSW.
This MSW-specific function can be used to disable the use of WS_EX_COMPOSITED
for this window and all of its parents and so allow using wxClientDC with it.
WS_EX_COMPOSITED
style is turned on by default when creating the windows and it is strongly recommended not to use this functions to remove it, but to instead change the drawing code to avoid using wxClientDC.
If you do need to use it, please note that this function doesn't exist in the other ports and has to be explicitly bracketed by the checks for wxMSW, e.g.
bool wxWindow::Navigate | ( | int | flags = wxNavigationKeyEvent::IsForward | ) |
Performs a keyboard navigation action starting from this window.
This method is equivalent to calling NavigateIn() method on the parent window.
flags | A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange. |
bool wxWindow::NavigateIn | ( | int | flags = wxNavigationKeyEvent::IsForward | ) |
Performs a keyboard navigation action inside this window.
See Navigate() for more information.
|
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.
count | The number of sequential IDs to reserve. |
|
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).
bool wxWindow::PageUp | ( | ) |
Same as ScrollPages (-1).
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:
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).
deleteHandler | If this is true, the handler will be deleted after it is removed (and the returned value will be nullptr). |
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).
Note that this function switches focus to this window before showing the menu.
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.
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.
|
protectedvirtual |
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.
|
protected |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.
|
protected |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.
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.
bool wxWindow::ProcessWindowEventLocally | ( | wxEvent & | event | ) |
Wrapper for wxEvtHandler::ProcessEventLocally().
This method is similar to ProcessWindowEvent() but can be used to search for the event handler only in this window and any event handlers pushed on top of it. Unlike ProcessWindowEvent() it won't propagate the event upwards. But it will use the validator and event handlers associated with this window, if any.
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:
you will end up with the following situation:
Note that you can use wxWindow::PopEventHandler to remove the event handler.
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). |
|
protectedvirtual |
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.
|
virtual |
Raises the window to the top of the window hierarchy (Z-order).
Notice that this function only requests the window manager to raise this window to the top of Z-order. Depending on its configuration, the window manager may raise the window, not do it at all or indicate that a window requested to be raised in some other way, e.g. by flashing its icon if it is minimized.
|
virtual |
Causes this window, and all of its children recursively, 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.
eraseBackground | If true, the background will be erased too. Note that in non-MSW ports background is always erased. |
rect | If non-null, only the given rectangle will be treated as damaged. |
Reimplemented in wxMenuBar.
void wxWindow::RefreshRect | ( | const wxRect & | rect, |
bool | eraseBackground = true |
||
) |
|
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.
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 key code of the hotkey, e.g. an ASCII character such as 'K' or one of elements of wxKeyCode enum. |
void wxWindow::ReleaseMouse | ( | ) |
Releases mouse input captured with CaptureMouse().
|
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.
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.
handler | The event handler to remove, must be non-null and must be present in this windows event handlers stack. |
|
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.
Notice that currently you need to explicitly call wxNotebook::RemovePage() before reparenting a notebook page.
newParent | New parent. |
|
protected |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.
Converts from screen to client window coordinates.
pt | The screen position. |
void wxWindow::ScreenToClient | ( | int * | x, |
int * | y | ||
) | const |
Converts from screen to client window coordinates.
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 |
Scrolls the window by the given number of lines down (if lines is positive) or up.
Reimplemented in wxRibbonPage, and wxRibbonGallery.
|
virtual |
Scrolls the window by the given number of pages down (if pages is positive) or up.
|
virtual |
Physically scrolls the pixels in the window and move child windows accordingly.
dx | Amount to scroll horizontally. |
dy | Amount to scroll vertically. |
rect | Rectangle to scroll, if it is nullptr, the whole window is scrolled (this is always the case under wxGTK which doesn't support this parameter) |
|
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 |
Send idle event to window and all subwindows.
Returns true if more idle time is requested.
|
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.
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).
flags | See description of this parameter in SendSizeEvent() documentation. |
|
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.
autoLayout | Set this to true if you wish the Layout() function to be called automatically when the window is resized. |
|
virtual |
Sets the background colour of the window.
Notice that as with SetForegroundColour(), setting the background colour of a native control may not affect the entire control and could be not supported at all depending on the control and platform.
Please see InheritAttributes() for explanation of the difference between this method and SetOwnBackgroundColour().
colour | The colour to be used as the background colour; pass wxNullColour to reset to the default colour. Note that you may want to use wxSystemSettings::GetColour() to retrieve a suitable colour to use rather than setting a hard-coded one. |
Reimplemented in wxListCtrl.
|
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.
Under wxGTK, wxOSX and wxMSW, you can use wxBG_STYLE_TRANSPARENT to obtain full transparency of the window background. Note that wxGTK supports this only since GTK 2.12 with a compositing manager enabled, call IsTransparentBackgroundSupported() to check whether this is the case, see the example of doing it in the shapedsample". Under wxMSW this is supported since 3.3.0.
Also, in order for SetBackgroundStyle(wxBG_STYLE_TRANSPARENT)
to work, it must be called before Create(). If you're using your own wxWindow-derived class you should write your code in the following way:
|
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().
void wxWindow::SetCaret | ( | wxCaret * | caret | ) |
Sets the caret() associated with the window.
void wxWindow::SetClientSize | ( | const wxRect & | rect | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void wxWindow::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 wxWindow::SetClientSize | ( | int | width, |
int | height | ||
) |
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.
Note that special value of -1 which can be used in some other functions to preserve the existing size is not supported for width and height here, i.e. they both must be valid, positive integers.
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.
constraints | The constraints to set. Pass nullptr to disassociate and delete the window's constraints. |
void wxWindow::SetContainingSizer | ( | wxSizer * | sizer | ) |
Used by wxSizer internally to notify the window about being managed by the given sizer.
This method should not be called from outside the library, unless you're implementing a custom sizer class – and in the latter case you must call this method with the pointer to the sizer itself whenever a window is added to it and with nullptr argument when the window is removed from it.
|
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.
cursor | Specifies the cursor that the window should normally display. |
void wxWindow::SetDoubleBuffered | ( | bool | on | ) |
Turn on or off double buffering of the window if the system supports it.
|
virtual |
Associates a drop target with this window.
If the window already has a drop target, it is deleted.
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.
handler | Specifies the handler to be set. Cannot be nullptr. |
|
virtual |
Sets the extra style bits for the window.
The currently defined extra style bits are reported in the class description.
|
virtual |
This sets the window to receive keyboard input.
Reimplemented in wxPanel.
|
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 |
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().
font | Font to associate with this window, pass wxNullFont to reset to the default font. |
Reimplemented in wxRichTextCtrl, wxInfoBar, wxAuiNotebook, and wxAuiToolBar.
|
virtual |
Sets the foreground colour of the window.
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. Additionally, not all native controls support changing their foreground colour so this method may change their colour only partially or even not at all.
Please see InheritAttributes() for explanation of the difference between this method and SetOwnForegroundColour().
colour | The colour to be used as the foreground colour; pass wxNullColour to reset to the default colour. |
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.
void wxWindow::SetId | ( | wxWindowID | winid | ) |
Sets the identifier of the window.
|
protectedvirtual |
Sets the initial window size if none is given (i.e. at least one of the components of the size passed to ctor/Create() is wxDefaultCoord).
void 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.)
|
virtual |
Sets the window's label.
Please note that not all windows have labels and this function may do nothing in this case. And some other derived windows use different functions for changing the text shown in them, e.g. wxTextCtrl uses wxTextCtrl::SetValue() or wxTextCtrl::ChangeValue() and trying to use SetLabel() on it will assert to help to detect possibly erroneous calls to SetLabel().
label | The window label. |
Reimplemented in wxStaticText, wxControl, wxCommandLinkButton, and wxButton.
|
virtual |
Sets the layout direction for this window.
This function is only supported under MSW and GTK platforms, but not under Mac currently.
|
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:
|
virtual |
Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.
Reimplemented in wxTopLevelWindow.
|
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:
|
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.
Reimplemented in wxTopLevelWindow.
|
virtual |
|
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.
Reimplemented from wxEvtHandler.
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.
void wxWindow::SetOwnFont | ( | const wxFont & | font | ) |
Sets the font of the window but prevents it from being inherited by the children of this window.
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.
void wxWindow::SetPalette | ( | const wxPalette & | pal | ) |
void wxWindow::SetPosition | ( | const wxPoint & | pt | ) |
Moves the window to the specified position.
This is exactly the same as calling Move() with the default arguments.
|
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.
Reimplemented from wxEvtHandler.
|
virtual |
Sets the scrollbar properties of a built-in scrollbar.
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. |
Reimplemented in wxScrollBar.
|
virtual |
Sets the position of one of the built-in scrollbars.
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. |
void wxWindow::SetSize | ( | const wxRect & | rect | ) |
Sets the size of the window in pixels.
The size is specified using a wxRect, wxSize or by a couple of int
objects.
void wxWindow::SetSize | ( | const wxSize & | size | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void wxWindow::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 wxWindow::SetSize | ( | int | x, |
int | y, | ||
int | width, | ||
int | height, | ||
int | sizeFlags = wxSIZE_AUTO |
||
) |
Sets the size of the window in pixels.
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:
|
|
virtual |
Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.
Please use SetMinSize() and SetMaxSize() instead.
Reimplemented in wxTopLevelWindow.
|
virtual |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
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.
sizer | The sizer to set. Pass nullptr 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. |
void wxWindow::SetSizerAndFit | ( | wxSizer * | sizer, |
bool | deleteOld = true |
||
) |
Associate the sizer with the window and set the window size and minimal size accordingly.
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 minimal size to the same size, this preventing the user from resizing this window to be less than this minimal size (if it's a top-level window which can be directly resized by the user).
|
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 | ( | const wxString & | tipString | ) |
Attach a tooltip to the window.
wxToolTip pointer can be nullptr 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.
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.
|
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 |
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.
void wxWindow::SetWindowStyle | ( | long | style | ) |
See SetWindowStyleFlag() for more info.
|
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 called after changing the others for the change to take place immediately.
See Window styles for more information about flags.
Reimplemented in wxListCtrl, and wxAuiToolBar.
void wxWindow::SetWindowVariant | ( | wxWindowVariant | variant | ) |
Chooses a different variant of the window display to use.
Window variants currently just differ in size, as can be seen from wxWindowVariant documentation. Under all platforms but macOS, this function does nothing more than change the font used by the window. However under macOS it is implemented natively and selects the appropriate variant of the native widget, which has better appearance than just scaled down or up version of the normal variant, so it should be preferred to directly tweaking the font size.
By default the controls naturally use the normal variant.
|
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.
Reimplemented in wxRichTextCtrl.
|
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.
Notice that the default state of newly created top level windows is hidden (to allow you to create their contents without flicker) unlike for all the other, not derived from wxTopLevelWindow, windows that are by default created in the shown state.
show | If true displays the window. Otherwise, hides it. |
Reimplemented in wxDialog, and wxAuiMDIChildFrame.
|
virtual |
This function shows a window, like Show(), but using a special visual effect if possible.
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. |
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.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convert pixel values of the current toolkit to DPI-independent pixel values.
A DPI-independent pixel is just a pixel at the standard 96 DPI resolution. To keep the same physical size at higher resolution, the physical pixel value must be scaled by GetDPIScaleFactor() but this scaling may be already done by the underlying toolkit (GTK+, Cocoa, ...) automatically. This method performs the conversion only if it is not already done by the lower level toolkit, For example, you may want to use this to store window sizes and positions so that they can be re-used regardless of the display DPI:
Also note that if either component of sz has the special value of -1, it is returned unchanged independently of the current DPI, to preserve the special value of -1 in wxWidgets API (it is often used to mean "unspecified").
Non window-specific pixel to DPI-independent pixels conversion functions.
The display resolution depends on the window in general as different windows can appear on different monitors using different resolutions, however sometimes no window is available for converting the resolution independent pixels to the physical values and in this case these static overloads can be used with nullptr value for w argument.
Using these methods is discouraged as passing nullptr will prevent your application from correctly supporting monitors with different resolutions even in the future wxWidgets versions which will add support for them, and passing non-null window is just a less convenient way of calling the non-static ToDIP() method.
int wxWindow::ToDIP | ( | int | d | ) | const |
Convert pixel values of the current toolkit to DPI-independent pixel values.
This is the same as ToDIP(const wxSize& sz) overload, but assumes that the resolution is the same in horizontal and vertical directions.
If d has the special value of -1, it is returned unchanged independently of the current DPI.
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
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.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convert from logical pixels to physical pixels.
This function performs the transformation in the converse direction compared to FromPhys().
Convert from logical pixels to physical pixels for any window.
This function can be used without any window pointer, i.e. w can be nullptr. In this case, it uses the content scale factor of the main screen if supported or just does nothing (i.e. uses scale factor of 1) otherwise.
Using member overloads is always preferable, if possible, as they always use the actually appropriate content scale factor.
int wxWindow::ToPhys | ( | int | d | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
virtual |
Transfers values from child controls to data areas specified by their validators.
Returns false if a transfer failed.
Notice that this also calls TransferDataFromWindow() for all children recursively.
|
virtual |
Transfers values to child controls from data areas specified by their validators.
Notice that this also calls TransferDataToWindow() for all children recursively.
|
virtual |
Unregisters a system wide hotkey.
hotkeyId | Numeric identifier of the hotkey. Must be the same id that was passed to RegisterHotKey(). |
|
static |
Unreserve an ID or range of IDs that was reserved by NewControlId().
See Window IDs for more information.
id | The starting ID of the range of IDs to unreserve. |
count | The number of sequential IDs to unreserve. |
void wxWindow::UnsetToolTip | ( | ) |
|
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 |
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.
bool wxWindow::UseBackgroundColour | ( | ) | const |
Return true if a background colour has been set for this window.
Same as UseBgCol()
bool wxWindow::UseBgCol | ( | ) | const |
Return true if a background colour has been set for this window.
bool wxWindow::UseForegroundColour | ( | ) | const |
Return true if a foreground colour has been set for this window.
|
virtual |
Validates the current values of the child controls using their validators.
Notice that this also calls Validate() for all children recursively.
|
virtual |
Moves the pointer to the given position on the window.
x | The new x position for the cursor. |
y | The new y position for the cursor. |
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.