• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_ActiveEvent</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="SDL Event Structures."
14HREF="eventstructures.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_Event"
17HREF="sdlevent.html"><LINK
18REL="NEXT"
19TITLE="SDL_KeyboardEvent"
20HREF="sdlkeyboardevent.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdlevent.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdlkeyboardevent.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLACTIVEEVENT"
74></A
75>SDL_ActiveEvent</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN3955"
80></A
81><H2
82>Name</H2
83>SDL_ActiveEvent&nbsp;--&nbsp;Application visibility event structure</DIV
84><DIV
85CLASS="REFSECT1"
86><A
87NAME="AEN3958"
88></A
89><H2
90>Structure Definition</H2
91><PRE
92CLASS="PROGRAMLISTING"
93>typedef struct{
94  Uint8 type;
95  Uint8 gain;
96  Uint8 state;
97} SDL_ActiveEvent;</PRE
98></DIV
99><DIV
100CLASS="REFSECT1"
101><A
102NAME="AEN3961"
103></A
104><H2
105>Structure Data</H2
106><DIV
107CLASS="INFORMALTABLE"
108><A
109NAME="AEN3963"
110></A
111><P
112></P
113><TABLE
114BORDER="0"
115CLASS="CALSTABLE"
116><TBODY
117><TR
118><TD
119ALIGN="LEFT"
120VALIGN="TOP"
121><TT
122CLASS="STRUCTFIELD"
123><I
124>type</I
125></TT
126></TD
127><TD
128ALIGN="LEFT"
129VALIGN="TOP"
130><TT
131CLASS="LITERAL"
132>SDL_ACTIVEEVENT.</TT
133></TD
134></TR
135><TR
136><TD
137ALIGN="LEFT"
138VALIGN="TOP"
139><TT
140CLASS="STRUCTFIELD"
141><I
142>gain</I
143></TT
144></TD
145><TD
146ALIGN="LEFT"
147VALIGN="TOP"
148>0 if the event is a loss or 1 if it is a gain.</TD
149></TR
150><TR
151><TD
152ALIGN="LEFT"
153VALIGN="TOP"
154><TT
155CLASS="STRUCTFIELD"
156><I
157>state</I
158></TT
159></TD
160><TD
161ALIGN="LEFT"
162VALIGN="TOP"
163><TT
164CLASS="LITERAL"
165>SDL_APPMOUSEFOCUS</TT
166> if mouse focus was gained or lost, <TT
167CLASS="LITERAL"
168>SDL_APPINPUTFOCUS</TT
169> if input focus was gained or lost, or <TT
170CLASS="LITERAL"
171>SDL_APPACTIVE</TT
172> if the application was iconified (<TT
173CLASS="STRUCTFIELD"
174><I
175>gain</I
176></TT
177>=0) or restored(<TT
178CLASS="STRUCTFIELD"
179><I
180>gain</I
181></TT
182>=1).</TD
183></TR
184></TBODY
185></TABLE
186><P
187></P
188></DIV
189></DIV
190><DIV
191CLASS="REFSECT1"
192><A
193NAME="AEN3984"
194></A
195><H2
196>Description</H2
197><P
198><SPAN
199CLASS="STRUCTNAME"
200>SDL_ActiveEvent</SPAN
201> is a member of the <A
202HREF="sdlevent.html"
203><SPAN
204CLASS="STRUCTNAME"
205>SDL_Event</SPAN
206></A
207> union and is used when an event of type <TT
208CLASS="LITERAL"
209>SDL_ACTIVEEVENT</TT
210> is reported.</P
211><P
212>When the mouse leaves or enters the window area a <TT
213CLASS="LITERAL"
214>SDL_APPMOUSEFOCUS</TT
215> type activation event occurs, if the mouse entered the window then <TT
216CLASS="STRUCTFIELD"
217><I
218>gain</I
219></TT
220> will be 1, otherwise <TT
221CLASS="STRUCTFIELD"
222><I
223>gain</I
224></TT
225> will be 0. A <TT
226CLASS="LITERAL"
227>SDL_APPINPUTFOCUS</TT
228> type activation event occurs when the application loses or gains keyboard focus. This usually occurs when another application is made active. Finally, a <TT
229CLASS="LITERAL"
230>SDL_APPACTIVE</TT
231> type event occurs when the application is either minimised/iconified (<TT
232CLASS="STRUCTFIELD"
233><I
234>gain</I
235></TT
236>=0) or restored.</P
237><DIV
238CLASS="NOTE"
239><BLOCKQUOTE
240CLASS="NOTE"
241><P
242><B
243>Note: </B
244>This event does not occur when an application window is first created.</P
245></BLOCKQUOTE
246></DIV
247></DIV
248><DIV
249CLASS="REFSECT1"
250><A
251NAME="AEN4000"
252></A
253><H2
254>See Also</H2
255><P
256><A
257HREF="sdlevent.html"
258><SPAN
259CLASS="STRUCTNAME"
260>SDL_Event</SPAN
261></A
262>,
263<A
264HREF="sdlgetappstate.html"
265><TT
266CLASS="FUNCTION"
267>SDL_GetAppState</TT
268></A
269></P
270></DIV
271><DIV
272CLASS="NAVFOOTER"
273><HR
274ALIGN="LEFT"
275WIDTH="100%"><TABLE
276SUMMARY="Footer navigation table"
277WIDTH="100%"
278BORDER="0"
279CELLPADDING="0"
280CELLSPACING="0"
281><TR
282><TD
283WIDTH="33%"
284ALIGN="left"
285VALIGN="top"
286><A
287HREF="sdlevent.html"
288ACCESSKEY="P"
289>Prev</A
290></TD
291><TD
292WIDTH="34%"
293ALIGN="center"
294VALIGN="top"
295><A
296HREF="index.html"
297ACCESSKEY="H"
298>Home</A
299></TD
300><TD
301WIDTH="33%"
302ALIGN="right"
303VALIGN="top"
304><A
305HREF="sdlkeyboardevent.html"
306ACCESSKEY="N"
307>Next</A
308></TD
309></TR
310><TR
311><TD
312WIDTH="33%"
313ALIGN="left"
314VALIGN="top"
315>SDL_Event</TD
316><TD
317WIDTH="34%"
318ALIGN="center"
319VALIGN="top"
320><A
321HREF="eventstructures.html"
322ACCESSKEY="U"
323>Up</A
324></TD
325><TD
326WIDTH="33%"
327ALIGN="right"
328VALIGN="top"
329>SDL_KeyboardEvent</TD
330></TR
331></TABLE
332></DIV
333></BODY
334></HTML
335>