diff options
author | Matthias Clasen <matthiasc@src.gnome.org> | 2001-12-08 21:39:34 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2001-12-08 21:39:34 +0000 |
commit | 63b4e379579be48c2fbbd067cc273c41a3444aa0 (patch) | |
tree | a51161fd834097dbf3a7922869203f758f2ecf1b /gtk/gtkaccelgroup.c | |
parent | 1d0e9b7f289cac390509778007c32d93f7a48e3e (diff) | |
download | gtk+-63b4e379579be48c2fbbd067cc273c41a3444aa0.tar.gz |
Doc markup fix.
* gtk/gtkwidget.c: Doc markup fix.
* gtk/gtktreeviewcolumn.c: Markup fixes. (#66447)
* gtk/gtktreestore.c: Typo fixes. (#66445)
* gtk/gtkaccelgroup.c: Misc doc markup. (#66425)
* gtk/gtkclipboard.c (gtk_clipboard_get_owner): Fix reference
to gtk_clipboard_set_with_owner(). (#66424)
* gtk/tmpl/gtkclipboard.sgml: Fix references to
get_clipboard_set_with_owner(). (#66424)
Diffstat (limited to 'gtk/gtkaccelgroup.c')
-rw-r--r-- | gtk/gtkaccelgroup.c | 63 |
1 files changed, 34 insertions, 29 deletions
diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c index a502943223..0e9b4866a6 100644 --- a/gtk/gtkaccelgroup.c +++ b/gtk/gtkaccelgroup.c @@ -52,8 +52,8 @@ static guint default_accel_mod_mask = (GDK_SHIFT_MASK | /* --- functions --- */ /** - * gtk_accel_group_get_type - * @returns: the type ID for accelerator groups + * gtk_accel_group_get_type: + * @returns: the type ID for accelerator groups. */ GType gtk_accel_group_get_type (void) @@ -165,7 +165,7 @@ gtk_accel_group_init (GtkAccelGroup *accel_group) } /** - * gtk_accel_group_new + * gtk_accel_group_new: * @returns: a new #GtkAccelGroup object * * Creates a new #GtkAccelGroup. @@ -277,9 +277,11 @@ gtk_accel_group_find (GtkAccelGroup *accel_group, } /** - * gtk_accel_group_lock + * gtk_accel_group_lock: * @accel_group: a #GtkAccelGroup * + * Locks the given accelerator group. + * * Locking an acelerator group prevents the accelerators contained * within it to be changed during runtime. Refer to * gtk_accel_map_change_entry() about runtime accelerator changes. @@ -297,11 +299,10 @@ gtk_accel_group_lock (GtkAccelGroup *accel_group) } /** - * gtk_accel_group_unlock + * gtk_accel_group_unlock: * @accel_group: a #GtkAccelGroup * - * This function undoes the last call to gtk_accel_group_lock() - * on this @accel_group. + * Undoes the last call to gtk_accel_group_lock() on this @accel_group. */ void gtk_accel_group_unlock (GtkAccelGroup *accel_group) @@ -463,18 +464,20 @@ quick_accel_find (GtkAccelGroup *accel_group, } /** - * gtk_accel_group_connect - * @accel_group: the ccelerator group to install an accelerator in + * gtk_accel_group_connect: + * @accel_group: the accelerator group to install an accelerator in * @accel_key: key value of the accelerator * @accel_mods: modifier combination of the accelerator * @accel_flags: a flag mask to configure this accelerator * @closure: closure to be executed upon accelerator activation * - * Install an accelerator in this group. When @accel_group is being activated + * Installs an accelerator in this group. When @accel_group is being activated * in response to a call to gtk_accel_groups_activate(), @closure will be * invoked if the @accel_key and @accel_mods from gtk_accel_groups_activate() * match those of this connection. + * * The signature used for the @closure is that of #GtkAccelGroupActivate. + * * Note that, due to implementation details, a single closure can only be * connected to one accelerator group. */ @@ -497,17 +500,18 @@ gtk_accel_group_connect (GtkAccelGroup *accel_group, } /** - * gtk_accel_group_connect_by_path - * @accel_group: the ccelerator group to install an accelerator in + * gtk_accel_group_connect_by_path: + * @accel_group: the accelerator group to install an accelerator in * @accel_path: path used for determining key and modifiers. * @closure: closure to be executed upon accelerator activation * - * Install an accelerator in this group, using a accelerator path to look - * up the appropriate key and modifiers. (See gtk_accel_map_add_entry()) + * Installs an accelerator in this group, using an accelerator path to look + * up the appropriate key and modifiers (see gtk_accel_map_add_entry()). * When @accel_group is being activated in response to a call to * gtk_accel_groups_activate(), @closure will be invoked if the @accel_key and * @accel_mods from gtk_accel_groups_activate() match the key and modifiers * for the path. + * * The signature used for the @closure is that of #GtkAccelGroupActivate. */ void @@ -541,12 +545,12 @@ gtk_accel_group_connect_by_path (GtkAccelGroup *accel_group, } /** - * gtk_accel_group_disconnect + * gtk_accel_group_disconnect: * @accel_group: the accelerator group to remove an accelerator from * @closure: the closure to remove from this accelerator group * @returns: %TRUE if the closure was found and got disconnected * - * Remove an accelerator previously installed through + * Removes an accelerator previously installed through * gtk_accel_group_connect(). */ gboolean @@ -569,13 +573,14 @@ gtk_accel_group_disconnect (GtkAccelGroup *accel_group, } /** - * gtk_accel_group_disconnect_key - * @accel_group: the ccelerator group to install an accelerator in + * gtk_accel_group_disconnect_key: + * @accel_group: the accelerator group to install an accelerator in * @accel_key: key value of the accelerator * @accel_mods: modifier combination of the accelerator - * @returns: %TRUE if there was an accelerator which could be removed, %FALSE otherwise + * @returns: %TRUE if there was an accelerator which could be + * removed, %FALSE otherwise * - * Remove an accelerator previously installed through + * Removes an accelerator previously installed through * gtk_accel_group_connect(). */ gboolean @@ -744,14 +749,14 @@ gtk_accel_groups_activate (GObject *object, } /** - * gtk_accelerator_valid + * gtk_accelerator_valid: * @keyval: a GDK keyval * @modifiers: modifier mask * @returns: %TRUE if the accelerator is valid * * Determines whether a given keyval and modifier mask constitute - * a valid keyboard accelerator. For example, the GDK_a keyval - * plus GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator. + * a valid keyboard accelerator. For example, the #GDK_a keyval + * plus #GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator. * But by default (see gtk_accelerator_set_default_mod_mask()) you * cannot use the NumLock key as an accelerator modifier. */ @@ -884,7 +889,7 @@ is_release (const gchar *string) } /** - * gtk_accelerator_parse + * gtk_accelerator_parse: * @accelerator: string representing an accelerator * @accelerator_key: return location for accelerator keyval * @accelerator_mods: return location for accelerator modifier mask @@ -1002,14 +1007,14 @@ gtk_accelerator_parse (const gchar *accelerator, } /** - * gtk_accelerator_name + * gtk_accelerator_name: * @accelerator_key: accelerator keyval * @accelerator_mods: accelerator modifier mask - * @returns: a newly allocated accelerator name + * @returns: a newly-allocated accelerator name * * Converts an accelerator keyval and modifier mask * into a string parseable by gtk_accelerator_parse(). - * For example, if you pass in GDK_q and GDK_CONTROL_MASK, + * For example, if you pass in #GDK_q and #GDK_CONTROL_MASK, * this function returns "<Control>q". * * The caller of this function must free the returned string. @@ -1105,7 +1110,7 @@ gtk_accelerator_name (guint accelerator_key, } /** - * gtk_accelerator_set_default_mod_mask + * gtk_accelerator_set_default_mod_mask: * @default_mod_mask: accelerator modifier mask * * Sets the modifiers that will be considered significant for keyboard @@ -1123,7 +1128,7 @@ gtk_accelerator_set_default_mod_mask (GdkModifierType default_mod_mask) } /** - * gtk_accelerator_get_default_mod_mask + * gtk_accelerator_get_default_mod_mask: * @returns: the default accelerator modifier mask * * Gets the value set by gtk_accelerator_set_default_mod_mask(). |