summaryrefslogtreecommitdiff
path: root/doc/html/classsf_1_1Event.htm
blob: c22c85d5e1364e3b9987c7e315f6d675b928c728 (plain)
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <title>SFML - Simple and Fast Multimedia Library</title>
        <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
        <link href="tabs.css" rel="stylesheet" type="text/css" />
    </head>
    <body>
        <div id="logo">
            <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
        </div>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
  <ul>
    <li><a href="index.htm"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.htm"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.htm"><span>Classes</span></a></li>
    <li><a href="files.htm"><span>Files</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.htm"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.htm"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.htm"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.htm"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<div class="nav">
<a class="el" href="namespacesf.htm">sf</a>::<a class="el" href="classsf_1_1Event.htm">Event</a></div>
<h1>sf::Event Class Reference</h1><!-- doxytag: class="sf::Event" --><a class="el" href="classsf_1_1Event.htm" title="Event defines a system event and its parameters.">Event</a> defines a system event and its parameters.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Event_8hpp-source.htm">Event.hpp</a>&gt;</code>
<p>
<a href="classsf_1_1Event-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a">EventType</a> { <br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a316e4212e083f1dce79efd8d9e9c0a95">Closed</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a67fd26d7e520bc6722db3ff47ef24941">Resized</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4abd7877b5011a337268357c973e8347bd">LostFocus</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a8c5003ced508499933d540df8a6023ec">GainedFocus</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a7e09871dc984080ff528e4f7e073e874">TextEntered</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4ac3c7abfaa98c73bfe6be0b57df09c71b">KeyPressed</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4aa5bcc1e603d5a6f4c137af39558bd5d1">KeyReleased</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a5cc9d3941af2a36049f4f9922c934a80">MouseWheelMoved</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a55a3dcc8bf6c40e37f9ff2cdf606481f">MouseButtonPressed</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a9be69ecc07e484467ebbb133182fe5c1">MouseButtonReleased</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a4ff4fc3b3dc857e3617a63feb54be209">MouseMoved</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a50d98590a953e74c7ccf3dabadb22067">MouseEntered</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4aa90b8526b328e0246d04b026de17c6e7">MouseLeft</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4ade775771e9d3cbb61195b605c51de12a">JoyButtonPressed</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4af46cb19972ae5314adbccc52fea942a2">JoyButtonReleased</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4ade4f95e7116fb238a36d1e565e42e78a">JoyMoved</a>
<br>
 }</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enumeration of the different types of events.  <a href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a">EventType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Event.htm#90d5da29dd2f49d13dc10e7a402c0b65">Type</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type of the event.  <a href="#90d5da29dd2f49d13dc10e7a402c0b65"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap><a class="anchor" name="d0b8d1f46b2c3ff70843eccb438c6038"></a><!-- doxytag: member="sf::Event::@2" ref="d0b8d1f46b2c3ff70843eccb438c6038" args="" -->
union {</td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structsf_1_1Event_1_1KeyEvent.htm">KeyEvent</a>&nbsp;&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#529227c18c1530068dafd241da7b0af9">Key</a></td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structsf_1_1Event_1_1TextEvent.htm">TextEvent</a>&nbsp;&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#b5e7e4154cd3734502f226303f68c58d">Text</a></td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structsf_1_1Event_1_1MouseMoveEvent.htm">MouseMoveEvent</a>&nbsp;&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#0ac5a0cd79bea16e374023f18b8d39db">MouseMove</a></td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structsf_1_1Event_1_1MouseButtonEvent.htm">MouseButtonEvent</a>&nbsp;&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#bcd104440e0e43647d8f0ba49a593210">MouseButton</a></td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structsf_1_1Event_1_1MouseWheelEvent.htm">MouseWheelEvent</a>&nbsp;&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#64d0f7a2cce7196de0a0e28b2d3fdd7c">MouseWheel</a></td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structsf_1_1Event_1_1JoyMoveEvent.htm">JoyMoveEvent</a>&nbsp;&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#7225b7733f73845dc8d07af7c8ecfb22">JoyMove</a></td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structsf_1_1Event_1_1JoyButtonEvent.htm">JoyButtonEvent</a>&nbsp;&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#d39651df3634e2bcdc4c567933055464">JoyButton</a></td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structsf_1_1Event_1_1SizeEvent.htm">SizeEvent</a>&nbsp;&nbsp;&nbsp;<a class="el" href="classsf_1_1Event.htm#bf98a968c19a31f9719ff40839c28f9e">Size</a></td></tr>

<tr><td class="memItemLeft" nowrap valign="top">};&nbsp;</td><td class="memItemRight" valign="bottom"></td></tr>

<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1Event_1_1JoyButtonEvent.htm">JoyButtonEvent</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Joystick buttons events parameters.  <a href="structsf_1_1Event_1_1JoyButtonEvent.htm#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1Event_1_1JoyMoveEvent.htm">JoyMoveEvent</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Joystick axis move event parameters.  <a href="structsf_1_1Event_1_1JoyMoveEvent.htm#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1Event_1_1KeyEvent.htm">KeyEvent</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Keyboard event parameters.  <a href="structsf_1_1Event_1_1KeyEvent.htm#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1Event_1_1MouseButtonEvent.htm">MouseButtonEvent</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="namespacesf_1_1Mouse.htm" title="Definition of button codes for mouse events.">Mouse</a> buttons events parameters.  <a href="structsf_1_1Event_1_1MouseButtonEvent.htm#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1Event_1_1MouseMoveEvent.htm">MouseMoveEvent</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="namespacesf_1_1Mouse.htm" title="Definition of button codes for mouse events.">Mouse</a> move event parameters.  <a href="structsf_1_1Event_1_1MouseMoveEvent.htm#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1Event_1_1MouseWheelEvent.htm">MouseWheelEvent</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="namespacesf_1_1Mouse.htm" title="Definition of button codes for mouse events.">Mouse</a> wheel events parameters.  <a href="structsf_1_1Event_1_1MouseWheelEvent.htm#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1Event_1_1SizeEvent.htm">SizeEvent</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size events parameters.  <a href="structsf_1_1Event_1_1SizeEvent.htm#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1Event_1_1TextEvent.htm">TextEvent</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Text event parameters.  <a href="structsf_1_1Event_1_1TextEvent.htm#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classsf_1_1Event.htm" title="Event defines a system event and its parameters.">Event</a> defines a system event and its parameters. 
<p>

<p>
Definition at line <a class="el" href="Event_8hpp-source.htm#l00191">191</a> of file <a class="el" href="Event_8hpp-source.htm">Event.hpp</a>.<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="f41fa9ed45c02449030699f671331d4a"></a><!-- doxytag: member="sf::Event::EventType" ref="f41fa9ed45c02449030699f671331d4a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a">sf::Event::EventType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Enumeration of the different types of events. 
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4a316e4212e083f1dce79efd8d9e9c0a95"></a><!-- doxytag: member="Closed" ref="f41fa9ed45c02449030699f671331d4a316e4212e083f1dce79efd8d9e9c0a95" args="" -->Closed</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4a67fd26d7e520bc6722db3ff47ef24941"></a><!-- doxytag: member="Resized" ref="f41fa9ed45c02449030699f671331d4a67fd26d7e520bc6722db3ff47ef24941" args="" -->Resized</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4abd7877b5011a337268357c973e8347bd"></a><!-- doxytag: member="LostFocus" ref="f41fa9ed45c02449030699f671331d4abd7877b5011a337268357c973e8347bd" args="" -->LostFocus</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4a8c5003ced508499933d540df8a6023ec"></a><!-- doxytag: member="GainedFocus" ref="f41fa9ed45c02449030699f671331d4a8c5003ced508499933d540df8a6023ec" args="" -->GainedFocus</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4a7e09871dc984080ff528e4f7e073e874"></a><!-- doxytag: member="TextEntered" ref="f41fa9ed45c02449030699f671331d4a7e09871dc984080ff528e4f7e073e874" args="" -->TextEntered</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4ac3c7abfaa98c73bfe6be0b57df09c71b"></a><!-- doxytag: member="KeyPressed" ref="f41fa9ed45c02449030699f671331d4ac3c7abfaa98c73bfe6be0b57df09c71b" args="" -->KeyPressed</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4aa5bcc1e603d5a6f4c137af39558bd5d1"></a><!-- doxytag: member="KeyReleased" ref="f41fa9ed45c02449030699f671331d4aa5bcc1e603d5a6f4c137af39558bd5d1" args="" -->KeyReleased</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4a5cc9d3941af2a36049f4f9922c934a80"></a><!-- doxytag: member="MouseWheelMoved" ref="f41fa9ed45c02449030699f671331d4a5cc9d3941af2a36049f4f9922c934a80" args="" -->MouseWheelMoved</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4a55a3dcc8bf6c40e37f9ff2cdf606481f"></a><!-- doxytag: member="MouseButtonPressed" ref="f41fa9ed45c02449030699f671331d4a55a3dcc8bf6c40e37f9ff2cdf606481f" args="" -->MouseButtonPressed</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4a9be69ecc07e484467ebbb133182fe5c1"></a><!-- doxytag: member="MouseButtonReleased" ref="f41fa9ed45c02449030699f671331d4a9be69ecc07e484467ebbb133182fe5c1" args="" -->MouseButtonReleased</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4a4ff4fc3b3dc857e3617a63feb54be209"></a><!-- doxytag: member="MouseMoved" ref="f41fa9ed45c02449030699f671331d4a4ff4fc3b3dc857e3617a63feb54be209" args="" -->MouseMoved</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4a50d98590a953e74c7ccf3dabadb22067"></a><!-- doxytag: member="MouseEntered" ref="f41fa9ed45c02449030699f671331d4a50d98590a953e74c7ccf3dabadb22067" args="" -->MouseEntered</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4aa90b8526b328e0246d04b026de17c6e7"></a><!-- doxytag: member="MouseLeft" ref="f41fa9ed45c02449030699f671331d4aa90b8526b328e0246d04b026de17c6e7" args="" -->MouseLeft</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4ade775771e9d3cbb61195b605c51de12a"></a><!-- doxytag: member="JoyButtonPressed" ref="f41fa9ed45c02449030699f671331d4ade775771e9d3cbb61195b605c51de12a" args="" -->JoyButtonPressed</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4af46cb19972ae5314adbccc52fea942a2"></a><!-- doxytag: member="JoyButtonReleased" ref="f41fa9ed45c02449030699f671331d4af46cb19972ae5314adbccc52fea942a2" args="" -->JoyButtonReleased</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f41fa9ed45c02449030699f671331d4ade4f95e7116fb238a36d1e565e42e78a"></a><!-- doxytag: member="JoyMoved" ref="f41fa9ed45c02449030699f671331d4ade4f95e7116fb238a36d1e565e42e78a" args="" -->JoyMoved</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>

<p>
Definition at line <a class="el" href="Event_8hpp-source.htm#l00272">272</a> of file <a class="el" href="Event_8hpp-source.htm">Event.hpp</a>.
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="90d5da29dd2f49d13dc10e7a402c0b65"></a><!-- doxytag: member="sf::Event::Type" ref="90d5da29dd2f49d13dc10e7a402c0b65" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1Event.htm#f41fa9ed45c02449030699f671331d4a">EventType</a> <a class="el" href="classsf_1_1Event.htm#90d5da29dd2f49d13dc10e7a402c0b65">sf::Event::Type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Type of the event. 
<p>

<p>
Definition at line <a class="el" href="Event_8hpp-source.htm#l00295">295</a> of file <a class="el" href="Event_8hpp-source.htm">Event.hpp</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Event_8hpp-source.htm">Event.hpp</a></ul>

        <p id="footer">
            &nbsp;::&nbsp; Copyright &copy; 2007-2008 Laurent Gomila, all rights reserved &nbsp;::&nbsp;
            Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> &nbsp;::&nbsp;
        </p>

    </body>
</html>