Clarified wxPropertyGrid::HitTest() docs

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

diff --git a/include/wx/window.h b/include/wx/window.h
index 33d33ce50d8e3690bb7344ecbbae5ae3e9c9ef57..cc879cfd98a70b09f402a38e91e4b30ff2063dd9 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -87,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;


@@ -118,24 +118,36 @@ enum wxWindowVariant
 // valid values for Show/HideWithEffect()
 enum wxShowEffect
 {
 // valid values for Show/HideWithEffect()
 enum wxShowEffect
 {

-    wxSHOW_EFFECT_ROLL,
-    wxSHOW_EFFECT_SLIDE,
+    wxSHOW_EFFECT_ROLL_TO_LEFT,
+    wxSHOW_EFFECT_ROLL_TO_RIGHT,
+    wxSHOW_EFFECT_ROLL_TO_TOP,
+    wxSHOW_EFFECT_ROLL_TO_BOTTOM,
+    wxSHOW_EFFECT_SLIDE_TO_LEFT,
+    wxSHOW_EFFECT_SLIDE_TO_RIGHT,
+    wxSHOW_EFFECT_SLIDE_TO_TOP,
+    wxSHOW_EFFECT_SLIDE_TO_BOTTOM,

     wxSHOW_EFFECT_BLEND,
     wxSHOW_EFFECT_EXPAND,
     wxSHOW_EFFECT_MAX
 };
 
     wxSHOW_EFFECT_BLEND,
     wxSHOW_EFFECT_EXPAND,
     wxSHOW_EFFECT_MAX
 };
 

+// flags for SendSizeEvent()
+enum
+{
+    wxSEND_EVENT_POST = 1
+};
+

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


@@ -149,7 +161,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


@@ -187,7 +199,7 @@ public:
     bool DestroyChildren();
 
         // is the window being deleted?
     bool DestroyChildren();
 
         // is the window being deleted?

-    bool IsBeingDeleted() const { return m_isBeingDeleted; }
+    bool IsBeingDeleted() const;

 
     // window attributes
     // -----------------
 
     // window attributes
     // -----------------


@@ -362,12 +374,8 @@ public:
         // 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)

-    wxSize GetBestSize() const
-    {
-        if (m_bestSizeCache.IsFullySpecified())
-            return m_bestSizeCache;
-        return DoGetBestSize();
-    }
+    wxSize GetBestSize() const;
+    

     void GetBestSize(int *w, int *h) const
     {
         wxSize s = GetBestSize();
     void GetBestSize(int *w, int *h) const
     {
         wxSize s = GetBestSize();


@@ -390,7 +398,7 @@ public:
         // This function will merge the window's best size into the window's
         // minimum size, giving priority to the min size components, and
         // returns the results.
         // This function will merge the window's best size into the window's
         // minimum size, giving priority to the min size components, and
         // returns the results.

-    wxSize GetEffectiveMinSize() const;
+    virtual wxSize GetEffectiveMinSize() const;

     wxDEPRECATED( wxSize GetBestFittingSize() const );  // replaced by GetEffectiveMinSize
     wxDEPRECATED( wxSize GetAdjustedMinSize() const );  // replaced by GetEffectiveMinSize
 
     wxDEPRECATED( wxSize GetBestFittingSize() const );  // replaced by GetEffectiveMinSize
     wxDEPRECATED( wxSize GetAdjustedMinSize() const );  // replaced by GetEffectiveMinSize
 


@@ -446,8 +454,8 @@ public:
         // Call these to override what GetBestSize() returns. This
         // method is only virtual because it is overriden in wxTLW
         // as a different API for SetSizeHints().
         // Call these to override what GetBestSize() returns. This
         // method is only virtual because it is overriden in wxTLW
         // as a different API for SetSizeHints().

-    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);
+    virtual void SetMaxSize(const wxSize& maxSize);

 
         // Like Set*Size, but for client, not window, size
     virtual void SetMinClientSize(const wxSize& size)
 
         // Like Set*Size, but for client, not window, size
     virtual void SetMinClientSize(const wxSize& size)


@@ -517,13 +525,40 @@ 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).
     // direction (-1 if unknown).

-    virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
-    { return false; }
+    virtual bool
+    InformFirstDirection(int WXUNUSED(direction),
+                         int WXUNUSED(size),
+                         int WXUNUSED(availableOtherDir))
+    {
+        return false;
+    }
+
+    // sends a size event to the window using its current size -- this has an
+    // effect of refreshing the window layout
+    //
+    // by default the event is sent, i.e. processed immediately, but if flags
+    // value includes wxSEND_EVENT_POST then it's posted, i.e. only schedule
+    // for later processing
+    virtual void SendSizeEvent(int flags = 0);
+
+    // this is a safe wrapper for GetParent()->SendSizeEvent(): it checks that
+    // we have a parent window and it's not in process of being deleted
+    //
+    // this is used by controls such as tool/status bars changes to which must
+    // also result in parent re-layout
+    void SendSizeEventToParent(int flags = 0);
+
+    // this is a more readable synonym for SendSizeEvent(wxSEND_EVENT_POST)
+    void PostSizeEvent() { SendSizeEvent(wxSEND_EVENT_POST); }
+
+    // this is the same as SendSizeEventToParent() but using PostSizeEvent()
+    void PostSizeEventToParent() { SendSizeEventToParent(wxSEND_EVENT_POST); }
+

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


@@ -538,27 +573,15 @@ public:
         //
         // timeout specifies how long the animation should take, in ms, the
         // default value of 0 means to use the default (system-dependent) value
         //
         // timeout specifies how long the animation should take, in ms, the
         // default value of 0 means to use the default (system-dependent) value

-        //
-        // direction is only used with wxSHOW_EFFECT_ROLL and SLIDE values
-    virtual bool ShowWithEffect(wxShowEffect effect,
-                                unsigned timeout = 0,
-                                wxDirection dir = wxBOTTOM)
+    virtual bool ShowWithEffect(wxShowEffect WXUNUSED(effect),
+                                unsigned WXUNUSED(timeout) = 0)

     {
     {

-        wxUnusedVar(effect);
-        wxUnusedVar(timeout);
-        wxUnusedVar(dir);
-

         return Show();
     }
 
         return Show();
     }
 

-    virtual bool HideWithEffect(wxShowEffect effect,
-                                unsigned timeout = 0,
-                                wxDirection dir = wxBOTTOM)
+    virtual bool HideWithEffect(wxShowEffect WXUNUSED(effect),
+                                unsigned WXUNUSED(timeout) = 0)

     {
     {

-        wxUnusedVar(effect);
-        wxUnusedVar(timeout);
-        wxUnusedVar(dir);
-

         return Hide();
     }
 
         return Hide();
     }
 


@@ -765,7 +788,7 @@ public:
 
         // replace the event handler (allows to completely subclass the
         // window)
 
         // replace the event handler (allows to completely subclass the
         // window)

-    void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; }
+    void SetEventHandler( wxEvtHandler *handler );

 
         // push/pop event handler: allows to chain a custom event handler to
         // alreasy existing ones
 
         // push/pop event handler: allows to chain a custom event handler to
         // alreasy existing ones


@@ -779,13 +802,44 @@ public:
         // be there)
     bool RemoveEventHandler(wxEvtHandler *handler);
 
         // be there)
     bool RemoveEventHandler(wxEvtHandler *handler);
 

-    // Process an event by calling GetEventHandler()->ProcessEvent() and
-    // handling any exceptions thrown by event handlers. It's mostly useful
-    // when processing wx events when called from C code (e.g. in GTK+
-    // callback) when the exception wouldn't correctly propagate to
-    // wxEventLoop.
+        // Process an event by calling GetEventHandler()->ProcessEvent(): this
+        // is a straightforward replacement for ProcessEvent() itself which
+        // shouldn't be used directly with windows as it doesn't take into
+        // account any event handlers associated with the window
+    bool ProcessWindowEvent(wxEvent& event)
+        { return GetEventHandler()->ProcessEvent(event); }
+
+        // Process an event by calling GetEventHandler()->ProcessEvent() and
+        // handling any exceptions thrown by event handlers. It's mostly useful
+        // when processing wx events when called from C code (e.g. in GTK+
+        // callback) when the exception wouldn't correctly propagate to
+        // wxEventLoop.

     bool HandleWindowEvent(wxEvent& event) const;
 
     bool HandleWindowEvent(wxEvent& event) const;
 

+        // disable wxEvtHandler double-linked list mechanism:
+    virtual void SetNextHandler(wxEvtHandler *handler);
+    virtual void SetPreviousHandler(wxEvtHandler *handler);
+
+protected:
+
+    // NOTE: we change the access specifier of the following wxEvtHandler functions
+    //       so that the user won't be able to call them directly.
+    //       Calling wxWindow::ProcessEvent in fact only works when there are NO
+    //       event handlers pushed on the window.
+    //       To ensure correct operation, instead of wxWindow::ProcessEvent
+    //       you must always call wxWindow::GetEventHandler()->ProcessEvent()
+    //       or HandleWindowEvent().
+    //       The same holds for all other wxEvtHandler functions.
+
+    using wxEvtHandler::ProcessEvent;
+    using wxEvtHandler::ProcessThreadEvent;
+    using wxEvtHandler::SafelyProcessEvent;
+    using wxEvtHandler::ProcessPendingEvents;
+    using wxEvtHandler::AddPendingEvent;
+    using wxEvtHandler::QueueEvent;
+
+public:
+

     // validators
     // ----------
 
     // validators
     // ----------
 


@@ -888,16 +942,10 @@ 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

-    void Freeze() { if ( !m_freezeCount++ ) DoFreeze(); }
+    void Freeze();

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

-    void Thaw()
-    {
-        wxASSERT_MSG( m_freezeCount, "Thaw() without matching Freeze()" );
-
-        if ( !--m_freezeCount )
-            DoThaw();
-    }
+    void Thaw();

 
         // return true if window had been frozen and not unthawed yet
     bool IsFrozen() const { return m_freezeCount != 0; }
 
         // return true if window had been frozen and not unthawed yet
     bool IsFrozen() const { return m_freezeCount != 0; }


@@ -1016,8 +1064,8 @@ public:
         // font
     virtual void GetTextExtent(const wxString& string,
                                int *x, int *y,
         // font
     virtual void GetTextExtent(const wxString& string,
                                int *x, int *y,

-                               int *descent = (int *) NULL,
-                               int *externalLeading = (int *) NULL,
+                               int *descent = NULL,
+                               int *externalLeading = NULL,

                                const wxFont *theFont = (const wxFont *) NULL)
                                const = 0;
 
                                const wxFont *theFont = (const wxFont *) NULL)
                                const = 0;
 


@@ -1120,7 +1168,7 @@ public:
 
         // scroll window to the specified position
     virtual void ScrollWindow( int dx, int dy,
 
         // scroll window to the specified position
     virtual void ScrollWindow( int dx, int dy,

-                               const wxRect* rect = (wxRect *) NULL ) = 0;
+                               const wxRect* rect = NULL ) = 0;

 
         // scrolls window by line/page: note that not all controls support this
         //
 
         // scrolls window by line/page: note that not all controls support this
         //


@@ -1156,9 +1204,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


@@ -1183,16 +1235,20 @@ public:
 #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 );

-        // attach a tooltip to the window
+        // attach a tooltip to the window, pointer can be NULL to remove
+        // existing tooltip

     void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); }
     void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); }

+        // more readable synonym for SetToolTip(NULL)
+    void UnsetToolTip() { SetToolTip(NULL); }

         // get the associated tooltip or NULL if none
     wxToolTip* GetToolTip() const { return m_tooltip; }
         // get the associated tooltip or NULL if none
     wxToolTip* GetToolTip() const { return m_tooltip; }

-    wxString GetToolTipText() const ;
-#else
+    wxString GetToolTipText() const;
+#else // !wxUSE_TOOLTIPS

         // make it much easier to compile apps in an environment
         // that doesn't support tooltips, such as PocketPC
         // make it much easier to compile apps in an environment
         // that doesn't support tooltips, such as PocketPC

-    inline void SetToolTip( const wxString & WXUNUSED(tip) ) {}
-#endif // wxUSE_TOOLTIPS
+    void SetToolTip(const wxString & WXUNUSED(tip)) { }
+    void UnsetToolTip() { }
+#endif // wxUSE_TOOLTIPS/!wxUSE_TOOLTIPS

 
     // drag and drop
     // -------------
 
     // drag and drop
     // -------------


@@ -1201,6 +1257,16 @@ public:
         // NULL; it's owned by the window and will be deleted by it)
     virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0;
     virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; }
         // NULL; it's owned by the window and will be deleted by it)
     virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0;
     virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; }

+
+    // Accept files for dragging
+    virtual void DragAcceptFiles(bool accept)
+#ifdef __WXMSW__
+    // it does have common implementation but not for MSW which has its own
+    // native version of it
+    = 0
+#endif // __WXMSW__
+    ;
+

 #endif // wxUSE_DRAG_AND_DROP
 
     // constraints and sizers
 #endif // wxUSE_DRAG_AND_DROP
 
     // constraints and sizers


@@ -1363,7 +1429,8 @@ protected:
     void SatisfyConstraints();
 #endif // wxUSE_CONSTRAINTS
 
     void SatisfyConstraints();
 #endif // wxUSE_CONSTRAINTS
 

-    // Send the wxWindowDestroyEvent
+    // Send the wxWindowDestroyEvent if not done yet and sets m_isBeingDeleted
+    // to true

     void SendDestroyEvent();
 
     // returns the main window of composite control; this is the window
     void SendDestroyEvent();
 
     // returns the main window of composite control; this is the window


@@ -1612,8 +1679,9 @@ private:
     void NotifyWindowOnEnableChange(bool enabled);
 
 #if wxUSE_MENUS
     void NotifyWindowOnEnableChange(bool enabled);
 
 #if wxUSE_MENUS

-    // temporary event handler used by GetPopupMenuSelectionFromUser()
+    // temporary event handlers used by GetPopupMenuSelectionFromUser()

     void InternalOnPopupMenu(wxCommandEvent& event);
     void InternalOnPopupMenu(wxCommandEvent& event);

+    void InternalOnPopupMenuUpdate(wxUpdateUIEvent& event);

 
     // implementation of the public GetPopupMenuSelectionFromUser() method
     int DoGetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y);
 
     // implementation of the public GetPopupMenuSelectionFromUser() method
     int DoGetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y);


@@ -1635,7 +1703,7 @@ private:
 
 
     DECLARE_ABSTRACT_CLASS(wxWindowBase)
 
 
     DECLARE_ABSTRACT_CLASS(wxWindowBase)

-    DECLARE_NO_COPY_CLASS(wxWindowBase)
+    wxDECLARE_NO_COPY_CLASS(wxWindowBase);

     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };
 


@@ -1717,7 +1785,7 @@ inline void wxWindowBase::SetInitialBestSize(const wxSize& size)
     #else // !wxUniv
         #define wxWindowMac wxWindow
     #endif // wxUniv
     #else // !wxUniv
         #define wxWindowMac wxWindow
     #endif // wxUniv

-    #include "wx/mac/window.h"
+    #include "wx/osx/window.h"

 #elif defined(__WXCOCOA__)
     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowCocoa
 #elif defined(__WXCOCOA__)
     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowCocoa


@@ -1751,7 +1819,7 @@ inline void wxWindowBase::SetInitialBestSize(const wxSize& size)
 
 inline wxWindow *wxWindowBase::GetGrandParent() const
 {
 
 inline wxWindow *wxWindowBase::GetGrandParent() const
 {

-    return m_parent ? m_parent->GetParent() : (wxWindow *)NULL;
+    return m_parent ? m_parent->GetParent() : NULL;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -1760,16 +1828,16 @@ 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()


@@ -1782,7 +1850,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); }