X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cf1a9bf4af038e88d2a9fffdc7f919fa91e7572..9b026e31597c72e45195b0a5bd854df7d06cc06d:/interface/wx/event.h

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 5cb9c497aa..3bcdf8f45f 100644
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -1560,6 +1560,23 @@ public:
 
 
 
+enum
+{
+    wxJOYSTICK1,
+    wxJOYSTICK2
+};
+
+// Which button is down?
+enum
+{
+    wxJOY_BUTTON_ANY = -1,
+    wxJOY_BUTTON1    = 1,
+    wxJOY_BUTTON2    = 2,
+    wxJOY_BUTTON3    = 4,
+    wxJOY_BUTTON4    = 8
+};
+
+
 /**
     @class wxJoystickEvent
 
@@ -1645,11 +1662,15 @@ public:
 
     /**
         Returns the x, y position of the joystick event.
+
+        These coordinates are valid for all the events except wxEVT_JOY_ZMOVE.
     */
     wxPoint GetPosition() const;
 
     /**
         Returns the z position of the joystick event.
+
+        This method can only be used for wxEVT_JOY_ZMOVE events.
     */
     int GetZPosition() const;
 
@@ -3451,11 +3472,19 @@ enum wxIdleMode
     (and especially the first one) increase the system load and so should be avoided
     if possible.
 
-    By default, idle events are sent to all windows (and also wxApp, as usual).
-    If this is causing a significant overhead in your application, you can call
-    wxIdleEvent::SetMode with the value wxIDLE_PROCESS_SPECIFIED, and set the
-    wxWS_EX_PROCESS_IDLE extra window style for every window which should receive
-    idle events.
+    By default, idle events are sent to all windows, including even the hidden
+    ones because they may be shown if some condition is met from their @c
+    wxEVT_IDLE (or related @c wxEVT_UPDATE_UI) handler. The children of hidden
+    windows do not receive idle events however as they can't change their state
+    in any way noticeable by the user. Finally, the global wxApp object also
+    receives these events, as usual, so it can be used for any global idle time
+    processing.
+
+    If sending idle events to all windows is causing a significant overhead in
+    your application, you can call wxIdleEvent::SetMode with the value
+    wxIDLE_PROCESS_SPECIFIED, and set the wxWS_EX_PROCESS_IDLE extra window
+    style for every window which should receive idle events, all the other ones
+    will not receive them in this case.
 
     @beginEventTable{wxIdleEvent}
     @event{EVT_IDLE(func)}
@@ -3870,9 +3899,12 @@ public:
     wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0, wxMenu* menu = NULL);
 
     /**
-        Returns the menu which is being opened or closed. This method should only be
-        used with the @c OPEN and @c CLOSE events and even for them the
-        returned pointer may be @NULL in some ports.
+        Returns the menu which is being opened or closed.
+
+        This method can only be used with the @c OPEN and @c CLOSE events.
+
+        The returned value is never @NULL in the ports implementing this
+        function, which currently includes all the major ones.
     */
     wxMenu* GetMenu() const;
 
@@ -3997,6 +4029,9 @@ public:
     @event{EVT_MOVE_START(func)}
         Process a @c wxEVT_MOVE_START event, which is generated when the user starts
         to move or size a window. wxMSW only.
+    @event{EVT_MOVING(func)}
+        Process a @c wxEVT_MOVING event, which is generated while the user is
+        moving the window. wxMSW only.
     @event{EVT_MOVE_END(func)}
         Process a @c wxEVT_MOVE_END event, which is generated when the user stops
         moving or sizing a window. wxMSW only.