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}, \param{wxEventType }{eventType = {\tt wxEVT\_NULL}}}
  25
  26 Constructor. Should not need to be used directly by an application.
  27
  28 \membersection{wxEvent::m\_eventObject}
  29
  30 \member{wxObject*}{m\_eventObject}
  31
  32 The object (usually a window) that the event was generated from,
  33 or should be sent to.
  34
  35 \membersection{wxEvent::m\_eventType}
  36
  37 \member{WXTYPE}{m\_eventType}
  38
  39 The type of the event, such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
  40
  41 \membersection{wxEvent::m\_id}
  42
  43 \member{int}{m\_id}
  44
  45 Identifier for the window.
  46
  47 \membersection{wxEvent::m\_propagationLevel}
  48
  49 \member{int}{m\_propagationLevel}
  50
  51 Indicates how many levels the event can propagate. This member is protected and
  52 should typically only be set in the constructors of the derived classes. It
  53 may be temporarily changed by \helpref{StopPropagation}{wxeventstoppropagation}
  54 and \helpref{ResumePropagation}{wxeventresumepropagation} and tested with
  55 \helpref{ShouldPropagate}{wxeventshouldpropagate}.
  56
  57 The initial value is set to either {\tt wxEVENT\_PROPAGATION\_NONE} (by
  58 default) meaning that the event shouldn't be propagated at all or to
  59 {\tt wxEVENT\_PROPAGATION\_MAX} (for command events) meaning that it should be
  60 propagated as much as necessary.
  61
  62 Any positive number means that the event should be propagated but no more than
  63 the given number of times. E.g. the propagation level may be set to $1$ to
  64 propagate the event to its parent only, but not to its grandparent.
  65
  66 \membersection{wxEvent::m\_skipped}
  67
  68 \member{bool}{m\_skipped}
  69
  70 Set to true by {\bf Skip} if this event should be skipped.
  71
  72 \membersection{wxEvent::m\_timeStamp}
  73
  74 \member{long}{m\_timeStamp}
  75
  76 Timestamp for this event.
  77
  78 \membersection{wxEvent::Clone}\label{wxeventclone}
  79
  80 \constfunc{virtual wxEvent*}{Clone}{\void}
  81
  82 Returns a copy of the event.
  83
  84 Any event that is posted to the wxWindows event system for later action (via
  85 \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent} or
  86 \helpref{wxPostEvent}{wxpostevent}) must implement this method. All wxWindows
  87 events fully implement this method, but any derived events implemented by the
  88 user should also implement this method just in case they (or some event
  89 derived from them) are ever posted.
  90
  91 All wxWindows events implement a copy constructor, so the easiest way of
  92 implementing the Clone function is to implement a copy constructor for
  93 a new event (call it MyEvent) and then define the Clone function like this:
  94 \begin{verbatim}
  95     wxEvent *Clone(void) const { return new MyEvent(*this); }
  96 \end{verbatim}
  97
  98 \membersection{wxEvent::GetEventObject}
  99
 100 \func{wxObject*}{GetEventObject}{\void}
 101
 102 Returns the object associated with the
 103 event, if any.
 104
 105 \membersection{wxEvent::GetEventType}
 106
 107 \func{WXTYPE}{GetEventType}{\void}
 108
 109 Returns the identifier of the given event type,
 110 such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
 111
 112 \membersection{wxEvent::GetId}
 113
 114 \constfunc{int}{GetId}{\void}
 115
 116 Returns the identifier associated with this event, such as a button command id.
 117
 118 \membersection{wxEvent::GetSkipped}
 119
 120 \constfunc{bool}{GetSkipped}{\void}
 121
 122 Returns true if the event handler should be skipped, false otherwise.
 123
 124 \membersection{wxEvent::GetTimestamp}
 125
 126 \func{long}{GetTimestamp}{\void}
 127
 128 Gets the timestamp for the event.
 129
 130 \membersection{wxEvent::IsCommandEvent}\label{wxeventiscommandevent}
 131
 132 \constfunc{bool}{IsCommandEvent}{\void}
 133
 134 Returns true if the event is or is derived from
 135 \helpref{wxCommandEvent}{wxcommandevent} else it returns false.
 136 Note: Exists only for optimization purposes.
 137
 138
 139 \membersection{wxEvent::ResumePropagation}\label{wxeventresumepropagation}
 140
 141 \func{void}{ResumePropagation}{\param{int }{propagationLevel}}
 142
 143 Sets the propagation level to the given value (for example returned from an
 144 earlier call to \helpref{StopPropagation}{wxeventstoppropagation}).
 145
 146
 147 \membersection{wxEvent::SetEventObject}
 148
 149 \func{void}{SetEventObject}{\param{wxObject* }{object}}
 150
 151 Sets the originating object.
 152
 153 \membersection{wxEvent::SetEventType}
 154
 155 \func{void}{SetEventType}{\param{WXTYPE }{typ}}
 156
 157 Sets the event type.
 158
 159 \membersection{wxEvent::SetId}
 160
 161 \func{void}{SetId}{\param{int}{ id}}
 162
 163 Sets the identifier associated with this event, such as a button command id.
 164
 165 \membersection{wxEvent::SetTimestamp}
 166
 167 \func{void}{SetTimestamp}{\param{long }{timeStamp}}
 168
 169 Sets the timestamp for the event.
 170
 171 Sets the originating object.
 172
 173 \membersection{wxEvent::ShouldPropagate}\label{wxeventshouldpropagate}
 174
 175 \constfunc{bool}{ShouldPropagate}{\void}
 176
 177 Test if this event should be propagated or not, i.e. if the propagation level
 178 is currently greater than $0$.
 179
 180 \membersection{wxEvent::Skip}\label{wxeventskip}
 181
 182 \func{void}{Skip}{\param{bool}{ skip = true}}
 183
 184 Called by an event handler to tell the event system that the
 185 event handler should be skipped, and the next valid handler used
 186 instead.
 187
 188 \membersection{wxEvent::StopPropagation}\label{wxeventstoppropagation}
 189
 190 \func{int}{StopPropagation}{\void}
 191
 192 Stop the event from propagating to its parent window.
 193
 194 Returns the old propagation level value which may be later passed to
 195 \helpref{ResumePropagation}{wxeventresumepropagation} to allow propagating the
 196 event again.
 197