]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/window.h
Change SetStringSelection to return bool like in other classes and ports
[wxWidgets.git] / include / wx / window.h
index 1b7071d6264ab10acb7cec7cca3970463cc4b424..d081cd409c55261c41a1f7dfe8642dc549d80737 100644 (file)
@@ -2,7 +2,7 @@
 // Name:        wx/window.h
 // Purpose:     wxWindowBase class - the interface of wxWindow
 // Author:      Vadim Zeitlin
 // Name:        wx/window.h
 // Purpose:     wxWindowBase class - the interface of wxWindow
 // Author:      Vadim Zeitlin
-// Modified by:
+// Modified by: Ron Lee
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWindows team
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWindows team
@@ -12,7 +12,7 @@
 #ifndef _WX_WINDOW_H_BASE_
 #define _WX_WINDOW_H_BASE_
 
 #ifndef _WX_WINDOW_H_BASE_
 #define _WX_WINDOW_H_BASE_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "windowbase.h"
 #endif
 
     #pragma interface "windowbase.h"
 #endif
 
 #include "wx/validate.h"        // for wxDefaultValidator (always include it)
 
 #if wxUSE_PALETTE
 #include "wx/validate.h"        // for wxDefaultValidator (always include it)
 
 #if wxUSE_PALETTE
-       #include "wx/dcclient.h"
-       #include "wx/palette.h"
+    #include "wx/palette.h"
 #endif // wxUSE_PALETTE
 
 #if wxUSE_ACCEL
     #include "wx/accel.h"
 #endif // wxUSE_ACCEL
 
 #endif // wxUSE_PALETTE
 
 #if wxUSE_ACCEL
     #include "wx/accel.h"
 #endif // wxUSE_ACCEL
 
+#if wxUSE_ACCESSIBILITY
+#include "wx/access.h"
+#endif
+
 // when building wxUniv/Foo we don't want the code for native menu use to be
 // compiled in - it should only be used when building real wxFoo
 #ifdef __WXUNIVERSAL__
 // when building wxUniv/Foo we don't want the code for native menu use to be
 // compiled in - it should only be used when building real wxFoo
 #ifdef __WXUNIVERSAL__
@@ -66,6 +69,39 @@ class WXDLLEXPORT wxToolTip;
 class WXDLLEXPORT wxWindowBase;
 class WXDLLEXPORT wxWindow;
 
 class WXDLLEXPORT wxWindowBase;
 class WXDLLEXPORT wxWindow;
 
+#if wxUSE_ACCESSIBILITY
+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
+};
+
 // ----------------------------------------------------------------------------
 // (pseudo)template list classes
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // (pseudo)template list classes
 // ----------------------------------------------------------------------------
@@ -95,12 +131,13 @@ 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,
-                    wxWindowID id,
+                    wxWindowID winid,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = 0,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = 0,
@@ -109,30 +146,20 @@ public:
 
     virtual ~wxWindowBase();
 
 
     virtual ~wxWindowBase();
 
-#if wxUSE_WX_RESOURCES
-    // these functions are implemented in resource.cpp and resourc2.cpp
-    virtual bool LoadFromResource(wxWindow *parent,
-                                  const wxString& resourceName,
-                                  const wxResourceTable *table = (const wxResourceTable *) NULL);
-    virtual wxControl *CreateItem(const wxItemResource* childResource,
-                                  const wxItemResource* parentResource,
-                                  const wxResourceTable *table = (const wxResourceTable *) NULL);
-#endif // wxUSE_WX_RESOURCES
-
     // 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?
@@ -160,9 +187,14 @@ 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
         // it is -1 which means "don't care"
         // window id uniquely identifies the window among its siblings unless
         // it is -1 which means "don't care"
-    void SetId( wxWindowID id ) { m_windowId = id; }
+    void SetId( wxWindowID winid ) { m_windowId = winid; }
     wxWindowID GetId() const { return m_windowId; }
 
         // generate a control id for the controls which were not given one by
     wxWindowID GetId() const { return m_windowId; }
 
         // generate a control id for the controls which were not given one by
@@ -170,10 +202,10 @@ public:
     static int NewControlId() { return --ms_lastControlId; }
         // get the id of the control following the one with the given
         // (autogenerated) id
     static int NewControlId() { return --ms_lastControlId; }
         // get the id of the control following the one with the given
         // (autogenerated) id
-    static int NextControlId(int id) { return id - 1; }
+    static int NextControlId(int winid) { return winid - 1; }
         // get the id of the control preceding the one with the given
         // (autogenerated) id
         // get the id of the control preceding the one with the given
         // (autogenerated) id
-    static int PrevControlId(int id) { return id + 1; }
+    static int PrevControlId(int winid) { return winid + 1; }
 
     // moving/resizing
     // ---------------
 
     // moving/resizing
     // ---------------
@@ -222,6 +254,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
     {
@@ -271,7 +305,18 @@ public:
             *h = s.y;
     }
 
             *h = s.y;
     }
 
-        // the generic centre function - centers the window on parent by
+        // 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
+        // (the window's smallest legible size), and any user specified
+        // MinSize hint.
+    wxSize GetAdjustedBestSize() const
+    {
+        wxSize  s( DoGetBestSize() );
+        return wxSize( wxMax( s.x, GetMinWidth() ), wxMax( s.y, GetMinHeight() ) );
+    }
+
+        // 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
     void Centre( int direction = wxBOTH );
         // default or on screen if it doesn't have parent or
         // wxCENTER_ON_SCREEN flag is given
     void Centre( int direction = wxBOTH );
@@ -288,10 +333,29 @@ public:
         // set window size to wrap around its children
     virtual void Fit();
 
         // set window size to wrap around its children
     virtual void Fit();
 
+        // set virtual size to satisfy children
+    virtual void FitInside();
+
         // 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 );
         // 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 );
+    void SetSizeHints( const wxSize& minSize,
+                       const wxSize& maxSize=wxDefaultSize,
+                       const wxSize& incSize=wxDefaultSize)
+    {
+        SetSizeHints(minSize.x, minSize.y,
+                     maxSize.x, maxSize.y,
+                     incSize.x, incSize.y);
+    }
+
+    virtual void SetVirtualSizeHints( int minW, int minH,
+                                      int maxW = -1, int maxH = -1 );
+    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; }
@@ -300,18 +364,57 @@ 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 ); }
+    
+        // 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
+        // the screen window size.  You may override the DoXXXVirtual
+        // methods below for classes where that is is the case.
+
+    void SetVirtualSize( const wxSize &size ) { DoSetVirtualSize( size.x, size.y ); }
+    void SetVirtualSize( int x, int y ) { DoSetVirtualSize( x, y ); }
+
+    wxSize GetVirtualSize() const { return DoGetVirtualSize(); }
+    void GetVirtualSize( int *x, int *y ) const
+    {
+        wxSize s( DoGetVirtualSize() );
+
+        if( x )
+            *x = s.GetWidth();
+        if( y )
+            *y = s.GetHeight();
+    }
+
+        // Override these methods for windows that have a virtual size
+        // independent of their client size.  eg. the virtual area of a
+        // wxScrolledWindow.  Default is to alias VirtualSize to ClientSize.
+
+    virtual void DoSetVirtualSize( int x, int y );
+    virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
+
+        // Return the largest of ClientSize and BestSize (as determined
+        // by a sizer, interior children, or other means)
+
+    virtual wxSize GetBestVirtualSize() const
+    {
+        wxSize  client( GetClientSize() );
+        wxSize  best( GetBestSize() );
+
+        return wxSize( wxMax( client.x, best.x ), wxMax( client.y, best.y ) );
+    }
 
     // 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; }
@@ -334,17 +437,33 @@ 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 it's 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
     // ---------------------------
 
         // set focus to this window
     virtual void SetFocus() = 0;
 
     // focus and keyboard handling
     // ---------------------------
 
         // set focus to this window
     virtual void SetFocus() = 0;
 
+        // set focus to this window as the result of a keyboard action
+    virtual void SetFocusFromKbd() { SetFocus(); }
+
         // return the window which currently has the focus or NULL
     static wxWindow *FindFocus() /* = 0: implement in derived classes */;
 
         // return the window which currently has the focus or NULL
     static wxWindow *FindFocus() /* = 0: implement in derived classes */;
 
@@ -367,6 +486,9 @@ public:
     virtual wxWindow *SetDefaultItem(wxWindow * WXUNUSED(child))
         { return NULL; }
 
     virtual wxWindow *SetDefaultItem(wxWindow * WXUNUSED(child))
         { return NULL; }
 
+        // set this child as temporary default
+    virtual void SetTmpDefaultItem(wxWindow * WXUNUSED(win)) { }
+
     // parent/children relations
     // -------------------------
 
     // parent/children relations
     // -------------------------
 
@@ -374,6 +496,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;
@@ -383,18 +508,28 @@ public:
 
         // it doesn't really change parent, use ReParent() instead
     void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
 
         // 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)
+        // 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 );
 
     virtual bool Reparent( wxWindowBase *newParent );
 
+        // implementation mostly
+    virtual void AddChild( wxWindowBase *child );
+    virtual void RemoveChild( wxWindowBase *child );
+
+    // looking for windows
+    // -------------------
+
         // find window among the descendants of this one either by id or by
         // name (return NULL if not found)
         // find window among the descendants of this one either by id or by
         // name (return NULL if not found)
-    wxWindow *FindWindow( long id );
+    wxWindow *FindWindow( long winid );
     wxWindow *FindWindow( const wxString& name );
 
     wxWindow *FindWindow( const wxString& name );
 
-        // implementation mostly
-    virtual void AddChild( wxWindowBase *child );
-    virtual void RemoveChild( wxWindowBase *child );
+        // Find a window among any window (all return NULL if not found)
+    static wxWindow *FindWindowById( long winid, const wxWindow *parent = NULL );
+    static wxWindow *FindWindowByName( const wxString& name,
+                                       const wxWindow *parent = NULL );
+    static wxWindow *FindWindowByLabel( const wxString& label,
+                                        const wxWindow *parent = NULL );
 
     // event handler stuff
     // -------------------
 
     // event handler stuff
     // -------------------
@@ -409,11 +544,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);
@@ -432,7 +567,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
@@ -448,8 +583,18 @@ public:
         { m_acceleratorTable = accel; }
     wxAcceleratorTable *GetAcceleratorTable()
         { return &m_acceleratorTable; }
         { m_acceleratorTable = accel; }
     wxAcceleratorTable *GetAcceleratorTable()
         { return &m_acceleratorTable; }
+
 #endif // wxUSE_ACCEL
 
 #endif // wxUSE_ACCEL
 
+#if wxUSE_HOTKEY
+    // hot keys (system wide accelerators)
+    // -----------------------------------
+
+    virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode);
+    virtual bool UnregisterHotKey(int hotkeyId);
+#endif // wxUSE_HOTKEY
+
+
     // dialog units translations
     // -------------------------
 
     // dialog units translations
     // -------------------------
 
@@ -494,17 +639,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() { }
@@ -536,26 +681,58 @@ 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_hasXXX" flag after setting the value
+        // to prevent it from being inherited by our children
+    virtual bool SetBackgroundColour(const wxColour& colour);
+    void SetDefaultBackgroundColour(const wxColour& colour)
+    {
+        if ( SetBackgroundColour(colour) )
+            m_hasBgCol = false;
+    }
+    wxColour GetBackgroundColour() const;
 
 
-    wxColour GetBackgroundColour() const { return m_backgroundColour; }
-    wxColour GetForegroundColour() const { return m_foregroundColour; }
+    virtual bool SetForegroundColour(const wxColour& colour);
+    void SetDefaultForegroundColour(const wxColour& colour)
+    {
+        if ( SetForegroundColour(colour) )
+            m_hasFgCol = false;
+    }
+    wxColour GetForegroundColour() const;
 
 
-        // set/retrieve the cursor for this window (SetCursor() returns TRUE
+        // 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)
+    {
+        if ( SetFont(font) )
+            m_hasFont = false;
+    }
+    const wxFont& GetFont() const { return DoGetFont(); }
+    wxFont& GetFont() { return DoGetFont(); }
+
+        // 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 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
     void SetCaret(wxCaret *caret);
 #if wxUSE_CARET
         // associate a caret with the window
     void SetCaret(wxCaret *caret);
@@ -612,11 +789,19 @@ public:
     // misc
     // ----
 
     // misc
     // ----
 
-    // get the window border style: uses the current style and falls back to
-    // the default style for this class otherwise (see GetDefaultBorder())
-    wxBorder GetBorder() const;
+    // get the window border style from the given flags: this is different from
+    // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
+    // translate wxBORDER_DEFAULT to something reasonable
+    wxBorder GetBorder(long flags) const;
 
 
-    void UpdateWindowUI();
+    // 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
+    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 )
 
 #if wxUSE_MENUS
     bool PopupMenu( wxMenu *menu, const wxPoint& pos )
@@ -640,8 +825,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;
@@ -652,9 +837,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); }
@@ -687,6 +872,7 @@ 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 ;
 #endif // wxUSE_TOOLTIPS
 
     // drag and drop
 #endif // wxUSE_TOOLTIPS
 
     // drag and drop
@@ -715,7 +901,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);
@@ -739,23 +925,30 @@ public:
     virtual bool Layout();
 
         // sizers
     virtual bool Layout();
 
         // sizers
-    void SetSizer(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) { m_containingSizer = sizer; }
+    void SetContainingSizer(wxSizer* sizer);
     wxSizer *GetContainingSizer() const { return m_containingSizer; }
 
     wxSizer *GetContainingSizer() const { return m_containingSizer; }
 
-    // backward compatibility
+    // accessibility
     // ----------------------
     // ----------------------
-#if WXWIN_COMPATIBILITY
-    bool Enabled() const { return IsEnabled(); }
+#if wxUSE_ACCESSIBILITY
+    // Override to create a specific accessible object.
+    virtual wxAccessible* CreateAccessible();
 
 
-    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
+    // Sets the accessible object.
+    void SetAccessible(wxAccessible* accessible) ;
+
+    // Returns the accessible object.
+    wxAccessible* GetAccessible() { return m_accessible; };
+
+    // Returns the accessible object, creating if necessary.
+    wxAccessible* GetOrCreateAccessible() ;
+#endif
 
     // implementation
     // --------------
 
     // implementation
     // --------------
@@ -768,7 +961,14 @@ public:
     void OnHelp(wxHelpEvent& event);
 #endif // wxUSE_HELP
 
     void OnHelp(wxHelpEvent& event);
 #endif // wxUSE_HELP
 
-        // get the haqndle of the window for the underlying window system: this
+        // virtual function for implementing internal idle
+        // behaviour
+        virtual void OnInternalIdle() {}
+
+        // call internal idle recursively
+//        void ProcessInternalIdle() ;
+
+        // get the handle of the window for the underlying window system: this
         // 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;
@@ -789,7 +989,32 @@ 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:
 protected:
+    // event handling specific to wxWindow
+    virtual bool TryValidator(wxEvent& event);
+    virtual bool TryParent(wxEvent& event);
+
+
+#if wxUSE_CONSTRAINTS
+    // satisfy the constraints for the windows but don't set the window sizes
+    void SatisfyConstraints();
+#endif // wxUSE_CONSTRAINTS
+
+    // Send the wxWindowDestroyEvent
+    void SendDestroyEvent();
+
     // the window id - a number which uniquely identifies a window among
     // its siblings unless it is -1
     wxWindowID           m_windowId;
     // the window id - a number which uniquely identifies a window among
     // its siblings unless it is -1
     wxWindowID           m_windowId;
@@ -801,7 +1026,10 @@ protected:
 
     // the minimal allowed size for the window (no minimal size if variable(s)
     // contain(s) -1)
 
     // the minimal allowed size for the window (no minimal size if variable(s)
     // contain(s) -1)
-    int                  m_minWidth, m_minHeight, m_maxWidth, m_maxHeight;
+    int                  m_minWidth,
+                         m_minHeight,
+                         m_maxWidth,
+                         m_maxHeight;
 
     // event handler for this window: usually is just 'this' but may be
     // changed with SetEventHandler()
 
     // event handler for this window: usually is just 'this' but may be
     // changed with SetEventHandler()
@@ -818,8 +1046,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;
@@ -878,26 +1107,45 @@ protected:
     bool                 m_hasCustomPalette;
 #endif // wxUSE_PALETTE
 
     bool                 m_hasCustomPalette;
 #endif // wxUSE_PALETTE
 
-protected:
+#if wxUSE_ACCESSIBILITY
+    wxAccessible*       m_accessible;
+#endif
+
+    // Initial window size, used as minimal size in Sizers
+    wxSize              m_initialSize;
+    
+    // Virtual size (scrolling)
+    wxSize                m_virtualSize;
 
 
-    // common part of all ctors: it is not virtual because it is called from
-    // ctor
-    void InitBase();
+    int                   m_minVirtualWidth;    // VirtualSizeHints
+    int                   m_minVirtualHeight;
+    int                   m_maxVirtualWidth;
+    int                   m_maxVirtualHeight;
+    
+    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 ...?
+    // 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; }
 
     // 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
     static int WidthDefault(int w) { return w == -1 ? 20 : w; }
     static int HeightDefault(int h) { return h == -1 ? 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
+    //
+    // 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)
     {
     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 || size.y == -1 )
         {
             wxSize sizeBest = DoGetBestSize();
@@ -966,19 +1214,26 @@ protected:
     virtual bool DoPopupMenu( wxMenu *menu, int x, int y ) = 0;
 #endif // wxUSE_MENUS
 
     virtual bool DoPopupMenu( wxMenu *menu, int x, int y ) = 0;
 #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;
 
     // the stack of windows which have captured the mouse
     static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext;
 
     // contains the last id generated by NewControlId
     static int ms_lastControlId;
 
     // 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()
@@ -994,7 +1249,6 @@ private:
         #define wxWindowNative wxWindowMSW
     #else // !wxUniv
         #define wxWindowMSW wxWindow
         #define wxWindowNative wxWindowMSW
     #else // !wxUniv
         #define wxWindowMSW wxWindow
-        #define sm_classwxWindowMSW sm_classwxWindow
     #endif // wxUniv/!wxUniv
     #include "wx/msw/window.h"
 #elif defined(__WXMOTIF__)
     #endif // wxUniv/!wxUniv
     #include "wx/msw/window.h"
 #elif defined(__WXMOTIF__)
@@ -1004,7 +1258,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__)
@@ -1012,7 +1265,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__)
@@ -1020,7 +1272,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__)
@@ -1028,15 +1279,20 @@ 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"
     #endif // wxUniv
     #include "wx/mac/window.h"
+#elif defined(__WXCOCOA__)
+    #ifdef __WXUNIVERSAL__
+        #define wxWindowNative wxWindowCocoa
+    #else // !wxUniv
+        #define wxWindowCocoa wxWindow
+    #endif // wxUniv
+    #include "wx/cocoa/window.h"
 #elif defined(__WXPM__)
     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowOS2
     #else // !wxUniv
         #define wxWindowOS2 wxWindow
 #elif defined(__WXPM__)
     #ifdef __WXUNIVERSAL__
         #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
@@ -1075,10 +1331,108 @@ WXDLLEXPORT extern wxPoint wxGetMousePosition();
 // get the currently active window of this application or NULL
 WXDLLEXPORT extern wxWindow *wxGetActiveWindow();
 
 // get the currently active window of this application or NULL
 WXDLLEXPORT extern wxWindow *wxGetActiveWindow();
 
+// get the (first) top level parent window
+WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win);
+
 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
 inline int NewControlId() { return wxWindowBase::NewControlId(); }
 
 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
 inline int NewControlId() { return wxWindowBase::NewControlId(); }
 
+#if wxUSE_ACCESSIBILITY
+// ----------------------------------------------------------------------------
+// accessible object for windows
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxWindowAccessible: public wxAccessible
+{
+public:
+    wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); }
+    virtual ~wxWindowAccessible() {};
+
+// Overridables
+
+        // Can return either a child object, or an integer
+        // representing the child element, starting from 1.
+    virtual wxAccStatus HitTest(const wxPoint& pt, int* childId, wxAccessible** childObject);
+
+        // Returns the rectangle for this object (id = 0) or a child element (id > 0).
+    virtual wxAccStatus GetLocation(wxRect& rect, int elementId);
+
+        // Navigates from fromId to toId/toObject.
+    virtual wxAccStatus Navigate(wxNavDir navDir, int fromId,
+                int* toId, wxAccessible** toObject);
+
+        // Gets the name of the specified object.
+    virtual wxAccStatus GetName(int childId, wxString* name);
+
+        // Gets the number of children.
+    virtual wxAccStatus GetChildCount(int* childCount);
+
+        // Gets the specified child (starting from 1).
+        // If *child is NULL and return value is wxACC_OK,
+        // this means that the child is a simple element and
+        // not an accessible object.
+    virtual wxAccStatus GetChild(int childId, wxAccessible** child);
+
+        // Gets the parent, or NULL.
+    virtual wxAccStatus GetParent(wxAccessible** parent);
+
+        // Performs the default action. childId is 0 (the action for this object)
+        // or > 0 (the action for a child).
+        // Return wxACC_NOT_SUPPORTED if there is no default action for this
+        // window (e.g. an edit control).
+    virtual wxAccStatus DoDefaultAction(int childId);
+
+        // Gets the default action for this object (0) or > 0 (the action for a child).
+        // Return wxACC_OK even if there is no action. actionName is the action, or the empty
+        // string if there is no action.
+        // The retrieved string describes the action that is performed on an object,
+        // not what the object does as a result. For example, a toolbar button that prints
+        // a document has a default action of "Press" rather than "Prints the current document."
+    virtual wxAccStatus GetDefaultAction(int childId, wxString* actionName);
+
+        // Returns the description for this object or a child.
+    virtual wxAccStatus GetDescription(int childId, wxString* description);
+
+        // Returns help text for this object or a child, similar to tooltip text.
+    virtual wxAccStatus GetHelpText(int childId, wxString* helpText);
+
+        // Returns the keyboard shortcut for this object or child.
+        // Return e.g. ALT+K
+    virtual wxAccStatus GetKeyboardShortcut(int childId, wxString* shortcut);
+
+        // Returns a role constant.
+    virtual wxAccStatus GetRole(int childId, wxAccRole* role);
+
+        // Returns a state constant.
+    virtual wxAccStatus GetState(int childId, long* state);
+
+        // Returns a localized string representing the value for the object
+        // or child.
+    virtual wxAccStatus GetValue(int childId, wxString* strValue);
+
+        // Selects the object or child.
+    virtual wxAccStatus Select(int childId, wxAccSelectionFlags selectFlags);
+
+        // Gets the window with the keyboard focus.
+        // If childId is 0 and child is NULL, no object in
+        // this subhierarchy has the focus.
+        // If this object has the focus, child should be 'this'.
+    virtual wxAccStatus GetFocus(int* childId, wxAccessible** child);
+
+        // Gets a variant representing the selected children
+        // of this object.
+        // Acceptable values:
+        // - 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 "void*" pointer to a wxAccessible child object
+    virtual wxAccStatus GetSelections(wxVariant* selections);
+};
+
+#endif // wxUSE_ACCESSIBILITY
+
+
 #endif
     // _WX_WINDOW_H_BASE_
 
 #endif
     // _WX_WINDOW_H_BASE_
 
-// vi:sts=4:sw=4:et