diff options
Diffstat (limited to 'distrib/sdl-1.2.15/docs/html/sdlkeyboardevent.html')
-rw-r--r-- | distrib/sdl-1.2.15/docs/html/sdlkeyboardevent.html | 375 |
1 files changed, 375 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/html/sdlkeyboardevent.html b/distrib/sdl-1.2.15/docs/html/sdlkeyboardevent.html new file mode 100644 index 0000000..1a6962c --- /dev/null +++ b/distrib/sdl-1.2.15/docs/html/sdlkeyboardevent.html @@ -0,0 +1,375 @@ +<HTML +><HEAD +><TITLE +>SDL_KeyboardEvent</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ +"><LINK +REL="HOME" +TITLE="SDL Library Documentation" +HREF="index.html"><LINK +REL="UP" +TITLE="SDL Event Structures." +HREF="eventstructures.html"><LINK +REL="PREVIOUS" +TITLE="SDL_ActiveEvent" +HREF="sdlactiveevent.html"><LINK +REL="NEXT" +TITLE="SDL_MouseMotionEvent" +HREF="sdlmousemotionevent.html"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFF8DC" +TEXT="#000000" +LINK="#0000ee" +VLINK="#551a8b" +ALINK="#ff0000" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>SDL Library Documentation</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="sdlactiveevent.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +></TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="sdlmousemotionevent.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><H1 +><A +NAME="SDLKEYBOARDEVENT" +></A +>SDL_KeyboardEvent</H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN4011" +></A +><H2 +>Name</H2 +>SDL_KeyboardEvent -- Keyboard event structure</DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN4014" +></A +><H2 +>Structure Definition</H2 +><PRE +CLASS="PROGRAMLISTING" +>typedef struct{ + Uint8 type; + Uint8 state; + SDL_keysym keysym; +} SDL_KeyboardEvent;</PRE +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN4017" +></A +><H2 +>Structure Data</H2 +><DIV +CLASS="INFORMALTABLE" +><A +NAME="AEN4019" +></A +><P +></P +><TABLE +BORDER="0" +CLASS="CALSTABLE" +><TBODY +><TR +><TD +ALIGN="LEFT" +VALIGN="TOP" +><TT +CLASS="STRUCTFIELD" +><I +>type</I +></TT +></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +><TT +CLASS="LITERAL" +>SDL_KEYDOWN</TT +> or <TT +CLASS="LITERAL" +>SDL_KEYUP</TT +></TD +></TR +><TR +><TD +ALIGN="LEFT" +VALIGN="TOP" +><TT +CLASS="STRUCTFIELD" +><I +>state</I +></TT +></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +><TT +CLASS="LITERAL" +>SDL_PRESSED</TT +> or <TT +CLASS="LITERAL" +>SDL_RELEASED</TT +></TD +></TR +><TR +><TD +ALIGN="LEFT" +VALIGN="TOP" +><TT +CLASS="STRUCTFIELD" +><I +>keysym</I +></TT +></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +>Contains key press information</TD +></TR +></TBODY +></TABLE +><P +></P +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN4038" +></A +><H2 +>Description</H2 +><P +><SPAN +CLASS="STRUCTNAME" +>SDL_KeyboardEvent</SPAN +> is a member of the <A +HREF="sdlevent.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_Event</SPAN +></A +> union and is used when an event of type <TT +CLASS="LITERAL" +>SDL_KEYDOWN</TT +> or <TT +CLASS="LITERAL" +>SDL_KEYUP</TT +> is reported.</P +><P +>The <TT +CLASS="STRUCTFIELD" +><I +>type</I +></TT +> and <TT +CLASS="STRUCTFIELD" +><I +>state</I +></TT +> actually report the same information, they just use different values to do it! A keyboard event occurs when a key is released (<TT +CLASS="STRUCTFIELD" +><I +>type</I +></TT +>=<TT +CLASS="LITERAL" +>SDK_KEYUP</TT +> or <TT +CLASS="STRUCTFIELD" +><I +>state</I +></TT +>=<TT +CLASS="LITERAL" +>SDL_RELEASED</TT +>) and when a key is pressed (<TT +CLASS="STRUCTFIELD" +><I +>type</I +></TT +>=<TT +CLASS="LITERAL" +>SDL_KEYDOWN</TT +> or <TT +CLASS="STRUCTFIELD" +><I +>state</I +></TT +>=<TT +CLASS="LITERAL" +>SDL_PRESSED</TT +>). The information on what key was pressed or released is in the <A +HREF="sdlkeysym.html" +><SPAN +CLASS="STRUCTNAME" +>keysym</SPAN +></A +> structure.</P +><DIV +CLASS="NOTE" +><BLOCKQUOTE +CLASS="NOTE" +><P +><B +>Note: </B +>Repeating <TT +CLASS="LITERAL" +>SDL_KEYDOWN</TT +> events will occur if key repeat is enabled (see <A +HREF="sdlenablekeyrepeat.html" +><TT +CLASS="FUNCTION" +>SDL_EnableKeyRepeat</TT +></A +>).</P +></BLOCKQUOTE +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN4064" +></A +><H2 +>See Also</H2 +><P +><A +HREF="sdlevent.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_Event</SPAN +></A +>, +<A +HREF="sdlkeysym.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_keysym</SPAN +></A +>, +<A +HREF="sdlenablekeyrepeat.html" +><TT +CLASS="FUNCTION" +>SDL_EnableKeyRepeat</TT +></A +>, +<A +HREF="sdlenableunicode.html" +><TT +CLASS="FUNCTION" +>SDL_EnableUNICODE</TT +></A +></P +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="sdlactiveevent.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="sdlmousemotionevent.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>SDL_ActiveEvent</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="eventstructures.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>SDL_MouseMotionEvent</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file |