Mercurial > sdl-ios-xcode
view docs/html/sdlenableunicode.html @ 1271:092722dbc766
Whoops! (hope this compiles...)
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Thu, 26 Jan 2006 07:38:43 +0000 |
parents | 355632dca928 |
children |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_EnableUNICODE</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="Event Functions." HREF="eventfunctions.html"><LINK REL="PREVIOUS" TITLE="SDL_GetKeyName" HREF="sdlgetkeyname.html"><LINK REL="NEXT" TITLE="SDL_EnableKeyRepeat" HREF="sdlenablekeyrepeat.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="sdlgetkeyname.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdlenablekeyrepeat.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLENABLEUNICODE" ></A >SDL_EnableUNICODE</H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN5805" ></A ><H2 >Name</H2 >SDL_EnableUNICODE -- Enable UNICODE translation</DIV ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN5808" ></A ><H2 >Synopsis</H2 ><DIV CLASS="FUNCSYNOPSIS" ><A NAME="AEN5809" ></A ><P ></P ><PRE CLASS="FUNCSYNOPSISINFO" >#include "SDL.h"</PRE ><P ><CODE ><CODE CLASS="FUNCDEF" >int <B CLASS="FSFUNC" >SDL_EnableUNICODE</B ></CODE >(int enable);</CODE ></P ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN5815" ></A ><H2 >Description</H2 ><P >Enables/Disables Unicode keyboard translation.</P ><P >To obtain the character codes corresponding to received keyboard events, Unicode translation must first be turned on using this function. The translation incurs a slight overhead for each keyboard event and is therefore disabled by default. For each subsequently received key down event, the <TT CLASS="STRUCTFIELD" ><I >unicode</I ></TT > member of the <A HREF="sdlkeysym.html" ><SPAN CLASS="STRUCTNAME" >SDL_keysym</SPAN ></A > structure will then contain the corresponding character code, or zero for keysyms that do not correspond to any character code.</P ><P >A value of 1 for <TT CLASS="PARAMETER" ><I >enable</I ></TT > enables Unicode translation; 0 disables it, and -1 leaves it unchanged (useful for querying the current translation mode).</P ><P >Note that only key press events will be translated, not release events.</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN5825" ></A ><H2 >Return Value</H2 ><P >Returns the previous translation mode (<SPAN CLASS="RETURNVALUE" >0</SPAN > or <SPAN CLASS="RETURNVALUE" >1</SPAN >).</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN5830" ></A ><H2 >See Also</H2 ><P ><A HREF="sdlkeysym.html" ><SPAN CLASS="STRUCTNAME" >SDL_keysym</SPAN ></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="sdlgetkeyname.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="sdlenablekeyrepeat.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >SDL_GetKeyName</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="eventfunctions.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_EnableKeyRepeat</TD ></TR ></TABLE ></DIV ></BODY ></HTML >