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 to discard any event (or a set of event types) directed to a specific window. More...
class  wxEvtHandler
 A class that can handle events from the windowing system. More...
class  wxKeyEvent
 This event class contains information about keypress (character) 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 using the control panel. 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  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  wxCommandEvent
 This event class contains information about command events, which originate from a variety of simple controls. 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
 An mouse capture lost event is sent to a window that obtained mouse capture, which was subsequently loss due to "external" event, for example when a dialog box is shown or if another application captures the mouse. More...
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 functionalities to wxCommandEvent coinceived for inter-threads communications. 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  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
 An 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 wxTopLevelWindow move change events. 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...

Defines

#define DEFINE_EVENT_TYPE(name)   const wxEventType name = wxNewEventType();
 Initializes a new event type using wxNewEventType().
#define wxDEFINE_EVENT(name, cls)   const wxEventTypeTag< cls > name(wxNewEventType())
 Define a new event type associated with the specified event class.
#define wxDECLARE_EVENT(name, cls)   wxDECLARE_EXPORTED_EVENT(wxEMPTY_PARAMETER_VALUE, name, cls)
 Declares a custom event type.
#define wxDECLARE_EXPORTED_EVENT(expdecl, name, cls)   extern const expdecl wxEventTypeTag< cls > name;
 Variant of wxDECLARE_EVENT() used for event types defined inside a shared library.
#define wxEVENT_HANDLER_CAST(functype, func)   (&func)
 Helper macro for definition of custom event table macros.
#define wx__DECLARE_EVT1(evt, id, fn)   wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
 This macro is used to define event table macros for handling custom events.
#define wx__DECLARE_EVT2(evt, id1, id2, fn)   DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
 Generalized version of the wx__DECLARE_EVT1() macro taking a range of IDs instead of a single one.
#define wx__DECLARE_EVT0(evt, fn)   wx__DECLARE_EVT1(evt, wxID_ANY, 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 DECLARE_EVENT_TABLE()
 Use this macro inside a class declaration to declare a static event table for that class.
#define BEGIN_EVENT_TABLE(theClass, baseClass)
 Use this macro in a source file to start listing static event handlers for a specific class.
#define END_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  wxUpdateUIMode {
  wxUPDATE_UI_PROCESS_ALL,
  wxUPDATE_UI_PROCESS_SPECIFIED
}
 

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

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.

Enumeration Type Documentation

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.

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

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.

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

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.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]