Mercurial > sdl-ios-xcode
annotate docs/html/sdlenableunicode.html @ 274:051b991765ba
David Snopek added Borland compiler support
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Wed, 13 Feb 2002 17:45:24 +0000 |
| parents | e5bc29de3f0a |
| children | 355632dca928 |
| rev | line source |
|---|---|
| 0 | 1 <HTML |
| 2 ><HEAD | |
| 3 ><TITLE | |
| 4 >SDL_EnableUNICODE</TITLE | |
| 5 ><META | |
| 6 NAME="GENERATOR" | |
|
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
| 0 | 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_GetKeyName" | |
| 17 HREF="sdlgetkeyname.html"><LINK | |
| 18 REL="NEXT" | |
| 19 TITLE="SDL_EnableKeyRepeat" | |
| 20 HREF="sdlenablekeyrepeat.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 WIDTH="100%" | |
| 32 BORDER="0" | |
| 33 CELLPADDING="0" | |
| 34 CELLSPACING="0" | |
| 35 ><TR | |
| 36 ><TH | |
| 37 COLSPAN="3" | |
| 38 ALIGN="center" | |
| 39 >SDL Library Documentation</TH | |
| 40 ></TR | |
| 41 ><TR | |
| 42 ><TD | |
| 43 WIDTH="10%" | |
| 44 ALIGN="left" | |
| 45 VALIGN="bottom" | |
| 46 ><A | |
| 47 HREF="sdlgetkeyname.html" | |
| 48 >Prev</A | |
| 49 ></TD | |
| 50 ><TD | |
| 51 WIDTH="80%" | |
| 52 ALIGN="center" | |
| 53 VALIGN="bottom" | |
| 54 ></TD | |
| 55 ><TD | |
| 56 WIDTH="10%" | |
| 57 ALIGN="right" | |
| 58 VALIGN="bottom" | |
| 59 ><A | |
| 60 HREF="sdlenablekeyrepeat.html" | |
| 61 >Next</A | |
| 62 ></TD | |
| 63 ></TR | |
| 64 ></TABLE | |
| 65 ><HR | |
| 66 ALIGN="LEFT" | |
| 67 WIDTH="100%"></DIV | |
| 68 ><H1 | |
| 69 ><A | |
| 70 NAME="SDLENABLEUNICODE" | |
| 71 >SDL_EnableUNICODE</A | |
| 72 ></H1 | |
| 73 ><DIV | |
| 74 CLASS="REFNAMEDIV" | |
| 75 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
76 NAME="AEN5417" |
| 0 | 77 ></A |
| 78 ><H2 | |
| 79 >Name</H2 | |
| 80 >SDL_EnableUNICODE -- Enable UNICODE translation</DIV | |
| 81 ><DIV | |
| 82 CLASS="REFSYNOPSISDIV" | |
| 83 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
84 NAME="AEN5420" |
| 0 | 85 ></A |
| 86 ><H2 | |
| 87 >Synopsis</H2 | |
| 88 ><DIV | |
| 89 CLASS="FUNCSYNOPSIS" | |
| 90 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
91 NAME="AEN5421" |
| 0 | 92 ></A |
| 93 ><P | |
| 94 ></P | |
| 95 ><PRE | |
| 96 CLASS="FUNCSYNOPSISINFO" | |
| 97 >#include "SDL.h"</PRE | |
| 98 ><P | |
| 99 ><CODE | |
| 100 ><CODE | |
| 101 CLASS="FUNCDEF" | |
| 102 >int <B | |
| 103 CLASS="FSFUNC" | |
| 104 >SDL_EnableUNICODE</B | |
| 105 ></CODE | |
| 106 >(int enable);</CODE | |
| 107 ></P | |
| 108 ><P | |
| 109 ></P | |
| 110 ></DIV | |
| 111 ></DIV | |
| 112 ><DIV | |
| 113 CLASS="REFSECT1" | |
| 114 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
115 NAME="AEN5427" |
| 0 | 116 ></A |
| 117 ><H2 | |
| 118 >Description</H2 | |
| 119 ><P | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
120 >Enables/Disables Unicode keyboard translation.</P |
| 0 | 121 ><P |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
122 >To obtain the character codes corresponding to received keyboard events, |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
123 Unicode translation must first be turned on using this function. The |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
124 translation incurs a slight overhead for each keyboard event and is therefore |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
125 disabled by default. For each subsequently received key down event, the |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
126 <TT |
| 0 | 127 CLASS="STRUCTFIELD" |
| 128 ><I | |
| 129 >unicode</I | |
| 130 ></TT | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
131 > member of the |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
132 <A |
| 0 | 133 HREF="sdlkeysym.html" |
| 134 ><SPAN | |
| 135 CLASS="STRUCTNAME" | |
| 136 >SDL_keysym</SPAN | |
| 137 ></A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
138 > structure |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
139 will then contain the corresponding character code, or zero for keysyms that do |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
140 not correspond to any character code.</P |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
141 ><P |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
142 >A value of 1 for <TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
143 CLASS="PARAMETER" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
144 ><I |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
145 >enable</I |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
146 ></TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
147 > enables Unicode translation; |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
148 0 disables it, and -1 leaves it unchanged (useful for querying the current |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
149 translation mode).</P |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
150 ><P |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
151 >Note that only key press events will be translated, not release events.</P |
| 0 | 152 ></DIV |
| 153 ><DIV | |
| 154 CLASS="REFSECT1" | |
| 155 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
156 NAME="AEN5437" |
| 0 | 157 ></A |
| 158 ><H2 | |
| 159 >Return Value</H2 | |
| 160 ><P | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
161 >Returns the previous translation mode (<SPAN |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
162 CLASS="RETURNVALUE" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
163 >0</SPAN |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
164 > or <SPAN |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
165 CLASS="RETURNVALUE" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
166 >1</SPAN |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
167 >).</P |
| 0 | 168 ></DIV |
| 169 ><DIV | |
| 170 CLASS="REFSECT1" | |
| 171 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
172 NAME="AEN5442" |
| 0 | 173 ></A |
| 174 ><H2 | |
| 175 >See Also</H2 | |
| 176 ><P | |
| 177 ><A | |
| 178 HREF="sdlkeysym.html" | |
| 179 ><SPAN | |
| 180 CLASS="STRUCTNAME" | |
| 181 >SDL_keysym</SPAN | |
| 182 ></A | |
| 183 ></P | |
| 184 ></DIV | |
| 185 ><DIV | |
| 186 CLASS="NAVFOOTER" | |
| 187 ><HR | |
| 188 ALIGN="LEFT" | |
| 189 WIDTH="100%"><TABLE | |
| 190 WIDTH="100%" | |
| 191 BORDER="0" | |
| 192 CELLPADDING="0" | |
| 193 CELLSPACING="0" | |
| 194 ><TR | |
| 195 ><TD | |
| 196 WIDTH="33%" | |
| 197 ALIGN="left" | |
| 198 VALIGN="top" | |
| 199 ><A | |
| 200 HREF="sdlgetkeyname.html" | |
| 201 >Prev</A | |
| 202 ></TD | |
| 203 ><TD | |
| 204 WIDTH="34%" | |
| 205 ALIGN="center" | |
| 206 VALIGN="top" | |
| 207 ><A | |
| 208 HREF="index.html" | |
| 209 >Home</A | |
| 210 ></TD | |
| 211 ><TD | |
| 212 WIDTH="33%" | |
| 213 ALIGN="right" | |
| 214 VALIGN="top" | |
| 215 ><A | |
| 216 HREF="sdlenablekeyrepeat.html" | |
| 217 >Next</A | |
| 218 ></TD | |
| 219 ></TR | |
| 220 ><TR | |
| 221 ><TD | |
| 222 WIDTH="33%" | |
| 223 ALIGN="left" | |
| 224 VALIGN="top" | |
| 225 >SDL_GetKeyName</TD | |
| 226 ><TD | |
| 227 WIDTH="34%" | |
| 228 ALIGN="center" | |
| 229 VALIGN="top" | |
| 230 ><A | |
| 231 HREF="eventfunctions.html" | |
| 232 >Up</A | |
| 233 ></TD | |
| 234 ><TD | |
| 235 WIDTH="33%" | |
| 236 ALIGN="right" | |
| 237 VALIGN="top" | |
| 238 >SDL_EnableKeyRepeat</TD | |
| 239 ></TR | |
| 240 ></TABLE | |
| 241 ></DIV | |
| 242 ></BODY | |
| 243 ></HTML | |
| 244 > |