<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.UI.Gtk.Gdk.Keys</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-Gtk-Gdk-Keys.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Gdk-Keys.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gtk-0.12.0: Binding to the Gtk+ graphical user interface library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable (depends on GHC)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>gtk2hs-users@lists.sourceforge.net</td></tr></table><p class="caption">Graphics.UI.Gtk.Gdk.Keys</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A <code><a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></code> is a numeric value identifying a keyboard key. The defined
values can be found at <http:
The names of the keys are the names of the macros without the prefix.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">type</span> <a href="#t:KeyVal">KeyVal</a> = <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word32">Word32</a></li><li class="src short"><a href="#v:keyName">keyName</a> :: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:keyFromName">keyFromName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></li><li class="src short"><a href="#v:keyToChar">keyToChar</a> :: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a></li><li class="src short"><a href="#v:keyvalConvertCase">keyvalConvertCase</a> :: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a> -> (<a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a>, <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a>)</li><li class="src short"><a href="#v:keyvalToUpper">keyvalToUpper</a> :: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a> -> <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></li><li class="src short"><a href="#v:keyvalToLower">keyvalToLower</a> :: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a> -> <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></li><li class="src short"><a href="#v:keyvalIsUpper">keyvalIsUpper</a> :: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:keyvalIsLower">keyvalIsLower</a> :: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:KeyVal" class="def">KeyVal</a> = <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word32">Word32</a><a href="src/Graphics-UI-Gtk-Gdk-Keys.html#KeyVal" class="link">Source</a></p><div class="doc"><p>Key values are the codes which are sent whenever a key is pressed or
released.
</p></div></div><div class="top"><p class="src"><a name="v:keyName" class="def">keyName</a> :: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Graphics-UI-Gtk-Gdk-Keys.html#keyName" class="link">Source</a></p><div class="doc"><p>Converts a key value into a symbolic name.
</p></div></div><div class="top"><p class="src"><a name="v:keyFromName" class="def">keyFromName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a><a href="src/Graphics-UI-Gtk-Gdk-Keys.html#keyFromName" class="link">Source</a></p><div class="doc"><p>Converts a key name to a key value.
</p></div></div><div class="top"><p class="src"><a name="v:keyToChar" class="def">keyToChar</a><a href="src/Graphics-UI-Gtk-Gdk-Keys.html#keyToChar" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></td><td class="doc"><p><code>keyval</code> - a Gdk key symbol
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a></td><td class="doc"><p>returns the corresponding unicode character, or
Nothing if there is no corresponding character.
</p></td></tr></table></div><div class="doc"><p>Convert from a Gdk key symbol to the corresponding Unicode character.
</p></div></div><div class="top"><p class="src"><a name="v:keyvalConvertCase" class="def">keyvalConvertCase</a><a href="src/Graphics-UI-Gtk-Gdk-Keys.html#keyvalConvertCase" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></td><td class="doc"><p><code>symbol</code> a keyval
</p></td></tr><tr><td class="src">-> (<a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a>, <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a>)</td><td class="doc"><p><code>(lower, upper)</code>
^ lower is the lowercase version of symbol.
^ upper is uppercase version of symbol.
</p></td></tr></table></div><div class="doc"><p>Obtains the upper- and lower-case versions of the keyval symbol. Examples of keyvals are GDK_a,
<code>Enter</code>, <code>F1</code>, etc.
</p></div></div><div class="top"><p class="src"><a name="v:keyvalToUpper" class="def">keyvalToUpper</a><a href="src/Graphics-UI-Gtk-Gdk-Keys.html#keyvalToUpper" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></td><td class="doc"><p><code>keyval</code> a key value.
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></td><td class="doc"><p>returns the upper case form of keyval,
or keyval itself if it is already in upper case or it is not subject to case
</p></td></tr></table></div><div class="doc"><p>Converts a key value to upper case, if applicable.
</p></div></div><div class="top"><p class="src"><a name="v:keyvalToLower" class="def">keyvalToLower</a><a href="src/Graphics-UI-Gtk-Gdk-Keys.html#keyvalToLower" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></td><td class="doc"><p><code>keyval</code> a key value.
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></td><td class="doc"><p>returns the lower case form of keyval,
or keyval itself if it is already in lower case or it is not subject to case
</p></td></tr></table></div><div class="doc"><p>Converts a key value to lower case, if applicable.
</p></div></div><div class="top"><p class="src"><a name="v:keyvalIsUpper" class="def">keyvalIsUpper</a><a href="src/Graphics-UI-Gtk-Gdk-Keys.html#keyvalIsUpper" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code> if keyval is in upper case, or if keyval is not subject to case conversion.
</p></td></tr></table></div><div class="doc"><p>Returns <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code> if the given key value is in upper case.
</p></div></div><div class="top"><p class="src"><a name="v:keyvalIsLower" class="def">keyvalIsLower</a><a href="src/Graphics-UI-Gtk-Gdk-Keys.html#keyvalIsLower" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Gdk-Keys.html#t:KeyVal">KeyVal</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code> if keyval is in upper case, or if keyval is not subject to case conversion.
</p></td></tr></table></div><div class="doc"><p>Returns <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code> if the given key value is in upper case.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
