Commit 5cc215cd authored by Matthias Clasen's avatar Matthias Clasen

Remove redundant doc comments.

parent 1cdd4cd2
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gdk/linux-fb/gdkselection-fb.c (gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
(gdk_text_property_to_utf8_list_for_display):
* gdk/linux-fb/gdkkeyboard-fb.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkselection-win32.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
* gdk/win32/gdkkeys-win32.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkgeometry-win32.c (gdk_window_scroll):
* gdk/win32/gdkfont-win32.c (gdk_font_from_description_for_display):
* gdk/win32/gdkevents-win32.c (gdk_keyboard_grab_info_libgtk_only):
Remove doc comments for non-backend-specific functions from win32
and linux-fb backends. These functions should be documented in the
x11 backend.
Wed Oct 23 17:06:02 2002 Kristian Rietveld <kris@gtk.org>
* gtk/gtktreemodel.c: s/NULL/0/ on the g_signal_emit lines to
......@@ -56,6 +79,10 @@ Wed Oct 23 00:56:15 2002 Kristian Rietveld <kris@gtk.org>
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtkinvisible.c (gtk_invisible_get_screen):
* gtk/gtkcolorsel.c
(gtk_color_selection_set_change_palette_with_screen_hook): Fix doc comments.
* gdk/linux-fb/gdkselection-fb.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_compound_text_for_display): Fix doc comments - why
do these overwrite the ones from gdk/x11/*.c ?!
......@@ -2440,7 +2467,7 @@ Mon Jul 01 17:19:00 2002 Bill Haneman <bill.haneman@sun.com>
Thu Jun 20 19:41:09 2002 Owen Taylor <otaylor@redhat.com>
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/**.c gtk/*.c
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/*.c gtk/*.c
tests/*.c: Renames:
gdk_get_default_display => gdk_display_get_default
......
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gdk/linux-fb/gdkselection-fb.c (gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
(gdk_text_property_to_utf8_list_for_display):
* gdk/linux-fb/gdkkeyboard-fb.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkselection-win32.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
* gdk/win32/gdkkeys-win32.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkgeometry-win32.c (gdk_window_scroll):
* gdk/win32/gdkfont-win32.c (gdk_font_from_description_for_display):
* gdk/win32/gdkevents-win32.c (gdk_keyboard_grab_info_libgtk_only):
Remove doc comments for non-backend-specific functions from win32
and linux-fb backends. These functions should be documented in the
x11 backend.
Wed Oct 23 17:06:02 2002 Kristian Rietveld <kris@gtk.org>
* gtk/gtktreemodel.c: s/NULL/0/ on the g_signal_emit lines to
......@@ -56,6 +79,10 @@ Wed Oct 23 00:56:15 2002 Kristian Rietveld <kris@gtk.org>
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtkinvisible.c (gtk_invisible_get_screen):
* gtk/gtkcolorsel.c
(gtk_color_selection_set_change_palette_with_screen_hook): Fix doc comments.
* gdk/linux-fb/gdkselection-fb.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_compound_text_for_display): Fix doc comments - why
do these overwrite the ones from gdk/x11/*.c ?!
......@@ -2440,7 +2467,7 @@ Mon Jul 01 17:19:00 2002 Bill Haneman <bill.haneman@sun.com>
Thu Jun 20 19:41:09 2002 Owen Taylor <otaylor@redhat.com>
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/**.c gtk/*.c
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/*.c gtk/*.c
tests/*.c: Renames:
gdk_get_default_display => gdk_display_get_default
......
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gdk/linux-fb/gdkselection-fb.c (gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
(gdk_text_property_to_utf8_list_for_display):
* gdk/linux-fb/gdkkeyboard-fb.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkselection-win32.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
* gdk/win32/gdkkeys-win32.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkgeometry-win32.c (gdk_window_scroll):
* gdk/win32/gdkfont-win32.c (gdk_font_from_description_for_display):
* gdk/win32/gdkevents-win32.c (gdk_keyboard_grab_info_libgtk_only):
Remove doc comments for non-backend-specific functions from win32
and linux-fb backends. These functions should be documented in the
x11 backend.
Wed Oct 23 17:06:02 2002 Kristian Rietveld <kris@gtk.org>
* gtk/gtktreemodel.c: s/NULL/0/ on the g_signal_emit lines to
......@@ -56,6 +79,10 @@ Wed Oct 23 00:56:15 2002 Kristian Rietveld <kris@gtk.org>
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtkinvisible.c (gtk_invisible_get_screen):
* gtk/gtkcolorsel.c
(gtk_color_selection_set_change_palette_with_screen_hook): Fix doc comments.
* gdk/linux-fb/gdkselection-fb.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_compound_text_for_display): Fix doc comments - why
do these overwrite the ones from gdk/x11/*.c ?!
......@@ -2440,7 +2467,7 @@ Mon Jul 01 17:19:00 2002 Bill Haneman <bill.haneman@sun.com>
Thu Jun 20 19:41:09 2002 Owen Taylor <otaylor@redhat.com>
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/**.c gtk/*.c
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/*.c gtk/*.c
tests/*.c: Renames:
gdk_get_default_display => gdk_display_get_default
......
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gdk/linux-fb/gdkselection-fb.c (gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
(gdk_text_property_to_utf8_list_for_display):
* gdk/linux-fb/gdkkeyboard-fb.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkselection-win32.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
* gdk/win32/gdkkeys-win32.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkgeometry-win32.c (gdk_window_scroll):
* gdk/win32/gdkfont-win32.c (gdk_font_from_description_for_display):
* gdk/win32/gdkevents-win32.c (gdk_keyboard_grab_info_libgtk_only):
Remove doc comments for non-backend-specific functions from win32
and linux-fb backends. These functions should be documented in the
x11 backend.
Wed Oct 23 17:06:02 2002 Kristian Rietveld <kris@gtk.org>
* gtk/gtktreemodel.c: s/NULL/0/ on the g_signal_emit lines to
......@@ -56,6 +79,10 @@ Wed Oct 23 00:56:15 2002 Kristian Rietveld <kris@gtk.org>
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtkinvisible.c (gtk_invisible_get_screen):
* gtk/gtkcolorsel.c
(gtk_color_selection_set_change_palette_with_screen_hook): Fix doc comments.
* gdk/linux-fb/gdkselection-fb.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_compound_text_for_display): Fix doc comments - why
do these overwrite the ones from gdk/x11/*.c ?!
......@@ -2440,7 +2467,7 @@ Mon Jul 01 17:19:00 2002 Bill Haneman <bill.haneman@sun.com>
Thu Jun 20 19:41:09 2002 Owen Taylor <otaylor@redhat.com>
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/**.c gtk/*.c
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/*.c gtk/*.c
tests/*.c: Renames:
gdk_get_default_display => gdk_display_get_default
......
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gdk/linux-fb/gdkselection-fb.c (gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
(gdk_text_property_to_utf8_list_for_display):
* gdk/linux-fb/gdkkeyboard-fb.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkselection-win32.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
* gdk/win32/gdkkeys-win32.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkgeometry-win32.c (gdk_window_scroll):
* gdk/win32/gdkfont-win32.c (gdk_font_from_description_for_display):
* gdk/win32/gdkevents-win32.c (gdk_keyboard_grab_info_libgtk_only):
Remove doc comments for non-backend-specific functions from win32
and linux-fb backends. These functions should be documented in the
x11 backend.
Wed Oct 23 17:06:02 2002 Kristian Rietveld <kris@gtk.org>
* gtk/gtktreemodel.c: s/NULL/0/ on the g_signal_emit lines to
......@@ -56,6 +79,10 @@ Wed Oct 23 00:56:15 2002 Kristian Rietveld <kris@gtk.org>
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtkinvisible.c (gtk_invisible_get_screen):
* gtk/gtkcolorsel.c
(gtk_color_selection_set_change_palette_with_screen_hook): Fix doc comments.
* gdk/linux-fb/gdkselection-fb.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_compound_text_for_display): Fix doc comments - why
do these overwrite the ones from gdk/x11/*.c ?!
......@@ -2440,7 +2467,7 @@ Mon Jul 01 17:19:00 2002 Bill Haneman <bill.haneman@sun.com>
Thu Jun 20 19:41:09 2002 Owen Taylor <otaylor@redhat.com>
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/**.c gtk/*.c
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/*.c gtk/*.c
tests/*.c: Renames:
gdk_get_default_display => gdk_display_get_default
......
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gdk/linux-fb/gdkselection-fb.c (gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
(gdk_text_property_to_utf8_list_for_display):
* gdk/linux-fb/gdkkeyboard-fb.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkselection-win32.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_string_target):
(gdk_utf8_to_compound_text_for_display):
* gdk/win32/gdkkeys-win32.c (gdk_keymap_get_entries_for_keyval):
(gdk_keymap_get_entries_for_keycode):
(gdk_keymap_lookup_key):
(gdk_keymap_translate_keyboard_state):
* gdk/win32/gdkgeometry-win32.c (gdk_window_scroll):
* gdk/win32/gdkfont-win32.c (gdk_font_from_description_for_display):
* gdk/win32/gdkevents-win32.c (gdk_keyboard_grab_info_libgtk_only):
Remove doc comments for non-backend-specific functions from win32
and linux-fb backends. These functions should be documented in the
x11 backend.
Wed Oct 23 17:06:02 2002 Kristian Rietveld <kris@gtk.org>
* gtk/gtktreemodel.c: s/NULL/0/ on the g_signal_emit lines to
......@@ -56,6 +79,10 @@ Wed Oct 23 00:56:15 2002 Kristian Rietveld <kris@gtk.org>
2002-10-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtkinvisible.c (gtk_invisible_get_screen):
* gtk/gtkcolorsel.c
(gtk_color_selection_set_change_palette_with_screen_hook): Fix doc comments.
* gdk/linux-fb/gdkselection-fb.c (gdk_text_property_to_utf8_list_for_display):
(gdk_utf8_to_compound_text_for_display): Fix doc comments - why
do these overwrite the ones from gdk/x11/*.c ?!
......@@ -2440,7 +2467,7 @@ Mon Jul 01 17:19:00 2002 Bill Haneman <bill.haneman@sun.com>
Thu Jun 20 19:41:09 2002 Owen Taylor <otaylor@redhat.com>
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/**.c gtk/*.c
* gdk/gdkdisplay.h gdk/gdkscreen.h gdk/*.c gtk/*.c
tests/*.c: Renames:
gdk_get_default_display => gdk_display_get_default
......
......@@ -235,27 +235,6 @@ gdk_fb_keyboard_close (void)
}
/**
* gdk_keymap_get_entries_for_keyval:
* @keymap: a #GdkKeymap, or %NULL to use the default keymap
* @keyval: a keyval, such as %GDK_a, %GDK_Up, %GDK_Return, etc.
* @keys: return location for an array of #GdkKeymapKey
* @n_keys: return location for number of elements in returned array
*
* Obtains a list of keycode/group/level combinations that will
* generate @keyval. Groups and levels are two kinds of keyboard mode;
* in general, the level determines whether the top or bottom symbol
* on a key is used, and the group determines whether the left or
* right symbol is used. On US keyboards, the shift key changes the
* keyboard level, and there are no groups. A group switch key might
* convert a keyboard between Hebrew to English modes, for example.
* #GdkEventKey contains a %group field that indicates the active
* keyboard group. The level is computed from the modifier mask.
* The returned array should be freed
* with g_free().
*
* Return value: %TRUE if keys were found and returned
**/
gboolean
gdk_keymap_get_entries_for_keyval (GdkKeymap *keymap,
guint keyval,
......@@ -273,23 +252,6 @@ gdk_keymap_get_entries_for_keyval (GdkKeymap *keymap,
n_keys);
}
/**
* gdk_keymap_get_entries_for_keycode:
* @keymap: a #GdkKeymap or %NULL to use the default keymap
* @hardware_keycode: a keycode
* @keys: return location for array of #GdkKeymapKey, or NULL
* @keyvals: return location for array of keyvals, or NULL
* @n_entries: length of @keys and @keyvals
*
* Returns the keyvals bound to @hardware_keycode.
* The Nth #GdkKeymapKey in @keys is bound to the Nth
* keyval in @keyvals. Free the returned arrays with g_free().
* When a keycode is pressed by the user, the keyval from
* this list of entries is selected by considering the effective
* keyboard group and level. See gdk_keymap_translate_keyboard_state().
*
* Returns: %TRUE if there were any entries
**/
gboolean
gdk_keymap_get_entries_for_keycode (GdkKeymap *keymap,
guint hardware_keycode,
......@@ -308,19 +270,6 @@ gdk_keymap_get_entries_for_keycode (GdkKeymap *keymap,
}
/**
* gdk_keymap_lookup_key:
* @keymap: a #GdkKeymap or %NULL to use the default keymap
* @key: a #GdkKeymapKey with keycode, group, and level initialized
*
* Looks up the keyval mapped to a keycode/group/level triplet.
* If no keyval is bound to @key, returns 0. For normal user input,
* you want to use gdk_keymap_translate_keyboard_state() instead of
* this function, since the effective group/level may not be
* the same as the current keyboard state.
*
* Return value: a keyval, or 0 if none was mapped to the given @key
**/
guint
gdk_keymap_lookup_key (GdkKeymap *keymap,
const GdkKeymapKey *key)
......@@ -333,30 +282,6 @@ gdk_keymap_lookup_key (GdkKeymap *keymap,
}
/**
* gdk_keymap_translate_keyboard_state:
* @keymap: a #GdkKeymap, or %NULL to use the default
* @hardware_keycode: a keycode
* @state: a modifier state
* @group: active keyboard group
* @keyval: return location for keyval
* @effective_group: return location for effective group
* @level: return location for level
* @consumed_modifiers: return location for modifiers that were used to determine the group or level
*
*
* Translates the contents of a #GdkEventKey into a keyval, effective
* group, and level. Modifiers that affected the translation and
* are thus unavailable for application use are returned in
* @consumed_modifiers. See gdk_keyval_get_keys() for an explanation of
* groups and levels. The @effective_group is the group that was
* actually used for the translation; some keys such as Enter are not
* affected by the active keyboard group. The @level is derived from
* @state. For convenience, #GdkEventKey already contains the translated
* keyval, so this function isn't as useful as you might think.
*
* Return value: %TRUE if there was a keyval bound to the keycode/state/group
**/
gboolean
gdk_keymap_translate_keyboard_state (GdkKeymap *keymap,
guint hardware_keycode,
......
......@@ -263,19 +263,6 @@ void gdk_free_compound_text (guchar *ctext)
g_warning ("gdk_free_compound_text() not implemented\n");
}
/**
* gdk_utf8_to_string_target:
* @str: a UTF-8 string
*
* Convert an UTF-8 string into the best possible representation
* as a STRING. The representation of characters not in STRING
* is not specified; it may be as pseudo-escape sequences
* \x{ABCD}, or it may be in some other form of approximation.
*
* Return value: the newly allocated string, or %NULL if the
* conversion failed. (It should not fail for
* any properly formed UTF-8 string.)
**/
gchar *
gdk_utf8_to_string_target (const gchar *str)
{
......@@ -283,21 +270,6 @@ gdk_utf8_to_string_target (const gchar *str)
return 0;
}
/**
* gdk_utf8_to_compound_text_for_display:
* @display: a #GdkDisplay
* @str: a UTF-8 string
* @encoding: location to store resulting encoding
* @format: location to store format of the result
* @ctext: location to store the data of the result
* @length: location to store the length of the data
* stored in @ctext
*
* Convert from UTF-8 to compound text.
*
* Return value: %TRUE if the conversion succeeded, otherwise
* false.
**/
gboolean
gdk_utf8_to_compound_text_for_display (GdkDisplay *display,
const gchar *str,
......@@ -380,22 +352,6 @@ make_list (const gchar *text,
}
/**
* gdk_text_property_to_utf8_list_for_display:
* @display: a #GdkDisplay
* @encoding: an atom representing the encoding of the text
* @format: the format of the property
* @text: the text to convert
* @length: the length of @text, in bytes
* @list: location to store the list of strings or %NULL. The
* list should be freed with g_strfreev().
*
* Convert a text property in the giving encoding to
* a list of UTF-8 strings.
*
* Return value: the number of strings in the resulting
* list.
**/
gint
gdk_text_property_to_utf8_list_for_display (GdkDisplay *display,
GdkAtom encoding,
......
......@@ -807,18 +807,6 @@ gdk_display_keyboard_ungrab (GdkDisplay *display,
k_grab_window = NULL;
}
/**
* gdk_keyboard_grab_info_libgtk_only:
* @grab_window: location to store current grab window
* @owner_events: location to store boolean indicating whether
* the @owner_events flag to gdk_keyboard_grab() was %TRUE.
*
* Determines information about the current keyboard grab.
* This is not public API and must not be used by applications.
*
* Return value: %TRUE if this application currently has the
* keyboard grabbed.
**/
gboolean
gdk_keyboard_grab_info_libgtk_only (GdkDisplay *display,
GdkWindow **grab_window,
......
......@@ -1234,19 +1234,6 @@ gdk_font_load_for_display (GdkDisplay *display,
return gdk_font_from_one_singlefont (gdk_font_load_internal (font_name));
}
/**
* gdk_font_from_description:
* @font_desc: a #PangoFontDescription.
*
* Load a #GdkFont based on a Pango font description. This font will
* only be an approximation of the Pango font, and
* internationalization will not be handled correctly. This function
* should only be used for legacy code that cannot be easily converted
* to use Pango. Using Pango directly will produce better results.
*
* Return value: the newly loaded font, or %NULL if the font
* cannot be loaded.
**/
GdkFont*
gdk_font_from_description_for_display (GdkDisplay *display,
PangoFontDescription *font_desc)
......
......@@ -291,21 +291,6 @@ gdk_window_guffaw_scroll (GdkWindow *window,
}
}
/**
* gdk_window_scroll:
* @window: a #GdkWindow
* @dx: Amount to scroll in the X direction
* @dy: Amount to scroll in the Y direction
*
* Scroll the contents of @window, both pixels and children, by the given
* amount. @window itself does not move. Portions of the window that the scroll
* operation brings in from offscreen areas are invalidated. The invalidated
* region may be bigger than what would strictly be necessary. (For Win32, a
* minimum area will be invalidated if the window has no subwindows, or if the
* edges of the window's parent do not extend beyond the edges of the window. In
* other cases, a multi-step process is used to scroll the window which may
* produce temporary visual artifacts and unnecessary invalidations.)
**/
void
gdk_window_scroll (GdkWindow *window,
gint dx,
......
......@@ -322,27 +322,6 @@ gdk_keymap_get_direction (GdkKeymap *keymap)
}
}
/**
* gdk_keymap_get_entries_for_keyval:
* @keymap: a #GdkKeymap, or %NULL to use the default keymap
* @keyval: a keyval, such as %GDK_a, %GDK_Up, %GDK_Return, etc.
* @keys: return location for an array of #GdkKeymapKey
* @n_keys: return location for number of elements in returned array
*
* Obtains a list of keycode/group/level combinations that will
* generate @keyval. Groups and levels are two kinds of keyboard mode;
* in general, the level determines whether the top or bottom symbol
* on a key is used, and the group determines whether the left or
* right symbol is used. On US keyboards, the shift key changes the
* keyboard level, and there are no groups. A group switch key might
* convert a keyboard between Hebrew to English modes, for example.
* #GdkEventKey contains a %group field that indicates the active
* keyboard group. The level is computed from the modifier mask.
* The returned array should be freed
* with g_free().
*
* Return value: %TRUE if keys were found and returned
**/
gboolean
gdk_keymap_get_entries_for_keyval (GdkKeymap *keymap,
guint keyval,
......@@ -419,23 +398,6 @@ gdk_keymap_get_entries_for_keyval (GdkKeymap *keymap,
return *n_keys > 0;
}
/**
* gdk_keymap_get_entries_for_keycode:
* @keymap: a #GdkKeymap or %NULL to use the default keymap
* @hardware_keycode: a keycode
* @keys: return location for array of #GdkKeymapKey, or NULL
* @keyvals: return location for array of keyvals, or NULL
* @n_entries: length of @keys and @keyvals
*
* Returns the keyvals bound to @hardware_keycode.
* The Nth #GdkKeymapKey in @keys is bound to the Nth
* keyval in @keyvals. Free the returned arrays with g_free().
* When a keycode is pressed by the user, the keyval from
* this list of entries is selected by considering the effective
* keyboard group and level. See gdk_keymap_translate_keyboard_state().
*
* Returns: %TRUE if there were any entries
**/
gboolean
gdk_keymap_get_entries_for_keycode (GdkKeymap *keymap,
guint hardware_keycode,
......@@ -530,20 +492,6 @@ gdk_keymap_get_entries_for_keycode (GdkKeymap *keymap,
return *n_entries > 0;
}
/**
* gdk_keymap_lookup_key:
* @keymap: a #GdkKeymap or %NULL to use the default keymap
* @key: a #GdkKeymapKey with keycode, group, and level initialized
*
* Looks up the keyval mapped to a keycode/group/level triplet.
* If no keyval is bound to @key, returns 0. For normal user input,
* you want to use gdk_keymap_translate_keyboard_state() instead of
* this function, since the effective group/level may not be
* the same as the current keyboard state.
*
* Return value: a keyval, or 0 if none was mapped to the given @key
**/
guint
gdk_keymap_lookup_key (GdkKeymap *keymap,
const GdkKeymapKey *key)
......@@ -573,30 +521,6 @@ gdk_keymap_lookup_key (GdkKeymap *keymap,
return sym;
}
/**
* gdk_keymap_translate_keyboard_state:
* @keymap: a #GdkKeymap, or %NULL to use the default
* @hardware_keycode: a keycode
* @state: a modifier state
* @group: active keyboard group
* @keyval: return location for keyval
* @effective_group: return location for effective group
* @level: return location for level
* @consumed_modifiers: return location for modifiers that were used to determine the group or level
*
*
* Translates the contents of a #GdkEventKey into a keyval, effective
* group, and level. Modifiers that affected the translation and
* are thus unavailable for application use are returned in
* @consumed_modifiers. See gdk_keyval_get_keys() for an explanation of
* groups and levels. The @effective_group is the group that was
* actually used for the translation; some keys such as Enter are not
* affected by the active keyboard group. The @level is derived from
* @state. For convenience, #GdkEventKey already contains the translated
* keyval, so this function isn't as useful as you might think.
*
* Return value: %TRUE if there was a keyval bound to the keycode/state/group
**/
gboolean
gdk_keymap_translate_keyboard_state (GdkKeymap *keymap,
guint hardware_keycode,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment