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