Fix text origin and bounding box computations in wxSVGFileDC.

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

diff --git a/interface/wx/window.h b/interface/wx/window.h
index 6a13cadcfd35b1038140850394d172d9f8c63f4a..ceada1baa7bf2b41d2730ac15871a3faf1a2814d 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -47,24 +47,29 @@ enum wxShowEffect
     wxSHOW_EFFECT_BLEND,
 
     /// Expanding or collapsing effect
     wxSHOW_EFFECT_BLEND,
 
     /// Expanding or collapsing effect

-    wxSHOW_EFFECT_EXPAND
+    wxSHOW_EFFECT_EXPAND,
+
+    wxSHOW_EFFECT_MAX

 };
 
 
 
 /**
 };
 
 
 
 /**

-   struct containing all the visual attributes of a control
+    Struct containing all the visual attributes of a control.

 */
 struct  wxVisualAttributes
 {
 */
 struct  wxVisualAttributes
 {

-    // the font used for control label/text inside it
+    /// The font used for control label/text inside it.

     wxFont font;
 
     wxFont font;
 

-    // the foreground colour
+    /// The foreground colour.

     wxColour colFg;
 
     wxColour colFg;
 

-    // the background colour, may be wxNullColour if the controls background
-    // colour is not solid
+    /**
+        The background colour.
+
+        May be wxNullColour if the controls background colour is not solid.
+     */

     wxColour colBg;
 };
 
     wxColour colBg;
 };
 


@@ -355,6 +360,26 @@ public:
         container windows.
      */
     virtual bool AcceptsFocusRecursively() const;
         container windows.
      */
     virtual bool AcceptsFocusRecursively() const;

+    
+    /**
+     Can this window itself have focus?
+    */
+    bool IsFocusable() const;
+
+    /**
+       Can this window have focus right now?
+        
+       If this method returns true, it means that calling SetFocus() will
+       put focus either to this window or one of its children, if you need
+       to know whether this window accepts focus itself, use IsFocusable()
+    */
+    bool CanAcceptFocus() const;
+
+    /**
+       Can this window be assigned focus from keyboard right now?
+    */
+    bool CanAcceptFocusFromKeyboard() const;
+

 
     /**
         Returns @true if the window (or in case of composite controls, its main
 
     /**
         Returns @true if the window (or in case of composite controls, its main


@@ -490,11 +515,31 @@ public:
         @see GetNextSibling()
     */
     wxWindow* GetPrevSibling() const;
         @see GetNextSibling()
     */
     wxWindow* GetPrevSibling() const;

+
+    /**
+        Check if the specified window is a descendant of this one.
+
+        Returns @true if the window is a descendant (i.e. a child or
+        grand-child or grand-grand-child or ...) of this one.
+
+        Notice that a window can never be a descendant of another one if they
+        are in different top level windows, i.e. a child of a wxDialog is not
+        considered to be a descendant of dialogs parent wxFrame.
+
+        @param win Any window, possible @NULL (@false is always returned then).
+
+        @since 2.9.4
+     */
+    bool IsDescendant(wxWindowBase* win) const;
+

     /**
         Reparents the window, i.e. the window will be removed from its
         current parent window (e.g. a non-standard toolbar in a wxFrame)
         and then re-inserted into another.
 
     /**
         Reparents the window, i.e. the window will be removed from its
         current parent window (e.g. a non-standard toolbar in a wxFrame)
         and then re-inserted into another.
 

+        Notice that currently you need to explicitly call
+        wxNotebook::RemovePage() before reparenting a notebook page.
+

         @param newParent
             New parent.
     */
         @param newParent
             New parent.
     */


@@ -714,7 +759,8 @@ public:
     /**
         @name Sizing functions
 
     /**
         @name Sizing functions
 

-        See also the protected functions DoGetBestSize() and SetInitialBestSize().
+        See also the protected functions DoGetBestSize() and
+        DoGetBestClientSize().

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


@@ -795,13 +841,38 @@ public:
         wxPanel), the size returned by this function will be the same as the size
         the window would have had after calling Fit().
 
         wxPanel), the size returned by this function will be the same as the size
         the window would have had after calling Fit().
 

-        Note that when you write your own widget you need to override the
-        DoGetBestSize() function instead of this (non-virtual!) function.
+        Override virtual DoGetBestSize() or, better, because it's usually more
+        convenient, DoGetBestClientSize() when writing your own custom window
+        class to change the value returned by this public non-virtual method.
+
+        Notice that the best size respects the minimal and maximal size
+        explicitly set for the window, if any. So even if some window believes
+        that it needs 200 pixels horizontally, calling SetMaxSize() with a
+        width of 100 would ensure that GetBestSize() returns the width of at
+        most 100 pixels.

 
         @see CacheBestSize(), @ref overview_windowsizing
     */
     wxSize GetBestSize() const;
 
 
         @see CacheBestSize(), @ref overview_windowsizing
     */
     wxSize GetBestSize() const;
 

+    /**
+        Returns the best height needed by this window if it had the given width.
+
+        @see DoGetBestClientHeight()
+
+        @since 2.9.4
+     */
+    int GetBestHeight(int width) const;
+
+    /**
+        Returns the best width needed by this window if it had the given height.
+
+        @see DoGetBestClientWidth()
+
+        @since 2.9.4
+     */
+    int GetBestWidth(int height) const;
+

     /**
         Returns the size of the window 'client area' in pixels.
 
     /**
         Returns the size of the window 'client area' in pixels.
 


@@ -1392,12 +1463,6 @@ public:
             A pointer to a integer value for the y coordinate. Pass the client
             coordinate in, and a screen coordinate will be passed out.
 
             A pointer to a integer value for the y coordinate. Pass the client
             coordinate in, and a screen coordinate will be passed out.
 

-        @beginWxPythonOnly
-        In place of a single overloaded method name, wxPython implements the following methods:
-            - 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.
         @beginWxPerlOnly
         In wxPerl this method returns a 2-element list instead of
         modifying its parameters.


@@ -1694,13 +1759,18 @@ public:
 
     /**
         Sets the background colour of the window.
 
     /**
         Sets the background colour of the window.

+
+        Notice that as with SetForegroundColour(), setting the background
+        colour of a native control may not affect the entire control and could
+        be not supported at all depending on the control and platform.
+

         Please see InheritAttributes() for explanation of the difference between
         this method and SetOwnBackgroundColour().
 
         @param colour
             The colour to be used as the background colour; pass
             wxNullColour to reset to the default colour.
         Please see InheritAttributes() for explanation of the difference between
         this method and SetOwnBackgroundColour().
 
         @param colour
             The colour to be used as the background colour; pass
             wxNullColour to reset to the default colour.

-            Note that you may want to use wxSystemSettings::GetColour() to retrieve 
+            Note that you may want to use wxSystemSettings::GetColour() to retrieve

             a suitable colour to use rather than setting an hard-coded one.
 
         @remarks The background colour is usually painted by the default
             a suitable colour to use rather than setting an hard-coded one.
 
         @remarks The background colour is usually painted by the default


@@ -1747,11 +1817,57 @@ public:
         @c wxBG_STYLE_PAINT is a simpler and more efficient solution to the same
         problem.
 
         @c wxBG_STYLE_PAINT is a simpler and more efficient solution to the same
         problem.
 

+
+        Under wxGTK and wxOSX, you can use ::wxBG_STYLE_TRANSPARENT to obtain
+        full transparency of the window background. Note that wxGTK supports
+        this only since GTK 2.12 with a compositing manager enabled, call
+        IsTransparentBackgroundSupported() to check whether this is the case.
+
+        Also, on order for @c SetBackgroundStyle(wxBG_STYLE_TRANSPARENT) to
+        work, it must be called before Create(). If you're using your own
+        wxWindow-derived class you should write your code in the following way:
+        @code
+            class MyWidget : public wxWindow
+            {
+            public:
+                MyWidget(wxWindow* parent, ...)
+                    : wxWindow() // Use default ctor here!
+                {
+                    // Do this first:
+                    SetBackgroundStyle(wxBG_STYLE_TRANSPARENT);
+
+                    // And really create the window afterwards:
+                    Create(parent, ...);
+                }
+            };
+        @endcode
+

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

-             SetTransparent()
+             SetTransparent(), IsTransparentBackgroundSupported()

     */
     virtual bool SetBackgroundStyle(wxBackgroundStyle style);
 
     */
     virtual bool SetBackgroundStyle(wxBackgroundStyle style);
 

+    /**
+        Checks whether using transparent background might work.
+
+        If this function returns @false, calling SetBackgroundStyle() with
+        ::wxBG_STYLE_TRANSPARENT is not going to work. If it returns @true,
+        setting transparent style should normally succeed.
+
+        Notice that this function would typically be called on the parent of a
+        window you want to set transparent background style for as the window
+        for which this method is called must be fully created.
+
+        @param reason
+            If not @NULL, a reason message is provided if transparency is not
+            supported.
+
+        @return @true if background transparency is supported.
+
+        @since 2.9.4
+    */
+    virtual bool IsTransparentBackgroundSupported(wxString *reason = NULL) const;
+

     /**
         Sets the font for this window. This function should not be called for the
         parent window if you don't want its font to be inherited by its children,
     /**
         Sets the font for this window. This function should not be called for the
         parent window if you don't want its font to be inherited by its children,


@@ -1777,6 +1893,13 @@ public:
 
     /**
         Sets the foreground colour of the window.
 
     /**
         Sets the foreground colour of the window.

+
+        The meaning of foreground colour varies according to the window class;
+        it may be the text colour or other colour, or it may not be used at
+        all. Additionally, not all native controls support changing their
+        foreground colour so this method may change their colour only partially
+        or even not at all.
+

         Please see InheritAttributes() for explanation of the difference between
         this method and SetOwnForegroundColour().
 
         Please see InheritAttributes() for explanation of the difference between
         this method and SetOwnForegroundColour().
 


@@ -1784,9 +1907,6 @@ public:
             The colour to be used as the foreground colour; pass
             wxNullColour to reset to the default colour.
 
             The colour to be used as the foreground colour; pass
             wxNullColour to reset to the default colour.
 

-        @remarks The meaning of foreground colour varies according to the window class;
-                 it may be the text colour or other colour, or it may not be used at all.
-

         @return @true if the colour was really changed, @false if it was already set
                 to this colour and nothing was done.
 
         @return @true if the colour was really changed, @false if it was already set
                 to this colour and nothing was done.
 


@@ -1803,6 +1923,18 @@ public:
     */
     void SetOwnBackgroundColour(const wxColour& colour);
 
     */
     void SetOwnBackgroundColour(const wxColour& colour);
 

+    /**
+        Return @true if this window inherits the background colour from its parent.
+
+        @see SetOwnBackgroundColour(), InheritAttributes()
+    */
+    bool InheritsBackgroundColour() const;
+
+    /**
+        Return @true if a background colour has been set for this window.
+    */
+    bool UseBgCol() const;
+

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


@@ -2407,7 +2539,7 @@ public:
 
         @see GetToolTip(), wxToolTip
     */
 
         @see GetToolTip(), wxToolTip
     */

-    void SetToolTip(const wxString& tip);
+    void SetToolTip(const wxString& tipString);

 
     /**
         @overload
 
     /**
         @overload


@@ -2592,6 +2724,14 @@ public:
     */
     virtual wxLayoutDirection GetLayoutDirection() const;
 
     */
     virtual wxLayoutDirection GetLayoutDirection() const;
 

+    /**
+       Mirror coordinates for RTL layout if this window uses it and if the
+       mirroring is not done automatically like Win32.
+    */
+    virtual wxCoord AdjustForLayoutDirection(wxCoord x,
+                                             wxCoord width,
+                                             wxCoord widthTotal) const;
+

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


@@ -2694,6 +2834,8 @@ public:
             @false if the window's close handler should be able to veto the destruction
             of this window, @true if it cannot.
 
             @false if the window's close handler should be able to veto the destruction
             of this window, @true if it cannot.
 

+        @return @true if the event was handled and not vetoed, @false otherwise.
+

         @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
         @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


@@ -3030,7 +3172,7 @@ public:
     /**
         Returns the platform-specific handle of the physical window.
         Cast it to an appropriate handle, such as @b HWND for Windows,
     /**
         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.
+        @b Widget for Motif or @b GtkWidget for GTK.

 
         @beginWxPerlOnly
         This method will return an integer in wxPerl.
 
         @beginWxPerlOnly
         This method will return an integer in wxPerl.


@@ -3087,6 +3229,9 @@ public:
     */
     virtual bool IsDoubleBuffered() const;
 
     */
     virtual bool IsDoubleBuffered() const;
 

+    /**
+       Turn on or off double buffering of the window if the system supports it.
+    */

     void SetDoubleBuffered(bool on);
 
     /**
     void SetDoubleBuffered(bool on);
 
     /**


@@ -3111,17 +3256,6 @@ public:
     */
     virtual bool IsTopLevel() const;
 
     */
     virtual bool IsTopLevel() const;
 

-    /**
-        Disables all other windows in the application so that
-        the user can only interact with this window.
-
-        @param modal
-            If @true, this call disables all other windows in the application so that
-            the user can only interact with this window. If @false, the effect is
-            reversed.
-    */
-    virtual void MakeModal(bool modal = true);
-

     
     /**
         This virtual function is normally only used internally, but
     
     /**
         This virtual function is normally only used internally, but


@@ -3135,6 +3269,12 @@ public:
     */
     virtual void OnInternalIdle();
 
     */
     virtual void OnInternalIdle();
 

+    /**
+       Send idle event to window and all subwindows. Returns true if more idle
+       time is requested.
+    */
+    virtual bool SendIdleEvents(wxIdleEvent& event);
+

     /**
         Registers a system wide hotkey. Every time the user presses the hotkey
         registered here, this window will receive a hotkey event.
     /**
         Registers a system wide hotkey. Every time the user presses the hotkey
         registered here, this window will receive a hotkey event.


@@ -3374,9 +3514,11 @@ protected:
     virtual void DoCentre(int direction);
 
     /**
     virtual void DoCentre(int direction);
 
     /**

-        Gets the size which best suits the window: for a control, it would be
-        the minimal size which doesn't truncate the control, for a panel - the
-        same size as it would have after a call to Fit().
+        Implementation of GetBestSize() that can be overridden.
+
+        Notice that it is usually more convenient to override
+        DoGetBestClientSize() rather than this method itself as you need to
+        explicitly account for the window borders size if you do the latter.

 
         The default implementation of this function is designed for use in container
         windows, such as wxPanel, and works something like this:
 
         The default implementation of this function is designed for use in container
         windows, such as wxPanel, and works something like this:


@@ -3394,11 +3536,65 @@ protected:
     */
     virtual wxSize DoGetBestSize() const;
 
     */
     virtual wxSize DoGetBestSize() const;
 

+    /**
+        Override this method to return the best size for a custom control.
+
+        A typical implementation of this method should compute the minimal size
+        needed to fully display the control contents taking into account the
+        current font size.
+
+        The default implementation simply returns ::wxDefaultSize and
+        GetBestSize() returns an arbitrary hardcoded size for the window, so
+        you must override it when implementing a custom window class.
+
+        @see @ref overview_windowsizing
+
+        @since 2.9.0
+     */
+    virtual wxSize DoGetBestClientSize() const;
+
+    /**
+        Override this method to implement height-for-width best size
+        calculation.
+
+        Return the height needed to fully display the control contents if its
+        width is fixed to the given value. Custom classes implementing
+        wrapping should override this method and return the height
+        corresponding to the number of lines needed to lay out the control
+        contents at this width.
+
+        Currently this method is not used by wxWidgets yet, however it is
+        planned that it will be used by the new sizer classes implementing
+        height-for-width layout strategy in the future.
+
+        Notice that implementing this method or even implementing both it and
+        DoGetBestClientWidth() doesn't replace overriding DoGetBestClientSize(),
+        i.e. you still need to implement the latter as well in order to provide
+        the best size when neither width nor height are constrained.
+
+        By default returns ::wxDefaultCoord meaning that the vertical component
+        of DoGetBestClientSize() return value should be used.
+
+        @since 2.9.4
+     */
+    virtual int DoGetBestClientHeight(int width) const;
+
+    /**
+        Override this method to implement width-for-height best size
+        calculation.
+
+        This method is exactly the same as DoGetBestClientHeight() except that
+        it determines the width assuming the height is fixed instead of vice
+        versa.
+
+        @since 2.9.4
+     */
+    virtual int DoGetBestClientWidth(int height) const;

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

-        @deprecated @todo provide deprecation description
+        @deprecated Use SetInitialSize() instead.

     */
     virtual void SetInitialBestSize(const wxSize& size);
 
     */
     virtual void SetInitialBestSize(const wxSize& size);