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\_skipped}
  48
  49 \member{bool}{m\_skipped}
  50
  51 Set to true by {\bf Skip} if this event should be skipped.
  52
  53 \membersection{wxEvent::m\_timeStamp}
  54
  55 \member{long}{m\_timeStamp}
  56
  57 Timestamp for this event.
  58
  59 \membersection{wxEvent::Clone}\label{wxeventclone}
  60
  61 \constfunc{virtual wxEvent*}{Clone}{\void}
  62
  63 Returns a copy of the event.
  64
  65 Any event that is posted to the wxWindows event system for later action (via
  66 \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent} or
  67 \helpref{wxPostEvent}{wxpostevent}) must implement this method. All wxWindows
  68 events fully implement this method, but any derived events implemented by the
  69 user should also implement this method just in case they (or some event
  70 derived from them) are ever posted.
  71
  72 All wxWindows events implement a copy constructor, so the easiest way of
  73 implementing the Clone function is to implement a copy constructor for
  74 a new event (call it MyEvent) and then define the Clone function like this:
  75 \begin{verbatim}
  76     wxEvent *Clone(void) const { return new MyEvent(*this); }
  77 \end{verbatim}
  78
  79 \membersection{wxEvent::GetEventObject}
  80
  81 \func{wxObject*}{GetEventObject}{\void}
  82
  83 Returns the object associated with the
  84 event, if any.
  85
  86 \membersection{wxEvent::GetEventType}
  87
  88 \func{WXTYPE}{GetEventType}{\void}
  89
  90 Returns the identifier of the given event type,
  91 such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
  92
  93 \membersection{wxEvent::GetId}
  94
  95 \func{int}{GetId}{\void}
  96
  97 Returns the identifier associated with this event, such as a button command id.
  98
  99 \membersection{wxEvent::GetSkipped}
 100
 101 \func{bool}{GetSkipped}{\void}
 102
 103 Returns true if the event handler should be skipped, false otherwise.
 104
 105 \membersection{wxEvent::GetTimestamp}
 106
 107 \func{long}{GetTimestamp}{\void}
 108
 109 Gets the timestamp for the event.
 110
 111 \membersection{wxEvent::SetEventObject}
 112
 113 \func{void}{SetEventObject}{\param{wxObject* }{object}}
 114
 115 Sets the originating object.
 116
 117 \membersection{wxEvent::SetEventType}
 118
 119 \func{void}{SetEventType}{\param{WXTYPE }{typ}}
 120
 121 Sets the event type.
 122
 123 \membersection{wxEvent::SetId}
 124
 125 \func{void}{SetId}{\param{int}{ id}}
 126
 127 Sets the identifier associated with this event, such as a button command id.
 128
 129 \membersection{wxEvent::SetTimestamp}
 130
 131 \func{void}{SetTimestamp}{\param{long }{timeStamp}}
 132
 133 Sets the timestamp for the event.
 134
 135 Sets the originating object.
 136
 137 \membersection{wxEvent::Skip}\label{wxeventskip}
 138
 139 \func{void}{Skip}{\param{bool}{ skip = true}}
 140
 141 Called by an event handler to tell the event system that the
 142 event handler should be skipped, and the next valid handler used
 143 instead.
 144