projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
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 | ||
| 954b8ae6 JS |
11 | \wxheading{Include files} |
| 12 | ||
| 13 | <wx/event.h> | |
| 14 | ||
| a660d684 KB |
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 | ||
| a660d684 KB |
66 | \membersection{wxEvent::GetEventObject} |
| 67 | ||
| 68 | \func{wxObject*}{GetEventObject}{\void} | |
| 69 | ||
| 70 | Returns the object associated with the | |
| 71 | event, if any. | |
| 72 | ||
| 73 | \membersection{wxEvent::GetEventType} | |
| 74 | ||
| 75 | \func{WXTYPE}{GetEventType}{\void} | |
| 76 | ||
| 77 | Returns the identifier of the given event type, | |
| 78 | such as wxEVENT\_TYPE\_BUTTON\_COMMAND. | |
| 79 | ||
| 80 | \membersection{wxEvent::GetId} | |
| 81 | ||
| 82 | \func{int}{GetId}{\void} | |
| 83 | ||
| 84 | Returns the identifier associated with this event, such as a button command id. | |
| 85 | ||
| 86 | \membersection{wxEvent::GetObjectType} | |
| 87 | ||
| 88 | \func{WXTYPE}{GetObjectType}{\void} | |
| 89 | ||
| 90 | Returns the type of the object associated with the | |
| 91 | event, such as wxTYPE\_BUTTON. | |
| 92 | ||
| 93 | \membersection{wxEvent::GetSkipped} | |
| 94 | ||
| 95 | \func{bool}{GetSkipped}{\void} | |
| 96 | ||
| 97 | Returns TRUE if the event handler should be skipped, FALSE otherwise. | |
| 98 | ||
| 99 | \membersection{wxEvent::GetTimestamp} | |
| 100 | ||
| 101 | \func{long}{GetTimestamp}{\void} | |
| 102 | ||
| 103 | Gets the timestamp for the event. | |
| 104 | ||
| 105 | \membersection{wxEvent::SetEventObject} | |
| 106 | ||
| 107 | \func{void}{SetEventObject}{\param{wxObject* }{object}} | |
| 108 | ||
| 109 | Sets the originating object. | |
| 110 | ||
| 111 | \membersection{wxEvent::SetEventType} | |
| 112 | ||
| 113 | \func{void}{SetEventType}{\param{WXTYPE }{typ}} | |
| 114 | ||
| 115 | Sets the event type. | |
| 116 | ||
| 117 | \membersection{wxEvent::SetId} | |
| 118 | ||
| 119 | \func{void}{SetId}{\param{int}{ id}} | |
| 120 | ||
| 121 | Sets the identifier associated with this event, such as a button command id. | |
| 122 | ||
| 123 | \membersection{wxEvent::SetTimestamp} | |
| 124 | ||
| 125 | \func{void}{SetTimestamp}{\param{long }{timeStamp}} | |
| 126 | ||
| 127 | Sets the timestamp for the event. | |
| 128 | ||
| 129 | Sets the originating object. | |
| 130 | ||
| 131 | \membersection{wxEvent::Skip}\label{wxeventskip} | |
| 132 | ||
| 133 | \func{void}{Skip}{\param{bool}{ skip = TRUE}} | |
| 134 | ||
| 135 | Called by an event handler to tell the event system that the | |
| 136 | event handler should be skipped, and the next valid handler used | |
| 137 | instead. | |
| 138 |