deprecated SetToTheWeek() and GetWeek(); added and documented new and well-defined...

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

diff --git a/include/wx/window.h b/include/wx/window.h
index 28ad751f8e5b3c885a7fda387ac08bea87a3e044..825294129642d8cfa7df1b3314cf471ed89d68da 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -5,7 +5,7 @@
 // Modified by: Ron Lee
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Modified by: Ron Lee
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -102,6 +102,10 @@ enum wxWindowVariant
     wxWINDOW_VARIANT_MAX
 };
 
     wxWINDOW_VARIANT_MAX
 };
 

+#if wxUSE_SYSTEM_OPTIONS
+    #define wxWINDOW_DEFAULT_VARIANT wxT("window-default-variant")
+#endif
+

 // ----------------------------------------------------------------------------
 // (pseudo)template list classes
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // (pseudo)template list classes
 // ----------------------------------------------------------------------------


@@ -168,7 +172,7 @@ public:
     // window attributes
     // -----------------
 
     // window attributes
     // -----------------
 

-        // NB: in future versions of wxWindows Set/GetTitle() will only work
+        // NB: in future versions of wxWidgets Set/GetTitle() will only work

         //     with the top level windows (such as dialogs and frames) and
         //     Set/GetLabel() only with the other ones (i.e. all controls).
 
         //     with the top level windows (such as dialogs and frames) and
         //     Set/GetLabel() only with the other ones (i.e. all controls).
 


@@ -193,7 +197,7 @@ public:
 
 
         // window id uniquely identifies the window among its siblings unless
 
 
         // window id uniquely identifies the window among its siblings unless

-        // it is -1 which means "don't care"
+        // it is wxID_ANY which means "don't care"

     void SetId( wxWindowID winid ) { m_windowId = winid; }
     wxWindowID GetId() const { return m_windowId; }
 
     void SetId( wxWindowID winid ) { m_windowId = winid; }
     wxWindowID GetId() const { return m_windowId; }
 


@@ -216,7 +220,7 @@ public:
         {  DoSetSize(x, y, width, height, sizeFlags); }
 
     void SetSize( int width, int height )
         {  DoSetSize(x, y, width, height, sizeFlags); }
 
     void SetSize( int width, int height )

-        { DoSetSize( -1, -1, width, height, wxSIZE_USE_EXISTING ); }
+        { DoSetSize( wxDefaultCoord, wxDefaultCoord, width, height, wxSIZE_USE_EXISTING ); }

 
     void SetSize( const wxSize& size )
         { SetSize( size.x, size.y); }
 
     void SetSize( const wxSize& size )
         { SetSize( size.x, size.y); }


@@ -225,7 +229,7 @@ public:
         { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
 
     void Move(int x, int y, int flags = wxSIZE_USE_EXISTING)
         { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
 
     void Move(int x, int y, int flags = wxSIZE_USE_EXISTING)

-        { DoSetSize(x, y, -1, -1, flags); }
+        { DoSetSize(x, y, wxDefaultCoord, wxDefaultCoord, flags); }

 
     void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING)
         { Move(pt.x, pt.y, flags); }
 
     void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING)
         { Move(pt.x, pt.y, flags); }


@@ -294,17 +298,29 @@ public:
     }
 
         // get the size best suited for the window (in fact, minimal
     }
 
         // get the size best suited for the window (in fact, minimal

-        // acceptable size using which it will still look "nice")
-    wxSize GetBestSize() const { return DoGetBestSize(); }
+        // acceptable size using which it will still look "nice" in
+        // most situations)
+    wxSize GetBestSize() const
+    {
+        if (m_bestSizeCache.IsFullySpecified())
+            return m_bestSizeCache;
+        return DoGetBestSize();
+    }

     void GetBestSize(int *w, int *h) const
     {
     void GetBestSize(int *w, int *h) const
     {

-        wxSize s = DoGetBestSize();
+        wxSize s = GetBestSize();

         if ( w )
             *w = s.x;
         if ( h )
             *h = s.y;
     }
 
         if ( w )
             *w = s.x;
         if ( h )
             *h = s.y;
     }
 

+        // reset the cached best size value so it will be recalculated the
+        // next time it is needed.
+    void InvalidateBestSize() { m_bestSizeCache = wxDefaultSize; }
+    void CacheBestSize(const wxSize& size) const
+        { wxConstCast(this, wxWindowBase)->m_bestSizeCache = size; }
+

         // There are times (and windows) where 'Best' size and 'Min' size
         // are vastly out of sync.  This should be remedied somehow, but in
         // the meantime, this method will return the larger of BestSize
         // There are times (and windows) where 'Best' size and 'Min' size
         // are vastly out of sync.  This should be remedied somehow, but in
         // the meantime, this method will return the larger of BestSize


@@ -312,10 +328,19 @@ public:
         // MinSize hint.
     wxSize GetAdjustedBestSize() const
     {
         // MinSize hint.
     wxSize GetAdjustedBestSize() const
     {

-        wxSize  s( DoGetBestSize() );
+        wxSize  s( GetBestSize() );

         return wxSize( wxMax( s.x, GetMinWidth() ), wxMax( s.y, GetMinHeight() ) );
     }
 
         return wxSize( wxMax( s.x, GetMinWidth() ), wxMax( s.y, GetMinHeight() ) );
     }
 

+        // This function will merge the window's best size into the window's
+        // minimum size, giving priority to the min size components, and
+        // returns the results.
+    wxSize GetBestFittingSize() const;
+
+        // A 'Smart' SetSize that will fill in default size values with 'best'
+        // size.  Sets the minsize to what was passed in.
+    void SetBestFittingSize(const wxSize& size=wxDefaultSize);
+

         // the generic centre function - centers the window on parent by`
         // default or on screen if it doesn't have parent or
         // wxCENTER_ON_SCREEN flag is given
         // the generic centre function - centers the window on parent by`
         // default or on screen if it doesn't have parent or
         // wxCENTER_ON_SCREEN flag is given


@@ -338,8 +363,8 @@ public:
 
         // set min/max size of the window
     virtual void SetSizeHints( int minW, int minH,
 
         // set min/max size of the window
     virtual void SetSizeHints( int minW, int minH,

-                               int maxW = -1, int maxH = -1,
-                               int incW = -1, int incH = -1 );
+                               int maxW = wxDefaultCoord, int maxH = wxDefaultCoord,
+                               int incW = wxDefaultCoord, int incH = wxDefaultCoord );

     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)


@@ -350,7 +375,7 @@ public:
     }
 
     virtual void SetVirtualSizeHints( int minW, int minH,
     }
 
     virtual void SetVirtualSizeHints( int minW, int minH,

-                                      int maxW = -1, int maxH = -1 );
+                                      int maxW = wxDefaultCoord, int maxH = wxDefaultCoord );

     void SetVirtualSizeHints( const wxSize& minSize,
                               const wxSize& maxSize=wxDefaultSize)
     {
     void SetVirtualSizeHints( const wxSize& minSize,
                               const wxSize& maxSize=wxDefaultSize)
     {


@@ -366,6 +391,9 @@ public:
     virtual wxSize GetMaxSize() const { return wxSize( m_maxWidth, m_maxHeight ); }
     virtual wxSize GetMinSize() const { return wxSize( m_minWidth, m_minHeight ); }
 
     virtual wxSize GetMaxSize() const { return wxSize( m_maxWidth, m_maxHeight ); }
     virtual wxSize GetMinSize() const { return wxSize( m_minWidth, m_minHeight ); }
 

+    void SetMinSize(const wxSize& minSize) { SetSizeHints(minSize); }
+    void SetMaxSize(const wxSize& maxSize) { SetSizeHints(GetMinSize(), maxSize); }
+

         // Methods for accessing the virtual size of a window.  For most
         // windows this is just the client area of the window, but for
         // some like scrolled windows it is more or less independent of
         // Methods for accessing the virtual size of a window.  For most
         // windows this is just the client area of the window, but for
         // some like scrolled windows it is more or less independent of


@@ -448,7 +476,7 @@ public:
 
         // Returns true if this class should have the background colour
         // changed to match the parent window's theme.  For example when a
 
         // Returns true if this class should have the background colour
         // changed to match the parent window's theme.  For example when a

-        // page is added to a notebook it and it's children may need to have
+        // page is added to a notebook it and its children may need to have

         // the colours adjusted depending on the current theme settings, but
         // not all windows/controls can do this without looking wrong.
     virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg))
         // the colours adjusted depending on the current theme settings, but
         // not all windows/controls can do this without looking wrong.
     virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg))


@@ -489,6 +517,17 @@ public:
         // set this child as temporary default
     virtual void SetTmpDefaultItem(wxWindow * WXUNUSED(win)) { }
 
         // set this child as temporary default
     virtual void SetTmpDefaultItem(wxWindow * WXUNUSED(win)) { }
 

+        // navigates in the specified direction by sending a wxNavigationKeyEvent
+    virtual bool Navigate(int flags = wxNavigationKeyEvent::IsForward);
+
+        // move this window just before/after the specified one in tab order
+        // (the other window must be our sibling!)
+    void MoveBeforeInTabOrder(wxWindow *win)
+        { DoMoveInTabOrder(win, MoveBefore); }
+    void MoveAfterInTabOrder(wxWindow *win)
+        { DoMoveInTabOrder(win, MoveAfter); }
+
+

     // parent/children relations
     // -------------------------
 
     // parent/children relations
     // -------------------------
 


@@ -506,7 +545,7 @@ public:
         // is this window a top level one?
     virtual bool IsTopLevel() const;
 
         // is this window a top level one?
     virtual bool IsTopLevel() const;
 

-        // it doesn't really change parent, use ReParent() instead
+        // it doesn't really change parent, use Reparent() instead

     void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
         // change the real parent of this window, return true if the parent
         // was changed, false otherwise (error or newParent == oldParent)
     void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
         // change the real parent of this window, return true if the parent
         // was changed, false otherwise (error or newParent == oldParent)


@@ -698,40 +737,43 @@ public:
 
         // set/retrieve the window colours (system defaults are used by
         // default): SetXXX() functions return true if colour was changed,
 
         // set/retrieve the window colours (system defaults are used by
         // default): SetXXX() functions return true if colour was changed,

-        // SetDefaultXXX() reset the "m_hasXXX" flag after setting the value
-        // to prevent it from being inherited by our children
+        // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the
+        // value to prevent it from being inherited by our children

     virtual bool SetBackgroundColour(const wxColour& colour);
     virtual bool SetBackgroundColour(const wxColour& colour);

-    void SetDefaultBackgroundColour(const wxColour& colour)
+    void SetOwnBackgroundColour(const wxColour& colour)

     {
         if ( SetBackgroundColour(colour) )
     {
         if ( SetBackgroundColour(colour) )

-            m_hasBgCol = false;
+            m_inheritBgCol = false;

     }
     wxColour GetBackgroundColour() const;
 
     virtual bool SetForegroundColour(const wxColour& colour);
     }
     wxColour GetBackgroundColour() const;
 
     virtual bool SetForegroundColour(const wxColour& colour);

-    void SetDefaultForegroundColour(const wxColour& colour)
+    void SetOwnForegroundColour(const wxColour& colour)

     {
         if ( SetForegroundColour(colour) )
     {
         if ( SetForegroundColour(colour) )

-            m_hasFgCol = false;
+            m_inheritFgCol = false;

     }
     wxColour GetForegroundColour() const;
 
     }
     wxColour GetForegroundColour() const;
 

+        // Set/get the background style.
+        // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
+    virtual bool SetBackgroundStyle(wxBackgroundStyle style) { m_backgroundStyle = style; return true; }
+    virtual wxBackgroundStyle GetBackgroundStyle() const { return m_backgroundStyle; }
+

         // set/retrieve the font for the window (SetFont() returns true if the
         // font really changed)
     virtual bool SetFont(const wxFont& font) = 0;
         // set/retrieve the font for the window (SetFont() returns true if the
         // font really changed)
     virtual bool SetFont(const wxFont& font) = 0;

-    void SetDefaultFont(const wxFont& font)
+    void SetOwnFont(const wxFont& font)

     {
         if ( SetFont(font) )
     {
         if ( SetFont(font) )

-            m_hasFont = false;
+            m_inheritFont = false;

     }
     }

-    const wxFont& GetFont() const { return DoGetFont(); }
-    wxFont& GetFont() { return DoGetFont(); }
+    wxFont GetFont() const;

 
         // set/retrieve the cursor for this window (SetCursor() returns true
         // if the cursor was really changed)
     virtual bool SetCursor( const wxCursor &cursor );
     const wxCursor& GetCursor() const { return m_cursor; }
 
         // set/retrieve the cursor for this window (SetCursor() returns true
         // if the cursor was really changed)
     virtual bool SetCursor( const wxCursor &cursor );
     const wxCursor& GetCursor() const { return m_cursor; }

-    wxCursor& GetCursor() { return m_cursor; }

 
 #if wxUSE_CARET
         // associate a caret with the window
 
 #if wxUSE_CARET
         // associate a caret with the window


@@ -804,9 +846,9 @@ public:
     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
 
 #if wxUSE_MENUS
     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
 
 #if wxUSE_MENUS

-    bool PopupMenu( wxMenu *menu, const wxPoint& pos )
+    bool PopupMenu(wxMenu *menu, const wxPoint& pos = wxDefaultPosition)

         { return DoPopupMenu(menu, pos.x, pos.y); }
         { return DoPopupMenu(menu, pos.x, pos.y); }

-    bool PopupMenu( wxMenu *menu, int x, int y )
+    bool PopupMenu(wxMenu *menu, int x, int y)

         { return DoPopupMenu(menu, x, y); }
 #endif // wxUSE_MENUS
 
         { return DoPopupMenu(menu, x, y); }
 #endif // wxUSE_MENUS
 


@@ -873,6 +915,10 @@ public:
         // get the associated tooltip or NULL if none
     wxToolTip* GetToolTip() const { return m_tooltip; }
     wxString GetToolTipText() const ;
         // get the associated tooltip or NULL if none
     wxToolTip* GetToolTip() const { return m_tooltip; }
     wxString GetToolTipText() const ;

+#else
+        // make it much easier to compile apps in an environment
+        // that doesn't support tooltips, such as PocketPC
+    inline void SetToolTip( const wxString & WXUNUSED(tip) ) {}

 #endif // wxUSE_TOOLTIPS
 
     // drag and drop
 #endif // wxUSE_TOOLTIPS
 
     // drag and drop


@@ -1006,6 +1052,13 @@ protected:
     virtual bool TryValidator(wxEvent& event);
     virtual bool TryParent(wxEvent& event);
 
     virtual bool TryValidator(wxEvent& event);
     virtual bool TryParent(wxEvent& event);
 

+    // common part of MoveBefore/AfterInTabOrder()
+    enum MoveKind
+    {
+        MoveBefore,     // insert before the given window
+        MoveAfter       // insert after the given window
+    };
+    virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);

 
 #if wxUSE_CONSTRAINTS
     // satisfy the constraints for the windows but don't set the window sizes
 
 #if wxUSE_CONSTRAINTS
     // satisfy the constraints for the windows but don't set the window sizes


@@ -1016,7 +1069,7 @@ protected:
     void SendDestroyEvent();
 
     // the window id - a number which uniquely identifies a window among
     void SendDestroyEvent();
 
     // the window id - a number which uniquely identifies a window among

-    // its siblings unless it is -1
+    // its siblings unless it is wxID_ANY

     wxWindowID           m_windowId;
 
     // the parent window of this window (or NULL) and the list of the children
     wxWindowID           m_windowId;
 
     // the parent window of this window (or NULL) and the list of the children


@@ -1025,7 +1078,7 @@ protected:
     wxWindowList         m_children;
 
     // the minimal allowed size for the window (no minimal size if variable(s)
     wxWindowList         m_children;
 
     // the minimal allowed size for the window (no minimal size if variable(s)

-    // contain(s) -1)
+    // contain(s) wxDefaultCoord)

     int                  m_minWidth,
                          m_minHeight,
                          m_maxWidth,
     int                  m_minWidth,
                          m_minHeight,
                          m_maxWidth,


@@ -1096,12 +1149,17 @@ protected:
     bool                 m_hasFgCol:1;
     bool                 m_hasFont:1;
 
     bool                 m_hasFgCol:1;
     bool                 m_hasFont:1;
 

+    // and should it be inherited by children?
+    bool                 m_inheritBgCol:1;
+    bool                 m_inheritFgCol:1;
+    bool                 m_inheritFont:1;
+

     // window attributes
     long                 m_windowStyle,
                          m_exStyle;
     wxString             m_windowName;
     bool                 m_themeEnabled;
     // window attributes
     long                 m_windowStyle,
                          m_exStyle;
     wxString             m_windowName;
     bool                 m_themeEnabled;

-
+    wxBackgroundStyle    m_backgroundStyle;

 #if wxUSE_PALETTE
     wxPalette            m_palette;
     bool                 m_hasCustomPalette;
 #if wxUSE_PALETTE
     wxPalette            m_palette;
     bool                 m_hasCustomPalette;


@@ -1127,18 +1185,28 @@ protected:
 
     // Get the default size for the new window if no explicit size given. TLWs
     // have their own default size so this is just for non top-level windows.
 
     // Get the default size for the new window if no explicit size given. TLWs
     // have their own default size so this is just for non top-level windows.

-    static int WidthDefault(int w) { return w == -1 ? 20 : w; }
-    static int HeightDefault(int h) { return h == -1 ? 20 : h; }
+    static int WidthDefault(int w) { return w == wxDefaultCoord ? 20 : w; }
+    static int HeightDefault(int h) { return h == wxDefaultCoord ? 20 : h; }
+
+
+    // Used to save the results of DoGetBestSize so it doesn't need to be
+    // recalculated each time the value is needed.
+    wxSize m_bestSizeCache;

 
 

-    // set the best size for the control if the default size was given:
-    // replaces the fields of size == -1 with the best values for them and
-    // calls SetSize() if needed
+    // keep the old name for compatibility, at least until all the internal
+    // usages of it are changed to SetBestFittingSize
+    void SetBestSize(const wxSize& size) { SetBestFittingSize(size); }
+
+    // set the initial window size if none is given (i.e. at least one of the
+    // components of the size passed to ctor/Create() is -1)

     //
     //

-    // This function is rather unfortunately named..  it's really just a
-    // smarter SetSize / convenience function for expanding wxDefaultSize.
-    // Note that it does not influence the value returned by GetBestSize
-    // at all.
-    void SetBestSize(const wxSize& size);
+    // normally just calls SetBestSize() for controls, but can be overridden
+    // not to do it for the controls which have to do some additional
+    // initialization (e.g. add strings to list box) before their best size
+    // can be accurately calculated
+    virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) {}
+
+

 
     // more pure virtual functions
     // ---------------------------
 
     // more pure virtual functions
     // ---------------------------


@@ -1193,7 +1261,7 @@ protected:
 #endif // wxUSE_TOOLTIPS
 
 #if wxUSE_MENUS
 #endif // wxUSE_TOOLTIPS
 
 #if wxUSE_MENUS

-    virtual bool DoPopupMenu( wxMenu *menu, int x, int y ) = 0;
+    virtual bool DoPopupMenu(wxMenu *menu, int x, int y) = 0;

 #endif // wxUSE_MENUS
 
     // Makes an adjustment to the window position to make it relative to the
 #endif // wxUSE_MENUS
 
     // Makes an adjustment to the window position to make it relative to the


@@ -1212,10 +1280,6 @@ private:
     // the stack of windows which have captured the mouse
     static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext;
 
     // the stack of windows which have captured the mouse
     static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext;
 

-    // implementation of both const and non-const versions of GetFont()
-    wxFont& DoGetFont() const;
-
-

     DECLARE_ABSTRACT_CLASS(wxWindowBase)
     DECLARE_NO_COPY_CLASS(wxWindowBase)
     DECLARE_EVENT_TABLE()
     DECLARE_ABSTRACT_CLASS(wxWindowBase)
     DECLARE_NO_COPY_CLASS(wxWindowBase)
     DECLARE_EVENT_TABLE()