A little different fix for how to delay the call to __wxCleanup

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

diff --git a/include/wx/window.h b/include/wx/window.h
index 549e6a61c5fc9bf2c61a0ff86a32fcf858a84ab4..af98d65c858a4d8387fab1404ddcaa18678392e9 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        window.h
+// Name:        wx/window.h

 // Purpose:     wxWindowBase class - the interface of wxWindow
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     wxWindowBase class - the interface of wxWindow
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -32,6 +32,11 @@
 
 #include "wx/validate.h"        // for wxDefaultValidator (always include it)
 
 
 #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
 #if wxUSE_ACCEL
     #include "wx/accel.h"
 #endif // wxUSE_ACCEL


@@ -49,7 +54,6 @@
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxCaret;
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxCaret;

-class WXDLLEXPORT wxClientData;

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


@@ -74,39 +78,6 @@ WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class
 
 WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows;
 
 
 WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows;
 

-// ----------------------------------------------------------------------------
-// helper classes used by [SG]etClientObject/Data
-//
-// TODO move into a separate header?
-// ----------------------------------------------------------------------------
-
-// what kind of client data do we have?
-enum wxClientDataType
-{
-    wxClientData_None,    // we don't know yet because we don't have it at all
-    wxClientData_Object,  // our client data is typed and we own it
-    wxClientData_Void     // client data is untyped and we don't own it
-};
-
-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.


@@ -170,10 +141,14 @@ 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)


@@ -318,8 +293,8 @@ 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 );
 

-    int GetMinWidth() const { return m_minWidth; }
-    int GetMinHeight() const { return m_minHeight; }
+    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; }
 
     int GetMaxWidth() const { return m_maxWidth; }
     int GetMaxHeight() const { return m_maxHeight; }
 


@@ -361,8 +336,8 @@ public:
     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; }
 

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

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


@@ -378,6 +353,17 @@ public:
         // click it
     virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
 
         // 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
     // -------------------------
 


@@ -422,6 +408,13 @@ public:
     void PushEventHandler( wxEvtHandler *handler );
     wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
 
     void PushEventHandler( wxEvtHandler *handler );
     wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
 

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


@@ -432,18 +425,6 @@ public:
     virtual wxValidator *GetValidator() { return m_windowValidator; }
 #endif // wxUSE_VALIDATORS
 
     virtual wxValidator *GetValidator() { return m_windowValidator; }
 #endif // wxUSE_VALIDATORS
 

-    // client data
-    // -----------
-
-        // 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 - but not both of them
-    void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
-    wxClientData *GetClientObject() const { return DoGetClientObject(); }
-
-    void SetClientData( void *data ) { DoSetClientData(data); }
-    void *GetClientData() const { return DoGetClientData(); }

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


@@ -491,9 +472,12 @@ 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();
 
         // get the window which currently captures the mouse or NULL
     static wxWindow *GetCapture();


@@ -663,6 +647,18 @@ 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
     // ----------------------
 
     // context-sensitive help
     // ----------------------
 


@@ -770,6 +766,22 @@ public:
         // platform-specific APIs
     virtual WXWidget GetHandle() const = 0;
 
         // platform-specific APIs
     virtual WXWidget GetHandle() const = 0;
 

+#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:
     // the window id - a number which uniquely identifies a window among
     // its siblings unless it is -1
 protected:
     // the window id - a number which uniquely identifies a window among
     // its siblings unless it is -1


@@ -815,17 +827,6 @@ protected:
     wxAcceleratorTable   m_acceleratorTable;
 #endif // wxUSE_ACCEL
 
     wxAcceleratorTable   m_acceleratorTable;
 #endif // wxUSE_ACCEL
 

-    // 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 - only one type of data can be used with the given window
-    // (i.e. you cannot set the void data and then associate the window with
-    // wxClientData or vice versa)
-    union
-    {
-        wxClientData *m_clientObject;
-        void         *m_clientData;
-    };
-

     // the tooltip for this window (may be NULL)
 #if wxUSE_TOOLTIPS
     wxToolTip           *m_tooltip;
     // the tooltip for this window (may be NULL)
 #if wxUSE_TOOLTIPS
     wxToolTip           *m_tooltip;


@@ -853,13 +854,24 @@ 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
     long                 m_windowStyle,
                          m_exStyle;
     wxString             m_windowName;
     bool                 m_themeEnabled;
 
     // window attributes
     long                 m_windowStyle,
                          m_exStyle;
     wxString             m_windowName;
     bool                 m_themeEnabled;
 

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


@@ -908,6 +920,10 @@ protected:
 
     virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const;
 
 
     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;
     // 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;


@@ -942,20 +958,19 @@ 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
 

-    // client data accessors
-    virtual void DoSetClientObject( wxClientData *data );
-    virtual wxClientData *DoGetClientObject() const;
-
-    virtual void DoSetClientData( void *data );
-    virtual void *DoGetClientData() const;
+    // 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);

 
 

-    // what kind of data do we have?
-    wxClientDataType m_clientDataType;

 
 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_ABSTRACT_CLASS(wxWindowBase)
     DECLARE_NO_COPY_CLASS(wxWindowBase)
     DECLARE_EVENT_TABLE()


@@ -984,8 +999,22 @@ private:
         #define sm_classwxWindowGTK sm_classwxWindow
     #endif // wxUniv
     #include "wx/gtk/window.h"
         #define sm_classwxWindowGTK sm_classwxWindow
     #endif // wxUniv
     #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__)
     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowMac
 #elif defined(__WXMAC__)
     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowMac