Fix discrepancy between different ways of measuring text extents under Mac.

[wxWidgets.git] / interface / wx / window.h

diff --git a/interface/wx/window.h b/interface/wx/window.h
index f8df29562111cdc2f2a51ed1d1004a67d9591a5f..ed15f4adb039c6fe16c3c92673fc206a3a0e6a5d 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -7,37 +7,18 @@
 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 

-/**
-    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
 {
 /**
     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,
 
     /// Roll window to the left
     wxSHOW_EFFECT_ROLL_TO_LEFT,
 


@@ -83,17 +64,6 @@ 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
 
 /**
     @class wxWindow
 


@@ -188,16 +158,17 @@ enum wxUpdateUI
 
     @beginExtraStyleTable
     @style{wxWS_EX_VALIDATE_RECURSIVELY}
 
     @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
     @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
     @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


@@ -206,23 +177,76 @@ enum wxUpdateUI
     @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
     @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
            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
     @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
 
     @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).
+    @event{EVT_CHAR(func)}
+        Process a @c wxEVT_CHAR 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_SHOW(func)}
+        Process a @c wxEVT_SHOW event. See wxShowEvent.
+    @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}
 
     @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
 {
 */
 class wxWindow : public wxEvtHandler
 {


@@ -452,7 +476,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 +501,7 @@ public:
     /**
         Returns the built-in scrollbar position.
 
     /**
         Returns the built-in scrollbar position.
 

-        @see See SetScrollbar()
+        @see SetScrollbar()

     */
     virtual int GetScrollPos(int orientation) const;
 
     */
     virtual int GetScrollPos(int orientation) const;
 


@@ -493,7 +520,23 @@ public:
     virtual int GetScrollThumb(int orientation) const;
 
     /**
     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.
 
         @param orient
             Orientation to check, either wxHORIZONTAL or wxVERTICAL.


@@ -641,7 +684,7 @@ public:
 
 
     /**
 
 
     /**

-        @name Sizing
+        @name Sizing functions

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


@@ -649,6 +692,8 @@ public:
 
     /**
         Sets the cached best size value.
 
     /**
         Sets the cached best size value.

+
+        @see GetBestSize()

     */
     void CacheBestSize(const wxSize& size) const;
 
     */
     void CacheBestSize(const wxSize& size) const;
 


@@ -721,6 +766,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().
         control label is not truncated. For windows containing subwindows (typically
         wxPanel), the size returned by this function will be the same as the size
         the window would have had after calling Fit().

+
+        Note that when you write your own widget you need to overload the
+        DoGetBestSize() function instead of this (non-virtual!) function.
+
+        @see CacheBestSize(), @ref overview_windowsizing

     */
     wxSize GetBestSize() const;
 
     */
     wxSize GetBestSize() const;
 


@@ -732,6 +782,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).
 
         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;
         @see GetSize(), GetVirtualSize()
     */
     void GetClientSize(int* width, int* height) const;


@@ -746,9 +801,12 @@ public:
         This is the value used by sizers to determine the appropriate
         ammount of space to allocate for the widget.
 
         This is the value used by sizers to determine the appropriate
         ammount of space to allocate for the widget.
 

+        This is the method called by any wxSizer when they query the size
+        of a certain window or control.
+

         @see GetBestSize(), SetInitialSize(), @ref overview_windowsizing
     */
         @see GetBestSize(), SetInitialSize(), @ref overview_windowsizing
     */

-    wxSize GetEffectiveMinSize() const;
+    virtual wxSize GetEffectiveMinSize() const;

 
     /**
         Returns the maximum size of window's client area.
 
     /**
         Returns the maximum size of window's client area.


@@ -757,7 +815,7 @@ public:
         possible size as well as the upper bound on window's size settable using
         SetClientSize().
 
         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;
 
     */
     virtual wxSize GetMaxClientSize() const;
 


@@ -767,7 +825,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().
 
         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;
 
     */
     virtual wxSize GetMaxSize() const;
 


@@ -778,7 +836,7 @@ public:
         It normally just returns the value set by SetMinClientSize(), but it can be
         overridden to do the calculation on demand.
 
         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;
 
     */
     virtual wxSize GetMinClientSize() const;
 


@@ -789,7 +847,7 @@ public:
         This method normally just returns the value set by SetMinSize(), but it
         can be overridden to do the calculation on demand.
 
         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;
 
     */
     virtual wxSize GetMinSize() const;
 


@@ -805,7 +863,12 @@ public:
         @param height
             Receives the window height.
 
         @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;
 
     */
     void GetSize(int* width, int* height) const;
 


@@ -818,6 +881,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.
         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;
 
     */
     wxSize GetVirtualSize() const;
 


@@ -837,22 +902,14 @@ public:
     */
     virtual wxSize GetWindowBorderSize() const;
 
     */
     virtual wxSize GetWindowBorderSize() const;
 

-    /**
-        Return the sizer that this window is a member of, if any, otherwise @NULL.
-    */
-    wxSizer* GetContainingSizer() const;
-
-    /**
-        Return the sizer associated with the window by a previous call to
-        SetSizer() or @NULL.
-    */
-    wxSizer* GetSizer() const;
-

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

+
+        @see CacheBestSize()

     */
     void InvalidateBestSize();
     */
     void InvalidateBestSize();

+

     /**
         Posts a size event to the window.
 
     /**
         Posts a size event to the window.
 


@@ -911,6 +968,8 @@ 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.
         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

     */
     virtual void SetClientSize(int width, int height);
 
     */
     virtual void SetClientSize(int width, int height);
 


@@ -947,7 +1006,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.
 
         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);
 
     */
     virtual void SetMaxClientSize(const wxSize& size);
 


@@ -955,7 +1019,7 @@ public:
         Sets the maximum size of the window, to indicate to the sizer layout mechanism
         that this is the maximum possible size.
 
         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);
 
     */
     virtual void SetMaxSize(const wxSize& size);
 


@@ -971,7 +1035,12 @@ public:
         prevent the program from explicitly making the window smaller than the
         specified size.
 
         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);
 
     */
     virtual void SetMinClientSize(const wxSize& size);
 


@@ -987,7 +1056,7 @@ public:
         SetSize(), it just ensures that it won't become smaller than this size
         during the automatic layout.
 
         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);
 
     */
     virtual void SetMinSize(const wxSize& size);
 


@@ -1032,7 +1101,7 @@ public:
                  should be supplied by wxWidgets, or that the current value of the
                  dimension should be used.
 
                  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);
     */
     void SetSize(int x, int y, int width, int height,
                  int sizeFlags = wxSIZE_AUTO);


@@ -1043,7 +1112,7 @@ public:
 
         @remarks This form must be used with non-default width and height values.
 
 
         @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);
 
     */
     virtual void SetSize(const wxRect& rect);
 


@@ -1062,42 +1131,16 @@ public:
         (such as wxDialog or wxFrame) is discouraged.
         Please use SetMinSize() and SetMaxSize() instead.
 
         (such as wxDialog or wxFrame) is discouraged.
         Please use SetMinSize() and SetMaxSize() instead.
 

-        @see wxTopLevelWindow::SetSizeHints
+        @see wxTopLevelWindow::SetSizeHints, @ref overview_windowsizing

     */
     void SetSizeHints( const wxSize& minSize,
                        const wxSize& maxSize=wxDefaultSize,
                        const wxSize& incSize=wxDefaultSize);
 
     */
     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.
-    */
-    void SetSizerAndFit(wxSizer* sizer, bool deleteOld = true);
-

     /**
         Sets the virtual size of the window in pixels.
     /**
         Sets the virtual size of the window in pixels.

+
+        @see @ref overview_windowsizing

     */
     void SetVirtualSize(int width, int height);
 
     */
     void SetVirtualSize(int width, int height);
 


@@ -1110,7 +1153,7 @@ public:
 
 
     /**
 
 
     /**

-        @name Positioning
+        @name Positioning functions

     */
     //@{
 
     */
     //@{
 


@@ -1164,6 +1207,11 @@ public:
         @param y
             Receives the y position of the window if non-@NULL.
 
         @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;
         @see GetScreenPosition()
     */
     void GetPosition(int* x, int* y) const;


@@ -1253,7 +1301,7 @@ public:
 
 
     /**
 
 
     /**

-        @name Coordinate conversion
+        @name Coordinate conversion functions

     */
     //@{
 
     */
     //@{
 


@@ -1272,6 +1320,11 @@ public:
             - ClientToScreen(point): Accepts and returns a wxPoint
             - ClientToScreenXY(x, y): Returns a 2-tuple, (x, y)
         @endWxPythonOnly
             - 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;
 
     */
     void ClientToScreen(int* x, int* y) const;
 


@@ -1408,12 +1461,12 @@ public:
 
     /**
         Returns the background style of the window.
 
     /**
         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;
 
         @see SetBackgroundColour(), GetForegroundColour(),
              SetBackgroundStyle(), SetTransparent()
     */
     virtual wxBackgroundStyle GetBackgroundStyle() const;

+

     /**
         Returns the character height for this window.
     */
     /**
         Returns the character height for this window.
     */


@@ -1478,11 +1531,18 @@ public:
             Return value for external leading (optional).
         @param font
             Font to use instead of the current window font (optional).
             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
 
     /**
         Gets the dimensions of the string as it would be drawn on the


@@ -1565,6 +1625,9 @@ public:
                  usually the themes represent the appearance chosen by the user
                  to be used for all applications on the system.
 
                  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
         @see GetBackgroundColour(), SetForegroundColour(),
              GetForegroundColour(), ClearBackground(),
              Refresh(), wxEraseEvent


@@ -1572,8 +1635,28 @@ public:
     virtual bool SetBackgroundColour(const wxColour& colour);
 
     /**
     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 wxBG_STYLE_ERASE which indicates that
+        the window background may be erased in EVT_ERASE_BACKGROUND handler.
+        This is a safe compatibility default however you may want to change it
+        to wxBG_STYLE_SYSTEM if you don't define any erase background event
+        handlers at all to avoid unnecessary generation of erase background
+        events and always let system erase the background. And you should
+        change the background style to wxBG_STYLE_PAINT if you define an
+        EVT_PAINT handler which completely overwrites the window background as
+        in this case erasing it previously, either in EVT_ERASE_BACKGROUND
+        handler or in the system default handler, would result in flicker as
+        the background pixels will be repainted twice every time the window is
+        redrawn. Do ensure that the background is entirely erased by your
+        EVT_PAINT handler in this case however as otherwise garbage may be left
+        on screen.
+
+        Notice that in previous versions of wxWidgets a common way to work
+        around the above mentioned flickering problem was to define an empty
+        EVT_ERASE_BACKGROUND handler. Setting background style to
+        wxBG_STYLE_PAINT is a simpler and more efficient solution to the same
+        problem.

 
         @see SetBackgroundColour(), GetForegroundColour(),
              SetTransparent()
 
         @see SetBackgroundColour(), GetForegroundColour(),
              SetTransparent()


@@ -1596,8 +1679,8 @@ public:
             Font to associate with this window, pass
             wxNullFont to reset to the default font.
 
             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()
     */
 
         @see GetFont(), InheritAttributes()
     */


@@ -1616,6 +1699,9 @@ public:
                  interpretation according to the window class; it may be
                  the text colour or other colour, or it may not be used at all.
 
                  interpretation 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()
     */
         @see GetForegroundColour(), SetBackgroundColour(),
              GetBackgroundColour(), ShouldInheritColours()
     */


@@ -1695,6 +1781,9 @@ public:
 
     /**
         @name Event-handling functions
 
     /**
         @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 +1797,8 @@ public:
     wxEvtHandler* GetEventHandler() const;
 
     /**
     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.
 
         @return Returns @true if the key pressed was for navigation and was
                 handled, @false otherwise.


@@ -1724,50 +1812,82 @@ public:
         @code
         GetEventHandler()->SafelyProcessEvent(event);
         @endcode
         @code
         GetEventHandler()->SafelyProcessEvent(event);
         @endcode

+
+        @see ProcessWindowEvent()

     */
     bool HandleWindowEvent(wxEvent& event) const;
 
     */
     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);
+

     /**
         Removes and returns the top-most event handler on the event handler stack.
 
     /**
         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
         @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.
 
     */
     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.
         @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);
 
     /**
     */
     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
 
         @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
 
         @return Returns @true if it was found and @false otherwise (this also
                 results in an assert failure so this function should


@@ -1780,29 +1900,43 @@ public:
     /**
         Sets the event handler for this window.
 
     /**
         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
         @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);
 
     */
     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

     */
     //@{
 
     */
     //@{
 


@@ -1858,11 +1992,26 @@ public:
     */
     void SetWindowStyle(long style);
 
     */
     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

     */
     //@{
 
     */
     //@{
 


@@ -1920,7 +2069,7 @@ public:
 
 
     /**
 
 
     /**

-        @name Z-order
+        @name Z order functions

     */
     //@{
 
     */
     //@{
 


@@ -1948,7 +2097,7 @@ public:
 
 
     /**
 
 
     /**

-        @name Show/hide, enable/disable functions
+        @name Window status functions

     */
     //@{
 
     */
     //@{
 


@@ -2068,8 +2217,10 @@ public:
             milliseconds. If the default value of 0 is used, the default
             animation time for the current platform is used.
 
             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
 
 
         @since 2.9.0
 


@@ -2081,181 +2232,88 @@ 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.
-
-        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.
+        Gets the help text to be used as context-sensitive help for this window.
+        Note that the text is actually stored by the current wxHelpProvider
+        implementation, and not in the window object itself.

 
 

-        @see InheritAttributes()
+        @see SetHelpText(), GetHelpTextAtPoint(), wxHelpProvider

     */
     */

-    static wxVisualAttributes GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+    wxString GetHelpText() const;

 
     /**
 
     /**

-        Finds the window or control which currently has the keyboard focus.
-
-        @remarks Note that this is a static function, so it can be called without
-                 needing a wxWindow pointer.
+        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 SetFocus(), HasFocus()
+        @see GetHelpText(), wxHelpProvider::AddHelp()

     */
     */

-    static wxWindow* FindFocus();
+    void SetHelpText(const wxString& helpText);

 
     /**
 
     /**

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

 
 

-        @see FindWindow()
+        @param point
+            Coordinates of the mouse at the moment of help event emission.
+        @param origin
+            Help event origin, see also wxHelpEvent::GetOrigin.

     */
     */

-    static wxWindow* FindWindowById(long id, const wxWindow* parent = 0);
+    virtual wxString GetHelpTextAtPoint(const wxPoint& point,
+                                        wxHelpEvent::Origin origin) const;

 
     /**
 
     /**

-        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()
+        Get the associated tooltip or @NULL if none.

     */
     */

-    static wxWindow* FindWindowByLabel(const wxString& label,
-                                       const wxWindow* parent = 0);
+    wxToolTip* GetToolTip() const;

 
     /**
 
     /**

-        Find a window by its name (as given in a window constructor or Create()
-        function call).
+        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.
+    /**
+        Attach a tooltip to the window.

 
 

-        The search is recursive in both cases. If no window with such name is found,
-        FindWindowByLabel() is called.
+        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.

 
 

-        @see FindWindow()
+        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

     */
     */

-    static wxWindow* FindWindowByName(const wxString& name,
-                                      const wxWindow* parent = 0);
+    void SetToolTip(const wxString& tip);

 
     /**
 
     /**

-        Returns the currently captured window.
-
-        @see HasCapture(), CaptureMouse(), ReleaseMouse(),
-             wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent
+        @overload

     */
     */

-    static wxWindow* GetCapture();
+    void SetToolTip(wxToolTip* tip);

 
     /**
 
     /**

-        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().
+        Unset any existing tooltip.

 
 

-        See @ref overview_windowids for more information.
+        @since 2.9.0

 
 

-        @param count
-            The number of sequential IDs to reserve.
+        @see SetToolTip()
+     */
+    void UnsetToolTip();

 
 

-        @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);
-
-    /**
-        Unset any existing tooltip.
-
-        @since 2.9.0
-
-        @see SetToolTip()
-     */
-    void UnsetToolTip();
-
-    //@}
-
-
-    /**
-        @name Popup/context menu functions
-    */
-    //@{
+        @name Popup/context menu functions
+    */
+    //@{

 
     /**
         This function shows a popup menu at the given position in this window and
 
     /**
         This function shows a popup menu at the given position in this window and


@@ -2322,190 +2380,66 @@ 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
-    */
-    void CaptureMouse();
-
-    /**
-        This function simply generates a wxCloseEvent whose handler usually tries
-        to close the window. It doesn't close the window itself, however.
-
-        @param force
-            @false if the window's close handler should be able to veto the destruction
-            of this window, @true if it cannot.
-
-        @remarks Close calls the close handler for the window, providing an
-                 opportunity for the window to choose whether to destroy
-                 the window. Usually it is only used with the top level
-                 windows (wxFrame and wxDialog classes) as the others
-                 are not supposed to have any special OnClose() logic.
-                The close handler should check whether the window is being deleted
-                forcibly, using wxCloseEvent::CanVeto, in which case it should
-                destroy the window using wxWindow::Destroy.
-                Note that calling Close does not guarantee that the window will
-                be destroyed; but it provides a way to simulate a manual close
-                of a window, which may or may not be implemented by destroying
-                the window. The default implementation of wxDialog::OnCloseWindow
-                does not necessarily delete the dialog, since it will simply
-                simulate an wxID_CANCEL event which is handled by the appropriate
-                button event handler and may do anything at all.
-                To guarantee that the window will be destroyed, call
-                wxWindow::Destroy instead
-
-        @see @ref overview_windowdeletion "Window Deletion Overview",
-             Destroy(), wxCloseEvent
-    */
-    bool Close(bool force = false);
-
-    /**
-        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.
+        Returns a pointer to the current validator for the window, or @NULL if
+        there is none.

     */
     */

-    virtual bool Destroy();
-
-    /**
-        Returns true if this window is in process of being destroyed.
-
-        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.
-
-        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;
+    virtual wxValidator* GetValidator();

 
     /**
 
     /**

-        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
+        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 DoUpdateWindowUI(wxUpdateUIEvent& event);
+    virtual void SetValidator(const wxValidator& validator);

 
     /**
 
     /**

-        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.
-
-        @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 DragAcceptFiles(bool accept);
+        Transfers values from child controls to data areas specified by their
+        validators. Returns @false if a transfer failed.

 
 

-    /**
-        Gets the accelerator table for this window. See wxAcceleratorTable.
-    */
-    wxAcceleratorTable* GetAcceleratorTable();
+        If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set,
+        the method will also call TransferDataFromWindow() of all child windows.

 
 

-    /**
-        Returns the accessible object for this window, if any.
-        See also wxAccessible.
+        @see TransferDataToWindow(), wxValidator, Validate()

     */
     */

-    wxAccessible* GetAccessible();
+    virtual bool TransferDataFromWindow();

 
     /**
 
     /**

-        Returns the caret() associated with the window.
-    */
-    wxCaret* GetCaret() const;
+        Transfers values to child controls from data areas specified by their
+        validators.

 
 

-    /**
-        Returns a pointer to the window's layout constraints, or @NULL if there are none.
-    */
-    wxLayoutConstraints* GetConstraints() const;
+        If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set,
+        the method will also call TransferDataToWindow() of all child windows.

 
 

-    /**
-        Return the cursor associated with this window.
+        @return Returns @false if a transfer failed.

 
 

-        @see SetCursor()
+        @see TransferDataFromWindow(), wxValidator, Validate()

     */
     */

-    const wxCursor& GetCursor() const;
+    virtual bool TransferDataToWindow();

 
     /**
 
     /**

-        Returns the associated drop target, which may be @NULL.
+        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.

 
 

-        @see SetDropTarget(), @ref overview_dnd
-    */
-    virtual wxDropTarget* GetDropTarget() const;
+        @return Returns @false if any of the validations failed.

 
 

-    /**
-        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.
+        @see TransferDataFromWindow(), TransferDataToWindow(),
+             wxValidator

     */
     */

-    virtual WXWidget GetHandle() const;
+    virtual bool Validate();

 
 

-    /**
-        Gets the help text to be used as context-sensitive help for this window.
-        Note that the text is actually stored by the current wxHelpProvider
-        implementation, and not in the window object itself.
+    //@}

 
 

-        @see SetHelpText(), GetHelpTextAtPoint(), wxHelpProvider
-    */
-    wxString GetHelpText() const;

 
     /**
 
     /**

-        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.
-
-        @param point
-            Coordinates of the mouse at the moment of help event emission.
-        @param origin
-            Help event origin, see also wxHelpEvent::GetOrigin.
+        @name wxWindow properties functions

     */
     */

-    virtual wxString GetHelpTextAtPoint(const wxPoint& point,
-                                        wxHelpEvent::Origin origin) const;
+    //@{

 
     /**
         Returns the identifier of the window.
 
     /**
         Returns the identifier of the window.


@@ -2531,6 +2465,12 @@ public:
     */
     virtual wxString GetLabel() const;
 
     */
     virtual wxString GetLabel() const;
 

+    /**
+        Returns the layout direction for this window,
+        Note that @c wxLayout_Default is returned if layout direction is not supported.
+    */
+    virtual wxLayoutDirection GetLayoutDirection() const;
+

     /**
         Returns the window's name.
 
     /**
         Returns the window's name.
 


@@ -2542,209 +2482,241 @@ public:
     */
     virtual wxString GetName() const;
 
     */
     virtual wxString GetName() const;
 

-    /**
-        Returns a pointer to the current validator for the window, or @NULL if
-        there is none.
-    */
-    virtual wxValidator* GetValidator();
-

     /**
         Returns the value previously passed to SetWindowVariant().
     */
     wxWindowVariant GetWindowVariant() const;
 
     /**
     /**
         Returns the value previously passed to SetWindowVariant().
     */
     wxWindowVariant GetWindowVariant() const;
 
     /**

-        Returns @true if this window has the current mouse capture.
-
-        @see CaptureMouse(), ReleaseMouse(), wxMouseCaptureLostEvent,
-             wxMouseCaptureChangedEvent
-    */
-    virtual bool HasCapture() const;
+        Sets the identifier of the window.

 
 

-    /**
-        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.
+        @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 bool HasMultiplePages() const;
+    void SetId(wxWindowID winid);

 
     /**
 
     /**

-        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.
+        Sets the window's label.

 
 

-        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 label
+            The window label.

 
 

-        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.
+        @see GetLabel()

     */
     */

-    virtual void InheritAttributes();
+    virtual void SetLabel(const wxString& label);

 
     /**
 
     /**

-        Sends an @c wxEVT_INIT_DIALOG event, whose handler usually transfers data
-        to the dialog via validators.
+        Sets the layout direction for this window.

     */
     */

-    virtual void InitDialog();
+    virtual void SetLayoutDirection(wxLayoutDirection dir);

 
     /**
 
     /**

-        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.
+        Sets the window's name.

 
 

-        @see wxBufferedDC
+        @param name
+            A name to set for the window.
+
+        @see GetName()

     */
     */

-    virtual bool IsDoubleBuffered() const;
+    virtual void SetName(const wxString& name);

 
     /**
 
     /**

-        Returns @true if the window is retained, @false otherwise.
+        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.

 
 

-        @remarks Retained windows are only available on X platforms.
+        By default the controls use the normal size, of course, but this function can
+        be used to change this.

     */
     */

-    virtual bool IsRetained() const;
+    void SetWindowVariant(wxWindowVariant variant);

 
     /**
 
     /**

-        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.
+        Gets the accelerator table for this window. See wxAcceleratorTable.

     */
     */

-    bool IsThisEnabled() const;
+    wxAcceleratorTable* GetAcceleratorTable();

 
     /**
 
     /**

-        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 the accessible object for this window, if any.
+        See also wxAccessible.

     */
     */

-    virtual bool IsTopLevel() const;
+    wxAccessible* GetAccessible();

 
     /**
 
     /**

-        Invokes the constraint-based layout algorithm or the sizer-based algorithm
-        for this window.
+        Sets the accelerator table for this window. See wxAcceleratorTable.
+    */
+    virtual void SetAcceleratorTable(const wxAcceleratorTable& accel);

 
 

-        This function does not get called automatically when the window is resized
-        because lots of windows deriving from wxWindow does not need this functionality.
-        If you want to have Layout() called automatically, you should derive
-        from wxPanel (see wxPanel::Layout).
+    /**
+        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);

 
 

-        @see @ref overview_windowsizing
+    //@}
+
+
+    /**
+        @name Window deletion functions

     */
     */

-    virtual bool Layout();
+    //@{

 
     /**
 
     /**

-        Disables all other windows in the application so that
-        the user can only interact with this window.
+        This function simply generates a wxCloseEvent whose handler usually tries
+        to close the window. It doesn't close the window itself, however.

 
 

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

     */
     */

-    virtual void MakeModal(bool modal = true);
+    bool Close(bool force = false);

 
     /**
 
     /**

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

 
 

-        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.
+        @return @true if the window has either been successfully deleted, or it
+                 has been added to the list of windows pending real deletion.

     */
     */

-    virtual void OnInternalIdle();
+    virtual bool Destroy();

 
     /**
 
     /**

-        Registers a system wide hotkey. Every time the user presses the hotkey
-        registered here, this window will receive a hotkey event.
+        Returns true if this window is in process of being destroyed.

 
 

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

 
 

-        @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.
+        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;

 
 

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

     */
     */

-    virtual bool RegisterHotKey(int hotkeyId, int modifiers,
-                                int virtualKeyCode);
+    //@{

 
     /**
 
     /**

-        Releases mouse input captured with CaptureMouse().
+        Returns the associated drop target, which may be @NULL.

 
 

-        @see CaptureMouse(), HasCapture(), ReleaseMouse(),
-             wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent
+        @see SetDropTarget(), @ref overview_dnd

     */
     */

-    void ReleaseMouse();
+    virtual wxDropTarget* GetDropTarget() const;

 
     /**
 
     /**

-        Sets the accelerator table for this window. See wxAcceleratorTable.
+        Associates a drop target with this window.
+        If the window already has a drop target, it is deleted.
+
+        @see GetDropTarget(), @ref overview_dnd

     */
     */

-    virtual void SetAcceleratorTable(const wxAcceleratorTable& accel);
+    virtual void SetDropTarget(wxDropTarget* target);

 
     /**
 
     /**

-        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.
+        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.
+
+        @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()

     */
     */

-    void SetAccessible(wxAccessible* accessible);
+    virtual void DragAcceptFiles(bool accept);
+
+    //@}
+

 
     /**
 
     /**

-        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).
+        @name Constraints, sizers and window layouting functions
+    */
+    //@{

 
 

-        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.
+    /**
+        Return the sizer that this window is a member of, if any, otherwise @NULL.
+    */
+    wxSizer* GetContainingSizer() 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).
+    /**
+        Return the sizer associated with the window by a previous call to
+        SetSizer() or @NULL.
+    */
+    wxSizer* GetSizer() const;
+
+    /**
+        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 @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.

 
 

-        @see SetConstraints()
+        @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.

     */
     */

-    void SetAutoLayout(bool autoLayout);
+    void SetSizer(wxSizer* sizer, bool deleteOld = true);

 
     /**
 
     /**

-        Sets the caret() associated with the window.
+        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.

     */
     */

-    void SetCaret(wxCaret* caret);
+    void SetSizerAndFit(wxSizer* sizer, bool deleteOld = true);
+
+    /**
+        Returns a pointer to the window's layout constraints, or @NULL if there are none.
+    */
+    wxLayoutConstraints* GetConstraints() const;

 
     /**
         Sets the window to have the given layout constraints. The window
 
     /**
         Sets the window to have the given layout constraints. The window


@@ -2764,6 +2736,96 @@ public:
     */
     void SetConstraints(wxLayoutConstraints* constraints);
 
     */
     void SetConstraints(wxLayoutConstraints* constraints);
 

+
+    /**
+        Invokes the constraint-based layout algorithm or the sizer-based algorithm
+        for this window.
+
+        This function does not get called automatically when the window is resized
+        because lots of windows deriving from wxWindow does not need this functionality.
+        If you want to have Layout() called automatically, you should derive
+        from wxPanel (see wxPanel::Layout).
+
+        @see @ref overview_windowsizing
+    */
+    virtual bool Layout();
+
+    /**
+        Determines whether the Layout() function will be called automatically
+        when the window is resized.
+
+        This method is called implicitly by SetSizer() but if you use SetConstraints()
+        you should call it manually or otherwise the window layout won't be correctly
+        updated when its size changes.
+
+        @param autoLayout
+            Set this to @true if you wish the Layout() function to be called
+            automatically when the window is resized.
+
+        @see SetSizer(), SetConstraints()
+    */
+    void SetAutoLayout(bool autoLayout);
+
+    //@}
+
+
+
+    /**
+        @name Mouse 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
+    */
+    void CaptureMouse();
+
+    /**
+        Returns the caret() associated with the window.
+    */
+    wxCaret* GetCaret() const;
+
+    /**
+        Return the cursor associated with this window.
+
+        @see SetCursor()
+    */
+    const wxCursor& GetCursor() const;
+
+    /**
+        Returns @true if this window has the current mouse capture.
+
+        @see CaptureMouse(), ReleaseMouse(), wxMouseCaptureLostEvent,
+             wxMouseCaptureChangedEvent
+    */
+    virtual bool HasCapture() const;
+
+    /**
+        Releases mouse input captured with CaptureMouse().
+
+        @see CaptureMouse(), HasCapture(), ReleaseMouse(),
+             wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent
+    */
+    void ReleaseMouse();
+
+    /**
+        Sets the caret() associated with the window.
+    */
+    void SetCaret(wxCaret* caret);
+

     /**
         Sets the window's cursor. Notice that the window cursor also sets it for the
         children of the window implicitly.
     /**
         Sets the window's cursor. Notice that the window cursor also sets it for the
         children of the window implicitly.


@@ -2779,108 +2841,192 @@ public:
     virtual bool SetCursor(const wxCursor& cursor);
 
     /**
     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()
+    /**
+        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

     */
     */

-    void SetHelpText(const wxString& helpText);
+    virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);

 
     /**
 
     /**

-        Sets the identifier of the window.
+        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.

 
 

-        @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.
+        @beginWxPerlOnly
+        This method will return an integer in wxPerl.
+        @endWxPerlOnly
+    */
+    virtual WXWidget GetHandle() const;

 
 

-        @see GetId(), @ref overview_windowids
+    /**
+        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.

     */
     */

-    void SetId(wxWindowID winid);
+    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();

 
     /**
 
     /**

-        Sets the window's label.
+        Sends an @c wxEVT_INIT_DIALOG event, whose handler usually transfers data
+        to the dialog via validators.
+    */
+    virtual void InitDialog();

 
 

-        @param label
-            The window label.
+    /**
+        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.
-
-        @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.
 
     /**
         Unregisters a system wide hotkey.


@@ -2909,7 +3055,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.
         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
 
         If you are calling this function from an OnInternalIdle or OnIdle
         function, make sure you pass the wxUPDATE_UI_FROMIDLE flag, since


@@ -2931,33 +3077,139 @@ public:
     */
     virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
 
     */
     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()
+    */
+    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()
+    */
+    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);

 
     //@}
 
 
     //@}
 

+
+

 protected:
 
     /**
 protected:
 
     /**


@@ -2997,6 +3249,36 @@ protected:
         explanations of when you might want to do it.
      */
     void SendDestroyEvent();
         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);
+    //@}

 };
 
 
 };