renamed Render's argument to not obfuscate its meaning

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

diff --git a/include/wx/window.h b/include/wx/window.h
index 596dadc0a406b9103fd4296adbb47a1adb6f9412..db5205b6a71aee14afca970f17497fc1256a7b13 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -5,14 +5,14 @@
 // 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
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_WINDOW_H_BASE_
 #define _WX_WINDOW_H_BASE_
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_WINDOW_H_BASE_
 #define _WX_WINDOW_H_BASE_
 

-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "windowbase.h"
 #endif
 
     #pragma interface "windowbase.h"
 #endif
 


@@ -73,6 +73,39 @@ class WXDLLEXPORT wxWindow;
 class WXDLLEXPORT wxAccessible;
 #endif
 
 class WXDLLEXPORT wxAccessible;
 #endif
 

+// ----------------------------------------------------------------------------
+// helper stuff used by wxWindow
+// ----------------------------------------------------------------------------
+
+// struct containing all the visual attributes of a control
+struct WXDLLEXPORT wxVisualAttributes
+{
+    // the font used for control label/text inside it
+    wxFont font;
+
+    // the foreground colour
+    wxColour colFg;
+
+    // the background colour, may be wxNullColour if the controls background
+    // colour is not solid
+    wxColour colBg;
+};
+
+// different window variants, on platforms like eg mac uses different
+// rendering sizes
+enum wxWindowVariant
+{
+    wxWINDOW_VARIANT_NORMAL,  // Normal size
+    wxWINDOW_VARIANT_SMALL,   // Smaller size (about 25 % smaller than normal)
+    wxWINDOW_VARIANT_MINI,    // Mini size (about 33 % smaller than normal)
+    wxWINDOW_VARIANT_LARGE,   // Large size (about 25 % larger than normal)
+    wxWINDOW_VARIANT_MAX
+};
+
+#if wxUSE_SYSTEM_OPTIONS
+    #define wxWINDOW_DEFAULT_VARIANT wxT("window-default-variant")
+#endif
+

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


@@ -102,8 +135,9 @@ public:
     // creating the window
     // -------------------
 
     // creating the window
     // -------------------
 

-        // default ctor
-    wxWindowBase() { InitBase(); }
+        // default ctor, initializes everything which can be initialized before
+        // Create()
+    wxWindowBase() ;

 
         // pseudo ctor (can't be virtual, called from ctor)
     bool CreateBase(wxWindowBase *parent,
 
         // pseudo ctor (can't be virtual, called from ctor)
     bool CreateBase(wxWindowBase *parent,


@@ -119,17 +153,17 @@ public:
     // deleting the window
     // -------------------
 
     // deleting the window
     // -------------------
 

-        // ask the window to close itself, return TRUE if the event handler
+        // ask the window to close itself, return true if the event handler

         // honoured our request
         // honoured our request

-    bool Close( bool force = FALSE );
+    bool Close( bool force = false );

 
         // the following functions delete the C++ objects (the window itself
         // or its children) as well as the GUI windows and normally should
         // never be used directly
 
 
         // the following functions delete the C++ objects (the window itself
         // or its children) as well as the GUI windows and normally should
         // never be used directly
 

-        // delete window unconditionally (dangerous!), returns TRUE if ok
+        // delete window unconditionally (dangerous!), returns true if ok

     virtual bool Destroy();
     virtual bool Destroy();

-        // delete all children of this window, returns TRUE if ok
+        // delete all children of this window, returns true if ok

     bool DestroyChildren();
 
         // is the window being deleted?
     bool DestroyChildren();
 
         // is the window being deleted?


@@ -138,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).
 


@@ -157,8 +191,13 @@ public:
     virtual void SetName( const wxString &name ) { m_windowName = name; }
     virtual wxString GetName() const { return m_windowName; }
 
     virtual void SetName( const wxString &name ) { m_windowName = name; }
     virtual wxString GetName() const { return m_windowName; }
 

+    // sets the window variant, calls internally DoSetVariant if variant has changed
+    void SetWindowVariant( wxWindowVariant variant ) ;
+    wxWindowVariant GetWindowVariant() const { return m_windowVariant ; }
+
+

         // 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; }
 


@@ -181,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); }


@@ -190,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); }


@@ -219,6 +258,8 @@ public:
         return wxPoint(w, h);
     }
 
         return wxPoint(w, h);
     }
 

+    void SetPosition( const wxPoint& pt ) { Move( pt ) ; }
+

     void GetSize( int *w, int *h ) const { DoGetSize(w, h); }
     wxSize GetSize() const
     {
     void GetSize( int *w, int *h ) const { DoGetSize(w, h); }
     wxSize GetSize() const
     {


@@ -257,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();
+    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


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


@@ -301,11 +363,32 @@ 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 )
+    {
+        DoSetSizeHints(minW, minH, maxW, maxH, incW, incH);
+    }
+
+    void SetSizeHints( const wxSize& minSize,
+                       const wxSize& maxSize=wxDefaultSize,
+                       const wxSize& incSize=wxDefaultSize)
+    {
+        DoSetSizeHints(minSize.x, minSize.y,
+                       maxSize.x, maxSize.y,
+                       incSize.x, incSize.y);
+    }
+
+    virtual void DoSetSizeHints(int minW, int minH,
+                                int maxW = wxDefaultCoord, int maxH = wxDefaultCoord,
+                               int incW = wxDefaultCoord, int incH = wxDefaultCoord );

 
     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)
+    {
+        SetVirtualSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y);
+    }

 
     virtual int GetMinWidth() const { return m_minWidth; }
     virtual int GetMinHeight() const { return m_minHeight; }
 
     virtual int GetMinWidth() const { return m_minWidth; }
     virtual int GetMinHeight() const { return m_minHeight; }


@@ -314,6 +397,10 @@ public:
 
         // Override this method to control the values given to Sizers etc.
     virtual wxSize GetMaxSize() const { return wxSize( m_maxWidth, m_maxHeight ); }
 
         // Override this method to control the values given to Sizers etc.
     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
 
         // Methods for accessing the virtual size of a window.  For most
         // windows this is just the client area of the window, but for


@@ -356,14 +443,14 @@ public:
     // window state
     // ------------
 
     // window state
     // ------------
 

-        // returns TRUE if window was shown/hidden, FALSE if the nothing was
+        // returns true if window was shown/hidden, false if the nothing was

         // done (window was already shown/hidden)
         // done (window was already shown/hidden)

-    virtual bool Show( bool show = TRUE );
-    bool Hide() { return Show(FALSE); }
+    virtual bool Show( bool show = true );
+    bool Hide() { return Show(false); }

 
 

-        // returns TRUE if window was enabled/disabled, FALSE if nothing done
-    virtual bool Enable( bool enable = TRUE );
-    bool Disable() { return Enable(FALSE); }
+        // returns true if window was enabled/disabled, false if nothing done
+    virtual bool Enable( bool enable = true );
+    bool Disable() { return Enable(false); }

 
     bool IsShown() const { return m_isShown; }
     bool IsEnabled() const { return m_isEnabled; }
 
     bool IsShown() const { return m_isShown; }
     bool IsEnabled() const { return m_isEnabled; }


@@ -386,11 +473,24 @@ public:
     long GetExtraStyle() const { return m_exStyle; }
 
         // make the window modal (all other windows unresponsive)
     long GetExtraStyle() const { return m_exStyle; }
 
         // make the window modal (all other windows unresponsive)

-    virtual void MakeModal(bool modal = TRUE);
+    virtual void MakeModal(bool modal = true);
+
+
+    // (primitive) theming support
+    // ---------------------------

 
     virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; }
     virtual bool GetThemeEnabled() const { return m_themeEnabled; }
 
 
     virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; }
     virtual bool GetThemeEnabled() const { return m_themeEnabled; }
 

+        // 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 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))
+        { /* do nothing */ }
+
+

     // focus and keyboard handling
     // ---------------------------
 
     // focus and keyboard handling
     // ---------------------------
 


@@ -401,7 +501,9 @@ public:
     virtual void SetFocusFromKbd() { SetFocus(); }
 
         // return the window which currently has the focus or NULL
     virtual void SetFocusFromKbd() { SetFocus(); }
 
         // return the window which currently has the focus or NULL

-    static wxWindow *FindFocus() /* = 0: implement in derived classes */;
+    static wxWindow *FindFocus();
+
+    static wxWindow *DoFindFocus() /* = 0: implement in derived classes */;

 
         // can this window have focus?
     virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
 
         // can this window have focus?
     virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }


@@ -425,6 +527,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
     // -------------------------
 


@@ -432,6 +545,9 @@ public:
     const wxWindowList& GetChildren() const { return m_children; }
     wxWindowList& GetChildren() { return m_children; }
 
     const wxWindowList& GetChildren() const { return m_children; }
     wxWindowList& GetChildren() { return m_children; }
 

+    // needed just for extended runtime
+    const wxWindowList& GetWindowChildren() const { return GetChildren() ; }
+

         // get the parent or the parent of the parent
     wxWindow *GetParent() const { return m_parent; }
     inline wxWindow *GetGrandParent() const;
         // get the parent or the parent of the parent
     wxWindow *GetParent() const { return m_parent; }
     inline wxWindow *GetGrandParent() const;


@@ -439,10 +555,10 @@ 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; }
     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)
+        // change the real parent of this window, return true if the parent
+        // was changed, false otherwise (error or newParent == oldParent)

     virtual bool Reparent( wxWindowBase *newParent );
 
         // implementation mostly
     virtual bool Reparent( wxWindowBase *newParent );
 
         // implementation mostly


@@ -477,11 +593,11 @@ public:
         // push/pop event handler: allows to chain a custom event handler to
         // alreasy existing ones
     void PushEventHandler( wxEvtHandler *handler );
         // push/pop event handler: allows to chain a custom event handler to
         // alreasy existing ones
     void PushEventHandler( wxEvtHandler *handler );

-    wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
+    wxEvtHandler *PopEventHandler( bool deleteHandler = false );

 
         // find the given handler in the event handler chain and remove (but
 
         // find the given handler in the event handler chain and remove (but

-        // not delete) it from the event handler chain, return TRUE if it was
-        // found and FALSE otherwise (this also results in an assert failure so
+        // not delete) it from the event handler chain, return true if it was
+        // found and false otherwise (this also results in an assert failure so

         // this function should only be called when the handler is supposed to
         // be there)
     bool RemoveEventHandler(wxEvtHandler *handler);
         // this function should only be called when the handler is supposed to
         // be there)
     bool RemoveEventHandler(wxEvtHandler *handler);


@@ -500,7 +616,7 @@ public:
     // dialog oriented functions
     // -------------------------
 
     // dialog oriented functions
     // -------------------------
 

-        // validate the correctness of input, return TRUE if ok
+        // validate the correctness of input, return true if ok

     virtual bool Validate();
 
         // transfer data between internal and GUI representations
     virtual bool Validate();
 
         // transfer data between internal and GUI representations


@@ -572,17 +688,17 @@ public:
 
         // mark the specified rectangle (or the whole window) as "dirty" so it
         // will be repainted
 
         // mark the specified rectangle (or the whole window) as "dirty" so it
         // will be repainted

-    virtual void Refresh( bool eraseBackground = TRUE,
+    virtual void Refresh( bool eraseBackground = true,

                           const wxRect *rect = (const wxRect *) NULL ) = 0;
 
         // a less awkward wrapper for Refresh
                           const wxRect *rect = (const wxRect *) NULL ) = 0;
 
         // a less awkward wrapper for Refresh

-    void RefreshRect(const wxRect& rect) { Refresh(TRUE, &rect); }
+    void RefreshRect(const wxRect& rect) { Refresh(true, &rect); }

 
         // repaint all invalid areas of the window immediately
     virtual void Update() { }
 
 
         // repaint all invalid areas of the window immediately
     virtual void Update() { }
 

-        // clear the window entirely
-    virtual void Clear() = 0;
+        // clear the window background
+    virtual void ClearBackground();

 
         // freeze the window: don't redraw it until it is thawed
     virtual void Freeze() { }
 
         // freeze the window: don't redraw it until it is thawed
     virtual void Freeze() { }


@@ -614,25 +730,60 @@ public:
     // colours, fonts and cursors
     // --------------------------
 
     // colours, fonts and cursors
     // --------------------------
 

+        // get the default attributes for the controls of this class: we
+        // provide a virtual function which can be used to query the default
+        // attributes of an existing control and a static function which can
+        // be used even when no existing object of the given class is
+        // available, but which won't return any styles specific to this
+        // particular control, of course (e.g. "Ok" button might have
+        // different -- bold for example -- font)
+    virtual wxVisualAttributes GetDefaultAttributes() const
+    {
+        return GetClassDefaultAttributes(GetWindowVariant());
+    }
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+

         // set/retrieve the window colours (system defaults are used by
         // set/retrieve the window colours (system defaults are used by

-        // default): Set functions return TRUE if colour was changed
-    virtual bool SetBackgroundColour( const wxColour &colour );
-    virtual bool SetForegroundColour( const wxColour &colour );
+        // default): SetXXX() functions return true if colour was changed,
+        // 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);
+    void SetOwnBackgroundColour(const wxColour& colour)
+    {
+        if ( SetBackgroundColour(colour) )
+            m_inheritBgCol = false;
+    }
+    wxColour GetBackgroundColour() const;

 
 

-    wxColour GetBackgroundColour() const { return m_backgroundColour; }
-    wxColour GetForegroundColour() const { return m_foregroundColour; }
+    virtual bool SetForegroundColour(const wxColour& colour);
+    void SetOwnForegroundColour(const wxColour& colour)
+    {
+        if ( SetForegroundColour(colour) )
+            m_inheritFgCol = false;
+    }
+    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;
+    void SetOwnFont(const wxFont& font)
+    {
+        if ( SetFont(font) )
+            m_inheritFont = false;
+    }
+    wxFont GetFont() const;

 
 

-        // set/retrieve the cursor for this window (SetCursor() returns TRUE
+        // 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; }
         // if the cursor was really changed)
     virtual bool SetCursor( const wxCursor &cursor );
     const wxCursor& GetCursor() const { return m_cursor; }

-    wxCursor& GetCursor() { return m_cursor; }
-
-        // set/retrieve the font for the window (SetFont() returns TRUE if the
-        // font really changed)
-    virtual bool SetFont( const wxFont &font ) = 0;
-    const wxFont& GetFont() const { return m_font; }
-    wxFont& GetFont() { return m_font; }

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


@@ -698,16 +849,16 @@ public:
     // get border for the flags of this window
     wxBorder GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
 
     // get border for the flags of this window
     wxBorder GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
 

-    // send wxUpdateUIEvents to this window, and children if recurse is TRUE
+    // send wxUpdateUIEvents to this window, and children if recurse is true

     virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
 
     // do the window-specific processing after processing the update event
     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
 
 #if wxUSE_MENUS
     virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
 
     // do the window-specific processing after processing the update event
     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
 


@@ -726,8 +877,8 @@ public:
                                int pos,
                                int thumbvisible,
                                int range,
                                int pos,
                                int thumbvisible,
                                int range,

-                               bool refresh = TRUE ) = 0;
-    virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ) = 0;
+                               bool refresh = true ) = 0;
+    virtual void SetScrollPos( int orient, int pos, bool refresh = true ) = 0;

     virtual int GetScrollPos( int orient ) const = 0;
     virtual int GetScrollThumb( int orient ) const = 0;
     virtual int GetScrollRange( int orient ) const = 0;
     virtual int GetScrollPos( int orient ) const = 0;
     virtual int GetScrollThumb( int orient ) const = 0;
     virtual int GetScrollRange( int orient ) const = 0;


@@ -738,9 +889,9 @@ public:
 
         // scrolls window by line/page: note that not all controls support this
         //
 
         // scrolls window by line/page: note that not all controls support this
         //

-        // return TRUE if the position changed, FALSE otherwise
-    virtual bool ScrollLines(int WXUNUSED(lines)) { return FALSE; }
-    virtual bool ScrollPages(int WXUNUSED(pages)) { return FALSE; }
+        // return true if the position changed, false otherwise
+    virtual bool ScrollLines(int WXUNUSED(lines)) { return false; }
+    virtual bool ScrollPages(int WXUNUSED(pages)) { return false; }

 
         // convenient wrappers for ScrollLines/Pages
     bool LineUp() { return ScrollLines(-1); }
 
         // convenient wrappers for ScrollLines/Pages
     bool LineUp() { return ScrollLines(-1); }


@@ -773,6 +924,11 @@ public:
     void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); }
         // get the associated tooltip or NULL if none
     wxToolTip* GetToolTip() const { return m_tooltip; }
     void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); }
         // 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


@@ -801,7 +957,7 @@ public:
     void ResetConstraints();
 
         // these methods may be overriden for special layout algorithms
     void ResetConstraints();
 
         // these methods may be overriden for special layout algorithms

-    virtual void SetConstraintSizes(bool recurse = TRUE);
+    virtual void SetConstraintSizes(bool recurse = true);

     virtual bool LayoutPhase1(int *noChanges);
     virtual bool LayoutPhase2(int *noChanges);
     virtual bool DoPhase(int phase);
     virtual bool LayoutPhase1(int *noChanges);
     virtual bool LayoutPhase2(int *noChanges);
     virtual bool DoPhase(int phase);


@@ -825,23 +981,13 @@ public:
     virtual bool Layout();
 
         // sizers
     virtual bool Layout();
 
         // sizers

-    void SetSizer(wxSizer *sizer, bool deleteOld = TRUE );
-    void SetSizerAndFit( wxSizer *sizer, bool deleteOld = TRUE );
+    void SetSizer(wxSizer *sizer, bool deleteOld = true );
+    void SetSizerAndFit( wxSizer *sizer, bool deleteOld = true );

 
     wxSizer *GetSizer() const { return m_windowSizer; }
 
     // Track if this window is a member of a sizer
 
     wxSizer *GetSizer() const { return m_windowSizer; }
 
     // Track if this window is a member of a sizer

-    void SetContainingSizer(wxSizer* sizer)
-    {
-        // adding a window to a sizer twice is going to result in fatal and
-        // hard to debug problems later because when deleting the second
-        // associated wxSizerItem we're going to dereference a dangling
-        // pointer; so try to detect this as early as possible
-        wxASSERT_MSG( !sizer || m_containingSizer != sizer,
-                        _T("Adding a window to the same sizer twice?") );
-
-        m_containingSizer = sizer;
-    }
+    void SetContainingSizer(wxSizer* sizer);

     wxSizer *GetContainingSizer() const { return m_containingSizer; }
 
     // accessibility
     wxSizer *GetContainingSizer() const { return m_containingSizer; }
 
     // accessibility


@@ -860,17 +1006,6 @@ public:
     wxAccessible* GetOrCreateAccessible() ;
 #endif
 
     wxAccessible* GetOrCreateAccessible() ;
 #endif
 

-    // backward compatibility
-    // ----------------------
-#if WXWIN_COMPATIBILITY
-    bool Enabled() const { return IsEnabled(); }
-
-    void SetButtonFont(const wxFont& font) { SetFont(font); }
-    void SetLabelFont(const wxFont& font) { SetFont(font); }
-    wxFont& GetLabelFont() { return GetFont(); };
-    wxFont& GetButtonFont() { return GetFont(); };
-#endif // WXWIN_COMPATIBILITY
-

     // implementation
     // --------------
 
     // implementation
     // --------------
 


@@ -893,6 +1028,10 @@ public:
         // is only used for wxWin itself or for user code which wants to call
         // platform-specific APIs
     virtual WXWidget GetHandle() const = 0;
         // is only used for wxWin itself or for user code which wants to call
         // platform-specific APIs
     virtual WXWidget GetHandle() const = 0;

+        // associate the window with a new native handle
+    virtual void AssociateHandle(WXWidget WXUNUSED(handle)) { }
+        // dissociate the current native handle from the window
+    virtual void DissociateHandle() { }

 
 #if wxUSE_PALETTE
         // Store the palette used by DCs in wxWindow so that the dcs can share
 
 #if wxUSE_PALETTE
         // Store the palette used by DCs in wxWindow so that the dcs can share


@@ -910,13 +1049,30 @@ public:
     wxWindow *GetAncestorWithCustomPalette() const;
 #endif // wxUSE_PALETTE
 
     wxWindow *GetAncestorWithCustomPalette() const;
 #endif // wxUSE_PALETTE
 

+    // inherit the parents visual attributes if they had been explicitly set
+    // by the user (i.e. we don't inherit default attributes) and if we don't
+    // have our own explicitly set
+    virtual void InheritAttributes();
+
+    // returns false from here if this window doesn't want to inherit the
+    // parents colours even if InheritAttributes() would normally do it
+    //
+    // this just provides a simple way to customize InheritAttributes()
+    // behaviour in the most common case
+    virtual bool ShouldInheritColours() const { return false; }
+

 protected:
     // event handling specific to wxWindow
 protected:
     // event handling specific to wxWindow

-#if wxUSE_VALIDATORS

     virtual bool TryValidator(wxEvent& event);
     virtual bool TryValidator(wxEvent& event);

-#endif // wxUSE_VALIDATORS

     virtual bool TryParent(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


@@ -926,8 +1082,14 @@ protected:
     // Send the wxWindowDestroyEvent
     void SendDestroyEvent();
 
     // Send the wxWindowDestroyEvent
     void SendDestroyEvent();
 

+    // returns the main window of composite control; this is the window
+    // that FindFocus returns if the focus is in one of composite control's
+    // windows
+    virtual wxWindow *GetMainWindowOfCompositeControl()
+        { return (wxWindow*)this; }
+

     // the window id - a number which uniquely identifies a window among
     // 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


@@ -936,7 +1098,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,


@@ -957,8 +1119,9 @@ protected:
 
     // visual window attributes
     wxCursor             m_cursor;
 
     // visual window attributes
     wxCursor             m_cursor;

-    wxFont               m_font;
-    wxColour             m_backgroundColour, m_foregroundColour;
+    wxFont               m_font;                // see m_hasFont
+    wxColour             m_backgroundColour,    //     m_hasBgCol
+                         m_foregroundColour;    //     m_hasFgCol

 
 #if wxUSE_CARET
     wxCaret             *m_caret;
 
 #if wxUSE_CARET
     wxCaret             *m_caret;


@@ -1006,12 +1169,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;


@@ -1020,6 +1188,7 @@ protected:
 #if wxUSE_ACCESSIBILITY
     wxAccessible*       m_accessible;
 #endif
 #if wxUSE_ACCESSIBILITY
     wxAccessible*       m_accessible;
 #endif

+

     // Virtual size (scrolling)
     wxSize                m_virtualSize;
 
     // Virtual size (scrolling)
     wxSize                m_virtualSize;
 


@@ -1028,43 +1197,36 @@ protected:
     int                   m_maxVirtualWidth;
     int                   m_maxVirtualHeight;
 
     int                   m_maxVirtualWidth;
     int                   m_maxVirtualHeight;
 

-    // common part of all ctors: it is not virtual because it is called from
-    // ctor
-    void InitBase();
+    wxWindowVariant       m_windowVariant ;

 
     // override this to change the default (i.e. used when no style is
     // specified) border for the window class
     virtual wxBorder GetDefaultBorder() const;
 
 
     // override this to change the default (i.e. used when no style is
     // specified) border for the window class
     virtual wxBorder GetDefaultBorder() const;
 

-    // get the default size for the new window if no explicit size given
-    // FIXME why 20 and not 30, 10 or ...?
-    static int WidthDefault(int w) { return w == -1 ? 20 : w; }
-    static int HeightDefault(int h) { return h == -1 ? 20 : h; }
+    // 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 == wxDefaultCoord ? 20 : w; }
+    static int HeightDefault(int h) { return h == wxDefaultCoord ? 20 : h; }
+

 
 

-    // 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
+    // Used to save the results of DoGetBestSize so it doesn't need to be
+    // recalculated each time the value is needed.
+    wxSize m_bestSizeCache;
+
+    // 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 wxDefaultCoord)

     //
     //

-    // 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)
-    {
-        // the size only needs to be changed if the current size is incomplete,
-        // i.e. one of the components was specified as default -- so if both
-        // were given, simply don't do anything
-        if ( size.x == -1 || size.y == -1 )
-        {
-            wxSize sizeBest = DoGetBestSize();
-            if ( size.x != -1 )
-                sizeBest.x = size.x;
-            if ( size.y != -1 )
-                sizeBest.y = size.y;
-
-            SetSize(sizeBest);
-        }
-    }
+    // 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
     // ---------------------------


@@ -1119,16 +1281,19 @@ 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
 
 #endif // wxUSE_MENUS
 

-    // Makes an adjustment to the window position (for example, a frame that has
-    // a toolbar that it manages itself).
-    virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags) const;
+    // Makes an adjustment to the window position to make it relative to the
+    // parents client area, e.g. if the parent is a frame with a toolbar, its
+    // (0, 0) is just below the toolbar
+    virtual void AdjustForParentClientOrigin(int& x, int& y,
+                                             int sizeFlags = 0) const;

 
 

+    // implements the window variants
+    virtual void DoSetWindowVariant( wxWindowVariant variant ) ;

 
 private:
 
 private:

-

     // contains the last id generated by NewControlId
     static int ms_lastControlId;
 
     // contains the last id generated by NewControlId
     static int ms_lastControlId;
 


@@ -1145,15 +1310,18 @@ private:
 // ----------------------------------------------------------------------------
 
 // include the declaration of the platform-specific class
 // ----------------------------------------------------------------------------
 
 // include the declaration of the platform-specific class

-#if defined(__WXMSW__)
+#if defined(__PALMOS__)
+    #ifdef __WXUNIVERSAL__
+        #define wxWindowNative wxWindowPalm
+    #else // !wxUniv
+        #define wxWindowPalm wxWindow
+    #endif // wxUniv/!wxUniv
+    #include "wx/palmos/window.h"
+#elif defined(__WXMSW__)

     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowMSW
     #else // !wxUniv
         #define wxWindowMSW wxWindow
     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowMSW
     #else // !wxUniv
         #define wxWindowMSW wxWindow

-        #define sm_classwxWindowMSW sm_classwxWindow
-        #define sm_constructorPropertiesCountwxWindowMSW sm_constructorPropertiesCountwxWindow
-        #define sm_constructorPropertieswxWindowMSW sm_constructorPropertieswxWindow
-        #define sm_constructorwxWindowMSW sm_constructorwxWindow

     #endif // wxUniv/!wxUniv
     #include "wx/msw/window.h"
 #elif defined(__WXMOTIF__)
     #endif // wxUniv/!wxUniv
     #include "wx/msw/window.h"
 #elif defined(__WXMOTIF__)


@@ -1163,7 +1331,6 @@ private:
         #define wxWindowNative wxWindowGTK
     #else // !wxUniv
         #define wxWindowGTK wxWindow
         #define wxWindowNative wxWindowGTK
     #else // !wxUniv
         #define wxWindowGTK wxWindow

-        #define sm_classwxWindowGTK sm_classwxWindow

     #endif // wxUniv
     #include "wx/gtk/window.h"
 #elif defined(__WXX11__)
     #endif // wxUniv
     #include "wx/gtk/window.h"
 #elif defined(__WXX11__)


@@ -1171,7 +1338,6 @@ private:
         #define wxWindowNative wxWindowX11
     #else // !wxUniv
         #define wxWindowX11 wxWindow
         #define wxWindowNative wxWindowX11
     #else // !wxUniv
         #define wxWindowX11 wxWindow

-        #define sm_classwxWindowX11 sm_classwxWindow

     #endif // wxUniv
     #include "wx/x11/window.h"
 #elif defined(__WXMGL__)
     #endif // wxUniv
     #include "wx/x11/window.h"
 #elif defined(__WXMGL__)


@@ -1179,7 +1345,6 @@ private:
         #define wxWindowNative wxWindowMGL
     #else // !wxUniv
         #define wxWindowMGL wxWindow
         #define wxWindowNative wxWindowMGL
     #else // !wxUniv
         #define wxWindowMGL wxWindow

-        #define sm_classwxWindowMGL sm_classwxWindow

     #endif // wxUniv
     #include "wx/mgl/window.h"
 #elif defined(__WXMAC__)
     #endif // wxUniv
     #include "wx/mgl/window.h"
 #elif defined(__WXMAC__)


@@ -1187,7 +1352,6 @@ private:
         #define wxWindowNative wxWindowMac
     #else // !wxUniv
         #define wxWindowMac wxWindow
         #define wxWindowNative wxWindowMac
     #else // !wxUniv
         #define wxWindowMac wxWindow

-        #define sm_classwxWindowMac sm_classwxWindow

     #endif // wxUniv
     #include "wx/mac/window.h"
 #elif defined(__WXCOCOA__)
     #endif // wxUniv
     #include "wx/mac/window.h"
 #elif defined(__WXCOCOA__)


@@ -1195,7 +1359,6 @@ private:
         #define wxWindowNative wxWindowCocoa
     #else // !wxUniv
         #define wxWindowCocoa wxWindow
         #define wxWindowNative wxWindowCocoa
     #else // !wxUniv
         #define wxWindowCocoa wxWindow

-        #define sm_classwxWindowCocoa sm_classwxWindow

     #endif // wxUniv
     #include "wx/cocoa/window.h"
 #elif defined(__WXPM__)
     #endif // wxUniv
     #include "wx/cocoa/window.h"
 #elif defined(__WXPM__)


@@ -1203,7 +1366,6 @@ private:
         #define wxWindowNative wxWindowOS2
     #else // !wxUniv
         #define wxWindowOS2 wxWindow
         #define wxWindowNative wxWindowOS2
     #else // !wxUniv
         #define wxWindowOS2 wxWindow

-        #define sm_classwxWindowOS2 sm_classwxWindow

     #endif // wxUniv/!wxUniv
     #include "wx/os2/window.h"
 #endif
     #endif // wxUniv/!wxUniv
     #include "wx/os2/window.h"
 #endif


@@ -1257,7 +1419,7 @@ class WXDLLEXPORT wxWindowAccessible: public wxAccessible
 {
 public:
     wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); }
 {
 public:
     wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); }

-    virtual ~wxWindowAccessible() {};
+    virtual ~wxWindowAccessible() {}

 
 // Overridables
 
 
 // Overridables
 


@@ -1333,7 +1495,7 @@ public:
         // Gets a variant representing the selected children
         // of this object.
         // Acceptable values:
         // Gets a variant representing the selected children
         // of this object.
         // Acceptable values:

-        // - a null variant (IsNull() returns TRUE)
+        // - a null variant (IsNull() returns true)

         // - a list variant (GetType() == wxT("list")
         // - an integer representing the selected child element,
         //   or 0 if this object is selected (GetType() == wxT("long")
         // - a list variant (GetType() == wxT("list")
         // - an integer representing the selected child element,
         //   or 0 if this object is selected (GetType() == wxT("long")