events and so gives the parent window an opportunity to modify the
keyboard handling of its children, e.g. it is used internally by
wxWidgets in some ports to intercept pressing Esc key in any child of a
- dialog to close the dialog itself when it's pressed. If the event is
- handled, i.e. the handler doesn't call wxEvent::Skip(), neither @c
- wxEVT_KEY_DOWN nor @c wxEVT_CHAR events will be generated (although @c
- wxEVT_KEY_UP still will be). Notice that this event is not generated
- when the mouse is captured as it is considered that the window which
- has the capture should receive all the keyboard events too without
- allowing its parent wxTopLevelWindow to interfere with their processing.
+ dialog to close the dialog itself when it's pressed. By default, if
+ this event is handled, i.e. the handler doesn't call wxEvent::Skip(),
+ neither @c wxEVT_KEY_DOWN nor @c wxEVT_CHAR events will be generated
+ (although @c wxEVT_KEY_UP still will be), i.e. it replaces the normal
+ key events. However by calling the special DoAllowNextEvent() method
+ you can handle @c wxEVT_CHAR_HOOK and still allow normal events
+ generation. This is something that is rarely useful but can be required
+ if you need to prevent a parent @c wxEVT_CHAR_HOOK handler from running
+ without suppressing the normal key events. Finally notice that this
+ event is not generated when the mouse is captured as it is considered
+ that the window which has the capture should receive all the keyboard
+ events too without allowing its parent wxTopLevelWindow to interfere
+ with their processing.
@endEventTable
@see wxKeyboardState
Returns the Y position (in client coordinates) of the event.
*/
wxCoord GetY() const;
+
+ /**
+ Allow normal key events generation.
+
+ Can be called from @c wxEVT_CHAR_HOOK handler to indicate that the
+ generation of normal events should @em not be suppressed, as it happens
+ by default when this event is handled.
+
+ The intended use of this method is to allow some window object to
+ prevent @c wxEVT_CHAR_HOOK handler in its parent window from running by
+ defining its own handler for this event. Without calling this method,
+ this would result in not generating @c wxEVT_KEY_DOWN nor @c wxEVT_CHAR
+ events at all but by calling it you can ensure that these events would
+ still be generated, even if @c wxEVT_CHAR_HOOK event was handled.
+
+ @since 2.9.3
+ */
+ void DoAllowNextEvent();
+
+ /**
+ Returns @true if DoAllowNextEvent() had been called, @false by default.
+
+ This method is used by wxWidgets itself to determine whether the normal
+ key events should be generated after @c wxEVT_CHAR_HOOK processing.
+
+ @since 2.9.3
+ */
+ bool IsNextEventAllowed() const;
};
+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
/**
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;
(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)}
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;
@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.
projects / wxWidgets.git / blobdiff