wxWidgets: interface/wx/event.h File Reference

| Version: 3.1.5

Loading...
Searching...
No Matches
Classes | Macros | Typedefs | Enumerations | Functions | Variables
event.h File Reference

## Classes
class | wxEvent
| An event is a structure holding information about an event passed to a callback or member function. More...
class | wxEventBlocker
| This class is a special event handler which allows discarding any event (or a set of event types) directed to a specific window. More...
class | wxPropagationDisabler
| Helper class to temporarily change an event to not propagate. More...
class | wxPropagateOnce
| Helper class to temporarily lower propagation level. More...
class | wxEvtHandler
| A class that can handle events from the windowing system. More...
class | wxKeyEvent
| This event class contains information about key press and release events. More...
class | wxJoystickEvent
| This event class contains information about joystick events, particularly events received by windows. More...
class | wxScrollWinEvent
| A scroll event holds information about events sent from scrolling windows. More...
class | wxSysColourChangedEvent
| This class is used for system colour change events, which are generated when the user changes the colour settings or when the system theme changes (e.g. More...
class | wxCommandEvent
| This event class contains information about command events, which originate from a variety of simple controls. More...
class | wxWindowCreateEvent
| This event is sent just after the actual window associated with a wxWindow object has been created. More...
class | wxPaintEvent
| A paint event is sent when a window's contents needs to be repainted. More...
class | wxMaximizeEvent
| An event being sent when a top level window is maximized. More...
class | wxFullScreenEvent
| An event being sent when the user enters or exits full screen mode. More...
class | wxUpdateUIEvent
| This class is used for pseudo-events which are called by wxWidgets to give an application the chance to update various user interface elements. More...
class | wxClipboardTextEvent
| This class represents the events generated by a control (typically a wxTextCtrl but other windows can generate these events as well) when its content gets copied or cut to, or pasted from the clipboard. More...
class | wxMouseEvent
| This event class contains information about the events generated by the mouse: they include mouse buttons press and release events and mouse move events. More...
class | wxDropFilesEvent
| This class is used for drop files events, that is, when files have been dropped onto the window. More...
class | wxActivateEvent
| An activate event is sent when a window or application is being activated or deactivated. More...
class | wxContextMenuEvent
| This class is used for context menu events, sent to give the application a chance to show a context (popup) menu for a wxWindow. More...
class | wxEraseEvent
| An erase event is sent when a window's background needs to be repainted. More...
class | wxFocusEvent
| A focus event is sent when a window's focus changes. More...
class | wxChildFocusEvent
| A child focus event is sent to a (parent-)window when one of its child windows gains focus, so that the window could restore the focus back to its corresponding child if it loses it now and regains later. More...
class | wxMouseCaptureLostEvent
| A mouse capture lost event is sent to a window that had obtained mouse capture, which was subsequently lost due to an "external" event (for example, when a dialog box is shown or if another application captures the mouse). More...
class | wxDisplayChangedEvent
| A display changed event is sent to top-level windows when the display resolution has changed. More...
class | wxDPIChangedEvent
| Event sent when the display scale factor or pixel density (measured in dots-per-inch, or DPI) of the monitor a window is on changes. More...
class | wxPaletteChangedEvent
class | wxQueryNewPaletteEvent
class | wxNotifyEvent
| This class is not used by the event handlers by itself, but is a base class for other event classes (such as wxBookCtrlEvent). More...
class | wxThreadEvent
| This class adds some simple functionality to wxEvent to facilitate inter-thread communication. More...
class | wxHelpEvent
| A help event is sent when the user has requested context-sensitive help. More...
class | wxScrollEvent
| A scroll event holds information about events sent from stand-alone scrollbars (see wxScrollBar) and sliders (see wxSlider). More...
class | wxGestureEvent
| This is the base class for all supported gesture events. More...
class | wxPanGestureEvent
| This event is generated when the user moves a finger on the surface. More...
class | wxZoomGestureEvent
| This event is generated when two fingers pinch the surface to zoom in or out. More...
class | wxRotateGestureEvent
| This event is generated when two fingers move in opposite directions on the surface. More...
class | wxTwoFingerTapEvent
| This event is generated when two fingers touch the surface at the same time. More...
class | wxLongPressEvent
| This event is generated when one finger touches the surface and remains stationary. More...
class | wxPressAndTapEvent
| This event is generated when the user press the surface with one finger and taps with another. More...
class | wxIdleEvent
| This class is used for idle events, which are generated when the system becomes idle. More...
class | wxInitDialogEvent
| A wxInitDialogEvent is sent as a dialog or panel is being initialised. More...
class | wxWindowDestroyEvent
| This event is sent as early as possible during the window destruction process. More...
class | wxNavigationKeyEvent
| This event class contains information about navigation events, generated by navigation keys such as tab and page down. More...
class | wxMouseCaptureChangedEvent
| A mouse capture changed event is sent to a window that loses its mouse capture. More...
class | wxCloseEvent
| This event class contains information about window and session close events. More...
class | wxMenuEvent
| This class is used for a variety of menu-related events. More...
class | wxShowEvent
| An event being sent when the window is shown or hidden. More...
class | wxIconizeEvent
| An event being sent when the frame is iconized (minimized) or restored. More...
class | wxMoveEvent
| A move event holds information about window position change. More...
class | wxSizeEvent
| A size event holds information about size change events of wxWindow. More...
class | wxSetCursorEvent
| A wxSetCursorEvent is generated from wxWindow when the mouse cursor is about to be set as a result of mouse motion. More...

## Macros
#define | wxDEFINE_EVENT(name, cls)
| Define a new event type associated with the specified event class.
#define | wxDECLARE_EVENT(name, cls)
| Declares a custom event type.
#define | wxDECLARE_EXPORTED_EVENT(expdecl, name, cls)
| Variant of wxDECLARE_EVENT() used for event types defined inside a shared library.
#define | wxEVENT_HANDLER_CAST(functype, func)
| Helper macro for definition of custom event table macros.
#define | wx__DECLARE_EVT1(evt, id, fn)
| This macro is used to define event table macros for handling custom events.
#define | wx__DECLARE_EVT2(evt, id1, id2, fn)
| Generalized version of the wx__DECLARE_EVT1() macro taking a range of IDs instead of a single one.
#define | wx__DECLARE_EVT0(evt, fn)
| Simplified version of the wx__DECLARE_EVT1() macro, to be used when the event type must be handled regardless of the ID associated with the specific event instances.
#define | wxDECLARE_EVENT_TABLE()
| Use this macro inside a class declaration to declare a static event table for that class.
#define | wxBEGIN_EVENT_TABLE(theClass, baseClass)
| Use this macro in a source file to start listing static event handlers for a specific class.
#define | wxEND_EVENT_TABLE()
| Use this macro in a source file to end listing static event handlers for a specific class.

## Typedefs
typedef int | wxEventType
| A value uniquely identifying the type of the event.

## Enumerations
enum | wxEventPropagation { wxEVENT_PROPAGATE_NONE = 0 , wxEVENT_PROPAGATE_MAX = INT_MAX }
| The predefined constants for the number of times we propagate event upwards window child-parent chain. More...
enum | wxEventCategory { wxEVT_CATEGORY_UI = 1 , wxEVT_CATEGORY_USER_INPUT = 2 , wxEVT_CATEGORY_SOCKET = 4 , wxEVT_CATEGORY_TIMER = 8 , wxEVT_CATEGORY_THREAD = 16 , wxEVT_CATEGORY_ALL }
| The different categories for a wxEvent; see wxEvent::GetEventCategory. More...
enum | wxKeyCategoryFlags { WXK_CATEGORY_ARROW , WXK_CATEGORY_PAGING , WXK_CATEGORY_JUMP , WXK_CATEGORY_TAB , WXK_CATEGORY_CUT , WXK_CATEGORY_NAVIGATION }
| Flags for categories of keys. More...
enum | { wxJOYSTICK1 , wxJOYSTICK2 }
enum | { wxJOY_BUTTON_ANY = -1 , wxJOY_BUTTON1 = 1 , wxJOY_BUTTON2 = 2 , wxJOY_BUTTON3 = 4 , wxJOY_BUTTON4 = 8 }
enum | wxUpdateUIMode { wxUPDATE_UI_PROCESS_ALL , wxUPDATE_UI_PROCESS_SPECIFIED }
| The possibles modes to pass to wxUpdateUIEvent::SetMode(). More...
enum | wxMouseWheelAxis { wxMOUSE_WHEEL_VERTICAL , wxMOUSE_WHEEL_HORIZONTAL }
| Possible axis values for mouse wheel scroll events. More...
enum | wxIdleMode { wxIDLE_PROCESS_ALL , wxIDLE_PROCESS_SPECIFIED }
| See wxIdleEvent::SetMode() for more info. More...

## Functions
wxEventType | wxNewEventType ()
| Generates a new unique event type.
void | wxPostEvent (wxEvtHandler *dest, const wxEvent &event)
| In a GUI application, this function posts event to the specified dest object using wxEvtHandler::AddPendingEvent().
void | wxQueueEvent (wxEvtHandler *dest, wxEvent *event)
| Queue an event for processing on the given object.

## Variables
wxEventType | wxEVT_NULL
| A special event type usually used to indicate that some wxEvent has yet no type assigned.
wxEventType | wxEVT_ANY
wxEventType | wxEVT_BUTTON
wxEventType | wxEVT_CHECKBOX
wxEventType | wxEVT_CHOICE
wxEventType | wxEVT_LISTBOX
wxEventType | wxEVT_LISTBOX_DCLICK
wxEventType | wxEVT_CHECKLISTBOX
wxEventType | wxEVT_MENU
wxEventType | wxEVT_SLIDER
wxEventType | wxEVT_RADIOBOX
wxEventType | wxEVT_RADIOBUTTON
wxEventType | wxEVT_SCROLLBAR
wxEventType | wxEVT_VLBOX
wxEventType | wxEVT_COMBOBOX
wxEventType | wxEVT_TOOL_RCLICKED
wxEventType | wxEVT_TOOL_DROPDOWN
wxEventType | wxEVT_TOOL_ENTER
wxEventType | wxEVT_COMBOBOX_DROPDOWN
wxEventType | wxEVT_COMBOBOX_CLOSEUP
wxEventType | wxEVT_THREAD
wxEventType | wxEVT_LEFT_DOWN
wxEventType | wxEVT_LEFT_UP
wxEventType | wxEVT_MIDDLE_DOWN
wxEventType | wxEVT_MIDDLE_UP
wxEventType | wxEVT_RIGHT_DOWN
wxEventType | wxEVT_RIGHT_UP
wxEventType | wxEVT_MOTION
wxEventType | wxEVT_ENTER_WINDOW
wxEventType | wxEVT_LEAVE_WINDOW
wxEventType | wxEVT_LEFT_DCLICK
wxEventType | wxEVT_MIDDLE_DCLICK
wxEventType | wxEVT_RIGHT_DCLICK
wxEventType | wxEVT_SET_FOCUS
wxEventType | wxEVT_KILL_FOCUS
wxEventType | wxEVT_CHILD_FOCUS
wxEventType | wxEVT_MOUSEWHEEL
wxEventType | wxEVT_MAGNIFY
wxEventType | wxEVT_AUX1_DOWN
wxEventType | wxEVT_AUX1_UP
wxEventType | wxEVT_AUX1_DCLICK
wxEventType | wxEVT_AUX2_DOWN
wxEventType | wxEVT_AUX2_UP
wxEventType | wxEVT_AUX2_DCLICK
wxEventType | wxEVT_CHAR
wxEventType | wxEVT_CHAR_HOOK
wxEventType | wxEVT_NAVIGATION_KEY
wxEventType | wxEVT_KEY_DOWN
wxEventType | wxEVT_KEY_UP
wxEventType | wxEVT_HOTKEY
wxEventType | wxEVT_SET_CURSOR
wxEventType | wxEVT_SCROLL_TOP
wxEventType | wxEVT_SCROLL_BOTTOM
wxEventType | wxEVT_SCROLL_LINEUP
wxEventType | wxEVT_SCROLL_LINEDOWN
wxEventType | wxEVT_SCROLL_PAGEUP
wxEventType | wxEVT_SCROLL_PAGEDOWN
wxEventType | wxEVT_SCROLL_THUMBTRACK
wxEventType | wxEVT_SCROLL_THUMBRELEASE
wxEventType | wxEVT_SCROLL_CHANGED
wxEventType | wxEVT_SPIN_UP
wxEventType | wxEVT_SPIN_DOWN
wxEventType | wxEVT_SPIN
wxEventType | wxEVT_SCROLLWIN_TOP
wxEventType | wxEVT_SCROLLWIN_BOTTOM
wxEventType | wxEVT_SCROLLWIN_LINEUP
wxEventType | wxEVT_SCROLLWIN_LINEDOWN
wxEventType | wxEVT_SCROLLWIN_PAGEUP
wxEventType | wxEVT_SCROLLWIN_PAGEDOWN
wxEventType | wxEVT_SCROLLWIN_THUMBTRACK
wxEventType | wxEVT_SCROLLWIN_THUMBRELEASE
wxEventType | wxEVT_GESTURE_PAN
wxEventType | wxEVT_GESTURE_ZOOM
wxEventType | wxEVT_GESTURE_ROTATE
wxEventType | wxEVT_TWO_FINGER_TAP
wxEventType | wxEVT_LONG_PRESS
wxEventType | wxEVT_PRESS_AND_TAP
wxEventType | wxEVT_SIZE
wxEventType | wxEVT_MOVE
wxEventType | wxEVT_CLOSE_WINDOW
wxEventType | wxEVT_END_SESSION
wxEventType | wxEVT_QUERY_END_SESSION
wxEventType | wxEVT_ACTIVATE_APP
wxEventType | wxEVT_ACTIVATE
wxEventType | wxEVT_CREATE
wxEventType | wxEVT_DESTROY
wxEventType | wxEVT_SHOW
wxEventType | wxEVT_ICONIZE
wxEventType | wxEVT_MAXIMIZE
wxEventType | wxEVT_MOUSE_CAPTURE_CHANGED
wxEventType | wxEVT_MOUSE_CAPTURE_LOST
wxEventType | wxEVT_PAINT
wxEventType | wxEVT_ERASE_BACKGROUND
wxEventType | wxEVT_NC_PAINT
wxEventType | wxEVT_MENU_OPEN
wxEventType | wxEVT_MENU_CLOSE
wxEventType | wxEVT_MENU_HIGHLIGHT
wxEventType | wxEVT_CONTEXT_MENU
wxEventType | wxEVT_SYS_COLOUR_CHANGED
wxEventType | wxEVT_DISPLAY_CHANGED
wxEventType | wxEVT_DPI_CHANGED
wxEventType | wxEVT_QUERY_NEW_PALETTE
wxEventType | wxEVT_PALETTE_CHANGED
wxEventType | wxEVT_JOY_BUTTON_DOWN
wxEventType | wxEVT_JOY_BUTTON_UP
wxEventType | wxEVT_JOY_MOVE
wxEventType | wxEVT_JOY_ZMOVE
wxEventType | wxEVT_DROP_FILES
wxEventType | wxEVT_INIT_DIALOG
wxEventType | wxEVT_IDLE
wxEventType | wxEVT_UPDATE_UI
wxEventType | wxEVT_SIZING
wxEventType | wxEVT_MOVING
wxEventType | wxEVT_MOVE_START
wxEventType | wxEVT_MOVE_END
wxEventType | wxEVT_HIBERNATE
wxEventType | wxEVT_TEXT_COPY
wxEventType | wxEVT_TEXT_CUT
wxEventType | wxEVT_TEXT_PASTE
wxEventType | wxEVT_COMMAND_LEFT_CLICK
wxEventType | wxEVT_COMMAND_LEFT_DCLICK
wxEventType | wxEVT_COMMAND_RIGHT_CLICK
wxEventType | wxEVT_COMMAND_RIGHT_DCLICK
wxEventType | wxEVT_COMMAND_SET_FOCUS
wxEventType | wxEVT_COMMAND_KILL_FOCUS
wxEventType | wxEVT_COMMAND_ENTER
wxEventType | wxEVT_HELP
wxEventType | wxEVT_DETAILED_HELP
wxEventType | wxEVT_TOOL
wxEventType | wxEVT_WINDOW_MODAL_DIALOG_CLOSED

## Macro Definition Documentation

## ◆ wx__DECLARE_EVT0

#define wx__DECLARE_EVT0 | ( |  | evt,
|  |  | fn )

Simplified version of the wx__DECLARE_EVT1() macro, to be used when the event type must be handled regardless of the ID associated with the specific event instances.

## ◆ wx__DECLARE_EVT1

#define wx__DECLARE_EVT1 | ( |  | evt,
|  |  | id,
|  |  | fn )

This macro is used to define event table macros for handling custom events.

Example of use:

class MyEvent : public wxEvent { ... };
// note that this is not necessary unless using old compilers: for the
// reasonably new ones just use &func instead of MyEventHandler(func)
typedef void (wxEvtHandler::*MyEventFunction)(MyEvent&);
#define MyEventHandler(func) wxEVENT_HANDLER_CAST(MyEventFunction, func)
wxDEFINE_EVENT(MY_EVENT_TYPE, MyEvent);
#define EVT_MY(id, func) \
wx__DECLARE_EVT1(MY_EVENT_TYPE, id, MyEventHandler(func))
...
wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
EVT_MY(wxID_ANY, MyFrame::OnMyEvent)
wxEND_EVENT_TABLE()
wxEvent
An event is a structure holding information about an event passed to a callback or member function.
Definition event.h:93
wxEvtHandler
A class that can handle events from the windowing system.
Definition event.h:382
wxFrame
A frame is a window whose size and position can (usually) be changed by the user.
Definition frame.h:153
wxID_ANY
@ wxID_ANY
Any id: means that we don't care about the id, whether when installing an event handler or when creat...
Definition defs.h:597
wxDEFINE_EVENT
#define wxDEFINE_EVENT(name, cls)
Define a new event type associated with the specified event class.
Definition event.h:4898
wxEND_EVENT_TABLE
#define wxEND_EVENT_TABLE()
Use this macro in a source file to end listing static event handlers for a specific class.
Definition event.h:5026

Parameters

  evt | The event type to handle.
  id | The identifier of events to handle.
  fn | The event handler method.

## ◆ wx__DECLARE_EVT2

#define wx__DECLARE_EVT2 | ( |  | evt,
|  |  | id1,
|  |  | id2,
|  |  | fn )

Generalized version of the wx__DECLARE_EVT1() macro taking a range of IDs instead of a single one.

Argument id1 is the first identifier of the range, id2 is the second identifier of the range.

## ◆ wxBEGIN_EVENT_TABLE

#define wxBEGIN_EVENT_TABLE | ( |  | theClass,
|  |  | baseClass )

Use this macro in a source file to start listing static event handlers for a specific class.

Use wxEND_EVENT_TABLE() to terminate the event-declaration block.

See also
  Event Handling with Event Tables

## ◆ wxDECLARE_EVENT

#define wxDECLARE_EVENT | ( |  | name,
|  |  | cls )

Declares a custom event type.

This macro declares a variable called name which must be defined elsewhere using wxDEFINE_EVENT().

The class cls must be the wxEvent-derived class associated with the events of this type and its full declaration must be visible from the point of use of this macro.

For example:

wxDECLARE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
class MyCustomEvent : public wxEvent { ... };
wxDECLARE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
wxCommandEvent
This event class contains information about command events, which originate from a variety of simple ...
Definition event.h:2007
wxDECLARE_EVENT
#define wxDECLARE_EVENT(name, cls)
Declares a custom event type.
Definition event.h:4918

## ◆ wxDECLARE_EVENT_TABLE

#define wxDECLARE_EVENT_TABLE | ( |  | ) |

Use this macro inside a class declaration to declare a static event table for that class.

In the implementation file you'll need to use the wxBEGIN_EVENT_TABLE() and the wxEND_EVENT_TABLE() macros, plus some additional `EVT_xxx` macro to capture events.

Note that this macro requires a final semicolon.

See also
  Event Handling with Event Tables

## ◆ wxDECLARE_EXPORTED_EVENT

#define wxDECLARE_EXPORTED_EVENT | ( |  | expdecl,
|  |  | name,
|  |  | cls )

Variant of wxDECLARE_EVENT() used for event types defined inside a shared library.

This is mostly used by wxWidgets internally, e.g.

wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_BUTTON, wxCommandEvent);
wxEVT_BUTTON
wxEventType wxEVT_BUTTON
Definition event.h:5062
wxDECLARE_EXPORTED_EVENT
#define wxDECLARE_EXPORTED_EVENT(expdecl, name, cls)
Variant of wxDECLARE_EVENT() used for event types defined inside a shared library.
Definition event.h:4929

## ◆ wxDEFINE_EVENT

#define wxDEFINE_EVENT | ( |  | name,
|  |  | cls )

Define a new event type associated with the specified event class.

This macro defines a new unique event type name associated with the event class cls.

For example:

wxDEFINE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
class MyCustomEvent : public wxEvent { ... };
wxDEFINE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);

See also
  wxDECLARE_EVENT(), Custom Event Summary

## ◆ wxEND_EVENT_TABLE

#define wxEND_EVENT_TABLE | ( |  | ) |

Use this macro in a source file to end listing static event handlers for a specific class.

Use wxBEGIN_EVENT_TABLE() to start the event-declaration block.

See also
  Event Handling with Event Tables

## ◆ wxEVENT_HANDLER_CAST

#define wxEVENT_HANDLER_CAST | ( |  | functype,
|  |  | func )

Helper macro for definition of custom event table macros.

This macro casts the given event handler to the given function type using `static_cast` to ensure that the actual handler is indeed compatible with it, before (unsafely) casting it to a generic function pointer used by the event tables.

See wx__DECLARE_EVT1 for an example of use.

See also
  Defining Your Own Event Class

## Typedef Documentation

## ◆ wxEventType

typedef int wxEventType

A value uniquely identifying the type of the event.

The values of this type should only be created using wxNewEventType().

See the macro wxDEFINE_EVENT_TYPE() for more information.

See also
  Events and Event Handling

## Enumeration Type Documentation

## ◆ anonymous enum

anonymous enum

Enumerator
wxJOY_BUTTON_ANY |
wxJOY_BUTTON1 |
wxJOY_BUTTON2 |
wxJOY_BUTTON3 |
wxJOY_BUTTON4 |

## ◆ anonymous enum

anonymous enum

Enumerator
wxJOYSTICK1 |
wxJOYSTICK2 |

## ◆ wxEventCategory

enum wxEventCategory

The different categories for a wxEvent; see wxEvent::GetEventCategory.

Note
  They are used as OR-combinable flags by wxEventLoopBase::YieldFor.

Enumerator
wxEVT_CATEGORY_UI | This is the category for those events which are generated to update the appearance of the GUI but which (usually) do not comport data processing, i.e. which do not provide input or output data (e.g. size events, scroll events, etc). They are events NOT directly generated by the user's input devices.
wxEVT_CATEGORY_USER_INPUT | This category groups those events which are generated directly from the user through input devices like mouse and keyboard and usually result in data to be processed from the application (e.g. mouse clicks, key presses, etc).
wxEVT_CATEGORY_SOCKET | This category is for wxSocketEvent.
wxEVT_CATEGORY_TIMER | This category is for wxTimerEvent.
wxEVT_CATEGORY_THREAD | This category is for any event used to send notifications from the secondary threads to the main one or in general for notifications among different threads (which may or may not be user-generated). See e.g. wxThreadEvent.
wxEVT_CATEGORY_ALL | This mask is used in wxEventLoopBase::YieldFor to specify that all event categories should be processed.

## ◆ wxEventPropagation

enum wxEventPropagation

The predefined constants for the number of times we propagate event upwards window child-parent chain.

Enumerator
wxEVENT_PROPAGATE_NONE | don't propagate it at all
wxEVENT_PROPAGATE_MAX | propagate it until it is processed

## ◆ wxIdleMode

enum wxIdleMode

See wxIdleEvent::SetMode() for more info.

Enumerator
wxIDLE_PROCESS_ALL | Send idle events to all windows.
wxIDLE_PROCESS_SPECIFIED | Send idle events to windows that have the wxWS_EX_PROCESS_IDLE flag specified.

## ◆ wxKeyCategoryFlags

enum wxKeyCategoryFlags

Flags for categories of keys.

These values are used by wxKeyEvent::IsKeyInCategory(). They may be combined via the bitwise operators |, &, and ~.

Since
  2.9.1

Enumerator
WXK_CATEGORY_ARROW | arrow keys, on and off numeric keypads
WXK_CATEGORY_PAGING | page up and page down keys, on and off numeric keypads
WXK_CATEGORY_JUMP | home and end keys, on and off numeric keypads
WXK_CATEGORY_TAB | tab key, on and off numeric keypads
WXK_CATEGORY_CUT | backspace and delete keys, on and off numeric keypads
WXK_CATEGORY_NAVIGATION | union of WXK_CATEGORY_ARROW, WXK_CATEGORY_PAGING, and WXK_CATEGORY_JUMP categories

## ◆ wxMouseWheelAxis

enum wxMouseWheelAxis

Possible axis values for mouse wheel scroll events.

Since
  2.9.4

Enumerator
wxMOUSE_WHEEL_VERTICAL | Vertical scroll event.
wxMOUSE_WHEEL_HORIZONTAL | Horizontal scroll event.

## ◆ wxUpdateUIMode

enum wxUpdateUIMode

The possibles modes to pass to wxUpdateUIEvent::SetMode().

Enumerator
wxUPDATE_UI_PROCESS_ALL | Send UI update events to all windows.
wxUPDATE_UI_PROCESS_SPECIFIED | Send UI update events to windows that have the wxWS_EX_PROCESS_UI_UPDATES flag specified.

## Function Documentation

## ◆ wxNewEventType()

wxEventType wxNewEventType | ( |  | ) |

Generates a new unique event type.

Usually this function is only used by wxDEFINE_EVENT() and not called directly.

## ◆ wxPostEvent()

void wxPostEvent | ( | wxEvtHandler * | dest,
|  | const wxEvent & | event )

In a GUI application, this function posts event to the specified dest object using wxEvtHandler::AddPendingEvent().

Otherwise, it dispatches event immediately using wxEvtHandler::ProcessEvent(). See the respective documentation for details (and caveats). Because of limitation of wxEvtHandler::AddPendingEvent() this function is not thread-safe for event objects having wxString fields, use wxQueueEvent() instead.

Include file:

    #include <wx/event.h>

## ◆ wxQueueEvent()

void wxQueueEvent | ( | wxEvtHandler * | dest,
|  | wxEvent * | event )

Queue an event for processing on the given object.

This is a wrapper around wxEvtHandler::QueueEvent(), see its documentation for more details.

Include file:

    #include <wx/event.h>

Parameters

  dest | The object to queue the event on, can't be `NULL`.
  event | The heap-allocated and non-`NULL` event to queue, the function takes ownership of it.

## Variable Documentation

## ◆ wxEVT_ACTIVATE

wxEventType wxEVT_ACTIVATE

## ◆ wxEVT_ACTIVATE_APP

wxEventType wxEVT_ACTIVATE_APP

## ◆ wxEVT_ANY

wxEventType wxEVT_ANY

## ◆ wxEVT_AUX1_DCLICK

wxEventType wxEVT_AUX1_DCLICK

## ◆ wxEVT_AUX1_DOWN

wxEventType wxEVT_AUX1_DOWN

## ◆ wxEVT_AUX1_UP

wxEventType wxEVT_AUX1_UP

## ◆ wxEVT_AUX2_DCLICK

wxEventType wxEVT_AUX2_DCLICK

## ◆ wxEVT_AUX2_DOWN

wxEventType wxEVT_AUX2_DOWN

## ◆ wxEVT_AUX2_UP

wxEventType wxEVT_AUX2_UP

## ◆ wxEVT_BUTTON

wxEventType wxEVT_BUTTON

## ◆ wxEVT_CHAR

wxEventType wxEVT_CHAR

## ◆ wxEVT_CHAR_HOOK

wxEventType wxEVT_CHAR_HOOK

## ◆ wxEVT_CHECKBOX

wxEventType wxEVT_CHECKBOX

## ◆ wxEVT_CHECKLISTBOX

wxEventType wxEVT_CHECKLISTBOX

## ◆ wxEVT_CHILD_FOCUS

wxEventType wxEVT_CHILD_FOCUS

## ◆ wxEVT_CHOICE

wxEventType wxEVT_CHOICE

## ◆ wxEVT_CLOSE_WINDOW

wxEventType wxEVT_CLOSE_WINDOW

## ◆ wxEVT_COMBOBOX

wxEventType wxEVT_COMBOBOX

## ◆ wxEVT_COMBOBOX_CLOSEUP

wxEventType wxEVT_COMBOBOX_CLOSEUP

## ◆ wxEVT_COMBOBOX_DROPDOWN

wxEventType wxEVT_COMBOBOX_DROPDOWN

## ◆ wxEVT_COMMAND_ENTER

wxEventType wxEVT_COMMAND_ENTER

## ◆ wxEVT_COMMAND_KILL_FOCUS

wxEventType wxEVT_COMMAND_KILL_FOCUS

## ◆ wxEVT_COMMAND_LEFT_CLICK

wxEventType wxEVT_COMMAND_LEFT_CLICK

## ◆ wxEVT_COMMAND_LEFT_DCLICK

wxEventType wxEVT_COMMAND_LEFT_DCLICK

## ◆ wxEVT_COMMAND_RIGHT_CLICK

wxEventType wxEVT_COMMAND_RIGHT_CLICK

## ◆ wxEVT_COMMAND_RIGHT_DCLICK

wxEventType wxEVT_COMMAND_RIGHT_DCLICK

## ◆ wxEVT_COMMAND_SET_FOCUS

wxEventType wxEVT_COMMAND_SET_FOCUS

## ◆ wxEVT_CONTEXT_MENU

wxEventType wxEVT_CONTEXT_MENU

## ◆ wxEVT_CREATE

wxEventType wxEVT_CREATE

## ◆ wxEVT_DESTROY

wxEventType wxEVT_DESTROY

## ◆ wxEVT_DETAILED_HELP

wxEventType wxEVT_DETAILED_HELP

## ◆ wxEVT_DISPLAY_CHANGED

wxEventType wxEVT_DISPLAY_CHANGED

## ◆ wxEVT_DPI_CHANGED

wxEventType wxEVT_DPI_CHANGED

## ◆ wxEVT_DROP_FILES

wxEventType wxEVT_DROP_FILES

## ◆ wxEVT_END_SESSION

wxEventType wxEVT_END_SESSION

## ◆ wxEVT_ENTER_WINDOW

wxEventType wxEVT_ENTER_WINDOW

## ◆ wxEVT_ERASE_BACKGROUND

wxEventType wxEVT_ERASE_BACKGROUND

## ◆ wxEVT_GESTURE_PAN

wxEventType wxEVT_GESTURE_PAN

## ◆ wxEVT_GESTURE_ROTATE

wxEventType wxEVT_GESTURE_ROTATE

## ◆ wxEVT_GESTURE_ZOOM

wxEventType wxEVT_GESTURE_ZOOM

## ◆ wxEVT_HELP

wxEventType wxEVT_HELP

## ◆ wxEVT_HIBERNATE

wxEventType wxEVT_HIBERNATE

## ◆ wxEVT_HOTKEY

wxEventType wxEVT_HOTKEY

## ◆ wxEVT_ICONIZE

wxEventType wxEVT_ICONIZE

## ◆ wxEVT_IDLE

wxEventType wxEVT_IDLE

## ◆ wxEVT_INIT_DIALOG

wxEventType wxEVT_INIT_DIALOG

## ◆ wxEVT_JOY_BUTTON_DOWN

wxEventType wxEVT_JOY_BUTTON_DOWN

## ◆ wxEVT_JOY_BUTTON_UP

wxEventType wxEVT_JOY_BUTTON_UP

## ◆ wxEVT_JOY_MOVE

wxEventType wxEVT_JOY_MOVE

## ◆ wxEVT_JOY_ZMOVE

wxEventType wxEVT_JOY_ZMOVE

## ◆ wxEVT_KEY_DOWN

wxEventType wxEVT_KEY_DOWN

## ◆ wxEVT_KEY_UP

wxEventType wxEVT_KEY_UP

## ◆ wxEVT_KILL_FOCUS

wxEventType wxEVT_KILL_FOCUS

## ◆ wxEVT_LEAVE_WINDOW

wxEventType wxEVT_LEAVE_WINDOW

## ◆ wxEVT_LEFT_DCLICK

wxEventType wxEVT_LEFT_DCLICK

## ◆ wxEVT_LEFT_DOWN

wxEventType wxEVT_LEFT_DOWN

## ◆ wxEVT_LEFT_UP

wxEventType wxEVT_LEFT_UP

## ◆ wxEVT_LISTBOX

wxEventType wxEVT_LISTBOX

## ◆ wxEVT_LISTBOX_DCLICK

wxEventType wxEVT_LISTBOX_DCLICK

## ◆ wxEVT_LONG_PRESS

wxEventType wxEVT_LONG_PRESS

## ◆ wxEVT_MAGNIFY

wxEventType wxEVT_MAGNIFY

## ◆ wxEVT_MAXIMIZE

wxEventType wxEVT_MAXIMIZE

## ◆ wxEVT_MENU

wxEventType wxEVT_MENU

## ◆ wxEVT_MENU_CLOSE

wxEventType wxEVT_MENU_CLOSE

## ◆ wxEVT_MENU_HIGHLIGHT

wxEventType wxEVT_MENU_HIGHLIGHT

## ◆ wxEVT_MENU_OPEN

wxEventType wxEVT_MENU_OPEN

## ◆ wxEVT_MIDDLE_DCLICK

wxEventType wxEVT_MIDDLE_DCLICK

## ◆ wxEVT_MIDDLE_DOWN

wxEventType wxEVT_MIDDLE_DOWN

## ◆ wxEVT_MIDDLE_UP

wxEventType wxEVT_MIDDLE_UP

## ◆ wxEVT_MOTION

wxEventType wxEVT_MOTION

## ◆ wxEVT_MOUSE_CAPTURE_CHANGED

wxEventType wxEVT_MOUSE_CAPTURE_CHANGED

## ◆ wxEVT_MOUSE_CAPTURE_LOST

wxEventType wxEVT_MOUSE_CAPTURE_LOST

## ◆ wxEVT_MOUSEWHEEL

wxEventType wxEVT_MOUSEWHEEL

## ◆ wxEVT_MOVE

wxEventType wxEVT_MOVE

## ◆ wxEVT_MOVE_END

wxEventType wxEVT_MOVE_END

## ◆ wxEVT_MOVE_START

wxEventType wxEVT_MOVE_START

## ◆ wxEVT_MOVING

wxEventType wxEVT_MOVING

## ◆ wxEVT_NAVIGATION_KEY

wxEventType wxEVT_NAVIGATION_KEY

## ◆ wxEVT_NC_PAINT

wxEventType wxEVT_NC_PAINT

## ◆ wxEVT_NULL

wxEventType wxEVT_NULL

A special event type usually used to indicate that some wxEvent has yet no type assigned.

## ◆ wxEVT_PAINT

wxEventType wxEVT_PAINT

## ◆ wxEVT_PALETTE_CHANGED

wxEventType wxEVT_PALETTE_CHANGED

## ◆ wxEVT_PRESS_AND_TAP

wxEventType wxEVT_PRESS_AND_TAP

## ◆ wxEVT_QUERY_END_SESSION

wxEventType wxEVT_QUERY_END_SESSION

## ◆ wxEVT_QUERY_NEW_PALETTE

wxEventType wxEVT_QUERY_NEW_PALETTE

## ◆ wxEVT_RADIOBOX

wxEventType wxEVT_RADIOBOX

## ◆ wxEVT_RADIOBUTTON

wxEventType wxEVT_RADIOBUTTON

## ◆ wxEVT_RIGHT_DCLICK

wxEventType wxEVT_RIGHT_DCLICK

## ◆ wxEVT_RIGHT_DOWN

wxEventType wxEVT_RIGHT_DOWN

## ◆ wxEVT_RIGHT_UP

wxEventType wxEVT_RIGHT_UP

## ◆ wxEVT_SCROLL_BOTTOM

wxEventType wxEVT_SCROLL_BOTTOM

## ◆ wxEVT_SCROLL_CHANGED

wxEventType wxEVT_SCROLL_CHANGED

## ◆ wxEVT_SCROLL_LINEDOWN

wxEventType wxEVT_SCROLL_LINEDOWN

## ◆ wxEVT_SCROLL_LINEUP

wxEventType wxEVT_SCROLL_LINEUP

## ◆ wxEVT_SCROLL_PAGEDOWN

wxEventType wxEVT_SCROLL_PAGEDOWN

## ◆ wxEVT_SCROLL_PAGEUP

wxEventType wxEVT_SCROLL_PAGEUP

## ◆ wxEVT_SCROLL_THUMBRELEASE

wxEventType wxEVT_SCROLL_THUMBRELEASE

## ◆ wxEVT_SCROLL_THUMBTRACK

wxEventType wxEVT_SCROLL_THUMBTRACK

## ◆ wxEVT_SCROLL_TOP

wxEventType wxEVT_SCROLL_TOP

## ◆ wxEVT_SCROLLBAR

wxEventType wxEVT_SCROLLBAR

## ◆ wxEVT_SCROLLWIN_BOTTOM

wxEventType wxEVT_SCROLLWIN_BOTTOM

## ◆ wxEVT_SCROLLWIN_LINEDOWN

wxEventType wxEVT_SCROLLWIN_LINEDOWN

## ◆ wxEVT_SCROLLWIN_LINEUP

wxEventType wxEVT_SCROLLWIN_LINEUP

## ◆ wxEVT_SCROLLWIN_PAGEDOWN

wxEventType wxEVT_SCROLLWIN_PAGEDOWN

## ◆ wxEVT_SCROLLWIN_PAGEUP

wxEventType wxEVT_SCROLLWIN_PAGEUP

## ◆ wxEVT_SCROLLWIN_THUMBRELEASE

wxEventType wxEVT_SCROLLWIN_THUMBRELEASE

## ◆ wxEVT_SCROLLWIN_THUMBTRACK

wxEventType wxEVT_SCROLLWIN_THUMBTRACK

## ◆ wxEVT_SCROLLWIN_TOP

wxEventType wxEVT_SCROLLWIN_TOP

## ◆ wxEVT_SET_CURSOR

wxEventType wxEVT_SET_CURSOR

## ◆ wxEVT_SET_FOCUS

wxEventType wxEVT_SET_FOCUS

## ◆ wxEVT_SHOW

wxEventType wxEVT_SHOW

## ◆ wxEVT_SIZE

wxEventType wxEVT_SIZE

## ◆ wxEVT_SIZING

wxEventType wxEVT_SIZING

## ◆ wxEVT_SLIDER

wxEventType wxEVT_SLIDER

## ◆ wxEVT_SPIN

wxEventType wxEVT_SPIN

## ◆ wxEVT_SPIN_DOWN

wxEventType wxEVT_SPIN_DOWN

## ◆ wxEVT_SPIN_UP

wxEventType wxEVT_SPIN_UP

## ◆ wxEVT_SYS_COLOUR_CHANGED

wxEventType wxEVT_SYS_COLOUR_CHANGED

## ◆ wxEVT_TEXT_COPY

wxEventType wxEVT_TEXT_COPY

## ◆ wxEVT_TEXT_CUT

wxEventType wxEVT_TEXT_CUT

## ◆ wxEVT_TEXT_PASTE

wxEventType wxEVT_TEXT_PASTE

## ◆ wxEVT_THREAD

wxEventType wxEVT_THREAD

## ◆ wxEVT_TOOL

wxEventType wxEVT_TOOL

## ◆ wxEVT_TOOL_DROPDOWN

wxEventType wxEVT_TOOL_DROPDOWN

## ◆ wxEVT_TOOL_ENTER

wxEventType wxEVT_TOOL_ENTER

## ◆ wxEVT_TOOL_RCLICKED

wxEventType wxEVT_TOOL_RCLICKED

## ◆ wxEVT_TWO_FINGER_TAP

wxEventType wxEVT_TWO_FINGER_TAP

## ◆ wxEVT_UPDATE_UI

wxEventType wxEVT_UPDATE_UI

## ◆ wxEVT_VLBOX

wxEventType wxEVT_VLBOX

## ◆ wxEVT_WINDOW_MODAL_DIALOG_CLOSED

wxEventType wxEVT_WINDOW_MODAL_DIALOG_CLOSED