docs/latex/wx/event.tex

   1 \section{\class{wxEvent}}\label{wxevent}
   2
   3 An event is a structure holding information about an event passed to a
   4 callback or member function. {\bf wxEvent} used to be a multipurpose
   5 event object, and is an abstract base class for other event classes (see below).
   6
   7 \wxheading{Derived from}
   8
   9 \helpref{wxObject}{wxobject}
  10
  11 \wxheading{Include files}
  12
  13 <wx/event.h>
  14
  15 \wxheading{See also}
  16
  17 \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
  18 \helpref{wxMouseEvent}{wxmouseevent}
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22 \membersection{wxEvent::wxEvent}
  23
  24 \func{}{wxEvent}{\param{int }{id = 0}}
  25
  26 Constructor. Should not need to be used directly by an application.
  27
  28 \membersection{wxEvent::m\_eventHandle}
  29
  30 \member{char*}{m\_eventHandle}
  31
  32 Handle of an underlying windowing system event handle, such as
  33 XEvent. Not guaranteed to be instantiated.
  34
  35 \membersection{wxEvent::m\_eventObject}
  36
  37 \member{wxObject*}{m\_eventObject}
  38
  39 The object (usually a window) that the event was generated from,
  40 or should be sent to.
  41
  42 \membersection{wxEvent::m\_eventType}
  43
  44 \member{WXTYPE}{m\_eventType}
  45
  46 The type of the event, such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
  47
  48 \membersection{wxEvent::m\_id}
  49
  50 \member{int}{m\_id}
  51
  52 Identifier for the window.
  53
  54 \membersection{wxEvent::m\_skipped}
  55
  56 \member{bool}{m\_skipped}
  57
  58 Set to TRUE by {\bf Skip} if this event should be skipped.
  59
  60 \membersection{wxEvent::m\_timeStamp}
  61
  62 \member{long}{m\_timeStamp}
  63
  64 Timestamp for this event.
  65
  66 \membersection{wxEvent::GetEventClass}
  67
  68 \func{WXTYPE}{GetEventClass}{\void}
  69
  70 Returns the identifier of the given event class,
  71 such as wxTYPE\_MOUSE\_EVENT.
  72
  73 \membersection{wxEvent::GetEventObject}
  74
  75 \func{wxObject*}{GetEventObject}{\void}
  76
  77 Returns the object associated with the
  78 event, if any.
  79
  80 \membersection{wxEvent::GetEventType}
  81
  82 \func{WXTYPE}{GetEventType}{\void}
  83
  84 Returns the identifier of the given event type,
  85 such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
  86
  87 \membersection{wxEvent::GetId}
  88
  89 \func{int}{GetId}{\void}
  90
  91 Returns the identifier associated with this event, such as a button command id.
  92
  93 \membersection{wxEvent::GetObjectType}
  94
  95 \func{WXTYPE}{GetObjectType}{\void}
  96
  97 Returns the type of the object associated with the
  98 event, such as wxTYPE\_BUTTON.
  99
 100 \membersection{wxEvent::GetSkipped}
 101
 102 \func{bool}{GetSkipped}{\void}
 103
 104 Returns TRUE if the event handler should be skipped, FALSE otherwise.
 105
 106 \membersection{wxEvent::GetTimestamp}
 107
 108 \func{long}{GetTimestamp}{\void}
 109
 110 Gets the timestamp for the event.
 111
 112 \membersection{wxEvent::SetEventObject}
 113
 114 \func{void}{SetEventObject}{\param{wxObject* }{object}}
 115
 116 Sets the originating object.
 117
 118 \membersection{wxEvent::SetEventType}
 119
 120 \func{void}{SetEventType}{\param{WXTYPE }{typ}}
 121
 122 Sets the event type.
 123
 124 \membersection{wxEvent::SetId}
 125
 126 \func{void}{SetId}{\param{int}{ id}}
 127
 128 Sets the identifier associated with this event, such as a button command id.
 129
 130 \membersection{wxEvent::SetTimestamp}
 131
 132 \func{void}{SetTimestamp}{\param{long }{timeStamp}}
 133
 134 Sets the timestamp for the event.
 135
 136 Sets the originating object.
 137
 138 \membersection{wxEvent::Skip}\label{wxeventskip}
 139
 140 \func{void}{Skip}{\param{bool}{ skip = TRUE}}
 141
 142 Called by an event handler to tell the event system that the
 143 event handler should be skipped, and the next valid handler used
 144 instead.
 145