X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d0a6715724f10ef967bd9c3868c433142efab9b1..3fbba098a22ccaf72fbc640482b94146b374c372:/interface/wx/window.h diff --git a/interface/wx/window.h b/interface/wx/window.h index f8df295621..6a13cadcfd 100644 --- a/interface/wx/window.h +++ b/interface/wx/window.h @@ -3,41 +3,22 @@ // Purpose: interface of wxWindow // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -/** - Background styles. See wxWindow::SetBackgroundStyle(). -*/ -enum wxBackgroundStyle -{ - /// Use the default background, as determined by - /// the system or the current theme. - wxBG_STYLE_SYSTEM, - - /// Use a solid colour for the background, this style is set automatically if you call - /// SetBackgroundColour() so you only need to set it explicitly if you had - /// changed the background style to something else before. - wxBG_STYLE_COLOUR, - - /// Don't draw the background at all, it's supposed that it is drawn by - /// the user-defined erase background event handler. - /// This style should be used to avoid flicker when the background is entirely - /// custom-drawn. - wxBG_STYLE_CUSTOM, - - /// The background is (partially) transparent,this style is automatically set if you call - /// SetTransparent() which is used to set the transparency level. - wxBG_STYLE_TRANSPARENT -}; - - /** Valid values for wxWindow::ShowWithEffect() and wxWindow::HideWithEffect(). */ enum wxShowEffect { + /** + No effect, equivalent to normal wxWindow::Show() or Hide() call. + + @since 2.9.1 + */ + wxSHOW_EFFECT_NONE, + /// Roll window to the left wxSHOW_EFFECT_ROLL_TO_LEFT, @@ -69,6 +50,25 @@ enum wxShowEffect wxSHOW_EFFECT_EXPAND }; + + +/** + struct containing all the visual attributes of a control +*/ +struct wxVisualAttributes +{ + // the font used for control label/text inside it + wxFont font; + + // the foreground colour + wxColour colFg; + + // the background colour, may be wxNullColour if the controls background + // colour is not solid + wxColour colBg; +}; + + /** Different window variants, on platforms like eg mac uses different rendering sizes. @@ -83,22 +83,11 @@ enum wxWindowVariant }; -/** - Flags which can be used in wxWindow::UpdateWindowUI(). -*/ -enum wxUpdateUI -{ - wxUPDATE_UI_NONE, - wxUPDATE_UI_RECURSE, - wxUPDATE_UI_FROMIDLE /**< Invoked from On(Internal)Idle */ -}; - - /** @class wxWindow wxWindow is the base class for all windows and represents any visible object - om screen. All controls, top level windows and so on are windows. Sizers and + 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 @@ -188,41 +177,97 @@ enum wxUpdateUI @beginExtraStyleTable @style{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. + By default, wxWindow::Validate(), wxWindow::TransferDataTo() and + wxWindow::TransferDataFromWindow() only work on + direct children of the window (compatible behaviour). + Set this flag to make them recursively descend into all subwindows. @style{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 - for the reasons explained in the @ref overview_eventhandling "Event Handling Overview". + for the reasons explained in the @ref overview_events. @style{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. + risk of creating a dialog/frame with this window as a parent, which + would lead to a crash if the parent were destroyed before the child. @style{wxWS_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. + will send a @c wxEVT_HELP event if the user clicked on an application window. This style cannot be used (because of the underlying native behaviour) together with @c wxMAXIMIZE_BOX or @c wxMINIMIZE_BOX, so these two styles are automatically turned off if this one is used. @style{wxWS_EX_PROCESS_IDLE} This window should always process idle events, even if the mode set - by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED. + by wxIdleEvent::SetMode is @c wxIDLE_PROCESS_SPECIFIED. @style{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. + mode set by wxUpdateUIEvent::SetMode is @c wxUPDATE_UI_PROCESS_SPECIFIED. @endExtraStyleTable + @beginEventEmissionTable + @event{EVT_ACTIVATE(id, func)} + Process a @c wxEVT_ACTIVATE event. See wxActivateEvent. + @event{EVT_CHILD_FOCUS(func)} + Process a @c wxEVT_CHILD_FOCUS event. See wxChildFocusEvent. + @event{EVT_CONTEXT_MENU(func)} + A right click (or other context menu command depending on platform) has been detected. + See wxContextMenuEvent. + @event{EVT_HELP(id, func)} + Process a @c wxEVT_HELP event. See wxHelpEvent. + @event{EVT_HELP_RANGE(id1, id2, func)} + Process a @c wxEVT_HELP event for a range of ids. See wxHelpEvent. + @event{EVT_DROP_FILES(func)} + Process a @c wxEVT_DROP_FILES event. See wxDropFilesEvent. + @event{EVT_ERASE_BACKGROUND(func)} + Process a @c wxEVT_ERASE_BACKGROUND event. See wxEraseEvent. + @event{EVT_SET_FOCUS(func)} + Process a @c wxEVT_SET_FOCUS event. See wxFocusEvent. + @event{EVT_KILL_FOCUS(func)} + Process a @c wxEVT_KILL_FOCUS event. See wxFocusEvent. + @event{EVT_IDLE(func)} + Process a @c wxEVT_IDLE event. See wxIdleEvent. + @event{EVT_JOY_*(func)} + Processes joystick events. See wxJoystickEvent. + @event{EVT_KEY_DOWN(func)} + Process a @c wxEVT_KEY_DOWN event (any key has been pressed). + See wxKeyEvent. + @event{EVT_KEY_UP(func)} + Process a @c wxEVT_KEY_UP event (any key has been released). + See wxKeyEvent. + @event{EVT_CHAR(func)} + Process a @c wxEVT_CHAR event. + See wxKeyEvent. + @event{EVT_CHAR_HOOK(func)} + Process a @c wxEVT_CHAR_HOOK event. + See wxKeyEvent. + @event{EVT_MOUSE_CAPTURE_LOST(func)} + Process a @c wxEVT_MOUSE_CAPTURE_LOST event. See wxMouseCaptureLostEvent. + @event{EVT_MOUSE_CAPTURE_CHANGED(func)} + Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event. See wxMouseCaptureChangedEvent. + @event{EVT_MOUSE_*(func)} + See wxMouseEvent. + @event{EVT_PAINT(func)} + Process a @c wxEVT_PAINT event. See wxPaintEvent. + @event{EVT_POWER_*(func)} + The system power state changed. See wxPowerEvent. + @event{EVT_SCROLLWIN_*(func)} + Process scroll events. See wxScrollWinEvent. + @event{EVT_SET_CURSOR(func)} + Process a @c wxEVT_SET_CURSOR event. See wxSetCursorEvent. + @event{EVT_SIZE(func)} + Process a @c wxEVT_SIZE event. See wxSizeEvent. + @event{EVT_SYS_COLOUR_CHANGED(func)} + Process a @c wxEVT_SYS_COLOUR_CHANGED event. See wxSysColourChangedEvent. + @endEventTable + @library{wxcore} @category{miscwnd} - @see @ref overview_eventhandling "Event handling overview", - @ref overview_windowsizing "Window sizing overview" + @see @ref overview_events, @ref overview_windowsizing */ class wxWindow : public wxEvtHandler { @@ -273,6 +318,13 @@ public: virtual ~wxWindow(); + bool Create(wxWindow *parent, + wxWindowID id, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = 0, + const wxString& name = wxPanelNameStr); + /** @name Focus functions @@ -298,7 +350,7 @@ public: virtual bool AcceptsFocusFromKeyboard() const; /** - Overridden to indicate wehter this window or one of its children accepts + 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. */ @@ -415,7 +467,7 @@ public: wxWindow* GetGrandParent() const; /** - Returns the next window after this one among the parent children or @NULL + Returns the next window after this one among the parent's children or @NULL if this window is the last child. @since 2.8.8 @@ -430,7 +482,7 @@ public: wxWindow* GetParent() const; /** - Returns the previous window before this one among the parent children or @c + Returns the previous window before this one among the parent's children or @c @NULL if this window is the first child. @since 2.8.8 @@ -439,7 +491,7 @@ public: */ wxWindow* GetPrevSibling() const; /** - Reparents the window, i.e the window will be removed from its + 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. @@ -452,7 +504,10 @@ public: /** - @name Scrolling and scrollbars + @name 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). */ //@{ @@ -474,7 +529,7 @@ public: /** Returns the built-in scrollbar position. - @see See SetScrollbar() + @see SetScrollbar() */ virtual int GetScrollPos(int orientation) const; @@ -493,7 +548,23 @@ public: virtual int GetScrollThumb(int orientation) const; /** - Returns @true if this window has a scroll bar for this orientation. + Returns @true if this window can have a scroll bar in this orientation. + + @param orient + Orientation to check, either wxHORIZONTAL or wxVERTICAL. + + @since 2.9.1 + */ + bool CanScroll(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. @param orient Orientation to check, either wxHORIZONTAL or wxVERTICAL. @@ -641,7 +712,7 @@ public: /** - @name Sizing + @name Sizing functions See also the protected functions DoGetBestSize() and SetInitialBestSize(). */ @@ -649,6 +720,8 @@ public: /** Sets the cached best size value. + + @see GetBestSize() */ void CacheBestSize(const wxSize& size) const; @@ -721,6 +794,11 @@ public: control label is not truncated. For windows containing subwindows (typically wxPanel), the size returned by this function will be the same as the size the window would have had after calling Fit(). + + Note that when you write your own widget you need to override the + DoGetBestSize() function instead of this (non-virtual!) function. + + @see CacheBestSize(), @ref overview_windowsizing */ wxSize GetBestSize() const; @@ -732,6 +810,11 @@ public: 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). + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns + a 2-element list (width, height). + @endWxPerlOnly + @see GetSize(), GetVirtualSize() */ void GetClientSize(int* width, int* height) const; @@ -744,11 +827,14 @@ public: /** 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 - ammount of space to allocate for the widget. + amount of space to allocate for the widget. + + This is the method called by a wxSizer when it queries the size + of a window or control. @see GetBestSize(), SetInitialSize(), @ref overview_windowsizing */ - wxSize GetEffectiveMinSize() const; + virtual wxSize GetEffectiveMinSize() const; /** Returns the maximum size of window's client area. @@ -757,7 +843,7 @@ public: possible size as well as the upper bound on window's size settable using SetClientSize(). - @see GetMaxSize() + @see GetMaxSize(), @ref overview_windowsizing */ virtual wxSize GetMaxClientSize() const; @@ -767,7 +853,7 @@ public: This is an indication to the sizer layout mechanism that this is the maximum possible size as well as the upper bound on window's size settable using SetSize(). - @see GetMaxClientSize() + @see GetMaxClientSize(), @ref overview_windowsizing */ virtual wxSize GetMaxSize() const; @@ -778,7 +864,7 @@ public: It normally just returns the value set by SetMinClientSize(), but it can be overridden to do the calculation on demand. - @see GetMinSize() + @see GetMinSize(), @ref overview_windowsizing */ virtual wxSize GetMinClientSize() const; @@ -789,10 +875,15 @@ public: This method normally just returns the value set by SetMinSize(), but it can be overridden to do the calculation on demand. - @see GetMinClientSize() + @see GetMinClientSize(), @ref overview_windowsizing */ virtual wxSize GetMinSize() const; + int GetMinWidth() const; + int GetMinHeight() const; + int GetMaxWidth() const; + int GetMaxHeight() const; + /** Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc. @@ -805,7 +896,12 @@ public: @param height Receives the window height. - @see GetClientSize(), GetVirtualSize() + @beginWxPerlOnly + In wxPerl this method is implemented as GetSizeWH() returning + a 2-element list (width, height). + @endWxPerlOnly + + @see GetClientSize(), GetVirtualSize(), @ref overview_windowsizing */ void GetSize(int* width, int* height) const; @@ -818,6 +914,8 @@ public: This gets the virtual size of the window in pixels. By default it returns the client size of the window, but after a call to SetVirtualSize() it will return the size set with that method. + + @see @ref overview_windowsizing */ wxSize GetVirtualSize() const; @@ -832,27 +930,38 @@ public: void GetVirtualSize(int* width, int* height) const; /** - Returns the size of the left/right and top/bottom borders of this window in x - and y components of the result respectively. + Return the largest of ClientSize and BestSize (as determined + by a sizer, interior children, or other means) */ - virtual wxSize GetWindowBorderSize() const; + virtual wxSize GetBestVirtualSize() const; /** - Return the sizer that this window is a member of, if any, otherwise @NULL. + Returns the size of the left/right and top/bottom borders of this window in x + and y components of the result respectively. */ - wxSizer* GetContainingSizer() const; + virtual wxSize GetWindowBorderSize() const; /** - Return the sizer associated with the window by a previous call to - SetSizer() or @NULL. + 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). */ - wxSizer* GetSizer() const; - + virtual bool + InformFirstDirection(int direction, + int size, + int availableOtherDir); + /** Resets the cached best size value so it will be recalculated the next time it is needed. + + @see CacheBestSize() */ void InvalidateBestSize(); + /** Posts a size event to the window. @@ -911,13 +1020,20 @@ public: than SetSize(), since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example. + + @see @ref overview_windowsizing + */ + void SetClientSize(int width, int height); + + /** + @overload */ - virtual void SetClientSize(int width, int height); + void SetClientSize(const wxSize& size); /** @overload */ - virtual void SetClientSize(const wxSize& size); + void SetClientSize(const wxRect& rect); /** This normally does not need to be called by user code. @@ -947,7 +1063,12 @@ public: 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. - @see SetMaxSize() + Note that this method is just a shortcut for: + @code + SetMaxSize(ClientToWindowSize(size)); + @endcode + + @see SetMaxSize(), @ref overview_windowsizing */ virtual void SetMaxClientSize(const wxSize& size); @@ -955,7 +1076,7 @@ public: Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size. - @see SetMaxClientSize() + @see SetMaxClientSize(), @ref overview_windowsizing */ virtual void SetMaxSize(const wxSize& size); @@ -971,7 +1092,12 @@ public: prevent the program from explicitly making the window smaller than the specified size. - @see SetMinSize() + Note that this method is just a shortcut for: + @code + SetMinSize(ClientToWindowSize(size)); + @endcode + + @see SetMinSize(), @ref overview_windowsizing */ virtual void SetMinClientSize(const wxSize& size); @@ -987,7 +1113,7 @@ public: SetSize(), it just ensures that it won't become smaller than this size during the automatic layout. - @see SetMinClientSize() + @see SetMinClientSize(), @ref overview_windowsizing */ virtual void SetMinSize(const wxSize& size); @@ -1032,7 +1158,7 @@ public: should be supplied by wxWidgets, or that the current value of the dimension should be used. - @see Move() + @see Move(), @ref overview_windowsizing */ void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO); @@ -1043,61 +1169,38 @@ public: @remarks This form must be used with non-default width and height values. - @see Move() + @see Move(), @ref overview_windowsizing */ - virtual void SetSize(const wxRect& rect); + void SetSize(const wxRect& rect); /** @overload */ - virtual void SetSize(const wxSize& size); + void SetSize(const wxSize& size); /** @overload */ - virtual void SetSize(int width, int height); + void SetSize(int width, int height); /** Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged. Please use SetMinSize() and SetMaxSize() instead. - @see wxTopLevelWindow::SetSizeHints - */ - void SetSizeHints( const wxSize& minSize, - const wxSize& maxSize=wxDefaultSize, - const wxSize& incSize=wxDefaultSize); - - /** - 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 @a sizer is non-@NULL and @false otherwise. - - @param sizer - The sizer to set. Pass @NULL to disassociate and conditionally delete - the window's sizer. See below. - @param deleteOld - If @true (the default), this will delete any pre-existing sizer. - Pass @false if you wish to handle deleting the old sizer yourself. - - @remarks SetSizer enables and disables Layout automatically. - */ - void SetSizer(wxSizer* sizer, bool deleteOld = true); - - /** - This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial - window size to the size needed to accommodate all sizer elements and sets the - size hints which, if this window is a top level one, prevent the user from - resizing it to be less than this minimial size. + @see wxTopLevelWindow::SetSizeHints, @ref overview_windowsizing */ - void SetSizerAndFit(wxSizer* sizer, bool deleteOld = true); + virtual void SetSizeHints( const wxSize& minSize, + const wxSize& maxSize=wxDefaultSize, + const wxSize& incSize=wxDefaultSize); + virtual void SetSizeHints( int minW, int minH, + int maxW = -1, int maxH = -1, + int incW = -1, int incH = -1 ); /** Sets the virtual size of the window in pixels. + + @see @ref overview_windowsizing */ void SetVirtualSize(int width, int height); @@ -1110,7 +1213,7 @@ public: /** - @name Positioning + @name Positioning functions */ //@{ @@ -1128,13 +1231,13 @@ public: Centres the window. @param direction - Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL - or wxBOTH. It may also include wxCENTRE_ON_SCREEN flag - if you want to center the window on the entire screen and not on its + 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. @remarks If the window is a top level one (i.e. doesn't have a parent), - it will be centered relative to the screen anyhow. + it will be centred relative to the screen anyhow. @see Center() */ @@ -1144,10 +1247,10 @@ public: Centres the window on its parent. This is a more readable synonym for Centre(). @param direction - Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL + Specifies the direction for the centring. May be wxHORIZONTAL, wxVERTICAL or wxBOTH. - @remarks This methods provides for a way to center top level windows over + @remarks This methods provides for a way to centre top level windows over their parents instead of the entire screen. If there is no parent or if the window is not a top level window, then behaviour is the same as Centre(). @@ -1155,6 +1258,7 @@ public: @see wxTopLevelWindow::CentreOnScreen */ void CentreOnParent(int direction = wxBOTH); + /** 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. @@ -1164,6 +1268,11 @@ public: @param y Receives the y position of the window if non-@NULL. + @beginWxPerlOnly + In wxPerl this method is implemented as GetPositionXY() returning + a 2-element list (x, y). + @endWxPerlOnly + @see GetScreenPosition() */ void GetPosition(int* x, int* y) const; @@ -1211,6 +1320,20 @@ public: */ wxRect GetScreenRect() 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...) + */ + virtual wxPoint GetClientAreaOrigin() const; + + /** + Get the client rectangle in window (i.e. client) coordinates + */ + wxRect GetClientRect() const; + + + /** Moves the window to the given position. @@ -1249,11 +1372,13 @@ public: */ void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING); + void SetPosition(const wxPoint& pt); + //@} /** - @name Coordinate conversion + @name Coordinate conversion functions */ //@{ @@ -1272,6 +1397,11 @@ public: - ClientToScreen(point): Accepts and returns a wxPoint - ClientToScreenXY(x, y): Returns a 2-tuple, (x, y) @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method returns a 2-element list instead of + modifying its parameters. + @endWxPerlOnly */ void ClientToScreen(int* x, int* y) const; @@ -1301,12 +1431,12 @@ public: @see ConvertPixelsToDialog() */ - wxPoint ConvertDialogToPixels(const wxPoint& pt); + wxPoint ConvertDialogToPixels(const wxPoint& pt) const; /** @overload */ - wxSize ConvertDialogToPixels(const wxSize& sz); + wxSize ConvertDialogToPixels(const wxSize& sz) const; /** Converts a point or size from pixels to dialog units. @@ -1321,12 +1451,12 @@ public: @see ConvertDialogToPixels() */ - wxPoint ConvertPixelsToDialog(const wxPoint& pt); + wxPoint ConvertPixelsToDialog(const wxPoint& pt) const; /** @overload */ - wxSize ConvertPixelsToDialog(const wxSize& sz); + wxSize ConvertPixelsToDialog(const wxSize& sz) const; /** Converts from screen to client window coordinates. @@ -1355,8 +1485,14 @@ public: //@{ /** - Clears the window by filling it with the current background colour. Does not - cause an erase background event to be generated. + 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. */ virtual void ClearBackground(); @@ -1381,12 +1517,12 @@ public: void Freeze(); /** - Reenables window updating after a previous call to Freeze(). + 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 thawn too. + If the window has any children, they are recursively thawed too. @see wxWindowUpdateLocker, Freeze(), IsFrozen() */ @@ -1408,12 +1544,12 @@ public: /** Returns the background style of the window. - The background style can be one of the wxBackgroundStyle. @see SetBackgroundColour(), GetForegroundColour(), SetBackgroundStyle(), SetTransparent() */ virtual wxBackgroundStyle GetBackgroundStyle() const; + /** Returns the character height for this window. */ @@ -1451,9 +1587,8 @@ public: /** Returns the foreground colour of the window. - @remarks The interpretation of foreground colour is open to - interpretation according to the window class; it may be - the text colour or other colour, or it may not be used at all. + @remarks The meaning of foreground colour varies according to the window class; + it may be the text colour or other colour, or it may not be used at all. @see SetForegroundColour(), SetBackgroundColour(), GetBackgroundColour() @@ -1464,7 +1599,7 @@ public: 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 @a w and @a h pointers. + The text extent is returned in the @a w and @a h pointers. @param string String whose extent is to be measured. @@ -1478,11 +1613,18 @@ public: Return value for external leading (optional). @param font Font to use instead of the current window font (optional). + + @beginWxPerlOnly + In wxPerl this method takes only the @a string and optionally + @a font parameters, and returns a 4-element list + (x, y, descent, externalLeading). + @endWxPerlOnly */ - virtual void GetTextExtent(const wxString& string, int* w, int* h, - int* descent = NULL, - int* externalLeading = NULL, - const wxFont* font = NULL) const; + void GetTextExtent(const wxString& string, + int* w, int* h, + int* descent = NULL, + int* externalLeading = NULL, + const wxFont* font = NULL) const; /** Gets the dimensions of the string as it would be drawn on the @@ -1498,6 +1640,11 @@ public: */ const wxRegion& GetUpdateRegion() const; + /** + Get the update rectangle bounding box in client coords + */ + wxRect GetUpdateClientRect() const; + /** Returns @true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background. @@ -1535,8 +1682,8 @@ public: /** 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. + 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 @@ -1551,8 +1698,10 @@ public: this method and SetOwnBackgroundColour(). @param colour - The colour to be used as the background colour, pass + 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 an hard-coded one. @remarks The background colour is usually painted by the default wxEraseEvent event handler function under Windows and @@ -1565,15 +1714,38 @@ public: usually the themes represent the appearance chosen by the user to be used for all applications on the system. + @return @true if the colour was really changed, @false if it was already set + to this colour and nothing was done. + @see GetBackgroundColour(), SetForegroundColour(), GetForegroundColour(), ClearBackground(), - Refresh(), wxEraseEvent + Refresh(), wxEraseEvent, wxSystemSettings */ virtual bool SetBackgroundColour(const wxColour& colour); /** - Sets the background style of the window. see GetBackgroundStyle() for - the description of the possible style values. + Sets the background style of the window. + + The default background style is @c wxBG_STYLE_ERASE which indicates that + the window background may be erased in @c EVT_ERASE_BACKGROUND handler. + This is a safe, compatibility default; however you may want to change it + to @c 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 @c wxBG_STYLE_PAINT if you define an + @c EVT_PAINT handler which completely overwrites the window background as + in this case erasing it previously, either in @c 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 + @c 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 + @c EVT_ERASE_BACKGROUND handler. Setting background style to + @c wxBG_STYLE_PAINT is a simpler and more efficient solution to the same + problem. @see SetBackgroundColour(), GetForegroundColour(), SetTransparent() @@ -1596,8 +1768,8 @@ public: Font to associate with this window, pass wxNullFont to reset to the default font. - @return @true if the want was really changed, @false if it was already set - to this font and so nothing was done. + @return @true if the font was really changed, @false if it was already set + to this font and nothing was done. @see GetFont(), InheritAttributes() */ @@ -1609,12 +1781,14 @@ public: this method and SetOwnForegroundColour(). @param colour - The colour to be used as the foreground colour, pass + The colour to be used as the foreground colour; pass wxNullColour to reset to the default colour. - @remarks The interpretation of foreground colour is open to - interpretation according to the window class; it may be - the text colour or other colour, or it may not be used at all. + @remarks The meaning of foreground colour varies according to the window class; + it may be the text colour or other colour, or it may not be used at all. + + @return @true if the colour was really changed, @false if it was already set + to this colour and nothing was done. @see GetForegroundColour(), SetBackgroundColour(), GetBackgroundColour(), ShouldInheritColours() @@ -1652,7 +1826,7 @@ public: /** 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. + 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. @@ -1661,7 +1835,7 @@ public: /** 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 + 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 @@ -1672,6 +1846,10 @@ public: */ virtual void SetThemeEnabled(bool enable); + /** + */ + virtual bool GetThemeEnabled() const; + /** Returns @true if the system supports transparent windows and calling SetTransparent() may succeed. If this function returns @false, transparent @@ -1695,6 +1873,9 @@ public: /** @name 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. */ //@{ @@ -1708,9 +1889,8 @@ public: wxEvtHandler* GetEventHandler() const; /** - 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. + 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. @return Returns @true if the key pressed was for navigation and was handled, @false otherwise. @@ -1724,50 +1904,95 @@ public: @code GetEventHandler()->SafelyProcessEvent(event); @endcode + + @see ProcessWindowEvent() */ bool HandleWindowEvent(wxEvent& event) const; + /** + Convenient wrapper for ProcessEvent(). + + This is the same as writing @code GetEventHandler()->ProcessEvent(event); + @endcode 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 ProcessWindowEvent(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. + + @since 2.9.1 + */ + bool ProcessWindowEventLocally(wxEvent& event); + /** Removes and returns the top-most event handler on the event handler stack. + E.g. in the case of: + @image html overview_events_winstack.png + when calling @c W->PopEventHandler(), the event handler @c A will be + removed and @c 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). + @param deleteHandler - If this is @true, the handler will be deleted after it is removed. - The default value is @false. + If this is @true, the handler will be deleted after it is removed + (and the returned value will be @NULL). - @see SetEventHandler(), GetEventHandler(), - PushEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler + @see @ref overview_events_processing */ wxEvtHandler* PopEventHandler(bool deleteHandler = false); /** 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 @e 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 @c A and @c B and a wxWindow instance + @c W and you call: + @code + W->PushEventHandler(A); + W->PushEventHandler(B); + @endcode + you will end up with the following situation: + @image html overview_events_winstack.png + + Note that you can use wxWindow::PopEventHandler to remove the event handler. + @param 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). - @remarks 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 - chain of event handlers, where an event not handled by one event - handler is handed to the next one in the chain. - Use wxWindow::PopEventHandler to remove the event handler. - - @see SetEventHandler(), GetEventHandler(), - PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler + @see @ref overview_events_processing */ void PushEventHandler(wxEvtHandler* handler); /** - Find the given @a handler in the windows event handler chain and remove - (but not delete) it from it. + Find the given @a handler in the windows event handler stack and + removes (but does not delete) it from the stack. + + See wxEvtHandler::Unlink() for more info. @param handler The event handler to remove, must be non-@NULL and - must be present in this windows event handlers chain + must be present in this windows event handlers stack. @return Returns @true if it was found and @false otherwise (this also results in an assert failure so this function should @@ -1780,29 +2005,43 @@ public: /** Sets the event handler for this window. + Note that if you use this function you may want to use as the "next" handler + of @a handler the window itself; in this way when @a handler doesn't process + an event, the window itself will have a chance to do it. + @param handler - Specifies the handler to be set. - - @remarks 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. - It is usually better to use wxWindow::PushEventHandler since - this sets up a chain of event handlers, where an event not - handled by one event handler is handed to the next one in the chain. - - @see GetEventHandler(), PushEventHandler(), - PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler + Specifies the handler to be set. Cannot be @NULL. + + @see @ref overview_events_processing */ void SetEventHandler(wxEvtHandler* handler); + /** + wxWindows cannot be used to form event handler chains; this function + thus will assert when called. + + Note that instead you can use PushEventHandler() or SetEventHandler() to + implement a stack of event handlers to override wxWindow's own + event handling mechanism. + */ + virtual void SetNextHandler(wxEvtHandler* handler); + + /** + wxWindows cannot be used to form event handler chains; this function + thus will assert when called. + + Note that instead you can use PushEventHandler() or SetEventHandler() to + implement a stack of event handlers to override wxWindow's own + event handling mechanism. + */ + virtual void SetPreviousHandler(wxEvtHandler* handler); + //@} + /** - @name Window styles + @name Window styles functions */ //@{ @@ -1844,7 +2083,7 @@ public: /** Sets the style of the window. Please note that some styles cannot be changed - after the window creation and that Refresh() might need to be be called + after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately. See @ref overview_windowstyles "Window styles" for more information about flags. @@ -1858,11 +2097,26 @@ public: */ void SetWindowStyle(long style); + /** + Turns the given @a 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. + + @return Returns @true if the style was turned on by this function, @false + if it was switched off. + + @see SetWindowStyleFlag(), HasFlag() + */ + bool ToggleWindowStyle(int flag); + //@} /** - @name Tab order + @name Tab order functions */ //@{ @@ -1907,20 +2161,20 @@ public: control. See also wxNavigationKeyEvent and HandleAsNavigationKey. */ - bool Navigate(int flags = IsForward); + bool Navigate(int flags = wxNavigationKeyEvent::IsForward); /** Performs a keyboard navigation action inside this window. See Navigate() for more information. */ - bool NavigateIn(int flags = IsForward); + bool NavigateIn(int flags = wxNavigationKeyEvent::IsForward); //@} /** - @name Z-order + @name Z order functions */ //@{ @@ -1937,6 +2191,12 @@ public: /** 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. + @remarks This function only works for wxTopLevelWindow-derived classes. @@ -1948,7 +2208,7 @@ public: /** - @name Show/hide, enable/disable functions + @name Window status functions */ //@{ @@ -2046,6 +2306,11 @@ public: 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. + @param show If @true displays the window. Otherwise, hides it. @@ -2068,8 +2333,10 @@ public: milliseconds. If the default value of 0 is used, the default animation time for the current platform is used. - @note Currently this function is only implemented in wxMSW and does the - same thing as Show() in the other ports. + @note Currently this function is only implemented in wxMSW and wxOSX + (for wxTopLevelWindows only in Carbon version and for any kind of + windows in Cocoa) and does the same thing as Show() in the other + ports. @since 2.9.0 @@ -2081,164 +2348,71 @@ public: //@} - // NOTE: static functions must have their own group or Doxygen will screw - // up the ordering of the member groups - /** - @name Static functions + @name Context-sensitive help functions */ //@{ /** - 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 @a 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. + 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. - 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(). + @see SetHelpText(), GetHelpTextAtPoint(), wxHelpProvider + */ + wxString GetHelpText() const; - The @c wxVisualAttributes structure has at least the fields - @c font, @c colFg and @c 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 @c colBg for the controls with themed background. + /** + Sets the help text to be used as context-sensitive help for this window. + Note that the text is actually stored by the current wxHelpProvider + implementation, and not in the window object itself. - @see InheritAttributes() + @see GetHelpText(), wxHelpProvider::AddHelp() */ - static wxVisualAttributes GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); + void SetHelpText(const wxString& helpText); /** - Finds the window or control which currently has the keyboard focus. + 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. - @remarks Note that this is a static function, so it can be called without - needing a wxWindow pointer. + @param point + Coordinates of the mouse at the moment of help event emission. + @param origin + Help event origin, see also wxHelpEvent::GetOrigin. + */ + virtual wxString GetHelpTextAtPoint(const wxPoint& point, + wxHelpEvent::Origin origin) const; - @see SetFocus(), HasFocus() + /** + Get the associated tooltip or @NULL if none. */ - static wxWindow* FindFocus(); + wxToolTip* GetToolTip() const; /** - Find the first window with the given @e id. + Get the text of the associated tooltip or empty string if none. + */ + wxString GetToolTipText() const; - If @a 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. + /** + Attach a tooltip to the window. - @see FindWindow() - */ - static wxWindow* FindWindowById(long id, const wxWindow* parent = 0); + wxToolTip pointer can be @NULL in the overload taking the pointer, + meaning to unset any existing tooltips; however UnsetToolTip() provides + a more readable alternative to this operation. - /** - Find a window by its label. + Notice that these methods are always available, even if wxWidgets was + compiled with @c wxUSE_TOOLTIPS set to 0, but don't do anything in this + case. - Depending on the type of window, the label may be a window title - or panel item label. If @a parent is @NULL, the search will start from all - top-level frames and dialog boxes; if non-@NULL, the search will be - limited to the given window hierarchy. - The search is recursive in both cases. + @see GetToolTip(), wxToolTip + */ + void SetToolTip(const wxString& tip); - @see FindWindow() + /** + @overload */ - static wxWindow* FindWindowByLabel(const wxString& label, - const wxWindow* parent = 0); - - /** - Find a window by its name (as given in a window constructor or Create() - function call). - - If @a parent is @NULL, the search will start from all top-level frames - and dialog boxes; if non-@NULL, the search will be limited to the given - window hierarchy. - - The search is recursive in both cases. If no window with such name is found, - FindWindowByLabel() is called. - - @see FindWindow() - */ - static wxWindow* FindWindowByName(const wxString& name, - const wxWindow* parent = 0); - - /** - Returns the currently captured window. - - @see HasCapture(), CaptureMouse(), ReleaseMouse(), - wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent - */ - static wxWindow* GetCapture(); - - /** - 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 @ref overview_windowids for more information. - - @param count - The number of sequential IDs to reserve. - - @return Returns the ID or the first ID of the range, or wxID_NONE if the - specified number of identifiers couldn't be allocated. - - @see UnreserveControlId(), wxIdManager, - @ref overview_windowids - */ - static wxWindowID NewControlId(int count = 1); - - /** - Unreserve an ID or range of IDs that was reserved by NewControlId(). - See @ref overview_windowids for more information. - - @param id - The starting ID of the range of IDs to unreserve. - @param count - The number of sequential IDs to unreserve. - - @see NewControlId(), wxIdManager, @ref overview_windowids - */ - static void UnreserveControlId(wxWindowID id, int count = 1); - - //@} - - - /** - @name Tooltip functions - */ - //@{ - - /** - Get the associated tooltip or @NULL if none. - */ - wxToolTip* GetToolTip() const; - - /** - Attach a tooltip to the window. - - wxToolTip pointer can be @NULL in the overload taking the pointer, - meaning to unset any existing tooltips, however UnsetToolTip() provides - a more readable alternative to this operation. - - Notice that these methods are always available, even if wxWidgets was - compiled with @c wxUSE_TOOLTIPS set to 0, but don't do anything in this - case. - - @see GetToolTip(), wxToolTip - */ - void SetToolTip(const wxString& tip); - - /** - @overload - */ - void SetToolTip(wxToolTip* tip); + void SetToolTip(wxToolTip* tip); /** Unset any existing tooltip. @@ -2274,6 +2448,10 @@ public: The parameter @a menu is the menu to show. The parameter @a pos (or the parameters @a x and @a 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. @return The selected menu item id or @c wxID_NONE if none selected or an @@ -2281,7 +2459,8 @@ public: @since 2.9.0 */ - int GetPopupMenuSelectionFromUser(wxMenu& menu, const wxPoint& pos); + int GetPopupMenuSelectionFromUser(wxMenu& menu, + const wxPoint& pos = wxDefaultPosition); /** @overload @@ -2293,7 +2472,7 @@ public: 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 usually. If the coordinates are not specified, current mouse + processed as usual. If coordinates are not specified, the current mouse cursor position is used. @a menu is the menu to pop up. @@ -2322,315 +2501,361 @@ public: //@} - /** - @name Miscellaneous functions + Validator functions */ //@{ /** - Directs all mouse input to this window. - Call ReleaseMouse() to release the capture. - - Note that wxWidgets maintains the stack of windows having captured the mouse - and when the mouse is released the capture returns to the window which had had - captured it previously and it is only really released if there were no previous - window. In particular, this means that you must release the mouse as many times - as you capture it, unless the window receives the wxMouseCaptureLostEvent event. - - Any application which captures the mouse in the beginning of some operation - must handle wxMouseCaptureLostEvent and cancel this operation when it receives - the event. The event handler must not recapture mouse. - - @see ReleaseMouse(), wxMouseCaptureLostEvent + Returns a pointer to the current validator for the window, or @NULL if + there is none. */ - void CaptureMouse(); + virtual wxValidator* GetValidator(); /** - This function simply generates a wxCloseEvent whose handler usually tries - to close the window. It doesn't close the window itself, however. + Deletes the current validator (if any) and sets the window validator, having + called wxValidator::Clone to create a new validator of this type. + */ + virtual void SetValidator(const wxValidator& validator); - @param force - @false if the window's close handler should be able to veto the destruction - of this window, @true if it cannot. + /** + Transfers values from child controls to data areas specified by their + validators. Returns @false if a transfer failed. - @remarks Close calls the close handler for the window, providing an - opportunity for the window to choose whether to destroy - the window. Usually it is only used with the top level - windows (wxFrame and wxDialog classes) as the others - are not supposed to have any special OnClose() logic. - The close handler should check whether the window is being deleted - forcibly, using wxCloseEvent::CanVeto, in which case it should - destroy the window using wxWindow::Destroy. - Note that calling Close does not guarantee that the window will - be destroyed; but it provides a way to simulate a manual close - of a window, which may or may not be implemented by destroying - the window. The default implementation of wxDialog::OnCloseWindow - does not necessarily delete the dialog, since it will simply - simulate an wxID_CANCEL event which is handled by the appropriate - button event handler and may do anything at all. - To guarantee that the window will be destroyed, call - wxWindow::Destroy instead + If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, + the method will also call TransferDataFromWindow() of all child windows. - @see @ref overview_windowdeletion "Window Deletion Overview", - Destroy(), wxCloseEvent + @see TransferDataToWindow(), wxValidator, Validate() */ - bool Close(bool force = false); + virtual bool TransferDataFromWindow(); /** - 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. + Transfers values to child controls from data areas specified by their + validators. - @return @true if the window has either been successfully deleted, or it - has been added to the list of windows pending real deletion. + If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, + the method will also call TransferDataToWindow() of all child windows. + + @return Returns @false if a transfer failed. + + @see TransferDataFromWindow(), wxValidator, Validate() */ - virtual bool Destroy(); + virtual bool TransferDataToWindow(); /** - Returns true if this window is in process of being destroyed. + Validates the current values of the child controls using their validators. + If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, + the method will also call Validate() of all child windows. - The 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. + @return Returns @false if any of the validations failed. - This function returns @true if this window, or one of its parent - windows, is scheduled for destruction and can be useful to avoid - manipulating it as it's usually useless to do something with a window - which is on the point of disappearing anyhow. - */ - bool IsBeingDeleted() const; + @see TransferDataFromWindow(), TransferDataToWindow(), + wxValidator + */ + virtual bool Validate(); - /** - 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: + //@} - @code - // 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()); - } - } - @endcode + /** + @name wxWindow properties functions */ - virtual void DoUpdateWindowUI(wxUpdateUIEvent& event); + //@{ /** - Enables or disables eligibility for drop file events (OnDropFiles). - - @param accept - If @true, the window is eligible for drop file events. - If @false, the window will not accept drop file events. + Returns the identifier of the window. - @remarks Windows only until version 2.8.9, available on all platforms - since 2.8.10. Cannot be used together with SetDropTarget() on - non-Windows platforms. + @remarks Each window has an integer identifier. If the application + has not provided one (or the default wxID_ANY) a unique + identifier with a negative value will be generated. - @see SetDropTarget() + @see SetId(), @ref overview_windowids */ - virtual void DragAcceptFiles(bool accept); + wxWindowID GetId() const; /** - Gets the accelerator table for this window. See wxAcceleratorTable. - */ - wxAcceleratorTable* GetAcceleratorTable(); + Generic way of getting a label from any window, for + identification purposes. - /** - Returns the accessible object for this window, if any. - See also wxAccessible. + @remarks The interpretation of this function differs from class to class. + For frames and dialogs, the value returned is the + title. For buttons or static text controls, it is the + button text. This function can be useful for + meta-programs (such as testing tools or special-needs + access programs) which need to identify windows by name. */ - wxAccessible* GetAccessible(); + virtual wxString GetLabel() const; /** - Returns the caret() associated with the window. + Returns the layout direction for this window, + Note that @c wxLayout_Default is returned if layout direction is not supported. */ - wxCaret* GetCaret() const; + virtual wxLayoutDirection GetLayoutDirection() const; /** - Returns a pointer to the window's layout constraints, or @NULL if there are none. + Returns the window's name. + + @remarks This name is not guaranteed to be unique; it is up to the + programmer to supply an appropriate name in the window + constructor or via SetName(). + + @see SetName() */ - wxLayoutConstraints* GetConstraints() const; + virtual wxString GetName() const; /** - Return the cursor associated with this window. - - @see SetCursor() + Returns the value previously passed to SetWindowVariant(). */ - const wxCursor& GetCursor() const; + wxWindowVariant GetWindowVariant() const; /** - Returns the associated drop target, which may be @NULL. + Sets the identifier of the window. - @see SetDropTarget(), @ref overview_dnd + @remarks Each window has an integer identifier. If the application has + not provided one, an identifier will be generated. + Normally, the identifier should be provided on creation + and should not be modified subsequently. + + @see GetId(), @ref overview_windowids */ - virtual wxDropTarget* GetDropTarget() const; + void SetId(wxWindowID winid); /** - Returns the platform-specific handle of the physical window. - Cast it to an appropriate handle, such as @b HWND for Windows, - @b Widget for Motif, @b GtkWidget for GTK or @b WinHandle for PalmOS. + Sets the window's label. + + @param label + The window label. + + @see GetLabel() */ - virtual WXWidget GetHandle() const; + virtual void SetLabel(const wxString& label); /** - 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. + Sets the layout direction for this window. + */ + virtual void SetLayoutDirection(wxLayoutDirection dir); - @see SetHelpText(), GetHelpTextAtPoint(), wxHelpProvider + /** + Sets the window's name. + + @param name + A name to set for the window. + + @see GetName() */ - wxString GetHelpText() const; + virtual void SetName(const wxString& name); /** - 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. + 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. - @param point - Coordinates of the mouse at the moment of help event emission. - @param origin - Help event origin, see also wxHelpEvent::GetOrigin. + By default the controls use the normal size, of course, but this function can + be used to change this. */ - virtual wxString GetHelpTextAtPoint(const wxPoint& point, - wxHelpEvent::Origin origin) const; + void SetWindowVariant(wxWindowVariant variant); /** - Returns the identifier of the window. + Gets the accelerator table for this window. See wxAcceleratorTable. + */ + wxAcceleratorTable* GetAcceleratorTable(); - @remarks Each window has an integer identifier. If the application - has not provided one (or the default wxID_ANY) an unique - identifier with a negative value will be generated. + /** + Returns the accessible object for this window, if any. + See also wxAccessible. + */ + wxAccessible* GetAccessible(); - @see SetId(), @ref overview_windowids + /** + Sets the accelerator table for this window. See wxAcceleratorTable. */ - wxWindowID GetId() const; + virtual void SetAcceleratorTable(const wxAcceleratorTable& accel); /** - Generic way of getting a label from any window, for - identification purposes. + Sets the accessible for this window. Any existing accessible for this window + will be deleted first, if not identical to @e accessible. + See also wxAccessible. + */ + void SetAccessible(wxAccessible* accessible); - @remarks The interpretation of this function differs from class to class. - For frames and dialogs, the value returned is the - title. For buttons or static text controls, it is the - button text. This function can be useful for - meta-programs (such as testing tools or special-needs - access programs) which need to identify windows by name. + //@} + + + /** + @name Window deletion functions */ - virtual wxString GetLabel() const; + //@{ /** - Returns the window's name. + This function simply generates a wxCloseEvent whose handler usually tries + to close the window. It doesn't close the window itself, however. - @remarks This name is not guaranteed to be unique; it is up to the - programmer to supply an appropriate name in the window - constructor or via SetName(). + @param force + @false if the window's close handler should be able to veto the destruction + of this window, @true if it cannot. - @see SetName() + @remarks Close calls the close handler for the window, providing an + opportunity for the window to choose whether to destroy + the window. Usually it is only used with the top level + windows (wxFrame and wxDialog classes) as the others + are not supposed to have any special OnClose() logic. + The close handler should check whether the window is being deleted + forcibly, using wxCloseEvent::CanVeto, in which case it should + destroy the window using wxWindow::Destroy. + Note that calling Close does not guarantee that the window will + be destroyed; but it provides a way to simulate a manual close + of a window, which may or may not be implemented by destroying + the window. The default implementation of wxDialog::OnCloseWindow + does not necessarily delete the dialog, since it will simply + simulate an wxID_CANCEL event which is handled by the appropriate + button event handler and may do anything at all. + To guarantee that the window will be destroyed, call + wxWindow::Destroy instead + + @see @ref overview_windowdeletion "Window Deletion Overview", + Destroy(), wxCloseEvent */ - virtual wxString GetName() const; + bool Close(bool force = false); /** - Returns a pointer to the current validator for the window, or @NULL if - there is none. + 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. + + @return @true if the window has either been successfully deleted, or it + has been added to the list of windows pending real deletion. */ - virtual wxValidator* GetValidator(); + virtual bool Destroy(); /** - Returns the value previously passed to SetWindowVariant(). + Returns true if this window is in process of being destroyed. + + Top level windows are not deleted immediately but are rather + scheduled for later destruction to give them time to process any + pending messages; see Destroy() description. + + This function returns @true if this window, or one of its parent + windows, is scheduled for destruction and can be useful to avoid + manipulating it as it's usually useless to do something with a window + which is on the point of disappearing anyhow. + */ + bool IsBeingDeleted() const; + + //@} + + + + /** + @name Drag and drop functions */ - wxWindowVariant GetWindowVariant() const; + //@{ /** - Returns @true if this window has the current mouse capture. + Returns the associated drop target, which may be @NULL. - @see CaptureMouse(), ReleaseMouse(), wxMouseCaptureLostEvent, - wxMouseCaptureChangedEvent + @see SetDropTarget(), @ref overview_dnd */ - virtual bool HasCapture() const; + virtual wxDropTarget* GetDropTarget() const; /** - 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 do it as well to - allow the library to handle such windows appropriately. + Associates a drop target with this window. + If the window already has a drop target, it is deleted. + + @see GetDropTarget(), @ref overview_dnd */ - virtual bool HasMultiplePages() const; + virtual void SetDropTarget(wxDropTarget* target); /** - 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. + Enables or disables eligibility for drop file events (OnDropFiles). - By "intelligently" the following is meant: by default, all windows use their - own @ref 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. + @param accept + If @true, the window is eligible for drop file events. + If @false, the window will not accept drop file events. - 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. + @remarks Windows only until version 2.8.9, available on all platforms + since 2.8.10. Cannot be used together with SetDropTarget() on + non-Windows platforms. + + @see SetDropTarget() */ - virtual void InheritAttributes(); + virtual void DragAcceptFiles(bool accept); + + //@} + /** - Sends an @c wxEVT_INIT_DIALOG event, whose handler usually transfers data - to the dialog via validators. + @name Constraints, sizers and window layout functions */ - virtual void InitDialog(); + //@{ /** - 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. + Returns the sizer of which this window is a member, if any, otherwise @NULL. + */ + wxSizer* GetContainingSizer() const; - @see wxBufferedDC + /** + Returns the sizer associated with the window by a previous call to + SetSizer(), or @NULL. */ - virtual bool IsDoubleBuffered() const; + wxSizer* GetSizer() const; /** - Returns @true if the window is retained, @false otherwise. + Sets the window to have the given layout sizer. - @remarks Retained windows are only available on X platforms. + 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 @a deleteOld parameter is @true. + + Note that this function will also call SetAutoLayout() implicitly with @true + parameter if the @a sizer is non-@NULL and @false otherwise so that the + sizer will be effectively used to layout the window children whenever + it is resized. + + @param sizer + The sizer to set. Pass @NULL to disassociate and conditionally delete + the window's sizer. See below. + @param deleteOld + If @true (the default), this will delete any pre-existing sizer. + Pass @false if you wish to handle deleting the old sizer yourself + but remember to do it yourself in this case to avoid memory leaks. + + @remarks SetSizer enables and disables Layout automatically. */ - virtual bool IsRetained() const; + void SetSizer(wxSizer* sizer, bool deleteOld = true); /** - Returns @true if this window is intrinsically enabled, @false otherwise, - i.e. if @ref Enable() Enable(@false) had been called. This method is - mostly used for wxWidgets itself, user code should normally use - IsEnabled() instead. + This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial + window size to the size needed to accommodate all sizer elements and sets the + size hints which, if this window is a top level one, prevent the user from + resizing it to be less than this minimal size. */ - bool IsThisEnabled() const; + void SetSizerAndFit(wxSizer* sizer, bool deleteOld = true); /** - 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). + Returns a pointer to the window's layout constraints, or @NULL if there are none. */ - virtual bool IsTopLevel() const; + wxLayoutConstraints* GetConstraints() const; + + /** + 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. + + @param constraints + The constraints to set. Pass @NULL to disassociate and delete the window's + constraints. + + @remarks You must call SetAutoLayout() to tell a window to use + the constraints automatically in OnSize; otherwise, you + must override OnSize and call Layout() explicitly. When + setting both a wxLayoutConstraints and a wxSizer, only + the sizer will have effect. + */ + void SetConstraints(wxLayoutConstraints* constraints); /** Invokes the constraint-based layout algorithm or the sizer-based algorithm @@ -2646,124 +2871,83 @@ public: virtual bool Layout(); /** - Disables all other windows in the application so that - the user can only interact with this window. + Determines whether the Layout() function will be called automatically + when the window is resized. - @param modal - If @true, this call disables all other windows in the application so that - the user can only interact with this window. If @false, the effect is - reversed. - */ - virtual void MakeModal(bool modal = true); + 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. - /** - 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. + @param autoLayout + Set this to @true if you wish the Layout() function to be called + automatically when the window is resized. - 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. + @see SetSizer(), SetConstraints() */ - virtual void OnInternalIdle(); + void SetAutoLayout(bool autoLayout); - /** - Registers a system wide hotkey. Every time the user presses the hotkey - registered here, this window will receive a hotkey event. + bool GetAutoLayout() const; - 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. + //@} - @param 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. - @param 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. - @param virtualKeyCode - The virtual key code of the hotkey. - @return @true if the hotkey was registered successfully. @false if some - other application already registered a hotkey with this - modifier/virtualKeyCode combination. - @remarks Use EVT_HOTKEY(hotkeyId, fnc) in the event table to capture the - event. This function is currently only implemented - under Windows. It is used in the Windows CE port for - detecting hardware button presses. - - @see UnregisterHotKey() + /** + @name Mouse functions */ - virtual bool RegisterHotKey(int hotkeyId, int modifiers, - int virtualKeyCode); + //@{ /** - Releases mouse input captured with CaptureMouse(). + Directs all mouse input to this window. + Call ReleaseMouse() to release the capture. - @see CaptureMouse(), HasCapture(), ReleaseMouse(), - wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent + Note that wxWidgets maintains the stack of windows having captured the mouse + and when the mouse is released the capture returns to the window which had had + captured it previously and it is only really released if there were no previous + window. In particular, this means that you must release the mouse as many times + as you capture it, unless the window receives the wxMouseCaptureLostEvent event. + + Any application which captures the mouse in the beginning of some operation + must handle wxMouseCaptureLostEvent and cancel this operation when it receives + the event. The event handler must not recapture mouse. + + @see ReleaseMouse(), wxMouseCaptureLostEvent */ - void ReleaseMouse(); + void CaptureMouse(); /** - Sets the accelerator table for this window. See wxAcceleratorTable. + Returns the caret() associated with the window. */ - virtual void SetAcceleratorTable(const wxAcceleratorTable& accel); + wxCaret* GetCaret() const; /** - Sets the accessible for this window. Any existing accessible for this window - will be deleted first, if not identical to @e accessible. - See also wxAccessible. + Return the cursor associated with this window. + + @see SetCursor() */ - void SetAccessible(wxAccessible* accessible); + const wxCursor& GetCursor() const; /** - Determines whether the Layout() function will be called automatically - when the window is resized. Please note that this only happens for the - windows usually used to contain children, namely wxPanel and wxTopLevelWindow - (and the classes deriving from them). + Returns @true if this window has the current mouse capture. - 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. + @see CaptureMouse(), ReleaseMouse(), wxMouseCaptureLostEvent, + wxMouseCaptureChangedEvent + */ + virtual bool HasCapture() const; - @param autoLayout - Set this to @true if you wish the Layout() function to be - called automatically when the window is resized - (really happens only if you derive from wxPanel or wxTopLevelWindow). + /** + Releases mouse input captured with CaptureMouse(). - @see SetConstraints() + @see CaptureMouse(), HasCapture(), ReleaseMouse(), + wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent */ - void SetAutoLayout(bool autoLayout); + void ReleaseMouse(); /** Sets the caret() associated with the window. */ void SetCaret(wxCaret* caret); - /** - 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. - - @param constraints - The constraints to set. Pass @NULL to disassociate and delete the window's - constraints. - - @remarks You must call SetAutoLayout() to tell a window to use - the constraints automatically in OnSize; otherwise, you - must override OnSize and call Layout() explicitly. When - setting both a wxLayoutConstraints and a wxSizer, only - the sizer will have effect. - */ - void SetConstraints(wxLayoutConstraints* constraints); - /** Sets the window's cursor. Notice that the window cursor also sets it for the children of the window implicitly. @@ -2779,108 +2963,211 @@ public: virtual bool SetCursor(const wxCursor& cursor); /** - Associates a drop target with this window. - If the window already has a drop target, it is deleted. + Moves the pointer to the given position on the window. - @see GetDropTarget(), @ref overview_dnd + @note Apple Human Interface Guidelines forbid moving the mouse cursor + programmatically so you should avoid using this function in Mac + applications (and probably avoid using it under the other + platforms without good reason as well). + + @param x + The new x position for the cursor. + @param y + The new y position for the cursor. */ - virtual void SetDropTarget(wxDropTarget* target); + virtual void WarpPointer(int x, int y); + + //@} + + + /** - 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. + @name Miscellaneous functions + */ + //@{ - @see GetHelpText(), wxHelpProvider::AddHelp() + wxHitTest HitTest(wxCoord x, wxCoord y) const; + wxHitTest HitTest(const wxPoint& pt) 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 */ - void SetHelpText(const wxString& helpText); + wxBorder GetBorder(long flags) const; /** - Sets the identifier of the window. + Get border for the flags of this window + */ + wxBorder GetBorder() const; - @remarks Each window has an integer identifier. If the application has - not provided one, an identifier will be generated. - Normally, the identifier should be provided on creation - and should not be modified subsequently. + + /** + 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: - @see GetId(), @ref overview_windowids + @code + // 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()); + } + } + @endcode */ - void SetId(wxWindowID winid); + virtual void DoUpdateWindowUI(wxUpdateUIEvent& event); /** - Sets the window's label. + Returns the platform-specific handle of the physical window. + Cast it to an appropriate handle, such as @b HWND for Windows, + @b Widget for Motif, @b GtkWidget for GTK or @b WinHandle for PalmOS. - @param label - The window label. + @beginWxPerlOnly + This method will return an integer in wxPerl. + @endWxPerlOnly + */ + virtual WXWidget GetHandle() const; + + /** + 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. + */ + virtual bool HasMultiplePages() const; + + /** + 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 @ref GetClassDefaultAttributes() default attributes. + However if some of the parents attributes are explicitly (that is, using + SetFont() and not wxWindow::SetOwnFont) changed and if the corresponding + attribute hadn't been explicitly set for this window itself, then this + window takes the same value as used by the parent. + In addition, if the window overrides ShouldInheritColours() to return @false, + the colours will not be changed no matter what and only the font might. + + This rather complicated logic is necessary in order to accommodate the + different usage scenarios. The most common one is when all default attributes + are used and in this case, nothing should be inherited as in modern GUIs + different controls use different fonts (and colours) than their siblings so + they can't inherit the same value from the parent. However it was also deemed + desirable to allow to simply change the attributes of all children at once by + just changing the font or colour of their common parent, hence in this case we + do inherit the parents attributes. + */ + virtual void InheritAttributes(); + + /** + Sends an @c wxEVT_INIT_DIALOG event, whose handler usually transfers data + to the dialog via validators. + */ + virtual void InitDialog(); + + /** + Returns @true if the window contents is double-buffered by the system, i.e. if + any drawing done on the window is really done on a temporary backing surface + and transferred to the screen all at once later. - @see GetLabel() + @see wxBufferedDC */ - virtual void SetLabel(const wxString& label); + virtual bool IsDoubleBuffered() const; - /** - Sets the window's name. + void SetDoubleBuffered(bool on); - @param name - A name to set for the window. + /** + Returns @true if the window is retained, @false otherwise. - @see GetName() + @remarks Retained windows are only available on X platforms. */ - virtual void SetName(const wxString& name); + virtual bool IsRetained() const; /** - Deletes the current validator (if any) and sets the window validator, having - called wxValidator::Clone to create a new validator of this type. + Returns @true if this window is intrinsically enabled, @false otherwise, + i.e. if @ref Enable() Enable(@false) had been called. This method is + mostly used for wxWidgets itself, user code should normally use + IsEnabled() instead. */ - virtual void SetValidator(const wxValidator& validator); + bool IsThisEnabled() const; /** - This function can be called under all platforms but only does anything under - Mac OS X 10.3+ currently. Under this system, each of the standard control can - exist in several sizes which correspond to the elements of wxWindowVariant enum. - - By default the controls use the normal size, of course, but this function can - be used to change this. + 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). */ - void SetWindowVariant(wxWindowVariant variant); + virtual bool IsTopLevel() const; /** - Turns the given @a 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. - - @return Returns @true if the style was turned on by this function, @false - if it was switched off. + Disables all other windows in the application so that + the user can only interact with this window. - @see SetWindowStyleFlag(), HasFlag() + @param modal + If @true, this call disables all other windows in the application so that + the user can only interact with this window. If @false, the effect is + reversed. */ - bool ToggleWindowStyle(int flag); + virtual void MakeModal(bool modal = true); + /** - Transfers values from child controls to data areas specified by their - validators. Returns @false if a transfer failed. - - If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, - the method will also call TransferDataFromWindow() of all child windows. + 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. - @see TransferDataToWindow(), wxValidator, Validate() + 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. */ - virtual bool TransferDataFromWindow(); + virtual void OnInternalIdle(); /** - Transfers values to child controls from data areas specified by their - validators. + Registers a system wide hotkey. Every time the user presses the hotkey + registered here, this window will receive a hotkey event. - If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, - the method will also call TransferDataToWindow() of all child windows. + 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. - @return Returns @false if a transfer failed. + @param 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. + @param 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. + @param virtualKeyCode + The virtual key code of the hotkey. - @see TransferDataFromWindow(), wxValidator, Validate() + @return @true if the hotkey was registered successfully. @false if some + other application already registered a hotkey with this + modifier/virtualKeyCode combination. + + @remarks Use EVT_HOTKEY(hotkeyId, fnc) in the event table to capture the + event. This function is currently only implemented + under Windows. It is used in the Windows CE port for + detecting hardware button presses. + + @see UnregisterHotKey() */ - virtual bool TransferDataToWindow(); + virtual bool RegisterHotKey(int hotkeyId, int modifiers, + int virtualKeyCode); /** Unregisters a system wide hotkey. @@ -2909,7 +3196,7 @@ public: 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. - @a flags should be a bitlist of one or more of the wxUpdateUI enumeration. + @a 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 @@ -2931,35 +3218,161 @@ public: */ virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE); + //@} + + + // NOTE: static functions must have their own group or Doxygen will screw + // up the ordering of the member groups + /** - Validates the current values of the child controls using their validators. - If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, - the method will also call Validate() of all child windows. + @name Miscellaneous static functions + */ + //@{ - @return Returns @false if any of the validations failed. + /** + Returns the default font and colours which are used by the control. - @see TransferDataFromWindow(), TransferDataToWindow(), - wxValidator + 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 @a 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 @c wxVisualAttributes structure has at least the fields + @c font, @c colFg and @c 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 @c colBg for the controls with themed background. + + @see InheritAttributes() */ - virtual bool Validate(); + static wxVisualAttributes GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); /** - Moves the pointer to the given position on the window. + Finds the window or control which currently has the keyboard focus. - @note This function is not supported under Mac because Apple Human - Interface Guidelines forbid moving the mouse cursor programmatically. + @remarks Note that this is a static function, so it can be called without + needing a wxWindow pointer. - @param x - The new x position for the cursor. - @param y - The new y position for the cursor. + @see SetFocus(), HasFocus() */ - virtual void WarpPointer(int x, int y); + static wxWindow* FindFocus(); + + /** + Find the first window with the given @e id. + + If @a parent is @NULL, the search will start from all top-level frames + and dialog boxes; if non-@NULL, the search will be limited to the given + window hierarchy. + The search is recursive in both cases. + + @see FindWindow() + + @return Window with the given @a id or @NULL if not found. + */ + static wxWindow* FindWindowById(long id, const wxWindow* parent = 0); + + /** + Find a window by its label. + + Depending on the type of window, the label may be a window title + or panel item label. If @a parent is @NULL, the search will start from all + top-level frames and dialog boxes; if non-@NULL, the search will be + limited to the given window hierarchy. + The search is recursive in both cases. + + @see FindWindow() + + @return Window with the given @a label or @NULL if not found. + */ + static wxWindow* FindWindowByLabel(const wxString& label, + const wxWindow* parent = 0); + + /** + Find a window by its name (as given in a window constructor or Create() + function call). + + If @a parent is @NULL, the search will start from all top-level frames + and dialog boxes; if non-@NULL, the search will be limited to the given + window hierarchy. + + The search is recursive in both cases. If no window with such name is found, + FindWindowByLabel() is called. + + @see FindWindow() + + @return Window with the given @a name or @NULL if not found. + */ + static wxWindow* FindWindowByName(const wxString& name, + const wxWindow* parent = 0); + + /** + Returns the currently captured window. + + @see HasCapture(), CaptureMouse(), ReleaseMouse(), + wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent + */ + static wxWindow* GetCapture(); + + /** + 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 @ref overview_windowids for more information. + + @param count + The number of sequential IDs to reserve. + + @return Returns the ID or the first ID of the range (i.e. the most negative), + or wxID_NONE if the specified number of identifiers couldn't be allocated. + + @see UnreserveControlId(), wxIdManager, + @ref overview_windowids + */ + static wxWindowID NewControlId(int count = 1); + + /** + Unreserve an ID or range of IDs that was reserved by NewControlId(). + See @ref overview_windowids for more information. + + @param id + The starting ID of the range of IDs to unreserve. + @param count + The number of sequential IDs to unreserve. + + @see NewControlId(), wxIdManager, @ref overview_windowids + */ + static void UnreserveControlId(wxWindowID id, int count = 1); //@} + + protected: + /** + Centres the window. + + @param direction + Specifies the direction for the centring. May be wxHORIZONTAL, + wxVERTICAL or wxBOTH. It may also include the wxCENTRE_ON_SCREEN + flag. + + @remarks This function is not meant to be called directly by user code, + but via Centre, Center, CentreOnParent, or CenterOnParent. + This function can be overridden to fine-tune centring behaviour. + */ + virtual void DoCentre(int direction); + /** 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 @@ -2997,6 +3410,36 @@ protected: explanations of when you might want to do it. */ void SendDestroyEvent(); + + /** + 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 @code GetEventHandler()->ProcessEvent() @endcode + + 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. + */ + virtual bool ProcessEvent(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. + */ + bool SafelyProcessEvent(wxEvent& event); + virtual void QueueEvent(wxEvent *event); + virtual void AddPendingEvent(const wxEvent& event); + void ProcessPendingEvents(); + bool ProcessThreadEvent(const wxEvent& event); + //@} };