Support using GetTextExtent() with empty string to get descent in wxOSX.

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

diff --git a/include/wx/event.h b/include/wx/event.h
index 0aaa2414effda6a35efdba4dc4dfe582d2037a6c..874d42e2746cf96859ed1b93d86c1bdd826f8e08 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -986,6 +986,9 @@ public:
         m_propagationLevel = propagationLevel;
     }
 
         m_propagationLevel = propagationLevel;
     }
 

+    // This method is for internal use only and allows to get the object that
+    // is propagating this event upwards the window hierarchy, if any.
+    wxEvtHandler* GetPropagatedFrom() const { return m_propagatedFrom; }

 
     // This is for internal use only and is only called by
     // wxEvtHandler::ProcessEvent() to check whether it's the first time this
 
     // This is for internal use only and is only called by
     // wxEvtHandler::ProcessEvent() to check whether it's the first time this


@@ -1000,6 +1003,24 @@ public:
         return false;
     }
 
         return false;
     }
 

+    // This is for internal use only and is used for setting, testing and
+    // resetting of m_willBeProcessedAgain flag.
+    void SetWillBeProcessedAgain()
+    {
+        m_willBeProcessedAgain = true;
+    }
+
+    bool WillBeProcessedAgain()
+    {
+        if ( m_willBeProcessedAgain )
+        {
+            m_willBeProcessedAgain = false;
+            return true;
+        }
+
+        return false;
+    }
+

     // This is also used only internally by ProcessEvent() to check if it
     // should process the event normally or only restrict the search for the
     // event handler to this object itself.
     // This is also used only internally by ProcessEvent() to check if it
     // should process the event normally or only restrict the search for the
     // event handler to this object itself.


@@ -1038,6 +1059,10 @@ protected:
     // the parent window (if any)
     int               m_propagationLevel;
 
     // the parent window (if any)
     int               m_propagationLevel;
 

+    // The object that the event is being propagated from, initially NULL and
+    // only set by wxPropagateOnce.
+    wxEvtHandler*     m_propagatedFrom;
+

     bool              m_skipped;
     bool              m_isCommandEvent;
 
     bool              m_skipped;
     bool              m_isCommandEvent;
 


@@ -1047,12 +1072,17 @@ protected:
     // once for this event
     bool m_wasProcessed;
 
     // once for this event
     bool m_wasProcessed;
 

+    // This one is initially false too, but can be set to true to indicate that
+    // the event will be passed to another handler if it's not processed in
+    // this one.
+    bool m_willBeProcessedAgain;
+

 protected:
     wxEvent(const wxEvent&);            // for implementing Clone()
     wxEvent& operator=(const wxEvent&); // for derived classes operator=()
 
 private:
 protected:
     wxEvent(const wxEvent&);            // for implementing Clone()
     wxEvent& operator=(const wxEvent&); // for derived classes operator=()
 
 private:

-    // it needs to access our m_propagationLevel
+    // It needs to access our m_propagationLevel and m_propagatedFrom fields.

     friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
 
     // and this one needs to access our m_handlerToProcessOnlyIn
     friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
 
     // and this one needs to access our m_handlerToProcessOnlyIn


@@ -1086,26 +1116,35 @@ private:
 };
 
 /*
 };
 
 /*

- * Another one to temporarily lower propagation level.
+ * Helper used to indicate that an event is propagated upwards the window
+ * hierarchy by the given window.

  */
 class WXDLLIMPEXP_BASE wxPropagateOnce
 {
 public:
  */
 class WXDLLIMPEXP_BASE wxPropagateOnce
 {
 public:

-    wxPropagateOnce(wxEvent& event) : m_event(event)
+    // The handler argument should normally be non-NULL to allow the parent
+    // event handler to know that it's being used to process an event coming
+    // from the child, it's only NULL by default for backwards compatibility.
+    wxPropagateOnce(wxEvent& event, wxEvtHandler* handler = NULL)
+        : m_event(event),
+          m_propagatedFromOld(event.m_propagatedFrom)

     {
         wxASSERT_MSG( m_event.m_propagationLevel > 0,
                         wxT("shouldn't be used unless ShouldPropagate()!") );
 
         m_event.m_propagationLevel--;
     {
         wxASSERT_MSG( m_event.m_propagationLevel > 0,
                         wxT("shouldn't be used unless ShouldPropagate()!") );
 
         m_event.m_propagationLevel--;

+        m_event.m_propagatedFrom = handler;

     }
 
     ~wxPropagateOnce()
     {
     }
 
     ~wxPropagateOnce()
     {

+        m_event.m_propagatedFrom = m_propagatedFromOld;

         m_event.m_propagationLevel++;
     }
 
 private:
     wxEvent& m_event;
         m_event.m_propagationLevel++;
     }
 
 private:
     wxEvent& m_event;

+    wxEvtHandler* const m_propagatedFromOld;

 
     wxDECLARE_NO_COPY_CLASS(wxPropagateOnce);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxPropagateOnce);
 };


@@ -1724,9 +1763,13 @@ public:
     wxMouseWheelAxis GetWheelAxis() const { return m_wheelAxis; }
 
     // Returns the configured number of lines (or whatever) to be scrolled per
     wxMouseWheelAxis GetWheelAxis() const { return m_wheelAxis; }
 
     // Returns the configured number of lines (or whatever) to be scrolled per

-    // wheel action.  Defaults to one.
+    // wheel action. Defaults to three.

     int GetLinesPerAction() const { return m_linesPerAction; }
 
     int GetLinesPerAction() const { return m_linesPerAction; }
 

+    // Returns the configured number of columns (or whatever) to be scrolled per
+    // wheel action. Defaults to three.
+    int GetColumnsPerAction() const { return m_columnsPerAction; }
+

     // Is the system set to do page scrolling?
     bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
 
     // Is the system set to do page scrolling?
     bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
 


@@ -1747,6 +1790,7 @@ public:
     int           m_wheelRotation;
     int           m_wheelDelta;
     int           m_linesPerAction;
     int           m_wheelRotation;
     int           m_wheelDelta;
     int           m_linesPerAction;

+    int           m_columnsPerAction;

 
 protected:
     void Assign(const wxMouseEvent& evt);
 
 protected:
     void Assign(const wxMouseEvent& evt);