AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

Update the docs for the event->key.string to say that @string is

Browse Source 
Fri Oct 18 15:13:24 2002  Owen Taylor  <otaylor@redhat.com>

        * gdk/tmpl/event_structs.sgml: Update the docs for
        the event->key.string to say that @string is deprecated.
This commit is contained in:
Owen Taylor 2002-10-18 19:14:54 +00:00 committed by Owen Taylor
parent 74e51bc109
commit d0c4e08535
2 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@ -1,3 +1,8 @@
Fri Oct 18 15:13:24 2002 Owen Taylor <otaylor@redhat.com>
* gdk/tmpl/event_structs.sgml: Update the docs for
the event->key.string to say that @string is deprecated.
Mon Oct 14 19:34:26 2002 Owen Taylor <otaylor@redhat.com>
* gdk/Makefile.am (content_files)

17
docs/reference/gdk/tmpl/event_structs.sgml
View File

@ -91,12 +91,17 @@ Shift and Alt) and the pointer buttons. See #GdkModifierType.
@keyval: the key that was pressed or released. See the <filename>&lt;gdk/gdkkeysym.h&gt;</filename>
header file for a complete list of GDK key codes.
@length: the length of @string.
@string: a nul-terminated multi-byte string containing the composed characters
resulting from the key press. When text is being input, in a #GtkEntry for
example, it is these characters which should be added to the input buffer.
When using <link linkend="gdk-Input-Methods">Input Methods</link> to support
internationalized text input, the composed characters appear here after the
pre-editing has been completed.
@string: a string containing the an approximation of the text that
would result from this keypress. The only correct way to handle text
input of text is using input methods (see #GtkIMContext), so this
field is deprecated and should never be used.
(gdk_unicode_to_keyval() provides a non-deprecated way of getting
an approximate translation for a key.) The string is encoded in the encoding
of the current locale (Note: this for backwards compatibility:
strings in GTK+ and GDK are typically in UTF-8.) and NUL-terminated.
In some cases, the translation of the key code will be a single
NUL byte, in which case looking at @length is necessary to distinguish
it from the an empty translation.
@hardware_keycode: the raw code of the key that was pressed or released.
@group: the keyboard group.