symbian-qemu-0.9.1-12/libsdl-trunk/docs/man3/SDL_EnableUNICODE.3
changeset 1 2fb8b9db1c86
equal deleted inserted replaced
0:ffa851df0825 1:2fb8b9db1c86
       
     1 .TH "SDL_EnableUNICODE" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
       
     2 .SH "NAME"
       
     3 SDL_EnableUNICODE \- Enable UNICODE translation
       
     4 .SH "SYNOPSIS"
       
     5 .PP
       
     6 \fB#include "SDL\&.h"
       
     7 .sp
       
     8 \fBint \fBSDL_EnableUNICODE\fP\fR(\fBint enable\fR);
       
     9 .SH "DESCRIPTION"
       
    10 .PP
       
    11 Enables/Disables Unicode keyboard translation\&.
       
    12 .PP
       
    13 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 \fBunicode\fR member of the \fI\fBSDL_keysym\fR\fR structure will then contain the corresponding character code, or zero for keysyms that do not correspond to any character code\&.
       
    14 .PP
       
    15 A value of 1 for \fBenable\fR enables Unicode translation; 0 disables it, and -1 leaves it unchanged (useful for querying the current translation mode)\&.
       
    16 .PP
       
    17 Note that only key press events will be translated, not release events\&.
       
    18 .SH "RETURN VALUE"
       
    19 .PP
       
    20 Returns the previous translation mode (\fB0\fR or \fB1\fR)\&.
       
    21 .SH "SEE ALSO"
       
    22 .PP
       
    23 \fI\fBSDL_keysym\fR\fR
       
    24 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59