1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<HTML>
<head><title>wxEvent</title></head>
<BODY BGCOLOR=#FFFFFF>
<A NAME="wxevent"></A><CENTER>
<A HREF="wx.htm"><img align=center src="contents.gif" BORDER=0 ALT="Contents"></A> <A HREF="wx22.htm#classref"><img align=center src="up.gif" BORDER=0 ALT="Up"></A> <A HREF="wx83.htm#wxeraseevent"><img align=center src="back.gif" BORDER=0 ALT="Previous"></A> <A HREF="wx85.htm#wxevthandler"><img align=center src="forward.gif" BORDER=0 ALT="Next"></A> </CENTER><HR>
<H2>wxEvent</H2>
<P>
An event is a structure holding information about an event passed to a
callback or member function. <B>wxEvent</B> used to be a multipurpose
event object, and is an abstract base class for other event classes (see below).<P>
<B><FONT COLOR="#FF0000">Derived from</FONT></B><P>
<A HREF="wx158.htm#wxobject">wxObject</A><P>
<B><FONT COLOR="#FF0000">Include files</FONT></B><P>
<wx/event.h><P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx52.htm#wxcommandevent">wxCommandEvent</A>,
<A HREF="wx150.htm#wxmouseevent">wxMouseEvent</A><P>
<B><FONT COLOR="#FF0000">Members</FONT></B><P>
<A HREF="#topic338">wxEvent::wxEvent</A><BR>
<A HREF="#topic339">wxEvent::m_eventHandle</A><BR>
<A HREF="#topic340">wxEvent::m_eventObject</A><BR>
<A HREF="#topic341">wxEvent::m_eventType</A><BR>
<A HREF="#topic342">wxEvent::m_id</A><BR>
<A HREF="#topic343">wxEvent::m_skipped</A><BR>
<A HREF="#topic344">wxEvent::m_timeStamp</A><BR>
<A HREF="#topic345">wxEvent::GetEventClass</A><BR>
<A HREF="#topic346">wxEvent::GetEventObject</A><BR>
<A HREF="#topic347">wxEvent::GetEventType</A><BR>
<A HREF="#topic348">wxEvent::GetId</A><BR>
<A HREF="#topic349">wxEvent::GetObjectType</A><BR>
<A HREF="#topic350">wxEvent::GetSkipped</A><BR>
<A HREF="#topic351">wxEvent::GetTimestamp</A><BR>
<A HREF="#topic352">wxEvent::SetEventObject</A><BR>
<A HREF="#topic353">wxEvent::SetEventType</A><BR>
<A HREF="#topic354">wxEvent::SetId</A><BR>
<A HREF="#topic355">wxEvent::SetTimestamp</A><BR>
<A HREF="#wxeventskip">wxEvent::Skip</A><BR>
<P>
<HR>
<A NAME="topic338"></A>
<H3>wxEvent::wxEvent</H3>
<P>
<B></B> <B>wxEvent</B>(<B>int </B><I>id = 0</I>)<P>
Constructor. Should not need to be used directly by an application.<P>
<HR>
<A NAME="topic339"></A>
<H3>wxEvent::m_eventHandle</H3>
<P>
char* m_eventHandle<P>
Handle of an underlying windowing system event handle, such as
XEvent. Not guaranteed to be instantiated.<P>
<HR>
<A NAME="topic340"></A>
<H3>wxEvent::m_eventObject</H3>
<P>
wxObject* m_eventObject<P>
The object (usually a window) that the event was generated from,
or should be sent to.<P>
<HR>
<A NAME="topic341"></A>
<H3>wxEvent::m_eventType</H3>
<P>
WXTYPE m_eventType<P>
The type of the event, such as wxEVENT_TYPE_BUTTON_COMMAND.<P>
<HR>
<A NAME="topic342"></A>
<H3>wxEvent::m_id</H3>
<P>
int m_id<P>
Identifier for the window.<P>
<HR>
<A NAME="topic343"></A>
<H3>wxEvent::m_skipped</H3>
<P>
bool m_skipped<P>
Set to TRUE by <B>Skip</B> if this event should be skipped.<P>
<HR>
<A NAME="topic344"></A>
<H3>wxEvent::m_timeStamp</H3>
<P>
long m_timeStamp<P>
Timestamp for this event.<P>
<HR>
<A NAME="topic345"></A>
<H3>wxEvent::GetEventClass</H3>
<P>
<B>WXTYPE</B> <B>GetEventClass</B>()<P>
Returns the identifier of the given event class,
such as wxTYPE_MOUSE_EVENT.<P>
<HR>
<A NAME="topic346"></A>
<H3>wxEvent::GetEventObject</H3>
<P>
<B>wxObject*</B> <B>GetEventObject</B>()<P>
Returns the object associated with the
event, if any.<P>
<HR>
<A NAME="topic347"></A>
<H3>wxEvent::GetEventType</H3>
<P>
<B>WXTYPE</B> <B>GetEventType</B>()<P>
Returns the identifier of the given event type,
such as wxEVENT_TYPE_BUTTON_COMMAND.<P>
<HR>
<A NAME="topic348"></A>
<H3>wxEvent::GetId</H3>
<P>
<B>int</B> <B>GetId</B>()<P>
Returns the identifier associated with this event, such as a button command id.<P>
<HR>
<A NAME="topic349"></A>
<H3>wxEvent::GetObjectType</H3>
<P>
<B>WXTYPE</B> <B>GetObjectType</B>()<P>
Returns the type of the object associated with the
event, such as wxTYPE_BUTTON.<P>
<HR>
<A NAME="topic350"></A>
<H3>wxEvent::GetSkipped</H3>
<P>
<B>bool</B> <B>GetSkipped</B>()<P>
Returns TRUE if the event handler should be skipped, FALSE otherwise.<P>
<HR>
<A NAME="topic351"></A>
<H3>wxEvent::GetTimestamp</H3>
<P>
<B>long</B> <B>GetTimestamp</B>()<P>
Gets the timestamp for the event.<P>
<HR>
<A NAME="topic352"></A>
<H3>wxEvent::SetEventObject</H3>
<P>
<B>void</B> <B>SetEventObject</B>(<B>wxObject* </B><I>object</I>)<P>
Sets the originating object.<P>
<HR>
<A NAME="topic353"></A>
<H3>wxEvent::SetEventType</H3>
<P>
<B>void</B> <B>SetEventType</B>(<B>WXTYPE </B><I>typ</I>)<P>
Sets the event type.<P>
<HR>
<A NAME="topic354"></A>
<H3>wxEvent::SetId</H3>
<P>
<B>void</B> <B>SetId</B>(<B>int</B><I> id</I>)<P>
Sets the identifier associated with this event, such as a button command id.<P>
<HR>
<A NAME="topic355"></A>
<H3>wxEvent::SetTimestamp</H3>
<P>
<B>void</B> <B>SetTimestamp</B>(<B>long </B><I>timeStamp</I>)<P>
Sets the timestamp for the event.<P>
Sets the originating object.<P>
<HR>
<A NAME="wxeventskip"></A>
<H3>wxEvent::Skip</H3>
<P>
<B>void</B> <B>Skip</B>(<B>bool</B><I> skip = TRUE</I>)<P>
Called by an event handler to tell the event system that the
event handler should be skipped, and the next valid handler used
instead.<P>
</BODY></HTML>
|
