~ubuntu-branches/ubuntu/raring/gtk+2.0/raring-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gdk/html/gdk-Keyboard-Handling.html

  • Committer: Package Import Robot
  • Author(s): Didier Roche, Till Kamppeter, Didier Roche
  • Date: 2012-09-24 13:56:56 UTC
  • mfrom: (1.14.15)
  • Revision ID: package-import@ubuntu.com-20120924135656-rjoa3makg1cvn7y1
Tags: 2.24.13-0ubuntu1
[ Till Kamppeter ]
* debian/patches/print-dialog-show-options-of-remote-dnssd-printers.patch:
  Make printing on remote DNS-SD/Bonjour-shared printers working
  (LP: #1053891).

[ Didier Roche ]
* New upstream release:
  - F10 always opens the menu, cannot be overriden (LP: #937822)

Show diffs side-by-side

added added

removed removed

Lines of Context:
48
48
struct              <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymapKey" title="struct GdkKeymapKey">GdkKeymapKey</a>;
49
49
<a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="returnvalue">GdkKeymap</span></a> *         <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-default" title="gdk_keymap_get_default ()">gdk_keymap_get_default</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
50
50
<a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="returnvalue">GdkKeymap</span></a> *         <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-for-display" title="gdk_keymap_get_for_display ()">gdk_keymap_get_for_display</a>          (<em class="parameter"><code><a class="link" href="GdkDisplay.html" title="GdkDisplay"><span class="type">GdkDisplay</span></a> *display</code></em>);
51
 
<span class="returnvalue">guint</span>               <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-lookup-key" title="gdk_keymap_lookup_key ()">gdk_keymap_lookup_key</a>               (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
 
51
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-lookup-key" title="gdk_keymap_lookup_key ()">gdk_keymap_lookup_key</a>               (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
52
52
                                                         <em class="parameter"><code>const <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymapKey" title="struct GdkKeymapKey"><span class="type">GdkKeymapKey</span></a> *key</code></em>);
53
 
<span class="returnvalue">gboolean</span>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state" title="gdk_keymap_translate_keyboard_state ()">gdk_keymap_translate_keyboard_state</a> (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
54
 
                                                         <em class="parameter"><code><span class="type">guint</span> hardware_keycode</code></em>,
 
53
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state" title="gdk_keymap_translate_keyboard_state ()">gdk_keymap_translate_keyboard_state</a> (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
 
54
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> hardware_keycode</code></em>,
55
55
                                                         <em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkModifierType" title="enum GdkModifierType"><span class="type">GdkModifierType</span></a> state</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">gint</span> group</code></em>,
57
 
                                                         <em class="parameter"><code><span class="type">guint</span> *keyval</code></em>,
58
 
                                                         <em class="parameter"><code><span class="type">gint</span> *effective_group</code></em>,
59
 
                                                         <em class="parameter"><code><span class="type">gint</span> *level</code></em>,
 
56
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> group</code></em>,
 
57
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *keyval</code></em>,
 
58
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *effective_group</code></em>,
 
59
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *level</code></em>,
60
60
                                                         <em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkModifierType" title="enum GdkModifierType"><span class="type">GdkModifierType</span></a> *consumed_modifiers</code></em>);
61
 
<span class="returnvalue">gboolean</span>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-entries-for-keyval" title="gdk_keymap_get_entries_for_keyval ()">gdk_keymap_get_entries_for_keyval</a>   (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
62
 
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
63
 
                                                         <em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymapKey" title="struct GdkKeymapKey"><span class="type">GdkKeymapKey</span></a> **keys</code></em>,
64
 
                                                         <em class="parameter"><code><span class="type">gint</span> *n_keys</code></em>);
65
 
<span class="returnvalue">gboolean</span>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-entries-for-keycode" title="gdk_keymap_get_entries_for_keycode ()">gdk_keymap_get_entries_for_keycode</a>  (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
66
 
                                                         <em class="parameter"><code><span class="type">guint</span> hardware_keycode</code></em>,
67
 
                                                         <em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymapKey" title="struct GdkKeymapKey"><span class="type">GdkKeymapKey</span></a> **keys</code></em>,
68
 
                                                         <em class="parameter"><code><span class="type">guint</span> **keyvals</code></em>,
69
 
                                                         <em class="parameter"><code><span class="type">gint</span> *n_entries</code></em>);
70
 
<a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Bidirectional-Text.html#PangoDirection"><span class="returnvalue">PangoDirection</span></a>      <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-direction" title="gdk_keymap_get_direction ()">gdk_keymap_get_direction</a>            (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);
71
 
<span class="returnvalue">gboolean</span>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-have-bidi-layouts" title="gdk_keymap_have_bidi_layouts ()">gdk_keymap_have_bidi_layouts</a>        (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);
72
 
<span class="returnvalue">gboolean</span>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-caps-lock-state" title="gdk_keymap_get_caps_lock_state ()">gdk_keymap_get_caps_lock_state</a>      (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);
 
61
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-entries-for-keyval" title="gdk_keymap_get_entries_for_keyval ()">gdk_keymap_get_entries_for_keyval</a>   (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
 
62
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>,
 
63
                                                         <em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymapKey" title="struct GdkKeymapKey"><span class="type">GdkKeymapKey</span></a> **keys</code></em>,
 
64
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *n_keys</code></em>);
 
65
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-entries-for-keycode" title="gdk_keymap_get_entries_for_keycode ()">gdk_keymap_get_entries_for_keycode</a>  (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
 
66
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> hardware_keycode</code></em>,
 
67
                                                         <em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymapKey" title="struct GdkKeymapKey"><span class="type">GdkKeymapKey</span></a> **keys</code></em>,
 
68
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> **keyvals</code></em>,
 
69
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *n_entries</code></em>);
 
70
<span class="returnvalue">PangoDirection</span>      <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-direction" title="gdk_keymap_get_direction ()">gdk_keymap_get_direction</a>            (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);
 
71
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-have-bidi-layouts" title="gdk_keymap_have_bidi_layouts ()">gdk_keymap_have_bidi_layouts</a>        (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);
 
72
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-caps-lock-state" title="gdk_keymap_get_caps_lock_state ()">gdk_keymap_get_caps_lock_state</a>      (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);
73
73
<span class="returnvalue">void</span>                <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-add-virtual-modifiers" title="gdk_keymap_add_virtual_modifiers ()">gdk_keymap_add_virtual_modifiers</a>    (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
74
74
                                                         <em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkModifierType" title="enum GdkModifierType"><span class="type">GdkModifierType</span></a> *state</code></em>);
75
 
<span class="returnvalue">gboolean</span>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-map-virtual-modifiers" title="gdk_keymap_map_virtual_modifiers ()">gdk_keymap_map_virtual_modifiers</a>    (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
 
75
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-map-virtual-modifiers" title="gdk_keymap_map_virtual_modifiers ()">gdk_keymap_map_virtual_modifiers</a>    (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
76
76
                                                         <em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkModifierType" title="enum GdkModifierType"><span class="type">GdkModifierType</span></a> *state</code></em>);
77
77
 
78
 
<span class="returnvalue">gchar</span> *             <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-name" title="gdk_keyval_name ()">gdk_keyval_name</a>                     (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);
79
 
<span class="returnvalue">guint</span>               <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-from-name" title="gdk_keyval_from_name ()">gdk_keyval_from_name</a>                (<em class="parameter"><code>const <span class="type">gchar</span> *keyval_name</code></em>);
80
 
 
81
 
<span class="returnvalue">void</span>                <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-convert-case" title="gdk_keyval_convert_case ()">gdk_keyval_convert_case</a>             (<em class="parameter"><code><span class="type">guint</span> symbol</code></em>,
82
 
                                                         <em class="parameter"><code><span class="type">guint</span> *lower</code></em>,
83
 
                                                         <em class="parameter"><code><span class="type">guint</span> *upper</code></em>);
84
 
<span class="returnvalue">guint</span>               <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-to-upper" title="gdk_keyval_to_upper ()">gdk_keyval_to_upper</a>                 (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);
85
 
<span class="returnvalue">guint</span>               <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-to-lower" title="gdk_keyval_to_lower ()">gdk_keyval_to_lower</a>                 (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);
86
 
<span class="returnvalue">gboolean</span>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-is-upper" title="gdk_keyval_is_upper ()">gdk_keyval_is_upper</a>                 (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);
87
 
<span class="returnvalue">gboolean</span>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-is-lower" title="gdk_keyval_is_lower ()">gdk_keyval_is_lower</a>                 (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);
88
 
 
89
 
<span class="returnvalue">guint32</span>             <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-to-unicode" title="gdk_keyval_to_unicode ()">gdk_keyval_to_unicode</a>               (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);
90
 
<span class="returnvalue">guint</span>               <a class="link" href="gdk-Keyboard-Handling.html#gdk-unicode-to-keyval" title="gdk_unicode_to_keyval ()">gdk_unicode_to_keyval</a>               (<em class="parameter"><code><span class="type">guint32</span> wc</code></em>);
 
78
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-name" title="gdk_keyval_name ()">gdk_keyval_name</a>                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);
 
79
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-from-name" title="gdk_keyval_from_name ()">gdk_keyval_from_name</a>                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *keyval_name</code></em>);
 
80
 
 
81
<span class="returnvalue">void</span>                <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-convert-case" title="gdk_keyval_convert_case ()">gdk_keyval_convert_case</a>             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> symbol</code></em>,
 
82
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *lower</code></em>,
 
83
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *upper</code></em>);
 
84
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-to-upper" title="gdk_keyval_to_upper ()">gdk_keyval_to_upper</a>                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);
 
85
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-to-lower" title="gdk_keyval_to_lower ()">gdk_keyval_to_lower</a>                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);
 
86
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-is-upper" title="gdk_keyval_is_upper ()">gdk_keyval_is_upper</a>                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);
 
87
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-is-lower" title="gdk_keyval_is_lower ()">gdk_keyval_is_lower</a>                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);
 
88
 
 
89
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             <a class="link" href="gdk-Keyboard-Handling.html#gdk-keyval-to-unicode" title="gdk_keyval_to_unicode ()">gdk_keyval_to_unicode</a>               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);
 
90
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gdk-Keyboard-Handling.html#gdk-unicode-to-keyval" title="gdk_unicode_to_keyval ()">gdk_unicode_to_keyval</a>               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> wc</code></em>);
91
91
</pre>
92
92
</div>
93
93
<div class="refsect1">
212
212
</colgroup>
213
213
<tbody>
214
214
<tr>
215
 
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="GdkKeymapKey.keycode"></a>keycode</code></em>;</span></p></td>
 
215
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GdkKeymapKey.keycode"></a>keycode</code></em>;</span></p></td>
216
216
<td>the hardware keycode. This is an identifying number for a
217
217
physical key.</td>
218
218
</tr>
219
219
<tr>
220
 
<td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="GdkKeymapKey.group"></a>group</code></em>;</span></p></td>
 
220
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GdkKeymapKey.group"></a>group</code></em>;</span></p></td>
221
221
<td>indicates movement in a horizontal direction. Usually groups are used
222
222
for two different languages. In group 0, a key might have two English
223
223
characters, and in group 1 it might have two Hebrew characters. The Hebrew
224
224
characters will be printed on the key next to the English characters.</td>
225
225
</tr>
226
226
<tr>
227
 
<td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="GdkKeymapKey.level"></a>level</code></em>;</span></p></td>
 
227
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GdkKeymapKey.level"></a>level</code></em>;</span></p></td>
228
228
<td>indicates which symbol on the key will be used, in a vertical direction.  So on a standard US keyboard, the key with the number "1" on it also has the
229
229
exclamation point ("!") character on it. The level indicates whether to use
230
230
the "1" or the "!" symbol. The letter keys are considered to have a lowercase
280
280
<hr>
281
281
<div class="refsect2">
282
282
<a name="gdk-keymap-lookup-key"></a><h3>gdk_keymap_lookup_key ()</h3>
283
 
<pre class="programlisting"><span class="returnvalue">guint</span>               gdk_keymap_lookup_key               (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
 
283
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gdk_keymap_lookup_key               (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
284
284
                                                         <em class="parameter"><code>const <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymapKey" title="struct GdkKeymapKey"><span class="type">GdkKeymapKey</span></a> *key</code></em>);</pre>
285
285
<p>
286
286
Looks up the keyval mapped to a keycode/group/level triplet.
297
297
<tbody>
298
298
<tr>
299
299
<td><p><span class="term"><em class="parameter"><code>keymap</code></em> :</span></p></td>
300
 
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to use the default keymap</td>
 
300
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default keymap</td>
301
301
</tr>
302
302
<tr>
303
303
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
314
314
<hr>
315
315
<div class="refsect2">
316
316
<a name="gdk-keymap-translate-keyboard-state"></a><h3>gdk_keymap_translate_keyboard_state ()</h3>
317
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gdk_keymap_translate_keyboard_state (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
318
 
                                                         <em class="parameter"><code><span class="type">guint</span> hardware_keycode</code></em>,
 
317
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gdk_keymap_translate_keyboard_state (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
 
318
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> hardware_keycode</code></em>,
319
319
                                                         <em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkModifierType" title="enum GdkModifierType"><span class="type">GdkModifierType</span></a> state</code></em>,
320
 
                                                         <em class="parameter"><code><span class="type">gint</span> group</code></em>,
321
 
                                                         <em class="parameter"><code><span class="type">guint</span> *keyval</code></em>,
322
 
                                                         <em class="parameter"><code><span class="type">gint</span> *effective_group</code></em>,
323
 
                                                         <em class="parameter"><code><span class="type">gint</span> *level</code></em>,
 
320
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> group</code></em>,
 
321
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *keyval</code></em>,
 
322
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *effective_group</code></em>,
 
323
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *level</code></em>,
324
324
                                                         <em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkModifierType" title="enum GdkModifierType"><span class="type">GdkModifierType</span></a> *consumed_modifiers</code></em>);</pre>
325
325
<p>
326
326
Translates the contents of a <a class="link" href="gdk-Event-Structures.html#GdkEventKey" title="struct GdkEventKey"><span class="type">GdkEventKey</span></a> into a keyval, effective
361
361
<span class="preproc">#define</span><span class="normal"> </span><span class="function">ALL_ACCELS_MASK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="gdk-Windows.html#GDK-CONTROL-MASK:CAPS">GDK_CONTROL_MASK</a> </span><span class="symbol">|</span><span class="normal"> <a href="gdk-Windows.html#GDK-SHIFT-MASK:CAPS">GDK_SHIFT_MASK</a> </span><span class="symbol">|</span><span class="normal"> <a href="gdk-Windows.html#GDK-MOD1-MASK:CAPS">GDK_MOD1_MASK</a></span><span class="symbol">)</span>
362
362
<span class="function"><a href="gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state">gdk_keymap_translate_keyboard_state</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">keymap</span><span class="symbol">,</span><span class="normal"> event</span><span class="symbol">-&gt;</span><span class="normal">hardware_keycode</span><span class="symbol">,</span>
363
363
<span class="normal">                                     event</span><span class="symbol">-&gt;</span><span class="normal">state</span><span class="symbol">,</span><span class="normal"> event</span><span class="symbol">-&gt;</span><span class="normal">group</span><span class="symbol">,</span>
364
 
<span class="normal">                                     </span><span class="symbol">&amp;</span><span class="normal">keyval</span><span class="symbol">,</span><span class="normal"> <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">consumed</span><span class="symbol">);</span>
 
364
<span class="normal">                                     </span><span class="symbol">&amp;</span><span class="normal">keyval</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">consumed</span><span class="symbol">);</span>
365
365
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">keyval </span><span class="symbol">==</span><span class="normal"> <a href="gdk-Cursors.html#GDK-PLUS:CAPS">GDK_PLUS</a> </span><span class="symbol">&amp;&amp;</span>
366
366
<span class="normal">    </span><span class="symbol">(</span><span class="normal">event</span><span class="symbol">-&gt;</span><span class="normal">state </span><span class="symbol">&amp;</span><span class="normal"> </span><span class="symbol">~</span><span class="normal">consumed </span><span class="symbol">&amp;</span><span class="normal"> ALL_ACCELS_MASK</span><span class="symbol">)</span><span class="normal"> </span><span class="symbol">==</span><span class="normal"> <a href="gdk-Windows.html#GDK-CONTROL-MASK:CAPS">GDK_CONTROL_MASK</a></span><span class="symbol">)</span>
367
367
<span class="normal">  </span><span class="comment">/* Control was pressed */</span></pre></td>
409
409
<p>
410
410
</p>
411
411
<p>
412
 
Note that passing <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>keymap</code></em> is deprecated and will stop
 
412
Note that passing <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>keymap</code></em> is deprecated and will stop
413
413
to work in GTK+ 3.0. Use <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-for-display" title="gdk_keymap_get_for_display ()"><code class="function">gdk_keymap_get_for_display()</code></a> instead.
414
414
</p>
415
415
<div class="variablelist"><table border="0" class="variablelist">
420
420
<tbody>
421
421
<tr>
422
422
<td><p><span class="term"><em class="parameter"><code>keymap</code></em> :</span></p></td>
423
 
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a>, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to use the default. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
423
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
424
424
</td>
425
425
</tr>
426
426
<tr>
437
437
</tr>
438
438
<tr>
439
439
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
440
 
<td>return location for keyval, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
440
<td>return location for keyval, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
441
441
</td>
442
442
</tr>
443
443
<tr>
444
444
<td><p><span class="term"><em class="parameter"><code>effective_group</code></em> :</span></p></td>
445
 
<td>return location for effective group, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
445
<td>return location for effective group, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
446
446
</td>
447
447
</tr>
448
448
<tr>
449
449
<td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
450
 
<td>return location for level, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
450
<td>return location for level, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
451
451
</td>
452
452
</tr>
453
453
<tr>
454
454
<td><p><span class="term"><em class="parameter"><code>consumed_modifiers</code></em> :</span></p></td>
455
455
<td>return location for modifiers that were used to
456
 
determine the group or level, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
456
determine the group or level, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
457
457
</td>
458
458
</tr>
459
459
<tr>
460
460
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
461
461
<td>
462
 
<code class="literal">TRUE</code> if there was a keyval bound to the keycode/state/group</td>
 
462
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there was a keyval bound to the keycode/state/group</td>
463
463
</tr>
464
464
</tbody>
465
465
</table></div>
467
467
<hr>
468
468
<div class="refsect2">
469
469
<a name="gdk-keymap-get-entries-for-keyval"></a><h3>gdk_keymap_get_entries_for_keyval ()</h3>
470
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gdk_keymap_get_entries_for_keyval   (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
471
 
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
470
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gdk_keymap_get_entries_for_keyval   (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
 
471
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>,
472
472
                                                         <em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymapKey" title="struct GdkKeymapKey"><span class="type">GdkKeymapKey</span></a> **keys</code></em>,
473
 
                                                         <em class="parameter"><code><span class="type">gint</span> *n_keys</code></em>);</pre>
 
473
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *n_keys</code></em>);</pre>
474
474
<p>
475
475
Obtains a list of keycode/group/level combinations that will
476
476
generate <em class="parameter"><code>keyval</code></em>. Groups and levels are two kinds of keyboard mode;
482
482
<a class="link" href="gdk-Event-Structures.html#GdkEventKey" title="struct GdkEventKey"><span class="type">GdkEventKey</span></a> contains a <code class="literal">group</code> field that indicates the active
483
483
keyboard group. The level is computed from the modifier mask.
484
484
The returned array should be freed
485
 
with <code class="function">g_free()</code>.
 
485
with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.
486
486
</p>
487
487
<div class="variablelist"><table border="0" class="variablelist">
488
488
<colgroup>
492
492
<tbody>
493
493
<tr>
494
494
<td><p><span class="term"><em class="parameter"><code>keymap</code></em> :</span></p></td>
495
 
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a>, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to use the default keymap</td>
 
495
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default keymap</td>
496
496
</tr>
497
497
<tr>
498
498
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
510
510
<tr>
511
511
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
512
512
<td>
513
 
<code class="literal">TRUE</code> if keys were found and returned</td>
 
513
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if keys were found and returned</td>
514
514
</tr>
515
515
</tbody>
516
516
</table></div>
518
518
<hr>
519
519
<div class="refsect2">
520
520
<a name="gdk-keymap-get-entries-for-keycode"></a><h3>gdk_keymap_get_entries_for_keycode ()</h3>
521
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gdk_keymap_get_entries_for_keycode  (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
522
 
                                                         <em class="parameter"><code><span class="type">guint</span> hardware_keycode</code></em>,
 
521
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gdk_keymap_get_entries_for_keycode  (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
 
522
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> hardware_keycode</code></em>,
523
523
                                                         <em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymapKey" title="struct GdkKeymapKey"><span class="type">GdkKeymapKey</span></a> **keys</code></em>,
524
 
                                                         <em class="parameter"><code><span class="type">guint</span> **keyvals</code></em>,
525
 
                                                         <em class="parameter"><code><span class="type">gint</span> *n_entries</code></em>);</pre>
 
524
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> **keyvals</code></em>,
 
525
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *n_entries</code></em>);</pre>
526
526
<p>
527
527
Returns the keyvals bound to <em class="parameter"><code>hardware_keycode</code></em>.
528
528
The Nth <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymapKey" title="struct GdkKeymapKey"><span class="type">GdkKeymapKey</span></a> in <em class="parameter"><code>keys</code></em> is bound to the Nth
529
 
keyval in <em class="parameter"><code>keyvals</code></em>. Free the returned arrays with <code class="function">g_free()</code>.
 
529
keyval in <em class="parameter"><code>keyvals</code></em>. Free the returned arrays with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.
530
530
When a keycode is pressed by the user, the keyval from
531
531
this list of entries is selected by considering the effective
532
532
keyboard group and level. See <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state" title="gdk_keymap_translate_keyboard_state ()"><code class="function">gdk_keymap_translate_keyboard_state()</code></a>.
539
539
<tbody>
540
540
<tr>
541
541
<td><p><span class="term"><em class="parameter"><code>keymap</code></em> :</span></p></td>
542
 
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to use the default keymap</td>
 
542
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default keymap</td>
543
543
</tr>
544
544
<tr>
545
545
<td><p><span class="term"><em class="parameter"><code>hardware_keycode</code></em> :</span></p></td>
561
561
<tr>
562
562
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
563
563
<td>
564
 
<code class="literal">TRUE</code> if there were any entries</td>
 
564
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there were any entries</td>
565
565
</tr>
566
566
</tbody>
567
567
</table></div>
569
569
<hr>
570
570
<div class="refsect2">
571
571
<a name="gdk-keymap-get-direction"></a><h3>gdk_keymap_get_direction ()</h3>
572
 
<pre class="programlisting"><a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Bidirectional-Text.html#PangoDirection"><span class="returnvalue">PangoDirection</span></a>      gdk_keymap_get_direction            (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);</pre>
 
572
<pre class="programlisting"><span class="returnvalue">PangoDirection</span>      gdk_keymap_get_direction            (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);</pre>
573
573
<p>
574
574
Returns the direction of effective layout of the keymap.
575
575
</p>
576
576
<p>
577
 
Note that passing <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>keymap</code></em> is deprecated and will stop
 
577
Note that passing <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>keymap</code></em> is deprecated and will stop
578
578
to work in GTK+ 3.0. Use <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-for-display" title="gdk_keymap_get_for_display ()"><code class="function">gdk_keymap_get_for_display()</code></a> instead.
579
579
</p>
580
580
<p>
588
588
<tbody>
589
589
<tr>
590
590
<td><p><span class="term"><em class="parameter"><code>keymap</code></em> :</span></p></td>
591
 
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to use the default keymap</td>
 
591
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default keymap</td>
592
592
</tr>
593
593
<tr>
594
594
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
595
595
<td>
596
 
<a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Bidirectional-Text.html#PANGO-DIRECTION-LTR:CAPS"><code class="literal">PANGO_DIRECTION_LTR</code></a> or <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Bidirectional-Text.html#PANGO-DIRECTION-RTL:CAPS"><code class="literal">PANGO_DIRECTION_RTL</code></a>
597
 
if it can determine the direction. <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Bidirectional-Text.html#PANGO-DIRECTION-NEUTRAL:CAPS"><code class="literal">PANGO_DIRECTION_NEUTRAL</code></a>
 
596
<code class="literal">PANGO_DIRECTION_LTR</code> or <code class="literal">PANGO_DIRECTION_RTL</code>
 
597
if it can determine the direction. <code class="literal">PANGO_DIRECTION_NEUTRAL</code>
598
598
otherwise.</td>
599
599
</tr>
600
600
</tbody>
603
603
<hr>
604
604
<div class="refsect2">
605
605
<a name="gdk-keymap-have-bidi-layouts"></a><h3>gdk_keymap_have_bidi_layouts ()</h3>
606
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gdk_keymap_have_bidi_layouts        (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);</pre>
 
606
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gdk_keymap_have_bidi_layouts        (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);</pre>
607
607
<p>
608
608
Determines if keyboard layouts for both right-to-left and left-to-right
609
609
languages are in use.
610
610
</p>
611
611
<p>
612
 
Note that passing <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>keymap</code></em> is deprecated and will stop
 
612
Note that passing <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>keymap</code></em> is deprecated and will stop
613
613
to work in GTK+ 3.0. Use <a class="link" href="gdk-Keyboard-Handling.html#gdk-keymap-get-for-display" title="gdk_keymap_get_for_display ()"><code class="function">gdk_keymap_get_for_display()</code></a> instead.
614
614
</p>
615
615
<div class="variablelist"><table border="0" class="variablelist">
620
620
<tbody>
621
621
<tr>
622
622
<td><p><span class="term"><em class="parameter"><code>keymap</code></em> :</span></p></td>
623
 
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to use the default keymap</td>
 
623
<td>a <a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default keymap</td>
624
624
</tr>
625
625
<tr>
626
626
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
627
627
<td>
628
 
<code class="literal">TRUE</code> if there are layouts in both directions, <code class="literal">FALSE</code> otherwise</td>
 
628
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there are layouts in both directions, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
629
629
</tr>
630
630
</tbody>
631
631
</table></div>
634
634
<hr>
635
635
<div class="refsect2">
636
636
<a name="gdk-keymap-get-caps-lock-state"></a><h3>gdk_keymap_get_caps_lock_state ()</h3>
637
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gdk_keymap_get_caps_lock_state      (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);</pre>
 
637
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gdk_keymap_get_caps_lock_state      (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>);</pre>
638
638
<p>
639
639
Returns whether the Caps Lock modifer is locked.
640
640
</p>
652
652
<tr>
653
653
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
654
654
<td>
655
 
<code class="literal">TRUE</code> if Caps Lock is on</td>
 
655
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if Caps Lock is on</td>
656
656
</tr>
657
657
</tbody>
658
658
</table></div>
700
700
<hr>
701
701
<div class="refsect2">
702
702
<a name="gdk-keymap-map-virtual-modifiers"></a><h3>gdk_keymap_map_virtual_modifiers ()</h3>
703
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gdk_keymap_map_virtual_modifiers    (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
 
703
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gdk_keymap_map_virtual_modifiers    (<em class="parameter"><code><a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap</code></em>,
704
704
                                                         <em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkModifierType" title="enum GdkModifierType"><span class="type">GdkModifierType</span></a> *state</code></em>);</pre>
705
705
<p>
706
706
Maps the virtual modifiers (i.e. Super, Hyper and Meta) which
729
729
<tr>
730
730
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
731
731
<td>
732
 
<code class="literal">TRUE</code> if no virtual modifiers were mapped to the
733
 
same non-virtual modifier. Note that <code class="literal">FALSE</code> is also returned
 
732
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if no virtual modifiers were mapped to the
 
733
same non-virtual modifier. Note that <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is also returned
734
734
if a virtual modifier is mapped to a non-virtual modifier that
735
735
was already set in <em class="parameter"><code>state</code></em>.</td>
736
736
</tr>
741
741
<hr>
742
742
<div class="refsect2">
743
743
<a name="gdk-keyval-name"></a><h3>gdk_keyval_name ()</h3>
744
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             gdk_keyval_name                     (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
 
744
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gdk_keyval_name                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);</pre>
745
745
<p>
746
746
Converts a key value into a symbolic name.
747
747
</p>
768
768
<tr>
769
769
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
770
770
<td>a string containing the name of the key,
771
 
or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>keyval</code></em> is not a valid key. The string should not be
 
771
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>keyval</code></em> is not a valid key. The string should not be
772
772
modified. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
773
773
</td>
774
774
</tr>
778
778
<hr>
779
779
<div class="refsect2">
780
780
<a name="gdk-keyval-from-name"></a><h3>gdk_keyval_from_name ()</h3>
781
 
<pre class="programlisting"><span class="returnvalue">guint</span>               gdk_keyval_from_name                (<em class="parameter"><code>const <span class="type">gchar</span> *keyval_name</code></em>);</pre>
 
781
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gdk_keyval_from_name                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *keyval_name</code></em>);</pre>
782
782
<p>
783
783
Converts a key name to a key value.
784
784
</p>
811
811
<hr>
812
812
<div class="refsect2">
813
813
<a name="gdk-keyval-convert-case"></a><h3>gdk_keyval_convert_case ()</h3>
814
 
<pre class="programlisting"><span class="returnvalue">void</span>                gdk_keyval_convert_case             (<em class="parameter"><code><span class="type">guint</span> symbol</code></em>,
815
 
                                                         <em class="parameter"><code><span class="type">guint</span> *lower</code></em>,
816
 
                                                         <em class="parameter"><code><span class="type">guint</span> *upper</code></em>);</pre>
 
814
<pre class="programlisting"><span class="returnvalue">void</span>                gdk_keyval_convert_case             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> symbol</code></em>,
 
815
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *lower</code></em>,
 
816
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *upper</code></em>);</pre>
817
817
<p>
818
818
Obtains the upper- and lower-case versions of the keyval <em class="parameter"><code>symbol</code></em>.
819
819
Examples of keyvals are <span class="type">GDK_a</span>, <span class="type">GDK_Enter</span>, <span class="type">GDK_F1</span>, etc.
844
844
<hr>
845
845
<div class="refsect2">
846
846
<a name="gdk-keyval-to-upper"></a><h3>gdk_keyval_to_upper ()</h3>
847
 
<pre class="programlisting"><span class="returnvalue">guint</span>               gdk_keyval_to_upper                 (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
 
847
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gdk_keyval_to_upper                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);</pre>
848
848
<p>
849
849
Converts a key value to upper case, if applicable.
850
850
</p>
869
869
<hr>
870
870
<div class="refsect2">
871
871
<a name="gdk-keyval-to-lower"></a><h3>gdk_keyval_to_lower ()</h3>
872
 
<pre class="programlisting"><span class="returnvalue">guint</span>               gdk_keyval_to_lower                 (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
 
872
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gdk_keyval_to_lower                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);</pre>
873
873
<p>
874
874
Converts a key value to lower case, if applicable.
875
875
</p>
894
894
<hr>
895
895
<div class="refsect2">
896
896
<a name="gdk-keyval-is-upper"></a><h3>gdk_keyval_is_upper ()</h3>
897
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gdk_keyval_is_upper                 (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
 
897
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gdk_keyval_is_upper                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);</pre>
898
898
<p>
899
 
Returns <code class="literal">TRUE</code> if the given key value is in upper case.
 
899
Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the given key value is in upper case.
900
900
</p>
901
901
<div class="variablelist"><table border="0" class="variablelist">
902
902
<colgroup>
911
911
<tr>
912
912
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
913
913
<td>
914
 
<code class="literal">TRUE</code> if <em class="parameter"><code>keyval</code></em> is in upper case, or if <em class="parameter"><code>keyval</code></em> is not subject to
 
914
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>keyval</code></em> is in upper case, or if <em class="parameter"><code>keyval</code></em> is not subject to
915
915
case conversion.</td>
916
916
</tr>
917
917
</tbody>
920
920
<hr>
921
921
<div class="refsect2">
922
922
<a name="gdk-keyval-is-lower"></a><h3>gdk_keyval_is_lower ()</h3>
923
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gdk_keyval_is_lower                 (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
 
923
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gdk_keyval_is_lower                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);</pre>
924
924
<p>
925
 
Returns <code class="literal">TRUE</code> if the given key value is in lower case.
 
925
Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the given key value is in lower case.
926
926
</p>
927
927
<div class="variablelist"><table border="0" class="variablelist">
928
928
<colgroup>
937
937
<tr>
938
938
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
939
939
<td>
940
 
<code class="literal">TRUE</code> if <em class="parameter"><code>keyval</code></em> is in lower case, or if <em class="parameter"><code>keyval</code></em> is not subject to
 
940
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>keyval</code></em> is in lower case, or if <em class="parameter"><code>keyval</code></em> is not subject to
941
941
case conversion.</td>
942
942
</tr>
943
943
</tbody>
946
946
<hr>
947
947
<div class="refsect2">
948
948
<a name="gdk-keyval-to-unicode"></a><h3>gdk_keyval_to_unicode ()</h3>
949
 
<pre class="programlisting"><span class="returnvalue">guint32</span>             gdk_keyval_to_unicode               (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
 
949
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             gdk_keyval_to_unicode               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);</pre>
950
950
<p>
951
951
Convert from a GDK key symbol to the corresponding ISO10646 (Unicode)
952
952
character.
972
972
<hr>
973
973
<div class="refsect2">
974
974
<a name="gdk-unicode-to-keyval"></a><h3>gdk_unicode_to_keyval ()</h3>
975
 
<pre class="programlisting"><span class="returnvalue">guint</span>               gdk_unicode_to_keyval               (<em class="parameter"><code><span class="type">guint32</span> wc</code></em>);</pre>
 
975
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gdk_unicode_to_keyval               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> wc</code></em>);</pre>
976
976
<p>
977
977
Convert from a ISO10646 character to a key symbol.
978
978
</p>
1001
1001
<div class="refsect2">
1002
1002
<a name="GdkKeymap-direction-changed"></a><h3>The <code class="literal">"direction-changed"</code> signal</h3>
1003
1003
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap,
1004
 
                                                        <span class="type">gpointer</span>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1004
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1005
1005
<p>
1006
1006
The ::direction-changed signal gets emitted when the direction of
1007
1007
the keymap changes.
1028
1028
<div class="refsect2">
1029
1029
<a name="GdkKeymap-keys-changed"></a><h3>The <code class="literal">"keys-changed"</code> signal</h3>
1030
1030
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap,
1031
 
                                                        <span class="type">gpointer</span>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1031
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1032
1032
<p>
1033
1033
The ::keys-changed signal is emitted when the mapping represented by
1034
1034
<em class="parameter"><code>keymap</code></em> changes.
1055
1055
<div class="refsect2">
1056
1056
<a name="GdkKeymap-state-changed"></a><h3>The <code class="literal">"state-changed"</code> signal</h3>
1057
1057
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gdk-Keyboard-Handling.html#GdkKeymap"><span class="type">GdkKeymap</span></a> *keymap,
1058
 
                                                        <span class="type">gpointer</span>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1058
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1059
1059
<p>
1060
1060
The ::state-changed signal is emitted when the state of the
1061
1061
keyboard changes, e.g when Caps Lock is turned on or off.