[sdl_omap.git] / docs / html / sdlenableunicode.html

<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&nbsp;--&nbsp;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
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_EnableUNICODE</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_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	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="sdlgetkeyname.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="sdlenablekeyrepeat.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="SDLENABLEUNICODE"
74	></A
75	>SDL_EnableUNICODE</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN5805"
80	></A
81	><H2
82	>Name</H2
83	>SDL_EnableUNICODE -- Enable UNICODE translation</DIV
84	><DIV
85	CLASS="REFSYNOPSISDIV"
86	><A
87	NAME="AEN5808"
88	></A
89	><H2
90	>Synopsis</H2
91	><DIV
92	CLASS="FUNCSYNOPSIS"
93	><A
94	NAME="AEN5809"
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	>int <B
106	CLASS="FSFUNC"
107	>SDL_EnableUNICODE</B
108	></CODE
109	>(int enable);</CODE
110	></P
111	><P
112	></P
113	></DIV
114	></DIV
115	><DIV
116	CLASS="REFSECT1"
117	><A
118	NAME="AEN5815"
119	></A
120	><H2
121	>Description</H2
122	><P
123	>Enables/Disables Unicode keyboard translation.</P
124	><P
125	>To obtain the character codes corresponding to received keyboard events,
126	Unicode translation must first be turned on using this function. The
127	translation incurs a slight overhead for each keyboard event and is therefore
128	disabled by default. For each subsequently received key down event, the
129	<TT
130	CLASS="STRUCTFIELD"
131	><I
132	>unicode</I
133	></TT
134	> member of the
135	<A
136	HREF="sdlkeysym.html"
137	><SPAN
138	CLASS="STRUCTNAME"
139	>SDL_keysym</SPAN
140	></A
141	> structure
142	will then contain the corresponding character code, or zero for keysyms that do
143	not correspond to any character code.</P
144	><P
145	>A value of 1 for <TT
146	CLASS="PARAMETER"
147	><I
148	>enable</I
149	></TT
150	> enables Unicode translation;
151	0 disables it, and -1 leaves it unchanged (useful for querying the current
152	translation mode).</P
153	><P
154	>Note that only key press events will be translated, not release events.</P
155	></DIV
156	><DIV
157	CLASS="REFSECT1"
158	><A
159	NAME="AEN5825"
160	></A
161	><H2
162	>Return Value</H2
163	><P
164	>Returns the previous translation mode (<SPAN
165	CLASS="RETURNVALUE"
166	>0</SPAN
167	> or <SPAN
168	CLASS="RETURNVALUE"
169	>1</SPAN
170	>).</P
171	></DIV
172	><DIV
173	CLASS="REFSECT1"
174	><A
175	NAME="AEN5830"
176	></A
177	><H2
178	>See Also</H2
179	><P
180	><A
181	HREF="sdlkeysym.html"
182	><SPAN
183	CLASS="STRUCTNAME"
184	>SDL_keysym</SPAN
185	></A
186	></P
187	></DIV
188	><DIV
189	CLASS="NAVFOOTER"
190	><HR
191	ALIGN="LEFT"
192	WIDTH="100%"><TABLE
193	SUMMARY="Footer navigation table"
194	WIDTH="100%"
195	BORDER="0"
196	CELLPADDING="0"
197	CELLSPACING="0"
198	><TR
199	><TD
200	WIDTH="33%"
201	ALIGN="left"
202	VALIGN="top"
203	><A
204	HREF="sdlgetkeyname.html"
205	ACCESSKEY="P"
206	>Prev</A
207	></TD
208	><TD
209	WIDTH="34%"
210	ALIGN="center"
211	VALIGN="top"
212	><A
213	HREF="index.html"
214	ACCESSKEY="H"
215	>Home</A
216	></TD
217	><TD
218	WIDTH="33%"
219	ALIGN="right"
220	VALIGN="top"
221	><A
222	HREF="sdlenablekeyrepeat.html"
223	ACCESSKEY="N"
224	>Next</A
225	></TD
226	></TR
227	><TR
228	><TD
229	WIDTH="33%"
230	ALIGN="left"
231	VALIGN="top"
232	>SDL_GetKeyName</TD
233	><TD
234	WIDTH="34%"
235	ALIGN="center"
236	VALIGN="top"
237	><A
238	HREF="eventfunctions.html"
239	ACCESSKEY="U"
240	>Up</A
241	></TD
242	><TD
243	WIDTH="33%"
244	ALIGN="right"
245	VALIGN="top"
246	>SDL_EnableKeyRepeat</TD
247	></TR
248	></TABLE
249	></DIV
250	></BODY
251	></HTML
252	>