aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_KeyboardEvent.3
diff options
context:
space:
mode:
authorSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
committerSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
commita546c7006355a7bd1df4267ee53d0bfa2c017c8c (patch)
tree01be0bf6c0d6968e1468ec9661fd52110f9b05a7 /distrib/sdl-1.2.15/docs/man3/SDL_KeyboardEvent.3
parentbaf3d7830396202df5cc47bd7bcee109c319cdb3 (diff)
parent0f809250987b64f491bd3b4b73c0f0d33036a786 (diff)
downloadexternal_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.zip
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.gz
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.bz2
Merge branch 'jb-mr1-release' of https://android.googlesource.com/platform/external/qemu into mr1-staging
Change-Id: I8a4a71ac65b08e6e17f26c942f67a15b85211115
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_KeyboardEvent.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_KeyboardEvent.338
1 files changed, 38 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_KeyboardEvent.3 b/distrib/sdl-1.2.15/docs/man3/SDL_KeyboardEvent.3
new file mode 100644
index 0000000..4aeea79
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_KeyboardEvent.3
@@ -0,0 +1,38 @@
+.TH "SDL_KeyboardEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
+.SH "NAME"
+SDL_KeyboardEvent \- Keyboard event structure
+.SH "STRUCTURE DEFINITION"
+.PP
+.nf
+\f(CWtypedef struct{
+ Uint8 type;
+ Uint8 state;
+ SDL_keysym keysym;
+} SDL_KeyboardEvent;\fR
+.fi
+.PP
+.SH "STRUCTURE DATA"
+.TP 20
+\fBtype\fR
+\fBSDL_KEYDOWN\fP or \fBSDL_KEYUP\fP
+.TP 20
+\fBstate\fR
+\fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP
+.TP 20
+\fBkeysym\fR
+Contains key press information
+.SH "DESCRIPTION"
+.PP
+\fBSDL_KeyboardEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_KEYDOWN\fP or \fBSDL_KEYUP\fP is reported\&.
+.PP
+The \fBtype\fR and \fBstate\fR actually report the same information, they just use different values to do it! A keyboard event occurs when a key is released (\fBtype\fR=\fBSDK_KEYUP\fP or \fBstate\fR=\fBSDL_RELEASED\fP) and when a key is pressed (\fBtype\fR=\fBSDL_KEYDOWN\fP or \fBstate\fR=\fBSDL_PRESSED\fP)\&. The information on what key was pressed or released is in the \fI\fBkeysym\fR\fR structure\&.
+.PP
+.RS
+\fBNote:
+.PP
+Repeating \fBSDL_KEYDOWN\fP events will occur if key repeat is enabled (see \fI\fBSDL_EnableKeyRepeat\fP\fR)\&.
+.RE
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_Event\fR\fR, \fI\fBSDL_keysym\fR\fR, \fI\fBSDL_EnableKeyRepeat\fP\fR, \fI\fBSDL_EnableUNICODE\fP\fR
+.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59