.\" This man page is automatically generated using
.\" kayadoc2man from the Kaya development tools and the -xmldocs compile 
.\" option. Editing it directly is not encouraged.
.\" It is under the same license as the source .k file that it was
.\" generated from.
.TH "SDL.SDLKey" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
SDL::SDLKey \- A key press
.SH "SYNOPSIS"
.B SDL::SDLKey<
\fI\fP
.B >
.IP "" -2
= 
.BI "UnknownKey(" "" ")"
.IP "" -2
| 
.BI "NormalKey(" "Char c" ")"
.IP "" -2
| 
.BI "NumpadKey(" "Int n" ")"
.IP "" -2
| 
.BI "FunctionKey(" "Int f" ")"
.IP "" -2
| 
.BI "ArrowUpKey(" "" ")"
.IP "" -2
| 
.BI "ArrowDownKey(" "" ")"
.IP "" -2
| 
.BI "ArrowLeftKey(" "" ")"
.IP "" -2
| 
.BI "ArrowRightKey(" "" ")"
.IP "" -2
| 
.BI "InsertKey(" "" ")"
.IP "" -2
| 
.BI "HomeKey(" "" ")"
.IP "" -2
| 
.BI "EndKey(" "" ")"
.IP "" -2
| 
.BI "PageUpKey(" "" ")"
.IP "" -2
| 
.BI "PageDownKey(" "" ")"
.SH "DESCRIPTION"
.PP
A key press. Most keys are represented by
\fBNormalKey \fP
, which contains the key in
\fBChar \fP
form. Numeric pad numbers are represented using
\fBNumpadKey \fP
, and function keys with
\fBFunctionKey \fP
 Additional constructors represent other special keys such as 'Page up' or 'Left arrow'. If the key is unrecognised,
\fBUnknownKey \fP
is returned.
.SH "AUTHORS"
Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/
.SH LICENSE
The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.