docs/html/sdlquitevent.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >SDL_QuitEvent</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
   8 "><LINK
   9 REL="HOME"
  10 TITLE="SDL Library Documentation"
  11 HREF="index.html"><LINK
  12 REL="UP"
  13 TITLE="SDL Event Structures."
  14 HREF="eventstructures.html"><LINK
  15 REL="PREVIOUS"
  16 TITLE="SDL_UserEvent"
  17 HREF="sdluserevent.html"><LINK
  18 REL="NEXT"
  19 TITLE="SDL_keysym"
  20 HREF="sdlkeysym.html"></HEAD
  21 ><BODY
  22 CLASS="REFENTRY"
  23 BGCOLOR="#FFF8DC"
  24 TEXT="#000000"
  25 LINK="#0000ee"
  26 VLINK="#551a8b"
  27 ALINK="#ff0000"
  28 ><DIV
  29 CLASS="NAVHEADER"
  30 ><TABLE
  31 SUMMARY="Header navigation table"
  32 WIDTH="100%"
  33 BORDER="0"
  34 CELLPADDING="0"
  35 CELLSPACING="0"
  36 ><TR
  37 ><TH
  38 COLSPAN="3"
  39 ALIGN="center"
  40 >SDL Library Documentation</TH
  41 ></TR
  42 ><TR
  43 ><TD
  44 WIDTH="10%"
  45 ALIGN="left"
  46 VALIGN="bottom"
  47 ><A
  48 HREF="sdluserevent.html"
  49 ACCESSKEY="P"
  50 >Prev</A
  51 ></TD
  52 ><TD
  53 WIDTH="80%"
  54 ALIGN="center"
  55 VALIGN="bottom"
  56 ></TD
  57 ><TD
  58 WIDTH="10%"
  59 ALIGN="right"
  60 VALIGN="bottom"
  61 ><A
  62 HREF="sdlkeysym.html"
  63 ACCESSKEY="N"
  64 >Next</A
  65 ></TD
  66 ></TR
  67 ></TABLE
  68 ><HR
  69 ALIGN="LEFT"
  70 WIDTH="100%"></DIV
  71 ><H1
  72 ><A
  73 NAME="SDLQUITEVENT"
  74 ></A
  75 >SDL_QuitEvent</H1
  76 ><DIV
  77 CLASS="REFNAMEDIV"
  78 ><A
  79 NAME="AEN4621"
  80 ></A
  81 ><H2
  82 >Name</H2
  83 >SDL_QuitEvent&nbsp;--&nbsp;Quit requested event</DIV
  84 ><DIV
  85 CLASS="REFSECT1"
  86 ><A
  87 NAME="AEN4624"
  88 ></A
  89 ><H2
  90 >Structure Definition</H2
  91 ><PRE
  92 CLASS="PROGRAMLISTING"
  93 >typedef struct{
  94   Uint8 type
  95 } SDL_QuitEvent;</PRE
  96 ></DIV
  97 ><DIV
  98 CLASS="REFSECT1"
  99 ><A
 100 NAME="AEN4627"
 101 ></A
 102 ><H2
 103 >Structure Data</H2
 104 ><DIV
 105 CLASS="INFORMALTABLE"
 106 ><A
 107 NAME="AEN4629"
 108 ></A
 109 ><P
 110 ></P
 111 ><TABLE
 112 BORDER="0"
 113 CLASS="CALSTABLE"
 114 ><TBODY
 115 ><TR
 116 ><TD
 117 ALIGN="LEFT"
 118 VALIGN="TOP"
 119 ><TT
 120 CLASS="STRUCTFIELD"
 121 ><I
 122 >type</I
 123 ></TT
 124 ></TD
 125 ><TD
 126 ALIGN="LEFT"
 127 VALIGN="TOP"
 128 ><TT
 129 CLASS="LITERAL"
 130 >SDL_QUIT</TT
 131 ></TD
 132 ></TR
 133 ></TBODY
 134 ></TABLE
 135 ><P
 136 ></P
 137 ></DIV
 138 ></DIV
 139 ><DIV
 140 CLASS="REFSECT1"
 141 ><A
 142 NAME="AEN4637"
 143 ></A
 144 ><H2
 145 >Description</H2
 146 ><P
 147 ><SPAN
 148 CLASS="STRUCTNAME"
 149 >SDL_QuitEvent</SPAN
 150 > is a member of the <A
 151 HREF="sdlevent.html"
 152 ><SPAN
 153 CLASS="STRUCTNAME"
 154 >SDL_Event</SPAN
 155 ></A
 156 > union and is used whan an event of type <TT
 157 CLASS="LITERAL"
 158 >SDL_QUIT</TT
 159 > is reported.</P
 160 ><P
 161 >As can be seen, the SDL_QuitEvent structure serves no useful purpose. The event itself, on the other hand, is very important. If you filter out or ignore a quit event then it is impossible for the user to close the window. On the other hand, if you do accept a quit event then the application window will be closed, and screen updates will still report success event though the application will no longer be visible.</P
 162 ><DIV
 163 CLASS="NOTE"
 164 ><BLOCKQUOTE
 165 CLASS="NOTE"
 166 ><P
 167 ><B
 168 >Note: </B
 169 >The macro <TT
 170 CLASS="FUNCTION"
 171 >SDL_QuitRequested</TT
 172 > will return non-zero if a quit event is pending</P
 173 ></BLOCKQUOTE
 174 ></DIV
 175 ></DIV
 176 ><DIV
 177 CLASS="REFSECT1"
 178 ><A
 179 NAME="AEN4648"
 180 ></A
 181 ><H2
 182 >See Also</H2
 183 ><P
 184 ><A
 185 HREF="sdlevent.html"
 186 ><SPAN
 187 CLASS="STRUCTNAME"
 188 >SDL_Event</SPAN
 189 ></A
 190 >,
 191 <A
 192 HREF="sdlseteventfilter.html"
 193 ><TT
 194 CLASS="FUNCTION"
 195 >SDL_SetEventFilter</TT
 196 ></A
 197 ></P
 198 ></DIV
 199 ><DIV
 200 CLASS="NAVFOOTER"
 201 ><HR
 202 ALIGN="LEFT"
 203 WIDTH="100%"><TABLE
 204 SUMMARY="Footer navigation table"
 205 WIDTH="100%"
 206 BORDER="0"
 207 CELLPADDING="0"
 208 CELLSPACING="0"
 209 ><TR
 210 ><TD
 211 WIDTH="33%"
 212 ALIGN="left"
 213 VALIGN="top"
 214 ><A
 215 HREF="sdluserevent.html"
 216 ACCESSKEY="P"
 217 >Prev</A
 218 ></TD
 219 ><TD
 220 WIDTH="34%"
 221 ALIGN="center"
 222 VALIGN="top"
 223 ><A
 224 HREF="index.html"
 225 ACCESSKEY="H"
 226 >Home</A
 227 ></TD
 228 ><TD
 229 WIDTH="33%"
 230 ALIGN="right"
 231 VALIGN="top"
 232 ><A
 233 HREF="sdlkeysym.html"
 234 ACCESSKEY="N"
 235 >Next</A
 236 ></TD
 237 ></TR
 238 ><TR
 239 ><TD
 240 WIDTH="33%"
 241 ALIGN="left"
 242 VALIGN="top"
 243 >SDL_UserEvent</TD
 244 ><TD
 245 WIDTH="34%"
 246 ALIGN="center"
 247 VALIGN="top"
 248 ><A
 249 HREF="eventstructures.html"
 250 ACCESSKEY="U"
 251 >Up</A
 252 ></TD
 253 ><TD
 254 WIDTH="33%"
 255 ALIGN="right"
 256 VALIGN="top"
 257 >SDL_keysym</TD
 258 ></TR
 259 ></TABLE
 260 ></DIV
 261 ></BODY
 262 ></HTML
 263 >