only declare AddProcessCallback for wxMotif and wxGTK

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

diff --git a/include/wx/window.h b/include/wx/window.h
index f0db87e1358d516780f8a8d022f3cb7b2868e86a..d953c23b7e6fa4b8d9a45b1bc165a978b02c5d36 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -71,9 +71,7 @@ class WXDLLIMPEXP_FWD_CORE wxControl;
 class WXDLLIMPEXP_FWD_CORE wxCursor;
 class WXDLLIMPEXP_FWD_CORE wxDC;
 class WXDLLIMPEXP_FWD_CORE wxDropTarget;
 class WXDLLIMPEXP_FWD_CORE wxCursor;
 class WXDLLIMPEXP_FWD_CORE wxDC;
 class WXDLLIMPEXP_FWD_CORE wxDropTarget;

-class WXDLLIMPEXP_FWD_CORE wxItemResource;

 class WXDLLIMPEXP_FWD_CORE wxLayoutConstraints;
 class WXDLLIMPEXP_FWD_CORE wxLayoutConstraints;

-class WXDLLIMPEXP_FWD_CORE wxResourceTable;

 class WXDLLIMPEXP_FWD_CORE wxSizer;
 class WXDLLIMPEXP_FWD_CORE wxToolTip;
 class WXDLLIMPEXP_FWD_CORE wxWindowBase;
 class WXDLLIMPEXP_FWD_CORE wxSizer;
 class WXDLLIMPEXP_FWD_CORE wxToolTip;
 class WXDLLIMPEXP_FWD_CORE wxWindowBase;


@@ -89,7 +87,7 @@ class WXDLLIMPEXP_FWD_CORE wxAccessible;
 // ----------------------------------------------------------------------------
 
 // struct containing all the visual attributes of a control
 // ----------------------------------------------------------------------------
 
 // struct containing all the visual attributes of a control

-struct WXDLLEXPORT wxVisualAttributes
+struct WXDLLIMPEXP_CORE wxVisualAttributes

 {
     // the font used for control label/text inside it
     wxFont font;
 {
     // the font used for control label/text inside it
     wxFont font;


@@ -131,13 +129,13 @@ enum wxShowEffect
 // (pseudo)template list classes
 // ----------------------------------------------------------------------------
 
 // (pseudo)template list classes
 // ----------------------------------------------------------------------------
 

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

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

-extern WXDLLEXPORT_DATA(wxWindowList) wxTopLevelWindows;
+extern WXDLLIMPEXP_DATA_CORE(wxWindowList) wxTopLevelWindows;

 extern WXDLLIMPEXP_DATA_CORE(wxList) wxPendingDelete;
 
 // ----------------------------------------------------------------------------
 extern WXDLLIMPEXP_DATA_CORE(wxList) wxPendingDelete;
 
 // ----------------------------------------------------------------------------


@@ -151,7 +149,7 @@ extern WXDLLIMPEXP_DATA_CORE(wxList) wxPendingDelete;
 // temporarily switches event handlers).
 // ----------------------------------------------------------------------------
 
 // temporarily switches event handlers).
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxWindowBase : public wxEvtHandler
+class WXDLLIMPEXP_CORE wxWindowBase : public wxEvtHandler

 {
 public:
     // creating the window
 {
 public:
     // creating the window


@@ -230,17 +228,21 @@ public:
     void SetId( wxWindowID winid ) { m_windowId = winid; }
     wxWindowID GetId() const { return m_windowId; }
 
     void SetId( wxWindowID winid ) { m_windowId = winid; }
     wxWindowID GetId() const { return m_windowId; }
 

-        // returns true if this id value belong to the range reserved for the
-        // auto-generated (by NewControlId()) ids (they're always negative)
-    static bool IsAutoGeneratedId(wxWindowID id);
-

         // generate a unique id (or count of them consecutively), returns a
         // generate a unique id (or count of them consecutively), returns a

-        // valid id in IsAutoGeneratedId() range or wxID_NONE if failed
-    static wxWindowID NewControlId(int count = 1);
+        // valid id in the auto-id range or wxID_NONE if failed.  If using
+        // autoid management, it will mark the id as reserved until it is
+        // used (by assigning it to a wxWindowIDRef) or unreserved.
+    static wxWindowID NewControlId(int count = 1)
+    {
+        return wxIdManager::ReserveId(count);
+    }

 
 

-        // mark an id previously returned by NewControlId() as being unused any
-        // more so that it can be reused again for another control later
-    static void ReleaseControlId(wxWindowID id);
+        // If an ID generated from NewControlId is not assigned to a wxWindowIDRef,
+        // it must be unreserved
+    static void UnreserveControlId(wxWindowID id, int count = 1)
+    {
+        wxIdManager::UnreserveId(id, count);
+    }

 
 
     // moving/resizing
 
 
     // moving/resizing


@@ -353,6 +355,10 @@ public:
         return wxRect(GetClientAreaOrigin(), GetClientSize());
     }
 
         return wxRect(GetClientAreaOrigin(), GetClientSize());
     }
 

+    // client<->window size conversion
+    virtual wxSize ClientToWindowSize(const wxSize& size) const;
+    virtual wxSize WindowToClientSize(const wxSize& size) const;
+

         // get the size best suited for the window (in fact, minimal
         // acceptable size using which it will still look "nice" in
         // most situations)
         // get the size best suited for the window (in fact, minimal
         // acceptable size using which it will still look "nice" in
         // most situations)


@@ -427,16 +433,14 @@ public:
                        const wxSize& incSize=wxDefaultSize)
     { DoSetSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y, incSize.x, incSize.y); }
 
                        const wxSize& incSize=wxDefaultSize)
     { DoSetSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y, incSize.x, incSize.y); }
 

-        // Methods for setting virtual size hints
-        // FIXME: What are virtual size hints?

 
 

-    virtual void SetVirtualSizeHints( int minW, int minH,
-                                      int maxW = wxDefaultCoord, int maxH = wxDefaultCoord );
-    void SetVirtualSizeHints( const wxSize& minSize,
-                              const wxSize& maxSize=wxDefaultSize)
-    {
-        SetVirtualSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y);
-    }
+#if WXWIN_COMPATIBILITY_2_8
+    // these are useless and do nothing since wxWidgets 2.9
+    wxDEPRECATED( virtual void SetVirtualSizeHints( int minW, int minH,
+                                      int maxW = wxDefaultCoord, int maxH = wxDefaultCoord ) );
+    wxDEPRECATED( void SetVirtualSizeHints( const wxSize& minSize,
+                                            const wxSize& maxSize=wxDefaultSize) );
+#endif // WXWIN_COMPATIBILITY_2_8

 
 
         // Call these to override what GetBestSize() returns. This
 
 
         // Call these to override what GetBestSize() returns. This


@@ -445,12 +449,24 @@ public:
     virtual void SetMinSize(const wxSize& minSize) { m_minWidth = minSize.x; m_minHeight = minSize.y; }
     virtual void SetMaxSize(const wxSize& maxSize) { m_maxWidth = maxSize.x; m_maxHeight = maxSize.y; }
 
     virtual void SetMinSize(const wxSize& minSize) { m_minWidth = minSize.x; m_minHeight = minSize.y; }
     virtual void SetMaxSize(const wxSize& maxSize) { m_maxWidth = maxSize.x; m_maxHeight = maxSize.y; }
 

+        // Like Set*Size, but for client, not window, size
+    virtual void SetMinClientSize(const wxSize& size)
+        { SetMinSize(ClientToWindowSize(size)); }
+    virtual void SetMaxClientSize(const wxSize& size)
+        { SetMaxSize(ClientToWindowSize(size)); }
+

         // Override these methods to impose restrictions on min/max size.
         // The easier way is to call SetMinSize() and SetMaxSize() which
         // will have the same effect. Doing both is non-sense.
     virtual wxSize GetMinSize() const { return wxSize(m_minWidth, m_minHeight); }
     virtual wxSize GetMaxSize() const { return wxSize(m_maxWidth, m_maxHeight); }
 
         // Override these methods to impose restrictions on min/max size.
         // The easier way is to call SetMinSize() and SetMaxSize() which
         // will have the same effect. Doing both is non-sense.
     virtual wxSize GetMinSize() const { return wxSize(m_minWidth, m_minHeight); }
     virtual wxSize GetMaxSize() const { return wxSize(m_maxWidth, m_maxHeight); }
 

+        // Like Get*Size, but for client, not window, size
+    virtual wxSize GetMinClientSize() const
+        { return WindowToClientSize(GetMinSize()); }
+    virtual wxSize GetMaxClientSize() const
+        { return WindowToClientSize(GetMaxSize()); }
+

         // Get the min and max values one by one
     int GetMinWidth() const { return GetMinSize().x; }
     int GetMinHeight() const { return GetMinSize().y; }
         // Get the min and max values one by one
     int GetMinWidth() const { return GetMinSize().x; }
     int GetMinHeight() const { return GetMinSize().y; }


@@ -501,10 +517,10 @@ public:
     virtual wxSize GetWindowBorderSize() const;
 
     // wxSizer and friends use this to give a chance to a component to recalc
     virtual wxSize GetWindowBorderSize() const;
 
     // wxSizer and friends use this to give a chance to a component to recalc

-    // its min size once one of the final size components is known. Override 
-    // this function when that is useful (such as for wxStaticText which can 
+    // its min size once one of the final size components is known. Override
+    // this function when that is useful (such as for wxStaticText which can

     // stretch over several lines). Parameter availableOtherDir
     // stretch over several lines). Parameter availableOtherDir

-    // tells the item how much more space there is available in the opposite 
+    // tells the item how much more space there is available in the opposite

     // direction (-1 if unknown).
     virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
     { return false; }
     // direction (-1 if unknown).
     virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
     { return false; }


@@ -620,6 +636,11 @@ public:
 
     static wxWindow *DoFindFocus() /* = 0: implement in derived classes */;
 
 
     static wxWindow *DoFindFocus() /* = 0: implement in derived classes */;
 

+        // return true if the window has focus (handles composite windows
+        // correctly - returns true if GetMainWindowOfCompositeControl()
+        // has focus)
+    virtual bool HasFocus() const;
+

         // can this window have focus in principle?
         //
         // the difference between AcceptsFocus[FromKeyboard]() and CanAcceptFocus
         // can this window have focus in principle?
         //
         // the difference between AcceptsFocus[FromKeyboard]() and CanAcceptFocus


@@ -671,6 +692,11 @@ public:
     bool Navigate(int flags = wxNavigationKeyEvent::IsForward)
         { return m_parent && ((wxWindowBase *)m_parent)->DoNavigateIn(flags); }
 
     bool Navigate(int flags = wxNavigationKeyEvent::IsForward)
         { return m_parent && ((wxWindowBase *)m_parent)->DoNavigateIn(flags); }
 

+    // this function will generate the appropriate call to Navigate() if the
+    // key event is one normally used for keyboard navigation and return true
+    // in this case
+    bool HandleAsNavigationKey(const wxKeyEvent& event);
+

         // move this window just before/after the specified one in tab order
         // (the other window must be our sibling!)
     void MoveBeforeInTabOrder(wxWindow *win)
         // move this window just before/after the specified one in tab order
         // (the other window must be our sibling!)
     void MoveBeforeInTabOrder(wxWindow *win)


@@ -862,13 +888,13 @@ public:
     virtual void ClearBackground();
 
         // freeze the window: don't redraw it until it is thawed
     virtual void ClearBackground();
 
         // freeze the window: don't redraw it until it is thawed

-    virtual void Freeze() { }
+    void Freeze();

 
         // thaw the window: redraw it after it had been frozen
 
         // thaw the window: redraw it after it had been frozen

-    virtual void Thaw() { }
+    void Thaw();

 
         // return true if window had been frozen and not unthawed yet
 
         // return true if window had been frozen and not unthawed yet

-    virtual bool IsFrozen() const { return false; }
+    bool IsFrozen() const { return m_freezeCount != 0; }

 
         // adjust DC for drawing on this window
     virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { }
 
         // adjust DC for drawing on this window
     virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { }


@@ -1050,9 +1076,8 @@ public:
     // show popup menu at the given position, generate events for the items
     // selected in it
     bool PopupMenu(wxMenu *menu, const wxPoint& pos = wxDefaultPosition)
     // show popup menu at the given position, generate events for the items
     // selected in it
     bool PopupMenu(wxMenu *menu, const wxPoint& pos = wxDefaultPosition)

-        { return DoPopupMenu(menu, pos.x, pos.y); }
-    bool PopupMenu(wxMenu *menu, int x, int y)
-        { return DoPopupMenu(menu, x, y); }
+        { return PopupMenu(menu, pos.x, pos.y); }
+    bool PopupMenu(wxMenu *menu, int x, int y);

 
     // simply return the id of the selected item or wxID_NONE without
     // generating any events
 
     // simply return the id of the selected item or wxID_NONE without
     // generating any events


@@ -1125,9 +1150,13 @@ public:
 #if wxUSE_HELP
         // associate this help text with this window
     void SetHelpText(const wxString& text);
 #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);
+
+#if WXWIN_COMPATIBILITY_2_8
+    // Associate this help text with all windows with the same id as this one.
+    // Don't use this, do wxHelpProvider::Get()->AddHelp(id, text);
+    wxDEPRECATED( void SetHelpTextForId(const wxString& text) );
+#endif // WXWIN_COMPATIBILITY_2_8
+

         // get the help string associated with the given position in this window
         //
         // notice that pt may be invalid if event origin is keyboard or unknown
         // get the help string associated with the given position in this window
         //
         // notice that pt may be invalid if event origin is keyboard or unknown


@@ -1355,7 +1384,7 @@ protected:
 
     // the window id - a number which uniquely identifies a window among
     // its siblings unless it is wxID_ANY
 
     // the window id - a number which uniquely identifies a window among
     // its siblings unless it is wxID_ANY

-    wxWindowID           m_windowId;
+    wxWindowIDRef        m_windowId;

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


@@ -1424,10 +1453,6 @@ protected:
     // Layout() window automatically when its size changes?
     bool                 m_autoLayout:1;
 
     // Layout() window automatically when its size changes?
     bool                 m_autoLayout:1;
 

-    // true if we had automatically allocated the id value for this window
-    // (i.e. wxID_ANY had been passed to the ctor)
-    bool                 m_freeId:1;
-

     // window state
     bool                 m_isShown:1;
     bool                 m_isEnabled:1;
     // window state
     bool                 m_isShown:1;
     bool                 m_isEnabled:1;


@@ -1463,11 +1488,6 @@ protected:
 
     wxScrollHelper       *m_scrollHelper;
 
 
     wxScrollHelper       *m_scrollHelper;
 

-    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
     wxWindowVariant       m_windowVariant ;
 
     // override this to change the default (i.e. used when no style is


@@ -1527,14 +1547,6 @@ protected:
     // same size as it would have after a call to Fit()
     virtual wxSize DoGetBestSize() const;
 
     // same size as it would have after a call to Fit()
     virtual wxSize DoGetBestSize() const;
 

-    // called from DoGetBestSize() to convert best virtual size (returned by
-    // the window sizer) to the best size for the window itself; this is
-    // overridden at wxScrolledWindow level to clump down virtual size to real
-    virtual wxSize GetWindowSizeForVirtualSize(const wxSize& size) const
-    {
-        return size;
-    }
-

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


@@ -1581,6 +1593,12 @@ protected:
     // implements the window variants
     virtual void DoSetWindowVariant( wxWindowVariant variant ) ;
 
     // implements the window variants
     virtual void DoSetWindowVariant( wxWindowVariant variant ) ;
 

+
+    // really freeze/thaw the window (should have port-specific implementation)
+    virtual void DoFreeze() { }
+    virtual void DoThaw() { }
+
+

     // Must be called when mouse capture is lost to send
     // wxMouseCaptureLostEvent to windows on capture stack.
     static void NotifyCaptureLost();
     // Must be called when mouse capture is lost to send
     // wxMouseCaptureLostEvent to windows on capture stack.
     static void NotifyCaptureLost();


@@ -1601,11 +1619,19 @@ private:
 
     // the stack of windows which have captured the mouse
     static struct WXDLLIMPEXP_FWD_CORE wxWindowNext *ms_winCaptureNext;
 
     // the stack of windows which have captured the mouse
     static struct WXDLLIMPEXP_FWD_CORE wxWindowNext *ms_winCaptureNext;

+

     // the window that currently has mouse capture
     static wxWindow *ms_winCaptureCurrent;
     // the window that currently has mouse capture
     static wxWindow *ms_winCaptureCurrent;

+

     // indicates if execution is inside CaptureMouse/ReleaseMouse
     static bool ms_winCaptureChanging;
 
     // indicates if execution is inside CaptureMouse/ReleaseMouse
     static bool ms_winCaptureChanging;
 

+
+    // number of Freeze() calls minus the number of Thaw() calls: we're frozen
+    // (i.e. not being updated) if it is positive
+    unsigned int m_freezeCount;
+
+

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


@@ -1732,21 +1758,21 @@ inline wxWindow *wxWindowBase::GetGrandParent() const
 
 // Find the wxWindow at the current mouse position, also returning the mouse
 // position.
 
 // Find the wxWindow at the current mouse position, also returning the mouse
 // position.

-extern WXDLLEXPORT wxWindow* wxFindWindowAtPointer(wxPoint& pt);
+extern WXDLLIMPEXP_CORE wxWindow* wxFindWindowAtPointer(wxPoint& pt);

 
 // Get the current mouse position.
 
 // Get the current mouse position.

-extern WXDLLEXPORT wxPoint wxGetMousePosition();
+extern WXDLLIMPEXP_CORE wxPoint wxGetMousePosition();

 
 // get the currently active window of this application or NULL
 
 // get the currently active window of this application or NULL

-extern WXDLLEXPORT wxWindow *wxGetActiveWindow();
+extern WXDLLIMPEXP_CORE wxWindow *wxGetActiveWindow();

 
 // get the (first) top level parent window
 
 // get the (first) top level parent window

-WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win);
+WXDLLIMPEXP_CORE wxWindow* wxGetTopLevelParent(wxWindow *win);

 
 #if WXWIN_COMPATIBILITY_2_6
     // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
 
 #if WXWIN_COMPATIBILITY_2_6
     // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()

-    wxDEPRECATED( int NewControlId() );
-    inline int NewControlId() { return wxWindowBase::NewControlId(); }
+    wxDEPRECATED( wxWindowID NewControlId() );
+    inline wxWindowID NewControlId() { return wxWindowBase::NewControlId(); }

 #endif // WXWIN_COMPATIBILITY_2_6
 
 #if wxUSE_ACCESSIBILITY
 #endif // WXWIN_COMPATIBILITY_2_6
 
 #if wxUSE_ACCESSIBILITY


@@ -1754,7 +1780,7 @@ WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win);
 // accessible object for windows
 // ----------------------------------------------------------------------------
 
 // accessible object for windows
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxWindowAccessible: public wxAccessible
+class WXDLLIMPEXP_CORE wxWindowAccessible: public wxAccessible

 {
 public:
     wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); }
 {
 public:
     wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); }