Home | History | Annotate | Download | only in html 
      1 <HTML
      2 ><HEAD
      3 ><TITLE
      4 >SDL_EventState</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="Event Functions."
     14 HREF="eventfunctions.html"><LINK
     15 REL="PREVIOUS"
     16 TITLE="SDL_GetEventFilter"
     17 HREF="sdlgeteventfilter.html"><LINK
     18 REL="NEXT"
     19 TITLE="SDL_GetKeyState"
     20 HREF="sdlgetkeystate.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="sdlgeteventfilter.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="sdlgetkeystate.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="SDLEVENTSTATE"
     74 ></A
     75 >SDL_EventState</H1
     76 ><DIV
     77 CLASS="REFNAMEDIV"
     78 ><A
     79 NAME="AEN5646"
     80 ></A
     81 ><H2
     82 >Name</H2
     83 >SDL_EventState&nbsp;--&nbsp;This function allows you to set the state of processing certain events.</DIV
     84 ><DIV
     85 CLASS="REFSYNOPSISDIV"
     86 ><A
     87 NAME="AEN5649"
     88 ></A
     89 ><H2
     90 >Synopsis</H2
     91 ><DIV
     92 CLASS="FUNCSYNOPSIS"
     93 ><A
     94 NAME="AEN5650"
     95 ></A
     96 ><P
     97 ></P
     98 ><PRE
     99 CLASS="FUNCSYNOPSISINFO"
    100 >#include "SDL.h"</PRE
    101 ><P
    102 ><CODE
    103 ><CODE
    104 CLASS="FUNCDEF"
    105 >Uint8 <B
    106 CLASS="FSFUNC"
    107 >SDL_EventState</B
    108 ></CODE
    109 >(Uint8 type, int state);</CODE
    110 ></P
    111 ><P
    112 ></P
    113 ></DIV
    114 ></DIV
    115 ><DIV
    116 CLASS="REFSECT1"
    117 ><A
    118 NAME="AEN5656"
    119 ></A
    120 ><H2
    121 >Description</H2
    122 ><P
    123 >This function allows you to set the state of processing certain event <TT
    124 CLASS="PARAMETER"
    125 ><I
    126 >type</I
    127 ></TT
    128 >'s.</P
    129 ><P
    130 >If <TT
    131 CLASS="PARAMETER"
    132 ><I
    133 >state</I
    134 ></TT
    135 > is set to <TT
    136 CLASS="LITERAL"
    137 >SDL_IGNORE</TT
    138 >, 
    139 that event <TT
    140 CLASS="PARAMETER"
    141 ><I
    142 >type</I
    143 ></TT
    144 > will be automatically dropped from the event queue and will 
    145 not be filtered.</P
    146 ><P
    147 >If <TT
    148 CLASS="PARAMETER"
    149 ><I
    150 >state</I
    151 ></TT
    152 > is set to <TT
    153 CLASS="LITERAL"
    154 >SDL_ENABLE</TT
    155 >, 
    156 that event <TT
    157 CLASS="PARAMETER"
    158 ><I
    159 >type</I
    160 ></TT
    161 > will be processed normally.</P
    162 ><P
    163 >If <TT
    164 CLASS="PARAMETER"
    165 ><I
    166 >state</I
    167 ></TT
    168 > is set to <TT
    169 CLASS="LITERAL"
    170 >SDL_QUERY</TT
    171 >,
    172 <TT
    173 CLASS="FUNCTION"
    174 >SDL_EventState</TT
    175 > will return the current processing 
    176 state of the specified event <TT
    177 CLASS="PARAMETER"
    178 ><I
    179 >type</I
    180 ></TT
    181 >.</P
    182 ><P
    183 >A list of event <TT
    184 CLASS="PARAMETER"
    185 ><I
    186 >type</I
    187 ></TT
    188 >'s can be found in the <A
    189 HREF="sdlevent.html"
    190 ><SPAN
    191 CLASS="STRUCTNAME"
    192 >SDL_Event</SPAN
    193 ></A
    194 > section.</P
    195 ></DIV
    196 ><DIV
    197 CLASS="REFSECT1"
    198 ><A
    199 NAME="AEN5677"
    200 ></A
    201 ><H2
    202 >See Also</H2
    203 ><P
    204 ><A
    205 HREF="sdlevent.html"
    206 ><SPAN
    207 CLASS="STRUCTNAME"
    208 >SDL_Event</SPAN
    209 ></A
    210 ></P
    211 ></DIV
    212 ><DIV
    213 CLASS="NAVFOOTER"
    214 ><HR
    215 ALIGN="LEFT"
    216 WIDTH="100%"><TABLE
    217 SUMMARY="Footer navigation table"
    218 WIDTH="100%"
    219 BORDER="0"
    220 CELLPADDING="0"
    221 CELLSPACING="0"
    222 ><TR
    223 ><TD
    224 WIDTH="33%"
    225 ALIGN="left"
    226 VALIGN="top"
    227 ><A
    228 HREF="sdlgeteventfilter.html"
    229 ACCESSKEY="P"
    230 >Prev</A
    231 ></TD
    232 ><TD
    233 WIDTH="34%"
    234 ALIGN="center"
    235 VALIGN="top"
    236 ><A
    237 HREF="index.html"
    238 ACCESSKEY="H"
    239 >Home</A
    240 ></TD
    241 ><TD
    242 WIDTH="33%"
    243 ALIGN="right"
    244 VALIGN="top"
    245 ><A
    246 HREF="sdlgetkeystate.html"
    247 ACCESSKEY="N"
    248 >Next</A
    249 ></TD
    250 ></TR
    251 ><TR
    252 ><TD
    253 WIDTH="33%"
    254 ALIGN="left"
    255 VALIGN="top"
    256 >SDL_GetEventFilter</TD
    257 ><TD
    258 WIDTH="34%"
    259 ALIGN="center"
    260 VALIGN="top"
    261 ><A
    262 HREF="eventfunctions.html"
    263 ACCESSKEY="U"
    264 >Up</A
    265 ></TD
    266 ><TD
    267 WIDTH="33%"
    268 ALIGN="right"
    269 VALIGN="top"
    270 >SDL_GetKeyState</TD
    271 ></TR
    272 ></TABLE
    273 ></DIV
    274 ></BODY
    275 ></HTML
    276 >