← Back to branch summary

~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-gdkkeymap.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-01-07 11:08:47 UTC
  • mfrom: (1.2.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20100107110847-f5av7e1ttudh7ra6
Tags: 2.17.0-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/class-gdkkeymap.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.Keymap</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkimage.html" title="gtk.gdk.Image"><link rel="next" href="class-gdkpangorenderer.html" title="gtk.gdk.PangoRenderer"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.Keymap</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkimage.html">Prev</a> </td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gdkpangorenderer.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gdkkeymap"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.Keymap</h2><p>gtk.gdk.Keymap — an object containing mappings of keys to key
2
 
values.</p></div><div class="refsect1" lang="en"><a name="id2755631"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Keymap</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.Keymap</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkimage.html" title="gtk.gdk.Image"><link rel="next" href="class-gdkpangorenderer.html" title="gtk.gdk.PangoRenderer"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.Keymap</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkimage.html">Prev</a> </td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gdkpangorenderer.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.gdk.Keymap"><a name="class-gdkkeymap"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.Keymap</h2><p>gtk.gdk.Keymap — an object containing mappings of keys to key
 
2
values.</p></div><div class="refsect1" title="Synopsis"><a name="id3305739"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Keymap</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
3
3
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#method-gdkkeymap--lookup-key" title="gtk.gdk.Keymap.lookup_key">lookup_key</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keycode</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>level</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#method-gdkkeymap--translate-keyboard-state" title="gtk.gdk.Keymap.translate_keyboard_state">translate_keyboard_state</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keycode</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>state</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#method-gdkkeymap--get-entries-for-keyval" title="gtk.gdk.Keymap.get_entries_for_keyval">get_entries_for_keyval</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#method-gdkkeymap--get-entries-for-keycode" title="gtk.gdk.Keymap.get_entries_for_keycode">get_entries_for_keycode</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hardware_keycode</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#method-gdkkeymap--get-direction" title="gtk.gdk.Keymap.get_direction">get_direction</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#method-gdkkeymap--have-bidi-layouts" title="gtk.gdk.Keymap.have_bidi_layouts">have_bidi_layouts</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">
4
4
<span class="bold"><strong>Functions</strong></span>
5
5
 
6
 
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keymap-get-default" title="gtk.gdk.keymap_get_default">gtk.gdk.keymap_get_default</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keymap-get-for-display" title="gtk.gdk.keymap_get_for_display">gtk.gdk.keymap_get_for_display</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-name" title="gtk.gdk.keyval_name">gtk.gdk.keyval_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-from-name" title="gtk.gdk.keyval_from_name">gtk.gdk.keyval_from_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval_name</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-convert-case" title="gtk.gdk.keyval_convert_case">gtk.gdk.keyval_convert_case</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>symbol</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-to-upper" title="gtk.gdk.keyval_to_upper">gtk.gdk.keyval_to_upper</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-to-lower" title="gtk.gdk.keyval_to_lower">gtk.gdk.keyval_to_lower</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-is-upper" title="gtk.gdk.keyval_is_upper">gtk.gdk.keyval_is_upper</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-is-lower" title="gtk.gdk.keyval_is_lower">gtk.gdk.keyval_is_lower</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-to-unicode" title="gtk.gdk.keyval_to_unicode">gtk.gdk.keyval_to_unicode</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--unicode-to-keyval" title="gtk.gdk.unicode_to_keyval">gtk.gdk.unicode_to_keyval</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>wc</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3124789"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
6
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keymap-get-default" title="gtk.gdk.keymap_get_default">gtk.gdk.keymap_get_default</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keymap-get-for-display" title="gtk.gdk.keymap_get_for_display">gtk.gdk.keymap_get_for_display</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-name" title="gtk.gdk.keyval_name">gtk.gdk.keyval_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-from-name" title="gtk.gdk.keyval_from_name">gtk.gdk.keyval_from_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval_name</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-convert-case" title="gtk.gdk.keyval_convert_case">gtk.gdk.keyval_convert_case</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>symbol</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-to-upper" title="gtk.gdk.keyval_to_upper">gtk.gdk.keyval_to_upper</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-to-lower" title="gtk.gdk.keyval_to_lower">gtk.gdk.keyval_to_lower</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-is-upper" title="gtk.gdk.keyval_is_upper">gtk.gdk.keyval_is_upper</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-is-lower" title="gtk.gdk.keyval_is_lower">gtk.gdk.keyval_is_lower</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--keyval-to-unicode" title="gtk.gdk.keyval_to_unicode">gtk.gdk.keyval_to_unicode</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkkeymap.html#function-gdk--unicode-to-keyval" title="gtk.gdk.unicode_to_keyval">gtk.gdk.unicode_to_keyval</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>wc</code></strong></span></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="id3196391"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
7
7
  +-- <a class="link" href="class-gdkkeymap.html" title="gtk.gdk.Keymap">gtk.gdk.Keymap</a>
8
 
</pre></div><div class="refsect1" lang="en"><a name="id3124815"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gdkkeymap.html#signal-gdkkeymap--direction-changed" title='The "direction-changed" gtk.gdk.Keymap Signal'>direction-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>gdkkeymap</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gdkkeymap.html#signal-gdkkeymap--keys-changed" title='The "keys-changed" gtk.gdk.Keymap Signal'>keys-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>gdkkeymap</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3124947"></a><h2>Description</h2><p>A <a class="link" href="class-gdkkeymap.html" title="gtk.gdk.Keymap"><code class="classname">gtk.gdk.Keymap</code></a>
 
8
</pre></div><div class="refsect1" title="Signal Prototypes"><a name="id3196417"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gdkkeymap.html#signal-gdkkeymap--direction-changed" title='The "direction-changed" gtk.gdk.Keymap Signal'>direction-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>gdkkeymap</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gdkkeymap.html#signal-gdkkeymap--keys-changed" title='The "keys-changed" gtk.gdk.Keymap Signal'>keys-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>gdkkeymap</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id3196550"></a><h2>Description</h2><p>A <a class="link" href="class-gdkkeymap.html" title="gtk.gdk.Keymap"><code class="classname">gtk.gdk.Keymap</code></a>
9
9
defines the translation from keyboard state (including a hardware key, a
10
10
modifier mask, and active keyboard group) to a keyval. This translation has
11
11
two phases. The first phase is to determine the effective keyboard group and
31
31
two different languages. In group 0, a key might have two English
32
32
characters, and in group 1 it might have two Hebrew characters. The Hebrew
33
33
characters will be printed on the key next to the English characters.
34
 
</p></div><div class="refsect1" lang="en"><a name="id3125026"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gdkkeymap--lookup-key"></a><h3>gtk.gdk.Keymap.lookup_key</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">lookup_key</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keycode</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>level</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keycode</code></strong> :</span></p></td><td>the hardware keycode.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>group</code></strong> :</span></p></td><td>the key group</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>level</code></strong> :</span></p></td><td>the key level</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a keyval, or 0 if none was mapped to the
 
34
</p></div><div class="refsect1" title="Methods"><a name="id3196629"></a><h2>Methods</h2><div class="refsect2" title="gtk.gdk.Keymap.lookup_key"><a name="method-gdkkeymap--lookup-key"></a><h3>gtk.gdk.Keymap.lookup_key</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">lookup_key</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keycode</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>level</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keycode</code></strong> :</span></p></td><td>the hardware keycode.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>group</code></strong> :</span></p></td><td>the key group</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>level</code></strong> :</span></p></td><td>the key level</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a keyval, or 0 if none was mapped to the
35
35
          (<em class="parameter"><code>keycode</code></em>, <em class="parameter"><code>group</code></em>,
36
 
          <em class="parameter"><code>level</code></em>) triplet.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">lookup_key</code>() method returns the
 
36
          <em class="parameter"><code>level</code></em>) triplet.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">lookup_key</code>() method returns the
37
37
keyval mapped to the specified (<em class="parameter"><code>keycode</code></em>,
38
38
<em class="parameter"><code>group</code></em>, <em class="parameter"><code>level</code></em>) triplet.  This
39
39
method returns 0 if no keyval is found. For normal user input, you want to
49
49
"1" on it also has the exclamation point ("!")  character on it. The level
50
50
indicates whether to use the "1" or the "!" symbol. The letter keys are
51
51
considered to have a lowercase letter at level 0, and an uppercase letter at
52
 
level 1, though only the uppercase letter is printed.</td></tr></tbody></table><p></p></div><div class="refsect2" lang="en"><a name="method-gdkkeymap--translate-keyboard-state"></a><h3>gtk.gdk.Keymap.translate_keyboard_state</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">translate_keyboard_state</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keycode</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>state</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keycode</code></strong> :</span></p></td><td>a keycode</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>state</code></strong> :</span></p></td><td>a modifier state</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>group</code></strong> :</span></p></td><td>an active keyboard group</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 4-tuple containing the keyval, the effective group,
 
52
level 1, though only the uppercase letter is printed.</td></tr></tbody></table><p></p></div><div class="refsect2" title="gtk.gdk.Keymap.translate_keyboard_state"><a name="method-gdkkeymap--translate-keyboard-state"></a><h3>gtk.gdk.Keymap.translate_keyboard_state</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">translate_keyboard_state</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keycode</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>state</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keycode</code></strong> :</span></p></td><td>a keycode</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>state</code></strong> :</span></p></td><td>a modifier state</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>group</code></strong> :</span></p></td><td>an active keyboard group</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 4-tuple containing the keyval, the effective group,
53
53
the level and the modifiers that were used to determine the group or
54
 
level</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">translate_keyboard_state</code>() method
 
54
level</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">translate_keyboard_state</code>() method
55
55
      translates the contents of a keyboard <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
56
56
      (specified by <em class="parameter"><code>keycode</code></em>,
57
57
      <em class="parameter"><code>state</code></em> and <em class="parameter"><code>group</code></em>) into a
65
65
      convenience, the keyboard <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
66
66
      already contains the translated keyval, so this method isn't as useful
67
67
      as you might think.</p><p>The value of <em class="parameter"><code>state</code></em> or the consumed
68
 
      modifiers is a combination of the <a class="xref" href="gdk-constants.html#gdk-modifier-constants" title="GDK Modifier Constants">GDK Modifier Constants</a>.</p><div class="refsect3" lang="en"><a name="id3002810"></a><h4>Consumed Modifiers</h4><p>The consumed modifiers are modifiers that should be masked out
 
68
      modifiers is a combination of the <a class="xref" href="gdk-constants.html#gdk-modifier-constants" title="GDK Modifier Constants">GDK Modifier Constants</a>.</p><div class="refsect3" title="Consumed Modifiers"><a name="id3249348"></a><h4>Consumed Modifiers</h4><p>The consumed modifiers are modifiers that should be masked out
69
69
from <em class="parameter"><code>state</code></em> when comparing this key press to a hot
70
70
key. For instance, on a US keyboard, the <span class="keysym">plus</span> symbol is
71
71
shifted, so when comparing a key press to a
87
87
Multi-modifier combinations are returned only when actually found in
88
88
<em class="parameter"><code>state</code></em>. When you store accelerators, you should always
89
89
store them with consumed modifiers removed. Store &lt;Control&gt;plus, not
90
 
&lt;Control&gt;&lt;Shift&gt;plus,</p></div></div><div class="refsect2" lang="en"><a name="method-gdkkeymap--get-entries-for-keyval"></a><h3>gtk.gdk.Keymap.get_entries_for_keyval</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_entries_for_keyval</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>a keyval, such as <code class="literal">GDK_a</code>,
 
90
&lt;Control&gt;&lt;Shift&gt;plus,</p></div></div><div class="refsect2" title="gtk.gdk.Keymap.get_entries_for_keyval"><a name="method-gdkkeymap--get-entries-for-keyval"></a><h3>gtk.gdk.Keymap.get_entries_for_keyval</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_entries_for_keyval</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>a keyval, such as <code class="literal">GDK_a</code>,
91
91
<code class="literal">GDK_Up</code>, <code class="literal">GDK_Return</code>,
92
92
etc.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a tuple containing 3-tuple containing a keycode,
93
93
a group and a level that will generate
94
 
<em class="parameter"><code>keyval</code></em>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_entries_for_keyval</code>() method
 
94
<em class="parameter"><code>keyval</code></em>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_entries_for_keyval</code>() method
95
95
returns a tuple of (keycode, group, level) 3-tuples that will generate
96
96
<em class="parameter"><code>keyval</code></em>. Groups and levels are two kinds of keyboard
97
97
mode; in general, the level determines whether the top or bottom symbol on a
101
101
English modes, for example, the <code class="literal">gtk.gdk.KEY_PRESS</code> and
102
102
<code class="literal">gtk.gdk.KEY_RELEASE</code> <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> objects
103
103
contain a <code class="literal">group</code> attribute that indicates the active
104
 
keyboard group. The level is computed from the modifier mask.</p></div><div class="refsect2" lang="en"><a name="method-gdkkeymap--get-entries-for-keycode"></a><h3>gtk.gdk.Keymap.get_entries_for_keycode</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_entries_for_keycode</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hardware_keycode</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>hardware_keycode</code></strong> :</span></p></td><td>a keycode</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a tuple containing 4-tuples: (keyval, keycode,
105
 
group, level)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_entries_for_keycode</code>() method
 
104
keyboard group. The level is computed from the modifier mask.</p></div><div class="refsect2" title="gtk.gdk.Keymap.get_entries_for_keycode"><a name="method-gdkkeymap--get-entries-for-keycode"></a><h3>gtk.gdk.Keymap.get_entries_for_keycode</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_entries_for_keycode</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hardware_keycode</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>hardware_keycode</code></strong> :</span></p></td><td>a keycode</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a tuple containing 4-tuples: (keyval, keycode,
 
105
group, level)</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_entries_for_keycode</code>() method
106
106
returns a tuple containing 4-tuples with: the keyvals bound to
107
107
<em class="parameter"><code>hardware_keycode</code></em>, the keycode, the group and the
108
108
level.  When a keycode is pressed by the user, the keyval from this list of
109
109
entries is selected by considering the effective keyboard group and
110
110
level. See the <a class="link" href="class-gdkkeymap.html#method-gdkkeymap--translate-keyboard-state" title="gtk.gdk.Keymap.translate_keyboard_state"><code class="methodname">translate_keyboard_state()</code></a>
111
 
method for more information.</p></div><div class="refsect2" lang="en"><a name="method-gdkkeymap--get-direction"></a><h3>gtk.gdk.Keymap.get_direction</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_direction</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a Pango direction: <code class="literal">pango.DIRECTION_LTR</code> or <code class="literal">pango.DIRECTION_RTL</code>.</td></tr></tbody></table><p>The <code class="methodname">get_direction</code>() method returns the direction of the keymap.</p></div><div class="refsect2" lang="en"><a name="method-gdkkeymap--have-bidi-layouts"></a><h3>gtk.gdk.Keymap.have_bidi_layouts</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">have_bidi_layouts</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if there are layouts in both directions,
 
111
method for more information.</p></div><div class="refsect2" title="gtk.gdk.Keymap.get_direction"><a name="method-gdkkeymap--get-direction"></a><h3>gtk.gdk.Keymap.get_direction</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_direction</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a Pango direction: <code class="literal">pango.DIRECTION_LTR</code> or <code class="literal">pango.DIRECTION_RTL</code>.</td></tr></tbody></table><p>The <code class="methodname">get_direction</code>() method returns the direction of the keymap.</p></div><div class="refsect2" title="gtk.gdk.Keymap.have_bidi_layouts"><a name="method-gdkkeymap--have-bidi-layouts"></a><h3>gtk.gdk.Keymap.have_bidi_layouts</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">have_bidi_layouts</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if there are layouts in both directions,
112
112
      <code class="literal">FALSE</code> otherwise.</td></tr></tbody></table><p>The <code class="methodname">have_bidi_layouts</code>() method
113
113
      determines if keyboard layouts for both right-to-left and left-to-right
114
 
      languages are in use.</p></div></div><div class="refsect1" lang="en"><a name="id3003321"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gdk--keymap-get-default"></a><h3>gtk.gdk.keymap_get_default</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keymap_get_default</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the default gdk keymap for the
 
114
      languages are in use.</p></div></div><div class="refsect1" title="Functions"><a name="id3249859"></a><h2>Functions</h2><div class="refsect2" title="gtk.gdk.keymap_get_default"><a name="function-gdk--keymap-get-default"></a><h3>gtk.gdk.keymap_get_default</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keymap_get_default</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the default gdk keymap for the
115
115
display.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.keymap_get_default</code>() function
116
116
returns the default <a class="link" href="class-gdkkeymap.html" title="gtk.gdk.Keymap"><code class="classname">gtk.gdk.Keymap</code></a> for
117
 
the display.</p></div><div class="refsect2" lang="en"><a name="function-gdk--keymap-get-for-display"></a><h3>gtk.gdk.keymap_get_for_display</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keymap_get_for_display</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>display</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the keymap for
118
 
          <em class="parameter"><code>display</code></em>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.2 and above.</p></div><p>The <code class="function">gtk.gdk.keymap_get_for_display</code>()
 
117
the display.</p></div><div class="refsect2" title="gtk.gdk.keymap_get_for_display"><a name="function-gdk--keymap-get-for-display"></a><h3>gtk.gdk.keymap_get_for_display</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keymap_get_for_display</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>display</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the keymap for
 
118
          <em class="parameter"><code>display</code></em>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.2 and above.</p></div><p>The <code class="function">gtk.gdk.keymap_get_for_display</code>()
119
119
function returns the <a class="link" href="class-gdkkeymap.html" title="gtk.gdk.Keymap"><code class="classname">gtk.gdk.Keymap</code></a> for
120
120
the <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>
121
 
specified by <em class="parameter"><code>display</code></em>.</p></div><div class="refsect2" lang="en"><a name="function-gdk--keyval-name"></a><h3>gtk.gdk.keyval_name</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>a key value</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a string containing the name of the key, or
 
121
specified by <em class="parameter"><code>display</code></em>.</p></div><div class="refsect2" title="gtk.gdk.keyval_name"><a name="function-gdk--keyval-name"></a><h3>gtk.gdk.keyval_name</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>a key value</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a string containing the name of the key, or
122
122
None if keyval is not a valid key.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.keyval_name</code>() function converts
123
123
the key value specified by <em class="parameter"><code>keyval</code></em> into a symbolic
124
 
name.</p></div><div class="refsect2" lang="en"><a name="function-gdk--keyval-from-name"></a><h3>gtk.gdk.keyval_from_name</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_from_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval_name</code></strong> :</span></p></td><td>a key name</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the corresponding key value or 0 if the key
 
124
name.</p></div><div class="refsect2" title="gtk.gdk.keyval_from_name"><a name="function-gdk--keyval-from-name"></a><h3>gtk.gdk.keyval_from_name</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_from_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval_name</code></strong> :</span></p></td><td>a key name</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the corresponding key value or 0 if the key
125
125
name is not a valid key.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.keyval_from_name</code>() function
126
126
converts the key name specified by <em class="parameter"><code>keyval_name</code></em> to a
127
 
key value.</p></div><div class="refsect2" lang="en"><a name="function-gdk--keyval-convert-case"></a><h3>gtk.gdk.keyval_convert_case</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_convert_case</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>symbol</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>symbol</code></strong> :</span></p></td><td>a keyval</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the lowercase and
 
127
key value.</p></div><div class="refsect2" title="gtk.gdk.keyval_convert_case"><a name="function-gdk--keyval-convert-case"></a><h3>gtk.gdk.keyval_convert_case</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_convert_case</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>symbol</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>symbol</code></strong> :</span></p></td><td>a keyval</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the lowercase and
128
128
          uppercase versions of
129
 
          <em class="parameter"><code>symbol</code></em></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <code class="function">gtk.gdk.keyval_convert_case</code>() function
 
129
          <em class="parameter"><code>symbol</code></em></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <code class="function">gtk.gdk.keyval_convert_case</code>() function
130
130
returns the lowercase and uppercase versions of the keyval specified by
131
 
<em class="parameter"><code>symbol</code></em>.</p></div><div class="refsect2" lang="en"><a name="function-gdk--keyval-to-upper"></a><h3>gtk.gdk.keyval_to_upper</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_to_upper</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>a key value.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the upper case form of keyval, or keyval itself
 
131
<em class="parameter"><code>symbol</code></em>.</p></div><div class="refsect2" title="gtk.gdk.keyval_to_upper"><a name="function-gdk--keyval-to-upper"></a><h3>gtk.gdk.keyval_to_upper</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_to_upper</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>a key value.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the upper case form of keyval, or keyval itself
132
132
if it is already in upper case or it is not subject to case
133
133
conversion.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.keyval_to_upper</code>() function
134
134
converts the key value specified by <em class="parameter"><code>keyval</code></em> to upper
135
 
case, if applicable.</p></div><div class="refsect2" lang="en"><a name="function-gdk--keyval-to-lower"></a><h3>gtk.gdk.keyval_to_lower</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_to_lower</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>the key value</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the lower case form of keyval, or keyval itself
 
135
case, if applicable.</p></div><div class="refsect2" title="gtk.gdk.keyval_to_lower"><a name="function-gdk--keyval-to-lower"></a><h3>gtk.gdk.keyval_to_lower</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_to_lower</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>the key value</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the lower case form of keyval, or keyval itself
136
136
if it is already in lower case or it is not subject to case
137
137
conversion.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.keyval_to_lower</code>() function
138
138
converts the key value specified by <em class="parameter"><code>keyval</code></em> to lower
139
 
case, if applicable. </p></div><div class="refsect2" lang="en"><a name="function-gdk--keyval-is-upper"></a><h3>gtk.gdk.keyval_is_upper</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_is_upper</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>the key value</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if
 
139
case, if applicable. </p></div><div class="refsect2" title="gtk.gdk.keyval_is_upper"><a name="function-gdk--keyval-is-upper"></a><h3>gtk.gdk.keyval_is_upper</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_is_upper</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>the key value</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if
140
140
<em class="parameter"><code>keyval</code></em> is in upper case or if keyval is not subject
141
141
to case conversion.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.keyval_is_upper</code>() function
142
142
returns <code class="literal">True</code> if the key value specified by
143
143
<em class="parameter"><code>keyval</code></em> is in upper case or not subject to case
144
 
conversion.</p></div><div class="refsect2" lang="en"><a name="function-gdk--keyval-is-lower"></a><h3>gtk.gdk.keyval_is_lower</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_is_lower</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>the key value</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if
 
144
conversion.</p></div><div class="refsect2" title="gtk.gdk.keyval_is_lower"><a name="function-gdk--keyval-is-lower"></a><h3>gtk.gdk.keyval_is_lower</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_is_lower</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>the key value</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if
145
145
<em class="parameter"><code>keyval</code></em> is in lower case, or if
146
146
<em class="parameter"><code>keyval</code></em> is not subject to case
147
147
conversion.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.keyval_is_lower</code>() function
148
148
returns <code class="literal">True</code> if the key value specified by
149
149
<em class="parameter"><code>keyval</code></em> is in lower case or is not subject to case
150
 
conversion.</p></div><div class="refsect2" lang="en"><a name="function-gdk--keyval-to-unicode"></a><h3>gtk.gdk.keyval_to_unicode</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_to_unicode</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>the key value</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> the corresponding unicode character, or 0 if
 
150
conversion.</p></div><div class="refsect2" title="gtk.gdk.keyval_to_unicode"><a name="function-gdk--keyval-to-unicode"></a><h3>gtk.gdk.keyval_to_unicode</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.keyval_to_unicode</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>the key value</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> the corresponding unicode character, or 0 if
151
151
there is no corresponding character.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.keyval_to_unicode</code>() function
152
152
converts the key value specified by <em class="parameter"><code>keyval</code></em> to the
153
 
corresponding ISO10646 (Unicode) character.</p></div><div class="refsect2" lang="en"><a name="function-gdk--unicode-to-keyval"></a><h3>gtk.gdk.unicode_to_keyval</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.unicode_to_keyval</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>wc</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>wc</code></strong> :</span></p></td><td> a ISO10646 encoded (unicode)
 
153
corresponding ISO10646 (Unicode) character.</p></div><div class="refsect2" title="gtk.gdk.unicode_to_keyval"><a name="function-gdk--unicode-to-keyval"></a><h3>gtk.gdk.unicode_to_keyval</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.unicode_to_keyval</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>wc</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>wc</code></strong> :</span></p></td><td> a ISO10646 encoded (unicode)
154
154
character</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the corresponding key value, if one exists. or,
155
155
if there is no corresponding symbol, <em class="parameter"><code>wc</code></em> |
156
156
0x01000000</td></tr></tbody></table><p>The <code class="function">gtk.gdk.unicode_to_keyval</code>() function
157
157
converts the ISO10646 (unicode) character specified by
158
 
<em class="parameter"><code>wc</code></em> to a key value.</p></div></div><div class="refsect1" lang="en"><a name="id3172234"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gdkkeymap--direction-changed"></a><h3>The "direction-changed" gtk.gdk.Keymap Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>gdkkeymap</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>gdkkeymap</code></em> :</span></p></td><td>the gdkkeymap that received the
 
158
<em class="parameter"><code>wc</code></em> to a key value.</p></div></div><div class="refsect1" title="Signals"><a name="id3449214"></a><h2>Signals</h2><div class="refsect2" title='The "direction-changed" gtk.gdk.Keymap Signal'><a name="signal-gdkkeymap--direction-changed"></a><h3>The "direction-changed" gtk.gdk.Keymap Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>gdkkeymap</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>gdkkeymap</code></em> :</span></p></td><td>the gdkkeymap that received the
159
159
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
160
160
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
161
161
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
162
162
any)</td></tr></tbody></table><p>The "direction-changed" signal is emitted when the pango text
163
 
direction of <em class="parameter"><code>gdkkeymap</code></em> is changed</p></div><div class="refsect2" lang="en"><a name="signal-gdkkeymap--keys-changed"></a><h3>The "keys-changed" gtk.gdk.Keymap Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>gdkkeymap</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>gdkkeymap</code></em> :</span></p></td><td>the gdkkeymap that received the
 
163
direction of <em class="parameter"><code>gdkkeymap</code></em> is changed</p></div><div class="refsect2" title='The "keys-changed" gtk.gdk.Keymap Signal'><a name="signal-gdkkeymap--keys-changed"></a><h3>The "keys-changed" gtk.gdk.Keymap Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>gdkkeymap</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>gdkkeymap</code></em> :</span></p></td><td>the gdkkeymap that received the
164
164
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
165
165
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
166
166
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
167
 
any)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.2 and above.</p></div><p>The "keys-changed" signal is emitted when the mapping
 
167
any)</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.2 and above.</p></div><p>The "keys-changed" signal is emitted when the mapping
168
168
represented by <em class="parameter"><code>keymap</code></em> changes.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gdkimage.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gdk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gdkpangorenderer.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.gdk.Image </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.gdk.PangoRenderer</td></tr></table></div></body></html>