Fix text origin and bounding box computations in wxSVGFileDC.

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

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 7cf8ec67f4d1008f0b1c8f3a75fd7020f3a81de2..73f66d5fe98e5a871cddbdbcf1a553e1264532ac 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -535,7 +535,7 @@ public:
         the chain until the event is processed or the chain is exhausted.
 
         This function is called from ProcessEvent() and, in turn, calls
         the chain until the event is processed or the chain is exhausted.
 
         This function is called from ProcessEvent() and, in turn, calls

-        TryThis() for each handler in turn. It is not virtual and so cannot be
+        TryBefore() and TryAfter(). It is not virtual and so cannot be

         overridden but can, and should, be called to forward an event to
         another handler instead of ProcessEvent() which would result in a
         duplicate call to TryAfter(), e.g. resulting in all unprocessed events
         overridden but can, and should, be called to forward an event to
         another handler instead of ProcessEvent() which would result in a
         duplicate call to TryAfter(), e.g. resulting in all unprocessed events


@@ -1153,25 +1153,6 @@ protected:
      */
     virtual bool TryBefore(wxEvent& event);
 
      */
     virtual bool TryBefore(wxEvent& event);
 

-    /**
-        Try to process the event in this event handler.
-
-        This method is called from ProcessEventLocally() and thus, indirectly,
-        from ProcessEvent(), please see the detailed description of the event
-        processing logic there.
-
-        It is currently @em not virtual and so may not be overridden.
-
-        @since 2.9.1
-
-        @param event
-            Event to process.
-        @return
-            @true if this object itself defines a handler for this event and
-            the handler didn't skip the event.
-     */
-    bool TryThis(wxEvent& event);
-

     /**
         Method called by ProcessEvent() as last resort.
 
     /**
         Method called by ProcessEvent() as last resort.
 


@@ -1412,11 +1393,11 @@ public:
         codes.
 
         Note that this method returns a meaningful value only for special
         codes.
 
         Note that this method returns a meaningful value only for special

-        non-alphanumeric keys or if the user entered a character that can be
-        represented in current locale's default charset. Otherwise, e.g. if the
-        user enters a Japanese character in a program not using Japanese
-        locale, this method returns @c WXK_NONE and GetUnicodeKey() should be
-        used to obtain the corresponding Unicode character.
+        non-alphanumeric keys or if the user entered a Latin-1 character (this
+        includes ASCII and the accented letters found in Western European
+        languages but not letters of other alphabets such as e.g. Cyrillic).
+        Otherwise it simply method returns @c WXK_NONE and GetUnicodeKey()
+        should be used to obtain the corresponding Unicode character.

 
         Using GetUnicodeKey() is in general the right thing to do if you are
         interested in the characters typed by the user, GetKeyCode() should be
 
         Using GetUnicodeKey() is in general the right thing to do if you are
         interested in the characters typed by the user, GetKeyCode() should be


@@ -1425,15 +1406,26 @@ public:
         @code
             void MyHandler::OnChar(wxKeyEvent& event)
             {
         @code
             void MyHandler::OnChar(wxKeyEvent& event)
             {

-                if ( event.GetUnicodeKey() != WXK_NONE )
+                wxChar uc = event.GetUnicodeKey();
+                if ( uc != WXK_NONE )

                 {
                 {

-                    // It's a printable character
-                    wxLogMessage("You pressed '%c'", event.GetUnicodeKey());
+                    // It's a "normal" character. Notice that this includes
+                    // control characters in 1..31 range, e.g. WXK_RETURN or
+                    // WXK_BACK, so check for them explicitly.
+                    if ( uc >= 32 )
+                    {
+                        wxLogMessage("You pressed '%c'", uc);
+                    }
+                    else
+                    {
+                        // It's a control character
+                        ...
+                    }

                 }
                 }

-                else
+                else // No Unicode equivalent.

                 {
                     // It's a special key, deal with all the known ones:
                 {
                     // It's a special key, deal with all the known ones:

-                    switch ( keycode )
+                    switch ( GetKeyCode() )

                     {
                         case WXK_LEFT:
                         case WXK_RIGHT:
                     {
                         case WXK_LEFT:
                         case WXK_RIGHT:


@@ -1463,6 +1455,9 @@ public:
     //@{
     /**
         Obtains the position (in client coordinates) at which the key was pressed.
     //@{
     /**
         Obtains the position (in client coordinates) at which the key was pressed.

+
+        Notice that this position is simply the current mouse pointer position
+        and has no special relationship to the key event itself.

     */
     wxPoint GetPosition() const;
     void GetPosition(long* x, long* y) const;
     */
     wxPoint GetPosition() const;
     void GetPosition(long* x, long* y) const;


@@ -1521,11 +1516,15 @@ public:
 
     /**
         Returns the X position (in client coordinates) of the event.
 
     /**
         Returns the X position (in client coordinates) of the event.

+
+        @see GetPosition()

     */
     wxCoord GetX() const;
 
     /**
         Returns the Y position (in client coordinates) of the event.
     */
     wxCoord GetX() const;
 
     /**
         Returns the Y position (in client coordinates) of the event.

+
+        @see GetPosition()

     */
     wxCoord GetY() const;
 
     */
     wxCoord GetY() const;
 


@@ -1560,6 +1559,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
 
 /**
     @class wxJoystickEvent
 


@@ -1645,11 +1661,15 @@ public:
 
     /**
         Returns the x, y position of the joystick event.
 
     /**
         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.
     */
     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;
 
     */
     int GetZPosition() const;
 


@@ -2157,8 +2177,8 @@ public:
     text was copied or cut.
 
     @note
     text was copied or cut.
 
     @note

-    These events are currently only generated by wxTextCtrl under GTK+.
-    They are generated by all controls under Windows.
+    These events are currently only generated by wxTextCtrl in wxGTK and wxOSX
+    but are also generated by wxComboBox without wxCB_READONLY style in wxMSW.

 
     @beginEventTable{wxClipboardTextEvent}
     @event{EVT_TEXT_COPY(id, func)}
 
     @beginEventTable{wxClipboardTextEvent}
     @event{EVT_TEXT_COPY(id, func)}


@@ -2185,6 +2205,16 @@ public:
     wxClipboardTextEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 };
 
     wxClipboardTextEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 };
 

+/**
+    Possible axis values for mouse wheel scroll events.
+
+    @since 2.9.4
+ */
+enum wxMouseWheelAxis
+{
+    wxMOUSE_WHEEL_VERTICAL,     ///< Vertical scroll event.
+    wxMOUSE_WHEEL_HORIZONTAL    ///< Horizontal scroll event.
+};

 
 
 /**
 
 
 /**


@@ -2438,12 +2468,16 @@ public:
     int GetWheelRotation() const;
 
     /**
     int GetWheelRotation() const;
 
     /**

-        Gets the axis the wheel operation concerns; @c 0 is the Y axis as on
-        most mouse wheels, @c 1 is the X axis.
+        Gets the axis the wheel operation concerns.
+
+        Usually the mouse wheel is used to scroll vertically so @c
+        wxMOUSE_WHEEL_VERTICAL is returned but some mice (and most trackpads)
+        also allow to use the wheel to scroll horizontally in which case
+        @c wxMOUSE_WHEEL_HORIZONTAL is returned.

 
 

-        Note that only some models of mouse have horizontal wheel axis.
+        Notice that before wxWidgets 2.9.4 this method returned @c int.

     */
     */

-    int GetWheelAxis() const;
+    wxMouseWheelAxis GetWheelAxis() const;

 
     /**
         Returns @true if the event was a mouse button event (not necessarily a button
 
     /**
         Returns @true if the event was a mouse button event (not necessarily a button


@@ -2691,7 +2725,7 @@ public:
     wxClientData* GetClientObject() const;
 
     /**
     wxClientData* GetClientObject() const;
 
     /**

-        Returns extra information dependant on the event objects type.
+        Returns extra information dependent on the event objects type.

 
         If the event comes from a listbox selection, it is a boolean
         determining whether the event was a selection (@true) or a
 
         If the event comes from a listbox selection, it is a boolean
         determining whether the event was a selection (@true) or a


@@ -2927,6 +2961,14 @@ public:
     window (whether using the mouse or keyboard) and when it is done from the
     program itself using wxWindow::SetFocus.
 
     window (whether using the mouse or keyboard) and when it is done from the
     program itself using wxWindow::SetFocus.
 

+    The focus event handlers should almost invariably call wxEvent::Skip() on
+    their event argument to allow the default handling to take place. Failure
+    to do this may result in incorrect behaviour of the native controls. Also
+    note that wxEVT_KILL_FOCUS handler must not call wxWindow::SetFocus() as
+    this, again, is not supported by all native controls. If you need to do
+    this, consider using the @ref sec_delayed_action described in wxIdleEvent
+    documentation.
+

     @beginEventTable{wxFocusEvent}
     @event{EVT_SET_FOCUS(func)}
         Process a @c wxEVT_SET_FOCUS event.
     @beginEventTable{wxFocusEvent}
     @event{EVT_SET_FOCUS(func)}
         Process a @c wxEVT_SET_FOCUS event.


@@ -3451,11 +3493,19 @@ enum wxIdleMode
     (and especially the first one) increase the system load and so should be avoided
     if possible.
 
     (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)}
 
     @beginEventTable{wxIdleEvent}
     @event{EVT_IDLE(func)}


@@ -3465,6 +3515,30 @@ enum wxIdleMode
     @library{wxbase}
     @category{events}
 
     @library{wxbase}
     @category{events}
 

+    @section sec_delayed_action Delayed Action Mechanism
+
+    wxIdleEvent can be used to perform some action "at slightly later time".
+    This can be necessary in several circumstances when, for whatever reason,
+    something can't be done in the current event handler. For example, if a
+    mouse event handler is called with the mouse button pressed, the mouse can
+    be currently captured and some operations with it -- notably capturing it
+    again -- might be impossible or lead to undesirable results. If you still
+    want to capture it, you can do it from @c wxEVT_IDLE handler when it is
+    called the next time instead of doing it immediately.
+
+    This can be achieved in two different ways: when using static event tables,
+    you will need a flag indicating to the (always connected) idle event
+    handler whether the desired action should be performed. The originally
+    called handler would then set it to indicate that it should indeed be done
+    and the idle handler itself would reset it to prevent it from doing the
+    same action again.
+
+    Using dynamically connected event handlers things are even simpler as the
+    original event handler can simply wxEvtHandler::Connect() or
+    wxEvtHandler::Bind() the idle event handler which would only be executed
+    then and could wxEvtHandler::Disconnect() or wxEvtHandler::Unbind() itself.
+
+

     @see @ref overview_events, wxUpdateUIEvent, wxWindow::OnInternalIdle
 */
 class wxIdleEvent : public wxEvent
     @see @ref overview_events, wxUpdateUIEvent, wxWindow::OnInternalIdle
 */
 class wxIdleEvent : public wxEvent


@@ -4000,6 +4074,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_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.
     @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.


@@ -4484,6 +4561,7 @@ wxEventType wxEVT_COMMAND_ENTER;
 wxEventType wxEVT_HELP;
 wxEventType wxEVT_DETAILED_HELP;
 wxEventType wxEVT_COMMAND_TEXT_UPDATED;
 wxEventType wxEVT_HELP;
 wxEventType wxEVT_DETAILED_HELP;
 wxEventType wxEVT_COMMAND_TEXT_UPDATED;

+wxEventType wxEVT_COMMAND_TEXT_ENTER;

 wxEventType wxEVT_COMMAND_TOOL_CLICKED;
 wxEventType wxEVT_WINDOW_MODAL_DIALOG_CLOSED;
 
 wxEventType wxEVT_COMMAND_TOOL_CLICKED;
 wxEventType wxEVT_WINDOW_MODAL_DIALOG_CLOSED;