don't use border styles for windows in wxUniversal

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

diff --git a/include/wx/window.h b/include/wx/window.h
index 9fb6eb4e7d01e869e095f89d0c1e55e61d7633cf..90611c917b58cf7aea4562e023d06ae440f26756 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        window.h
-// Purpose:     wxWindowBase class - the interface of wxWindowBase
+// Name:        wx/window.h
+// Purpose:     wxWindowBase class - the interface of wxWindow

 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     01/02/97
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     01/02/97


@@ -12,6 +12,10 @@
 #ifndef _WX_WINDOW_H_BASE_
 #define _WX_WINDOW_H_BASE_
 
 #ifndef _WX_WINDOW_H_BASE_
 #define _WX_WINDOW_H_BASE_
 

+#ifdef __GNUG__
+    #pragma interface "windowbase.h"
+#endif
+

 // ----------------------------------------------------------------------------
 // headers which we must include here
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers which we must include here
 // ----------------------------------------------------------------------------


@@ -24,23 +28,41 @@
 #include "wx/font.h"            // so we can't do without them
 #include "wx/colour.h"
 #include "wx/region.h"
 #include "wx/font.h"            // so we can't do without them
 #include "wx/colour.h"
 #include "wx/region.h"

-#include "wx/accel.h"
+#include "wx/utils.h"
+
+#include "wx/validate.h"        // for wxDefaultValidator (always include it)
+
+#if wxUSE_PALETTE
+       #include "wx/dcclient.h"
+       #include "wx/palette.h"
+#endif // wxUSE_PALETTE
+
+#if wxUSE_ACCEL
+    #include "wx/accel.h"
+#endif // wxUSE_ACCEL
+
+// 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__
+    #define wxUSE_MENUS_NATIVE 0
+#else // __WXMSW__
+    #define wxUSE_MENUS_NATIVE wxUSE_MENUS
+#endif // __WXUNIVERSAL__/__WXMSW__

 
 // ----------------------------------------------------------------------------
 // forward declarations
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // forward declarations
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxClientData;
+class WXDLLEXPORT wxCaret;

 class WXDLLEXPORT wxControl;
 class WXDLLEXPORT wxCursor;
 class WXDLLEXPORT wxControl;
 class WXDLLEXPORT wxCursor;

-class WXDLLEXPORT wxDc;
+class WXDLLEXPORT wxDC;

 class WXDLLEXPORT wxDropTarget;
 class WXDLLEXPORT wxItemResource;
 class WXDLLEXPORT wxLayoutConstraints;
 class WXDLLEXPORT wxResourceTable;
 class WXDLLEXPORT wxSizer;
 class WXDLLEXPORT wxToolTip;
 class WXDLLEXPORT wxDropTarget;
 class WXDLLEXPORT wxItemResource;
 class WXDLLEXPORT wxLayoutConstraints;
 class WXDLLEXPORT wxResourceTable;
 class WXDLLEXPORT wxSizer;
 class WXDLLEXPORT wxToolTip;

-class WXDLLEXPORT wxValidator;

 class WXDLLEXPORT wxWindowBase;
 class WXDLLEXPORT wxWindow;
 
 class WXDLLEXPORT wxWindowBase;
 class WXDLLEXPORT wxWindow;
 


@@ -48,7 +70,7 @@ class WXDLLEXPORT wxWindow;
 // (pseudo)template list classes
 // ----------------------------------------------------------------------------
 
 // (pseudo)template list classes
 // ----------------------------------------------------------------------------
 

-WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode);
+WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class WXDLLEXPORT);

 
 // ----------------------------------------------------------------------------
 // global variables
 
 // ----------------------------------------------------------------------------
 // global variables


@@ -56,31 +78,6 @@ WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode);
 
 WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows;
 
 
 WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows;
 

-// ----------------------------------------------------------------------------
-// helper classes used by [SG]etClientObject/Data
-//
-// TODO move into a separate header?
-// ----------------------------------------------------------------------------
-
-class wxClientData
-{
-public:
-    wxClientData() { }
-    virtual ~wxClientData() { }
-};
-
-class wxStringClientData : public wxClientData
-{
-public:
-    wxStringClientData() { }
-    wxStringClientData( const wxString &data ) : m_data(data) { }
-    void SetData( const wxString &data ) { m_data = data; }
-    const wxString& GetData() const { return m_data; }
-
-private:
-    wxString  m_data;
-};
-

 // ----------------------------------------------------------------------------
 // wxWindowBase is the base class for all GUI controls/widgets, this is the public
 // interface of this class.
 // ----------------------------------------------------------------------------
 // wxWindowBase is the base class for all GUI controls/widgets, this is the public
 // interface of this class.


@@ -94,8 +91,6 @@ private:
 
 class WXDLLEXPORT wxWindowBase : public wxEvtHandler
 {
 
 class WXDLLEXPORT wxWindowBase : public wxEvtHandler
 {

-    DECLARE_ABSTRACT_CLASS(wxWindowBase);
-

 public:
     // creating the window
     // -------------------
 public:
     // creating the window
     // -------------------


@@ -109,6 +104,7 @@ public:
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = 0,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = 0,

+                    const wxValidator& validator = wxDefaultValidator,

                     const wxString& name = wxPanelNameStr);
 
     virtual ~wxWindowBase();
                     const wxString& name = wxPanelNameStr);
 
     virtual ~wxWindowBase();


@@ -145,14 +141,19 @@ public:
     // window attributes
     // -----------------
 
     // window attributes
     // -----------------
 

+        // NB: in future versions of wxWindows 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).
+

         // the title (or label, see below) of the window: the text which the
         // window shows
         // the title (or label, see below) of the window: the text which the
         // window shows

-    virtual void SetTitle( const wxString & WXUNUSED(title) ) { }
-    virtual wxString GetTitle() const { return ""; }
+    virtual void SetTitle( const wxString& WXUNUSED(title) ) {}
+    virtual wxString GetTitle() const { return wxEmptyString; }

 
         // label is just the same as the title (but for, e.g., buttons it
         // makes more sense to speak about labels)
 
         // label is just the same as the title (but for, e.g., buttons it
         // makes more sense to speak about labels)

-    wxString GetLabel() const { return GetTitle(); }
+    virtual void SetLabel(const wxString& label) { SetTitle(label); }
+    virtual wxString GetLabel() const { return GetTitle(); }

 
         // the window name is used for ressource setting in X, it is not the
         // same as the window title/label
 
         // the window name is used for ressource setting in X, it is not the
         // same as the window title/label


@@ -166,7 +167,13 @@ public:
 
         // generate a control id for the controls which were not given one by
         // user
 
         // generate a control id for the controls which were not given one by
         // user

-    static int NewControlId() { return ++ms_lastControlId; }
+    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; }
+        // get the id of the control preceding the one with the given
+        // (autogenerated) id
+    static int PrevControlId(int id) { return id + 1; }

 
     // moving/resizing
     // ---------------
 
     // moving/resizing
     // ---------------


@@ -185,11 +192,11 @@ public:
     void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
         { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
 
     void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
         { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
 

-    void Move( int x, int y )
-        { DoSetSize( x, y, -1, -1, wxSIZE_USE_EXISTING ); }
+    void Move(int x, int y, int flags = wxSIZE_USE_EXISTING)
+        { DoSetSize(x, y, -1, -1, flags); }

 
 

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

 
         // Z-order
     virtual void Raise() = 0;
 
         // Z-order
     virtual void Raise() = 0;


@@ -241,9 +248,42 @@ public:
         return wxSize(w, h);
     }
 
         return wxSize(w, h);
     }
 

+        // get the origin of the client area of the window relative to the
+        // window top left corner (the client area may be shifted because of
+        // the borders, scrollbars, other decorations...)
+    virtual wxPoint GetClientAreaOrigin() const;
+
+        // get the client rectangle in window (i.e. client) coordinates
+    wxRect GetClientRect() const
+    {
+        return wxRect(GetClientAreaOrigin(), GetClientSize());
+    }
+
+        // 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(); }
+    void GetBestSize(int *w, int *h) const
+    {
+        wxSize s = DoGetBestSize();
+        if ( w )
+            *w = s.x;
+        if ( h )
+            *h = s.y;
+    }
+
+        // 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 );
+    void Center( int direction = wxBOTH ) { Centre(direction); }
+
+        // centre on screen (only works for top level windows)
+    void CentreOnScreen(int dir = wxBOTH) { Centre(dir | wxCENTER_ON_SCREEN); }
+    void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); }
+

         // centre with respect to the the parent window
         // centre with respect to the the parent window

-    void Centre( int direction = wxHORIZONTAL );
-    void Center( int direction = wxHORIZONTAL ) { Centre(direction); }
+    void CentreOnParent(int dir = wxBOTH) { Centre(dir | wxCENTER_FRAME); }
+    void CenterOnParent(int dir = wxBOTH) { CentreOnParent(dir); }

 
         // set window size to wrap around its children
     virtual void Fit();
 
         // set window size to wrap around its children
     virtual void Fit();


@@ -253,6 +293,11 @@ public:
                                int maxW = -1, int maxH = -1,
                                int incW = -1, int incH = -1 );
 
                                int maxW = -1, int maxH = -1,
                                int incW = -1, int incH = -1 );
 

+    virtual int GetMinWidth() const { return m_minWidth; }
+    virtual int GetMinHeight() const { return m_minHeight; }
+    int GetMaxWidth() const { return m_maxWidth; }
+    int GetMaxHeight() const { return m_maxHeight; }
+

     // window state
     // ------------
 
     // window state
     // ------------
 


@@ -278,15 +323,21 @@ public:
     long GetWindowStyle() const { return GetWindowStyleFlag(); }
 
     bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; }
     long GetWindowStyle() const { return GetWindowStyleFlag(); }
 
     bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; }

+    virtual bool IsRetained() const { return HasFlag(wxRETAINED); }

 
 

-    virtual bool IsRetained() const
-        { return (m_windowStyle & wxRETAINED) != 0; }
+        // extra style: the less often used style bits which can't be set with
+        // SetWindowStyleFlag()
+    virtual void SetExtraStyle(long exStyle) { m_exStyle = exStyle; }
+    long GetExtraStyle() const { return m_exStyle; }

 
         // make the window modal (all other windows unresponsive)
     virtual void MakeModal(bool modal = TRUE);
 
 
         // make the window modal (all other windows unresponsive)
     virtual void MakeModal(bool modal = TRUE);
 

-    // focus handling
-    // --------------
+    virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; }
+    virtual bool GetThemeEnabled() const { return m_themeEnabled; }
+
+    // focus and keyboard handling
+    // ---------------------------

 
         // set focus to this window
     virtual void SetFocus() = 0;
 
         // set focus to this window
     virtual void SetFocus() = 0;


@@ -297,6 +348,22 @@ public:
         // can this window have focus?
     virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
 
         // can this window have focus?
     virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
 

+        // can this window be given focus by keyboard navigation? if not, the
+        // only way to give it focus (provided it accepts it at all) is to
+        // click it
+    virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
+
+        // NB: these methods really don't belong here but with the current
+        //     class hierarchy there is no other place for them :-(
+
+        // get the default child of this parent, i.e. the one which is
+        // activated by pressing <Enter>
+    virtual wxWindow *GetDefaultItem() const { return NULL; }
+
+        // set this child as default, return the old default
+    virtual wxWindow *SetDefaultItem(wxWindow * WXUNUSED(child))
+        { return NULL; }
+

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


@@ -309,7 +376,7 @@ public:
     inline wxWindow *GetGrandParent() const;
 
         // is this window a top level one?
     inline wxWindow *GetGrandParent() const;
 
         // is this window a top level one?

-    bool IsTopLevel() const { return m_parent != 0; }
+    virtual bool IsTopLevel() const;

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


@@ -341,29 +408,23 @@ public:
     void PushEventHandler( wxEvtHandler *handler );
     wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
 
     void PushEventHandler( wxEvtHandler *handler );
     wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
 

-    // validators and client data
-    // --------------------------
+        // 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
+        // this function should only be called when the handler is supposed to
+        // be there)
+    bool RemoveEventHandler(wxEvtHandler *handler);

 
 

+    // validators
+    // ----------
+
+#if wxUSE_VALIDATORS

         // a window may have an associated validator which is used to control
         // user input
     virtual void SetValidator( const wxValidator &validator );
     virtual wxValidator *GetValidator() { return m_windowValidator; }
         // a window may have an associated validator which is used to control
         // user input
     virtual void SetValidator( const wxValidator &validator );
     virtual wxValidator *GetValidator() { return m_windowValidator; }

+#endif // wxUSE_VALIDATORS

 
 

-        // each window may have associated client data: either a pointer to
-        // wxClientData object in which case it is managed by the window (i.e.
-        // it will delete the data when it's destroyed) or an untyped pointer
-        // which won't be deleted by the window
-    virtual void SetClientObject( wxClientData *data )
-    {
-        if ( m_clientObject )
-            delete m_clientObject;
-
-        m_clientObject = data;
-    }
-    virtual wxClientData *GetClientObject() const { return m_clientObject; }
-
-    virtual void SetClientData( void *data ) { m_clientData = data; }
-    virtual void *GetClientData() const { return m_clientData; }

 
     // dialog oriented functions
     // -------------------------
 
     // dialog oriented functions
     // -------------------------


@@ -377,12 +438,14 @@ public:
 
     virtual void InitDialog();
 
 
     virtual void InitDialog();
 

+#if wxUSE_ACCEL

     // accelerators
     // ------------
     virtual void SetAcceleratorTable( const wxAcceleratorTable& accel )
         { m_acceleratorTable = accel; }
     wxAcceleratorTable *GetAcceleratorTable()
         { return &m_acceleratorTable; }
     // accelerators
     // ------------
     virtual void SetAcceleratorTable( const wxAcceleratorTable& accel )
         { m_acceleratorTable = accel; }
     wxAcceleratorTable *GetAcceleratorTable()
         { return &m_acceleratorTable; }

+#endif // wxUSE_ACCEL

 
     // dialog units translations
     // -------------------------
 
     // dialog units translations
     // -------------------------


@@ -409,9 +472,19 @@ public:
         // move the mouse to the specified position
     virtual void WarpPointer(int x, int y) = 0;
 
         // move the mouse to the specified position
     virtual void WarpPointer(int x, int y) = 0;
 

-        // start or end mouse capture
-    virtual void CaptureMouse() = 0;
-    virtual void ReleaseMouse() = 0;
+        // start or end mouse capture, these functions maintain the stack of
+        // windows having captured the mouse and after calling ReleaseMouse()
+        // the mouse is not released but returns to the window which had had
+        // captured it previously (if any)
+    void CaptureMouse();
+    void ReleaseMouse();
+
+        // get the window which currently captures the mouse or NULL
+    static wxWindow *GetCapture();
+
+        // does this window have the capture?
+    virtual bool HasCapture() const
+        { return (wxWindow *)this == GetCapture(); }

 
     // painting the window
     // -------------------
 
     // painting the window
     // -------------------


@@ -420,17 +493,33 @@ public:
         // will be repainted
     virtual void Refresh( bool eraseBackground = TRUE,
                           const wxRect *rect = (const wxRect *) NULL ) = 0;
         // will be repainted
     virtual void Refresh( bool eraseBackground = TRUE,
                           const wxRect *rect = (const wxRect *) NULL ) = 0;

+
+        // a less awkward wrapper for Refresh
+    void RefreshRect(const wxRect& rect) { Refresh(TRUE, &rect); }
+
+        // repaint all invalid areas of the window immediately
+    virtual void Update() { }
+

         // clear the window entirely
     virtual void Clear() = 0;
 
         // clear the window entirely
     virtual void Clear() = 0;
 

+        // freeze the window: don't redraw it until it is thawed
+    virtual void Freeze() { }
+
+        // thaw the window: redraw it after it had been frozen
+    virtual void Thaw() { }
+

         // adjust DC for drawing on this window
         // adjust DC for drawing on this window

-    virtual void PrepareDC( wxDC &dc ) { }
+    virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { }

 
         // the update region of the window contains the areas which must be
         // repainted by the program
     const wxRegion& GetUpdateRegion() const { return m_updateRegion; }
     wxRegion& GetUpdateRegion() { return m_updateRegion; }
 
 
         // the update region of the window contains the areas which must be
         // repainted by the program
     const wxRegion& GetUpdateRegion() const { return m_updateRegion; }
     wxRegion& GetUpdateRegion() { return m_updateRegion; }
 

+        // get the update rectangleregion bounding box in client coords
+    wxRect GetUpdateClientRect() const;
+

         // these functions verify whether the given point/rectangle belongs to
         // (or at least intersects with) the update region
     bool IsExposed( int x, int y ) const;
         // these functions verify whether the given point/rectangle belongs to
         // (or at least intersects with) the update region
     bool IsExposed( int x, int y ) const;


@@ -464,6 +553,13 @@ public:
     const wxFont& GetFont() const { return m_font; }
     wxFont& GetFont() { return m_font; }
 
     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);
+        // get the current caret (may be NULL)
+    wxCaret *GetCaret() const { return m_caret; }
+#endif // wxUSE_CARET
+

         // get the (average) character size for the current font
     virtual int GetCharHeight() const = 0;
     virtual int GetCharWidth() const = 0;
         // get the (average) character size for the current font
     virtual int GetCharHeight() const = 0;
     virtual int GetCharWidth() const = 0;


@@ -477,24 +573,69 @@ public:
                                const wxFont *theFont = (const wxFont *) NULL)
                                const = 0;
 
                                const wxFont *theFont = (const wxFont *) NULL)
                                const = 0;
 

+    // client <-> screen coords
+    // ------------------------
+

         // translate to/from screen/client coordinates (pointers may be NULL)
         // translate to/from screen/client coordinates (pointers may be NULL)

-    virtual void ClientToScreen( int *x, int *y ) const = 0;
-    virtual void ScreenToClient( int *x, int *y ) const = 0;
+    void ClientToScreen( int *x, int *y ) const
+        { DoClientToScreen(x, y); }
+    void ScreenToClient( int *x, int *y ) const
+        { DoScreenToClient(x, y); }
+
+        // wxPoint interface to do the same thing
+    wxPoint ClientToScreen(const wxPoint& pt) const
+    {
+        int x = pt.x, y = pt.y;
+        DoClientToScreen(&x, &y);
+
+        return wxPoint(x, y);
+    }
+
+    wxPoint ScreenToClient(const wxPoint& pt) const
+    {
+        int x = pt.x, y = pt.y;
+        DoScreenToClient(&x, &y);
+
+        return wxPoint(x, y);
+    }
+
+        // test where the given (in client coords) point lies
+    wxHitTest HitTest(wxCoord x, wxCoord y) const
+        { return DoHitTest(x, y); }
+
+    wxHitTest HitTest(const wxPoint& pt) const
+        { return DoHitTest(pt.x, pt.y); }

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

     void UpdateWindowUI();
 
     void UpdateWindowUI();
 

-    virtual bool PopupMenu( wxMenu *menu, int x, int y ) = 0;
+#if wxUSE_MENUS
+    bool PopupMenu( wxMenu *menu, const wxPoint& pos )
+        { return DoPopupMenu(menu, pos.x, pos.y); }
+    bool PopupMenu( wxMenu *menu, int x, int y )
+        { return DoPopupMenu(menu, x, y); }
+#endif // wxUSE_MENUS

 
     // scrollbars
     // ----------
 
 
     // scrollbars
     // ----------
 

+        // does the window have the scrollbar for this orientation?
+    bool HasScrollbar(int orient) const
+    {
+        return (m_windowStyle &
+                (orient == wxHORIZONTAL ? wxHSCROLL : wxVSCROLL)) != 0;
+    }
+

         // configure the window scrollbars
     virtual void SetScrollbar( int orient,
                                int pos,
         // configure the window scrollbars
     virtual void SetScrollbar( int orient,
                                int pos,

-                               int thumbVisible,
+                               int thumbvisible,

                                int range,
                                bool refresh = TRUE ) = 0;
     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ) = 0;
                                int range,
                                bool refresh = TRUE ) = 0;
     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ) = 0;


@@ -506,8 +647,36 @@ public:
     virtual void ScrollWindow( int dx, int dy,
                                const wxRect* rect = (wxRect *) NULL ) = 0;
 
     virtual void ScrollWindow( int dx, int dy,
                                const wxRect* rect = (wxRect *) NULL ) = 0;
 

+        // 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; }
+
+        // convenient wrappers for ScrollLines/Pages
+    bool LineUp() { return ScrollLines(-1); }
+    bool LineDown() { return ScrollLines(1); }
+    bool PageUp() { return ScrollPages(-1); }
+    bool PageDown() { return ScrollPages(1); }
+
+    // context-sensitive help
+    // ----------------------
+
+    // these are the convenience functions wrapping wxHelpProvider methods
+
+#if wxUSE_HELP
+        // associate this help text with this window
+    void SetHelpText(const wxString& text);
+        // associate this help text with all windows with the same id as this
+        // one
+    void SetHelpTextForId(const wxString& text);
+        // get the help string associated with this window (may be empty)
+    wxString GetHelpText() const;
+#endif // wxUSE_HELP
+

     // tooltips
     // --------
     // tooltips
     // --------

+

 #if wxUSE_TOOLTIPS
         // the easiest way to set a tooltip for a window is to use this method
     void SetToolTip( const wxString &tip );
 #if wxUSE_TOOLTIPS
         // the easiest way to set a tooltip for a window is to use this method
     void SetToolTip( const wxString &tip );


@@ -555,10 +724,9 @@ public:
     virtual void SetConstraintSizes(bool recurse = TRUE);
     virtual bool LayoutPhase1(int *noChanges);
     virtual bool LayoutPhase2(int *noChanges);
     virtual void SetConstraintSizes(bool recurse = TRUE);
     virtual bool LayoutPhase1(int *noChanges);
     virtual bool LayoutPhase2(int *noChanges);

-    virtual bool DoPhase(int);
+    virtual bool DoPhase(int phase);

 
         // these methods are virtual but normally won't be overridden
 
         // these methods are virtual but normally won't be overridden

-    virtual void TransformSizerToActual(int *x, int *y) const ;

     virtual void SetSizeConstraint(int x, int y, int w, int h);
     virtual void MoveConstraint(int x, int y);
     virtual void GetSizeConstraint(int *w, int *h) const ;
     virtual void SetSizeConstraint(int x, int y, int w, int h);
     virtual void MoveConstraint(int x, int y);
     virtual void GetSizeConstraint(int *w, int *h) const ;


@@ -566,15 +734,13 @@ public:
     virtual void GetPositionConstraint(int *x, int *y) const ;
 
         // sizers
     virtual void GetPositionConstraint(int *x, int *y) const ;
 
         // sizers

-        // TODO: what are they and how do they work??

     void SetSizer( wxSizer *sizer );
     wxSizer *GetSizer() const { return m_windowSizer; }
 
     void SetSizer( wxSizer *sizer );
     wxSizer *GetSizer() const { return m_windowSizer; }
 

-    void SetSizerParent( wxWindowBase *win ) { m_sizerParent = win; }
-    wxWindowBase *GetSizerParent() const { return m_sizerParent; }
+    // Track if this window is a member of a sizer
+    void SetContainingSizer(wxSizer* sizer) { m_containingSizer = sizer; }
+    wxSizer *GetContainingSizer() const { return m_containingSizer; }

 
 

-    virtual void SizerSetSize(int x, int y, int w, int h);
-    virtual void SizerMove(int x, int y);

 #endif // wxUSE_CONSTRAINTS
 
     // backward compatibility
 #endif // wxUSE_CONSTRAINTS
 
     // backward compatibility


@@ -594,28 +760,35 @@ public:
         // event handlers
     void OnSysColourChanged( wxSysColourChangedEvent& event );
     void OnInitDialog( wxInitDialogEvent &event );
         // event handlers
     void OnSysColourChanged( wxSysColourChangedEvent& event );
     void OnInitDialog( wxInitDialogEvent &event );

+    void OnMiddleClick( wxMouseEvent& event );
+#if wxUSE_HELP
+    void OnHelp(wxHelpEvent& event);
+#endif // wxUSE_HELP

 
 

-/*
-    // What is this doing in the platform independent part?
-    // No doc specifies this. Of what use would that be?
+        // get the haqndle 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;

 
 

-    // the window handle (for the underlying windowing system)
-    union
-    {
-        // we have 2 common names for this member, one for MSW and the other
-        // for the rest of the world
-        WXWidget m_widget;
-        WXWidget m_hWnd;
-    };
-    
-    // accessor
-    WXWidget GetHandle() const { return m_widget; }
-    
-*/
+#if wxUSE_PALETTE
+        // Store the palette used by DCs in wxWindow so that the dcs can share
+        // a palette. And we can respond to palette messages.
+    wxPalette GetPalette() const { return m_palette; }
+
+        // When palette is changed tell the DC to set the system palette to the
+        // new one.
+    void SetPalette(const wxPalette& pal);
+
+        // return true if we have a specific palette
+    bool HasCustomPalette() const { return m_hasCustomPalette; }
+
+        // return the first parent window with a custom palette or NULL
+    wxWindow *GetAncestorWithCustomPalette() const;
+#endif // wxUSE_PALETTE

 
 protected:
 
 protected:

-    // the window id - a number which uniquely identifies a window among 
-    // its siblings  unless it is -1
+    // the window id - a number which uniquely identifies a window among
+    // its siblings unless it is -1

     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


@@ -631,8 +804,10 @@ protected:
     // changed with SetEventHandler()
     wxEvtHandler        *m_eventHandler;
 
     // changed with SetEventHandler()
     wxEvtHandler        *m_eventHandler;
 

+#if wxUSE_VALIDATORS

     // associated validator or NULL if none
     wxValidator         *m_windowValidator;
     // associated validator or NULL if none
     wxValidator         *m_windowValidator;

+#endif // wxUSE_VALIDATORS

 
 #if wxUSE_DRAG_AND_DROP
     wxDropTarget        *m_dropTarget;
 
 #if wxUSE_DRAG_AND_DROP
     wxDropTarget        *m_dropTarget;


@@ -643,18 +818,18 @@ protected:
     wxFont               m_font;
     wxColour             m_backgroundColour, m_foregroundColour;
 
     wxFont               m_font;
     wxColour             m_backgroundColour, m_foregroundColour;
 

+#if wxUSE_CARET
+    wxCaret             *m_caret;
+#endif // wxUSE_CARET
+

     // the region which should be repainted in response to paint event
     wxRegion             m_updateRegion;
 
     // the region which should be repainted in response to paint event
     wxRegion             m_updateRegion;
 

+#if wxUSE_ACCEL

     // the accelerator table for the window which translates key strokes into
     // command events
     wxAcceleratorTable   m_acceleratorTable;
     // the accelerator table for the window which translates key strokes into
     // command events
     wxAcceleratorTable   m_acceleratorTable;

-
-    // user data associated with the window: either an object which will be
-    // deleted by the window when it's deleted or some raw pointer which we do
-    // nothing with
-    wxClientData        *m_clientObject;
-    void                *m_clientData;
+#endif // wxUSE_ACCEL

 
     // the tooltip for this window (may be NULL)
 #if wxUSE_TOOLTIPS
 
     // the tooltip for this window (may be NULL)
 #if wxUSE_TOOLTIPS


@@ -669,10 +844,11 @@ protected:
     // constraints this window is involved in
     wxWindowList        *m_constraintsInvolvedIn;
 
     // constraints this window is involved in
     wxWindowList        *m_constraintsInvolvedIn;
 

-    // top level and the parent sizers
-    // TODO what's this and how does it work?)
+    // this window's sizer

     wxSizer             *m_windowSizer;
     wxSizer             *m_windowSizer;

-    wxWindowBase        *m_sizerParent;
+
+    // The sizer this window is a member of, if any
+    wxSizer             *m_containingSizer;

 
     // Layout() window automatically when its size changes?
     bool                 m_autoLayout:1;
 
     // Layout() window automatically when its size changes?
     bool                 m_autoLayout:1;


@@ -683,20 +859,54 @@ protected:
     bool                 m_isEnabled:1;
     bool                 m_isBeingDeleted:1;
 
     bool                 m_isEnabled:1;
     bool                 m_isBeingDeleted:1;
 

+    // was the window colours/font explicitly changed by user?
+    bool                 m_hasBgCol:1;
+    bool                 m_hasFgCol:1;
+    bool                 m_hasFont:1;
+

     // window attributes
     // window attributes

-    long                 m_windowStyle;
+    long                 m_windowStyle,
+                         m_exStyle;

     wxString             m_windowName;
     wxString             m_windowName;

+    bool                 m_themeEnabled;
+
+#if wxUSE_PALETTE
+    wxPalette            m_palette;
+    bool                 m_hasCustomPalette;
+#endif // wxUSE_PALETTE

 
 protected:
 
 protected:

+

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

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

+    // 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
+    void SetBestSize(const wxSize& size)
+    {
+        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);
+        }
+    }
+

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


@@ -709,11 +919,26 @@ protected:
     //     overloaded Something()s in terms of DoSomething() which will be the
     //     only one to be virtual.
 
     //     overloaded Something()s in terms of DoSomething() which will be the
     //     only one to be virtual.
 

+    // coordinates translation
+    virtual void DoClientToScreen( int *x, int *y ) const = 0;
+    virtual void DoScreenToClient( int *x, int *y ) const = 0;
+
+    virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const;
+
+    // capture/release the mouse, used by Capture/ReleaseMouse()
+    virtual void DoCaptureMouse() = 0;
+    virtual void DoReleaseMouse() = 0;
+

     // retrieve the position/size of the window
     virtual void DoGetPosition( int *x, int *y ) const = 0;
     virtual void DoGetSize( int *width, int *height ) const = 0;
     virtual void DoGetClientSize( int *width, int *height ) const = 0;
 
     // retrieve the position/size of the window
     virtual void DoGetPosition( int *x, int *y ) const = 0;
     virtual void DoGetSize( int *width, int *height ) const = 0;
     virtual void DoGetClientSize( int *width, int *height ) const = 0;
 

+    // get the size which best suits the window: for a control, it would be
+    // the minimal size which doesn't truncate the control, for a panel - the
+    // same size as it would have after a call to Fit()
+    virtual wxSize DoGetBestSize() const;
+

     // this is the virtual function to be overriden in any derived class which
     // wants to change how SetSize() or Move() works - it is called by all
     // versions of these functions in the base class
     // this is the virtual function to be overriden in any derived class which
     // wants to change how SetSize() or Move() works - it is called by all
     // versions of these functions in the base class


@@ -724,14 +949,35 @@ protected:
     // same as DoSetSize() for the client size
     virtual void DoSetClientSize(int width, int height) = 0;
 
     // same as DoSetSize() for the client size
     virtual void DoSetClientSize(int width, int height) = 0;
 

+    // move the window to the specified location and resize it: this is called
+    // from both DoSetSize() and DoSetClientSize() and would usually just
+    // reposition this window except for composite controls which will want to
+    // arrange themselves inside the given rectangle
+    virtual void DoMoveWindow(int x, int y, int width, int height) = 0;
+

 #if wxUSE_TOOLTIPS
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif // wxUSE_TOOLTIPS
 
 #if wxUSE_TOOLTIPS
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif // wxUSE_TOOLTIPS
 

+#if 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);
+
+

 private:
 private:

+

     // contains the last id generated by NewControlId
     static int ms_lastControlId;
 
     // 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;
+
+    DECLARE_ABSTRACT_CLASS(wxWindowBase)
+    DECLARE_NO_COPY_CLASS(wxWindowBase)

     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };
 


@@ -739,18 +985,69 @@ private:
 // now include the declaration of wxWindow class
 // ----------------------------------------------------------------------------
 
 // now include the declaration of wxWindow class
 // ----------------------------------------------------------------------------
 

+// include the declaration of the platform-specific class

 #if defined(__WXMSW__)
 #if defined(__WXMSW__)

+    #ifdef __WXUNIVERSAL__
+        #define wxWindowNative wxWindowMSW
+    #else // !wxUniv
+        #define wxWindowMSW wxWindow
+        #define sm_classwxWindowMSW sm_classwxWindow
+    #endif // wxUniv/!wxUniv

     #include "wx/msw/window.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/window.h"
 #elif defined(__WXGTK__)
     #include "wx/msw/window.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/window.h"
 #elif defined(__WXGTK__)

+    #ifdef __WXUNIVERSAL__
+        #define wxWindowNative wxWindowGTK
+    #else // !wxUniv
+        #define wxWindowGTK wxWindow
+        #define sm_classwxWindowGTK sm_classwxWindow
+    #endif // wxUniv

     #include "wx/gtk/window.h"
     #include "wx/gtk/window.h"

-#elif defined(__WXQT__)
-    #include "wx/qt/window.h"
+#elif defined(__WXX11__)
+    #ifdef __WXUNIVERSAL__
+        #define wxWindowNative wxWindowX11
+    #else // !wxUniv
+        #define wxWindowX11 wxWindow
+        #define sm_classwxWindowX11 sm_classwxWindow
+    #endif // wxUniv
+    #include "wx/x11/window.h"
+#elif defined(__WXMGL__)
+    #ifdef __WXUNIVERSAL__
+        #define wxWindowNative wxWindowMGL
+    #else // !wxUniv
+        #define wxWindowMGL wxWindow
+        #define sm_classwxWindowMGL sm_classwxWindow
+    #endif // wxUniv
+    #include "wx/mgl/window.h"

 #elif defined(__WXMAC__)
 #elif defined(__WXMAC__)

+    #ifdef __WXUNIVERSAL__
+        #define wxWindowNative wxWindowMac
+    #else // !wxUniv
+        #define wxWindowMac wxWindow
+        #define sm_classwxWindowMac sm_classwxWindow
+    #endif // wxUniv

     #include "wx/mac/window.h"
     #include "wx/mac/window.h"

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

+// for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
+// for the native ports we already have defined it above
+#if defined(__WXUNIVERSAL__)
+    #ifndef wxWindowNative
+        #error "wxWindowNative must be defined above!"
+    #endif
+
+    #include "wx/univ/window.h"
+#endif // wxUniv
+

 // ----------------------------------------------------------------------------
 // inline functions which couldn't be declared in the class body because of
 // forward dependencies
 // ----------------------------------------------------------------------------
 // inline functions which couldn't be declared in the class body because of
 // forward dependencies


@@ -762,11 +1059,21 @@ inline wxWindow *wxWindowBase::GetGrandParent() const
 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------

-// global function
+// global functions

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-extern wxWindow* WXDLLEXPORT wxGetActiveWindow();
-inline int WXDLLEXPORT NewControlId() { return wxWindowBase::NewControlId(); }
+// Find the wxWindow at the current mouse position, also returning the mouse
+// position.
+WXDLLEXPORT extern wxWindow* wxFindWindowAtPointer(wxPoint& pt);
+
+// Get the current mouse position.
+WXDLLEXPORT extern wxPoint wxGetMousePosition();
+
+// get the currently active window of this application or NULL
+WXDLLEXPORT extern wxWindow *wxGetActiveWindow();
+
+// deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
+inline int NewControlId() { return wxWindowBase::NewControlId(); }

 
 #endif
     // _WX_WINDOW_H_BASE_
 
 #endif
     // _WX_WINDOW_H_BASE_