.\" This is a wxWidgets manpage page generated from the XML docs .TH wxWindow 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation" .SH NAME wxWindow \- .SH DESCRIPTION wxWindow is the base class for all windows and represents any visible object on screen. All controls, top level windows and so on are windows. Sizers and device contexts are not, however, as they don't appear on screen themselves. Please note that all children of the window will be deleted automatically by the destructor before the window itself is deleted which means that you don't have to worry about deleting them manually. Please see the window deletion overview for more information. Also note that in this, and many others, wxWidgets classes some GetXXX() methods may be overloaded (as, for example, GetSize or 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. Extra window styles The following are extra styles, set using wxWindow::SetExtraStyle . wxWS_EX_VALIDATE_RECURSIVELY By default, Validate/TransferDataTo/FromWindow() only work on direct children of the window (compatible behaviour). Set this flag to make them recursively descend into all subwindows. wxWS_EX_BLOCK_EVENTS wxCommandEvents and the objects of the derived classes are forwarded to the parent window and so on recursively by default. Using this flag for the given window allows to block this propagation at this window, i.e. prevent the events from being propagated further upwards. Dialogs have this flag on by default. wxWS_EX_TRANSIENT Don't use this window as an implicit parent for the other windows: this must be used with transient windows as otherwise there is the risk of creating a dialog/frame with this window as a parent which would lead to a crash if the parent is destroyed before the child. wxWS_EX_PROCESS_IDLE This window should always process idle events, even if the mode set by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED. wxWS_EX_PROCESS_UI_UPDATES This window should always process UI update events, even if the mode set by wxUpdateUIEvent::SetMode is wxUPDATE_UI_PROCESS_SPECIFIED. .SH "PARENTS" wxEvtHandler wxObject .SH "INCLUDE FILES" wx/window.h .SH MEMBERS .SS wxWindow () Default constructor. .SS wxWindow (wxWindow* parentwxWindowID idconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = 0const wxString& name = wxPanelNameStr) Constructs a window, which can be a child of a frame, dialog or any other non-control window. .SS ~wxWindow () Destructor. Deletes all subwindows, then deletes itself. Instead of using the delete operator explicitly, you should normally use wxWindow::Destroy so that wxWidgets can delete a window only when it is safe to do so, in idle time. .SS virtual void AddChild (wxWindow* child) 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. .SS void CacheBestSize (const wxSize& size) Sets the cached best size value. .SS virtual void CaptureMouse () Directs all mouse input to this window. Call wxWindow::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. .SS void Center (int direction) A synonym for Centre . .SS void CenterOnParent (int direction) A synonym for CentreOnParent . .SS void CenterOnScreen (int direction) A synonym for CentreOnScreen . .SS void Centre (int direction = wxBOTH) Centres the window. The flag wxCENTRE_FRAME is obsolete and should not be used any longer (it has no effect). .SS void CentreOnParent (int direction = wxBOTH) Centres the window on its parent. This is a more readable synonym for Centre . .SS void CentreOnScreen (int direction = wxBOTH) Centres the window on screen. This only works for top level windows - otherwise, the window will still be centered on its parent. .SS void ClearBackground () Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated. .SS virtual void ClientToScreen (int* xint* y) .SS virtual wxPoint ClientToScreen (const wxPoint& pt) Converts to screen coordinates from coordinates relative to this window. .SS bool 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. .SS wxPoint ConvertDialogToPixels (const wxPoint& pt) .SS wxSize ConvertDialogToPixels (const wxSize& sz) 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. .SS wxPoint ConvertPixelsToDialog (const wxPoint& pt) .SS wxSize ConvertPixelsToDialog (const wxSize& sz) 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. .SS virtual bool Destroy () 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. .SS virtual void DestroyChildren () Destroys all children of a window. Called automatically by the destructor. .SS bool Disable () Disables the window, same as Enable(false) . .SS virtual wxSize DoGetBestSize () Gets the size which best suits the window: for a control, it would be the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to Fit() . .SS virtual void DoUpdateWindowUI (wxUpdateUIEvent& event) Does the window-specific updating after processing the update event. This function is called by wxWindow::UpdateWindowUI in order to check return values in the wxUpdateUIEvent and act appropriately. For example, to allow frame and dialog title updating, wxWidgets implements this function as follows: // do the window-specific processing after processing the update event void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event) { if ( event.GetSetEnabled() ) Enable(event.GetEnabled()); if ( event.GetSetText() ) { if ( event.GetText() != GetTitle() ) SetTitle(event.GetText()); } } .SS virtual void DragAcceptFiles (bool accept) Enables or disables eligibility for drop file events (OnDropFiles). .SS virtual bool Enable (bool enable = true) Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is. .SS static wxWindow* FindFocus () Finds the window or control which currently has the keyboard focus. .SS wxWindow* FindWindow (long id) Find a child of this window, by identifier. .SS wxWindow* FindWindow (const wxString& name) Find a child of this window, by name. .SS static wxWindow* FindWindowById (long idwxWindow* parent = NULL) Find the first window with the given id . If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases. .SS static wxWindow* FindWindowByName (const wxString& namewxWindow* parent = NULL) Find a window by its name (as given in a window constructor or Create function call). If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases. If no window with such name is found, FindWindowByLabel is called. .SS static wxWindow* FindWindowByLabel (const wxString& labelwxWindow* parent = NULL) Find a window by its label. Depending on the type of window, the label may be a window title or panel item label. If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases. .SS virtual void Fit () Sizes the window so that it fits around its subwindows. This function won't do anything if there are no subwindows and will only really work correctly if the sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window->SetClientSize(child->GetSize()); instead of calling Fit. .SS virtual void FitInside () 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. .SS virtual void Freeze () Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to these two functions may be nested. 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. .SS wxAcceleratorTable* GetAcceleratorTable () Gets the accelerator table for this window. See wxAcceleratorTable . .SS wxAccessible* GetAccessible () Returns the accessible object for this window, if any. See also wxAccessible . .SS wxSize GetAdjustedBestSize () This method is similar to GetBestSize , except in one thing. GetBestSize should return the minimum untruncated size of the window, while this method will return the largest of BestSize and any user specified minimum size. ie. it is the minimum size the window should currently be drawn at, not the minimal size it can possibly tolerate. .SS virtual wxColour GetBackgroundColour () Returns the background colour of the window. .SS virtual wxBackgroundStyle GetBackgroundStyle () Returns the background style of the window. The background style indicates whether background colour should be determined by the system (wxBG_STYLE_SYSTEM), be set to a specific colour (wxBG_STYLE_COLOUR), or should be left to the application to implement (wxBG_STYLE_CUSTOM). On GTK+, use of wxBG_STYLE_CUSTOM allows the flicker-free drawing of a custom background, such as a tiled bitmap. Currently the style has no effect on other platforms. .SS wxSize GetBestFittingSize () Merges the window's best size into the min size and returns the result. .SS wxSize GetBestSize () 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 . .SS wxCaret * GetCaret () Returns the caret associated with the window. .SS static wxWindow * GetCapture () Returns the currently captured window. .SS virtual int GetCharHeight () Returns the character height for this window. .SS virtual int GetCharWidth () Returns the average character width for this window. .SS wxList& GetChildren () Returns a reference to the list of the window's children. .SS static wxVisualAttributes GetClassDefaultAttributes (wxWindowVariant variant = \texttt{wxWINDOW_VARIANT_NORMAL}) 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 wxWindow::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. .SS void GetClientSize (int* widthint* height) .SS wxSize GetClientSize () This gets 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. .SS wxLayoutConstraints* GetConstraints () Returns a pointer to the window's layout constraints, or NULL if there are none. .SS const wxSizer * GetContainingSizer () Return the sizer that this window is a member of, if any, otherwise NULL . .SS const wxCursor& GetCursor () Return the cursor associated with this window. .SS virtual wxVisualAttributes GetDefaultAttributes () Currently this is the same as calling GetClassDefaultAttributes ( 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. .SS wxDropTarget* GetDropTarget () Returns the associated drop target, which may be NULL. .SS wxEvtHandler* GetEventHandler () Returns the event handler for this window. By default, the window is its own event handler. .SS long GetExtraStyle () Returns the extra style bits for the window. .SS wxFont GetFont () Returns the font for this window. .SS virtual wxColour GetForegroundColour () Returns the foreground colour of the window. .SS wxWindow* GetGrandParent () Returns the grandparent of a window, or NULL if there isn't one. .SS void* GetHandle () Returns the platform-specific handle of the physical window. Cast it to an appropriate handle, such as HWND for Windows, Widget for Motif, GtkWidget for GTK or WinHandle for PalmOS. .SS virtual wxString GetHelpText () .SS int GetId () Returns the identifier of the window. .SS virtual wxString GetLabel () Generic way of getting a label from any window, for identification purposes. .SS wxSize GetMaxSize () Returns the maximum size of the window, an indication to the sizer layout mechanism that this is the maximum possible size. .SS wxSize GetMinSize () Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size. .SS virtual wxString GetName () Returns the window's name. .SS virtual wxWindow* GetParent () Returns the parent of the window, or NULL if there is no parent. .SS virtual void GetPosition (int* xint* y) .SS wxPoint GetPosition () This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows. .SS virtual wxRect GetRect () Returns the size and position of the window as a wxRect object. .SS virtual int GetScrollPos (int orientation) Returns the built-in scrollbar position. .SS virtual int GetScrollRange (int orientation) Returns the built-in scrollbar range. .SS virtual int GetScrollThumb (int orientation) Returns the built-in scrollbar thumb size. .SS void GetSize (int* widthint* height) .SS wxSize GetSize () This gets the size of the entire window in pixels, including title bar, border, scrollbars, etc. .SS wxSizer * GetSizer () Return the sizer associated with the window by a previous call to SetSizer() or NULL . .SS virtual void GetTextExtent (const wxString& stringint* xint* yint* descent = NULLint* externalLeading = NULLconst wxFont* font = NULLbool use16 = false) Gets the dimensions of the string as it would be drawn on the window with the currently selected font. .SS virtual wxString GetTitle () Gets the window's title. Applicable only to frames and dialogs. .SS wxToolTip* GetToolTip () Get the associated tooltip or NULL if none. .SS virtual wxRegion GetUpdateRegion () Returns the region specifying which parts of the window have been damaged. Should only be called within an wxPaintEvent handler. .SS wxValidator* GetValidator () Returns a pointer to the current validator for the window, or NULL if there is none. .SS void GetVirtualSize (int* widthint* height) .SS wxSize GetVirtualSize () 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 that size. GetSize , GetClientSize .SS long GetWindowStyleFlag () Gets the window style that was passed to the constructor or Create method. GetWindowStyle() is another name for the same function. .SS wxWindowVariant GetWindowVariant () Returns the value previously passed to wxWindow::SetWindowVariant . .SS virtual bool HasCapture () Returns true if this window has the current mouse capture. .SS virtual bool HasScrollbar (int orient) Returns true if this window has a scroll bar for this orientation. .SS virtual bool HasTransparentBackground () 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. .SS bool Hide () Equivalent to calling Show ( false ). .SS 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. By ``intelligently'' the following is meant: by default, all windows use their own default attributes. However if some of the parents attributes are explicitly (that is, using SetFont and not 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. .SS void InitDialog () Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators. .SS void InvalidateBestSize () Resets the cached best size value so it will be recalculated the next time it is needed. .SS virtual bool IsEnabled () Returns true if the window is enabled for input, false otherwise. .SS bool IsExposed (int xint y) .SS bool IsExposed (wxPoint &pt) .SS bool IsExposed (int xint yint wint h) .SS bool IsExposed (wxRect &rect) Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. .SS virtual bool IsRetained () Returns true if the window is retained, false otherwise. .SS virtual bool IsShown () Returns true if the window is shown, false if it has been hidden. .SS bool IsTopLevel () 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). .SS void Layout () Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See wxWindow::SetAutoLayout : when auto layout is on, this function gets called automatically when the window is resized. .SS void Lower () Lowers the window to the bottom of the window hierarchy. .SS virtual void MakeModal (bool flag) Disables all other windows in the application so that the user can only interact with this window. .SS void Move (int xint y) .SS void Move (const wxPoint& pt) Moves the window to the given position. .SS void 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. .SS void MoveBeforeInTabOrder (wxWindow *win) Same as MoveAfterInTabOrder except that it inserts this window just before win instead of putting it right after it. .SS bool Navigate (int flags = wxNavigationKeyEvent::IsForward) Does keyboard navigation from this window to another, by sending a wxNavigationKeyEvent. .SS 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. This function may be used to do delayed painting, for example, and most implementations call wxWindow::UpdateWindowUI in order to send update events to the window in idle time. .SS wxEvtHandler* PopEventHandler (bool deleteHandler = false) Removes and returns the top-most event handler on the event handler stack. .SS bool PopupMenu (wxMenu* menuconst wxPoint& pos = wxDefaultPosition) .SS bool PopupMenu (wxMenu* menuint xint y) .SS void PushEventHandler (wxEvtHandler* handler) Pushes this event handler onto the event stack for the window. .SS void Raise () Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for manage and child windows. .SS virtual void Refresh (bool eraseBackground = trueconst wxRect* rect = NULL) Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted. Note that repainting doesn't happen immediately but only during the next event loop iteration, if you need to update the window immediately you should use Update instead. .SS void RefreshRect (const wxRect& rectbool eraseBackground = true) Redraws the contents of the given rectangle: only the area inside it will be repainted. This is the same as Refresh but has a nicer syntax as it can be called with a temporary wxRect object as argument like this RefreshRect(wxRect(x, y, w, h)) . .SS bool RegisterHotKey (int hotkeyIdint modifiersint virtualKeyCode) 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. .SS virtual void ReleaseMouse () Releases mouse input captured with wxWindow::CaptureMouse . .SS virtual void RemoveChild (wxWindow* child) 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. .SS bool RemoveEventHandler (wxEvtHandler *handler) Find the given handler in the windows event handler chain and remove (but not delete) it from it. .SS virtual bool Reparent (wxWindow* newParent) 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. Available on Windows and GTK. .SS virtual void ScreenToClient (int* xint* y) .SS virtual wxPoint ScreenToClient (const wxPoint& pt) Converts from screen to client window coordinates. .SS virtual bool ScrollLines (int lines) Scrolls the window by the given number of lines down (if lines is positive) or up. .SS virtual bool ScrollPages (int pages) Scrolls the window by the given number of pages down (if pages is positive) or up. .SS virtual void ScrollWindow (int dxint dyconst wxRect* rect = NULL) Physically scrolls the pixels in the window and move child windows accordingly. .SS virtual void SetAcceleratorTable (const wxAcceleratorTable& accel) Sets the accelerator table for this window. See wxAcceleratorTable . .SS void 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 . .SS void SetAutoLayout (bool autoLayout) Determines whether the wxWindow::Layout function will be called automatically when the window is resized. It is called implicitly by wxWindow::SetSizer but if you use wxWindow::SetConstraints you should call it manually or otherwise the window layout won't be correctly updated when its size changes. .SS virtual bool SetBackgroundColour (const wxColour& colour) Sets the background colour of the window. Please see InheritAttributes for explanation of the difference between this method and SetOwnBackgroundColour . .SS virtual void SetBackgroundStyle (wxBackgroundStyle style) Sets the background style of the window. The background style indicates whether background colour should be determined by the system (wxBG_STYLE_SYSTEM), be set to a specific colour (wxBG_STYLE_COLOUR), or should be left to the application to implement (wxBG_STYLE_CUSTOM). On GTK+, use of wxBG_STYLE_CUSTOM allows the flicker-free drawing of a custom background, such as a tiled bitmap. Currently the style has no effect on other platforms. .SS void SetBestFittingSize (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. .SS void SetCaret (wxCaret *caret) Sets the caret associated with the window. .SS virtual void SetClientSize (int widthint height) .SS virtual void SetClientSize (const wxSize& size) 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 wxWindow::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. .SS void SetContainingSizer (wxSizer* sizer) This normally does not need to be called by user code. It is called when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed. .SS virtual void SetCursor (const wxCursor&cursor) .SS void 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. .SS 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). .SS 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. .SS 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. You may need to call this if you change the window size after construction and before adding to its parent sizer. .SS void SetOwnBackgroundColour (const wxColour& colour) Sets the background colour of the window but prevents it from being inherited by the children of this window. .SS void SetOwnFont (const wxFont& font) Sets the font of the window but prevents it from being inherited by the children of this window. .SS void SetOwnForegroundColour (const wxColour& colour) Sets the foreground colour of the window but prevents it from being inherited by the children of this window. .SS void SetDropTarget (wxDropTarget* target) Associates a drop target with this window. If the window already has a drop target, it is deleted. .SS void SetEventHandler (wxEvtHandler* handler) Sets the event handler for this window. .SS void SetExtraStyle (long exStyle) Sets the extra style bits for the window. The currently defined extra style bits are: wxWS_EX_VALIDATE_RECURSIVELY TransferDataTo/FromWindow() and Validate() methods will recursively descend into all children of the window if it has this style flag set. wxWS_EX_BLOCK_EVENTS Normally, the command events are propagated upwards to the window parent recursively until a handler for them is found. Using this style allows to prevent them from being propagated beyond this window. Notice that wxDialog has this style on by default for the reasons explained in the event processing overview . wxWS_EX_TRANSIENT This can be used to prevent a window from being used as an implicit parent for the dialogs which were created without a parent. It is useful for the windows which can disappear at any moment as creating children of such windows results in fatal problems. wxFRAME_EX_CONTEXTHELP Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send a wxEVT_HELP event if the user clicked on an application window. This style cannot be used together with wxMAXIMIZE_BOX or wxMINIMIZE_BOX, so you should use the style of wxDEFAULT_FRAME_STYLE & \textasciitilde(wxMINIMIZE_BOX | wxMAXIMIZE_BOX) for the frames having this style (the dialogs don't have minimize nor maximize box by default) wxWS_EX_PROCESS_IDLE This window should always process idle events, even if the mode set by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED. wxWS_EX_PROCESS_UI_UPDATES This window should always process UI update events, even if the mode set by wxUpdateUIEvent::SetMode is wxUPDATE_UI_PROCESS_SPECIFIED. .SS virtual void SetFocus () This sets the window to receive keyboard input. .SS 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). By default this method simply calls SetFocus but can be overridden to do something in addition to this in the derived classes. .SS void SetFont (const wxFont& font) 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. .SS virtual void SetForegroundColour (const wxColour& colour) Sets the foreground colour of the window. Please see InheritAttributes for explanation of the difference between this method and SetOwnForegroundColour . .SS virtual void SetHelpText (const wxString& helpText) .SS void SetId (int id) Sets the identifier of the window. .SS virtual void SetLabel (const wxString& label) Sets the window's label. .SS virtual void SetName (const wxString& name) Sets the window's name. .SS virtual void SetPalette (wxPalette* palette) Obsolete - use wxDC::SetPalette instead. .SS virtual void SetScrollbar (int orientationint positionint thumbSizeint rangebool refresh = true) .SS virtual void SetScrollPage (int orientationint pageSizebool refresh = true) .SS virtual void SetScrollPos (int orientationint posbool refresh = true) .SS virtual void SetScrollRange (int orientationint rangebool refresh = true) .SS virtual void SetSize (int xint yint widthint heightint sizeFlags = wxSIZE_AUTO) .SS virtual void SetSize (const wxRect& rect) Sets the size and position of the window in pixels. .SS virtual void SetSize (int widthint height) .SS virtual void SetSize (const wxSize& size) Sets the size of the window in pixels. .SS virtual void SetSizeHints (int minWint minHint maxW = -1int maxH = -1int incW = -1int incH = -1) .SS void SetSizeHints (const wxSize& minSizeconst wxSize& maxSize = wxDefaultSizeconst wxSize& incSize = wxDefaultSize) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. .SS void SetSizer (wxSizer* sizerbool 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. .SS void SetSizerAndFit (wxSizer* sizerbool deleteOld = true) The same as SetSizer , except it also sets the size hints for the window based on the sizer's minimum size. .SS virtual void SetTitle (const wxString& title) Sets the window's title. Applicable only to frames and dialogs. .SS 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 if 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. .SS void SetToolTip (const wxString& tip) .SS void SetToolTip (wxToolTip* tip) Attach a tooltip to the window. See also GetToolTip , wxToolTip .SS 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. .SS void SetVirtualSize (int widthint height) .SS void SetVirtualSize (const wxSize& size) Sets the virtual size of the window in pixels. .SS virtual void SetVirtualSizeHints (int minWint minHint maxW = -1int maxH = -1) .SS void SetVirtualSizeHints (const wxSize& minSize = wxDefaultSizeconst wxSize& maxSize = wxDefaultSize) Allows specification of minimum and maximum virtual window sizes. If a pair of values is not set (or set to -1), the default values will be used. .SS void SetWindowStyle (long style) Identical to SetWindowStyleFlag . .SS virtual void SetWindowStyleFlag (long style) Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might be called after changing the others for the change to take place immediately. See Window styles for more information about flags. .SS void SetWindowVariant (wxWindowVariantvariant) This function can be called under all platforms but only does anything under Mac OS X 10.3+ currently. Under this system, each of the standard control can exist in several sizes which correspond to the elements of wxWindowVariant enum: enum wxWindowVariant { wxWINDOW_VARIANT_NORMAL, // Normal size wxWINDOW_VARIANT_SMALL, // Smaller size (about 25 wxWINDOW_VARIANT_MINI, // Mini size (about 33 wxWINDOW_VARIANT_LARGE, // Large size (about 25 }; By default the controls use the normal size, of course, but this function can be used to change this. .SS virtual bool ShouldInheritColours () 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. .SS virtual bool Show (bool show = true) 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. .SS virtual void Thaw () Reenables 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 . .SS virtual bool TransferDataFromWindow () .SS virtual bool TransferDataToWindow () .SS bool UnregisterHotKey (int hotkeyId) Unregisters a system wide hotkey. .SS virtual void Update () Calling this method immediately repaints the invalidated area of the window and all of its children recursively while this would usually only happen when the flow of control returns to the event loop. Notice that this function doesn't refresh the window and does nothing if the window hadn't been already repainted. Use Refresh first if you want to immediately redraw the window unconditionally. .SS virtual void UpdateWindowUI (long flags = wxUPDATE_UI_NONE) This function sends wxUpdateUIEvents 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 following values. enum wxUpdateUI { wxUPDATE_UI_NONE = 0x0000, // No particular value wxUPDATE_UI_RECURSE = 0x0001, // Call the function for descendants wxUPDATE_UI_FROMIDLE = 0x0002 // Invoked from On(Internal)Idle }; 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. void MyWindow::OnInternalIdle() { if (wxUpdateUIEvent::CanUpdate(this)) UpdateWindowUI(wxUPDATE_UI_FROMIDLE); } .SS virtual bool Validate () Validates the current values of the child controls using their validators. If the window has wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. .SS void WarpPointer (int xint y) Moves the pointer to the given position on the window. NB: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically. .SH "WINDOW STYLES" .SS wxSIMPLE_BORDER wxSIMPLE_BORDER .SS wxDOUBLE_BORDER Displays a double border. Windows and Mac only. .SS wxSUNKEN_BORDER Displays a sunken border. .SS wxRAISED_BORDER Displays a raised border. .SS wxSTATIC_BORDER Displays a border suitable for a static control. Windows only. .SS wxNO_BORDER Displays no border, overriding the default border style for the window. .SS wxTRANSPARENT_WINDOW wxTRANSPARENT_WINDOW .SS wxTAB_TRAVERSAL Use this to enable tab traversal for non-dialog windows. .SS wxWANTS_CHARS wxWANTS_CHARS .SS wxNO_FULL_REPAINT_ON_RESIZE wxNO_FULL_REPAINT_ON_RESIZE .SS wxVSCROLL Use this style to enable a vertical scrollbar. .SS wxHSCROLL Use this style to enable a horizontal scrollbar. .SS wxALWAYS_SHOW_SB wxALWAYS_SHOW_SB .SS wxCLIP_CHILDREN wxCLIP_CHILDREN .SS wxFULL_REPAINT_ON_RESIZE wxFULL_REPAINT_ON_RESIZE .SH "SEE ALSO" wxEvtHandler wxObject Event handling overview .SH "AUTHORS" Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.