clarify role of wxToolBarToolBase (fixes #9874)

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

diff --git a/interface/wx/event.h b/interface/wx/event.h
index eb776912fea0de60918e12c130049aa1a32c8902..88f3714d07562dd5ca2216f19c02364d5e7896af 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -213,7 +213,7 @@ public:
         Note that the @a win window @b must remain alive until the
         wxEventBlocker object destruction.
     */
         Note that the @a win window @b must remain alive until the
         wxEventBlocker object destruction.
     */

-    wxEventBlocker(wxWindow* win, wxEventType = wxEVT_ANY);
+    wxEventBlocker(wxWindow* win, wxEventType type = -1);

 
     /**
         Destructor. The blocker will remove itself from the chain of event handlers for
 
     /**
         Destructor. The blocker will remove itself from the chain of event handlers for


@@ -321,7 +321,7 @@ public:
         share the same string buffer internally. Use QueueEvent() to avoid
         this.
 
         share the same string buffer internally. Use QueueEvent() to avoid
         this.
 

-        A copy of event is made by the function, so the original can be deleted
+        A copy of @a event is made by the function, so the original can be deleted

         as soon as function returns (it is common that the original is created
         on the stack). This requires that the wxEvent::Clone() method be
         implemented by event so that it can be duplicated and stored until it
         as soon as function returns (it is common that the original is created
         on the stack). This requires that the wxEvent::Clone() method be
         implemented by event so that it can be duplicated and stored until it


@@ -417,8 +417,8 @@ public:
         @param eventSink
             Object whose member function should be called.
     */
         @param eventSink
             Object whose member function should be called.
     */

-    bool Disconnect(wxEventType eventType = wxEVT_NULL,
-                    wxObjectEventFunction function = NULL,
+    bool Disconnect(wxEventType eventType,
+                    wxObjectEventFunction function,

                     wxObject* userData = NULL,
                     wxEvtHandler* eventSink = NULL);
 
                     wxObject* userData = NULL,
                     wxEvtHandler* eventSink = NULL);
 


@@ -440,8 +440,8 @@ public:
 
         This overload takes an additional range of source IDs.
     */
 
         This overload takes an additional range of source IDs.
     */

-    bool Disconnect(int id, int lastId = wxID_ANY,
-                    wxEventType eventType = wxEVT_NULL,
+    bool Disconnect(int id, int lastId,
+                    wxEventType eventType,

                     wxObjectEventFunction function = NULL,
                     wxObject* userData = NULL,
                     wxEvtHandler* eventSink = NULL);
                     wxObjectEventFunction function = NULL,
                     wxObject* userData = NULL,
                     wxEvtHandler* eventSink = NULL);


@@ -1899,15 +1899,15 @@ public:
         The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
         has moved off a tool.
     @event{EVT_COMMAND_LEFT_CLICK(id, func)}
         The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
         has moved off a tool.
     @event{EVT_COMMAND_LEFT_CLICK(id, func)}

-        Process a wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (Windows 95 and NT only).
+        Process a wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).

     @event{EVT_COMMAND_LEFT_DCLICK(id, func)}
     @event{EVT_COMMAND_LEFT_DCLICK(id, func)}

-        Process a wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (Windows 95 and NT only).
+        Process a wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).

     @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
     @event{EVT_COMMAND_RIGHT_CLICK(id, func)}

-        Process a wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (Windows 95 and NT only).
+        Process a wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).

     @event{EVT_COMMAND_SET_FOCUS(id, func)}
     @event{EVT_COMMAND_SET_FOCUS(id, func)}

-        Process a wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (Windows 95 and NT only).
+        Process a wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).

     @event{EVT_COMMAND_KILL_FOCUS(id, func)}
     @event{EVT_COMMAND_KILL_FOCUS(id, func)}

-        Process a wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (Windows 95 and NT only).
+        Process a wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).

     @event{EVT_COMMAND_ENTER(id, func)}
         Process a wxEVT_COMMAND_ENTER command, which is generated by a control.
     @endEventTable
     @event{EVT_COMMAND_ENTER(id, func)}
         Process a wxEVT_COMMAND_ENTER command, which is generated by a control.
     @endEventTable


@@ -1921,7 +1921,7 @@ public:
     /**
         Constructor.
     */
     /**
         Constructor.
     */

-    wxCommandEvent(wxEventType commandEventType = 0, int id = 0);
+    wxCommandEvent(wxEventType commandEventType = wxEVT_NULL, int id = 0);

 
     /**
         Returns client data pointer for a listbox or choice selection event
 
     /**
         Returns client data pointer for a listbox or choice selection event


@@ -2333,13 +2333,10 @@ public:
 
 
 
 
 
 

-/**
-    Indicates how a wxHelpEvent was generated.
-*/

 enum wxHelpEventOrigin
 {
 enum wxHelpEventOrigin
 {

-    wxHE_ORIGIN_UNKNOWN = -1,    /**< unrecognized event source. */
-    wxHE_ORIGIN_KEYBOARD,        /**< event generated from F1 key press. */
+    wxHE_ORIGIN_UNKNOWN = -1,
+    wxHE_ORIGIN_KEYBOARD,

 
     /** event generated by wxContextHelp or from the [?] button on
         the title bar (Windows). */
 
     /** event generated by wxContextHelp or from the [?] button on
         the title bar (Windows). */


@@ -2382,13 +2379,26 @@ enum wxHelpEventOrigin
 class wxHelpEvent : public wxCommandEvent
 {
 public:
 class wxHelpEvent : public wxCommandEvent
 {
 public:

+    /**
+        Indicates how a wxHelpEvent was generated.
+    */
+    enum Origin
+    {
+        Origin_Unknown,    /**< unrecognized event source. */
+        Origin_Keyboard,   /**< event generated from F1 key press. */
+
+        /** event generated by wxContextHelp or from the [?] button on
+            the title bar (Windows). */
+        Origin_HelpButton
+    };
+

     /**
         Constructor.
     */
     wxHelpEvent(wxEventType type = wxEVT_NULL,
                 wxWindowID winid = 0,
                 const wxPoint& pt = wxDefaultPosition,
     /**
         Constructor.
     */
     wxHelpEvent(wxEventType type = wxEVT_NULL,
                 wxWindowID winid = 0,
                 const wxPoint& pt = wxDefaultPosition,

-                wxHelpEventOrigin origin = wxHE_ORIGIN_UNKNOWN);
+                wxHelpEvent::Origin origin = Origin_Unknown);

 
     /**
         Returns the origin of the help event which is one of the ::wxHelpEventOrigin
 
     /**
         Returns the origin of the help event which is one of the ::wxHelpEventOrigin


@@ -2399,7 +2409,7 @@ public:
 
         @see SetOrigin()
     */
 
         @see SetOrigin()
     */

-    wxHelpEventOrigin GetOrigin() const;
+    wxHelpEvent::Origin GetOrigin() const;

 
     /**
         Returns the left-click position of the mouse, in screen coordinates.
 
     /**
         Returns the left-click position of the mouse, in screen coordinates.


@@ -2412,7 +2422,7 @@ public:
 
         @see GetOrigin()
     */
 
         @see GetOrigin()
     */

-    void SetOrigin(wxHelpEventOrigin);
+    void SetOrigin(wxHelpEvent::Origin origin);

 
     /**
         Sets the left-click position of the mouse, in screen coordinates.
 
     /**
         Sets the left-click position of the mouse, in screen coordinates.


@@ -2433,7 +2443,7 @@ public:
     events and use the event table macros mentioned below only for the scrollbar-like
     controls.
 
     events and use the event table macros mentioned below only for the scrollbar-like
     controls.
 

-    @section wxscrollevent_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
+    @section scrollevent_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED

 
     The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb
     using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed
 
     The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb
     using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed


@@ -2907,11 +2917,6 @@ public:
     */
     void SetCanVeto(bool canVeto);
 
     */
     void SetCanVeto(bool canVeto);
 

-    /**
-        Sets the 'force' flag.
-    */
-    void SetForce(bool force) const;
-

     /**
         Sets the 'logging off' flag.
     */
     /**
         Sets the 'logging off' flag.
     */