From 13a13e60bd358ce45f0dad1bffcc2b5f279790dd Mon Sep 17 00:00:00 2001 From: Miguel de Icaza Date: Tue, 18 Feb 2003 23:03:56 +0000 Subject: [PATCH] Add contribution from Cristopher svn path=/trunk/gtk-sharp/; revision=11706 --- doc/en/Gdk/Keymap.xml | 152 ++++++++++++++++++++++++++++-------------- 1 file changed, 103 insertions(+), 49 deletions(-) diff --git a/doc/en/Gdk/Keymap.xml b/doc/en/Gdk/Keymap.xml index b5038da58..89388d1ee 100644 --- a/doc/en/Gdk/Keymap.xml +++ b/doc/en/Gdk/Keymap.xml @@ -1,14 +1,22 @@ - + gdk-sharp 0.0.0.0 - To be added + Not thread safe - To be added - To be added + Object for keyboard code manipulation + + + Defines translations from keyboard states to a `keyval`. Two phase translation: determine keyboard group and level + for keyboard state, then lookup the keycode/group/level triplet in the keymap and get the corresponding keyval. + Keycode is the hardware/keyboard code for that key. Keygroup is used for language and horizontal tracking [ "group 1" is english, + "group 2" is hebrew]. Keylevel is used to track letter case/alternate representation and vertical movement [ level 0 is "a", + level 1 is "A" ; alternately, level 0 is "1" and level 1 is "!" ]. + + GLib.Object @@ -35,12 +43,21 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'Gdk.KeymapKey' - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + + Gets a list of keycode/group/level combinations that generate a `keyval`. + The returned list is stored in the `Gdk.KeymapKey keys` parameter/reference. + `uint keyval` is the final value for the combinations being collected. + `int n_keys` is the total number of combinations found and returned in `Gdk.KeymapKey keys`. + Level determining the top/bottom symbol and group determining the left/right symbol. + On US keyboards, shift changes level and there are no groups. Group can determine language mode, for example, Hebrew/English. + + An object of type 'uint', such as GDK_a, GDK_up, GDK_RETURN, etc. + An object of type 'Gdk.KeymapKey', the list of key sequences. + An object of type 'int', number of elements returned. + An object of type 'bool', returns true if keys were found and returned. + + None + @@ -56,13 +73,18 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'Gdk.KeymapKey' - To be added: an object of type 'uint' - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + + Stores in `Gdk.KeymapKey keys` a reference to a list of the keys bound to `hardware_keycode`. The nth Gdk.KeymapKey in `keys` is associated + with the nth keyval in `keyvals`. When a keycode is pressed by the user, the keyval from `keys` is selected. + + An object of type 'uint', a keyboard code + An object of type 'Gdk.KeymapKey', return reference for the list of keys + An object of type 'uint', return reference for the list of corresponding keyvals for `keys` + An object of type 'int', number of values stored in `keys` and `keyvals` + An object of type 'bool', true if entries were found. + + None + @@ -75,10 +97,14 @@ - To be added - To be added: an object of type 'Gdk.KeymapKey' - To be added: an object of type 'uint' - To be added + + Looks up a keyval mapped to a keycode/group/level triplet. If no keyval is bound to `key`, the method returns 0. + + An object of type 'Gdk.KeymapKey', initalized keycode/group/level triplet. + An object of type 'uint', a keyval or 0 if none was found. + + None + @@ -97,16 +123,21 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'Gdk.ModifierType' - To be added: an object of type 'int' - To be added: an object of type 'uint' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Gdk.ModifierType' - To be added: an object of type 'bool' - To be added + + Translates the contents of a Gdk.KeymapKey into a keyval/group/level. Modifiers affecting the translation are returned + in `consumed_modifiers`. `effective_group` is the group used in translation. Key level is determined by `state`. + + An object of type 'uint', a keyboard code. + An object of type 'Gdk.ModifierType', a modifier state. + An object of type 'int', active keyboard group. + An object of type 'uint', return reference for `keyval`. + An object of type 'int', return reference for `effective group`. + An object of type 'int', return reference for the new level. + An object of type 'Gdk.ModifierType', return reference for modifiers used to determine group/level. + An object of type 'bool', return `true` if keys were found and returned. + + None + @@ -117,8 +148,12 @@ - To be added - To be added + + To be added + + + None + @@ -129,10 +164,14 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'Gdk.Keymap' - To be added + + Creates a Keymap based upon the GLib type. + + An object of type 'uint', the GLib type. + An object of type 'Gdk.Keymap', and gtype. + + None + @@ -143,10 +182,15 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gdk.Keymap' - To be added + + This is an internal constructor, and should not be used by + user code. + + An object of type 'IntPtr', pointer to a C object. + An object of type 'Gdk.Keymap' + + Wrapper for the C object. + @@ -155,9 +199,11 @@ - To be added - To be added: an object of type 'Gdk.Keymap' - To be added + Default constructor + An object of type 'Gdk.Keymap' + + None + @@ -191,9 +237,13 @@ Pango.Direction - To be added - To be added: an object of type 'Pango.Direction' - To be added + + Member that represents the current direction of the keymap. + + An object of type 'Pango.Direction', current keymap direction. + + None + @@ -202,8 +252,12 @@ - To be added - To be added + + An event handler that fires when the direction of a keymap has been changed. + + + None +