widget: Document signal mnemonic-activate

Name the extra bool argument, and move the explanatory paragraph from
the emitting method to the signal, with some minor tweaks to wording.

https://bugzilla.gnome.org/show_bug.cgi?id=778534
This commit is contained in:
Daniel Boles 2017-02-12 15:52:02 +00:00
parent 104c9ac845
commit f8af23553b

View File

@ -2010,7 +2010,10 @@ G_GNUC_END_IGNORE_DEPRECATIONS
/**
* GtkWidget::mnemonic-activate:
* @widget: the object which received the signal.
* @arg1:
* @group_cycling: %TRUE if there are other widgets with the same mnemonic
*
* The default handler for this signal activates @widget if @group_cycling
* is %FALSE, or just makes @widget grab focus if @group_cycling is %TRUE.
*
* Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
@ -6839,14 +6842,10 @@ _gtk_widget_get_accel_path (GtkWidget *widget,
/**
* gtk_widget_mnemonic_activate:
* @widget: a #GtkWidget
* @group_cycling: %TRUE if there are other widgets with the same mnemonic
* @group_cycling: %TRUE if there are other widgets with the same mnemonic
*
* Emits the #GtkWidget::mnemonic-activate signal.
*
* The default handler for this signal activates the @widget if
* @group_cycling is %FALSE, and just grabs the focus if @group_cycling
* is %TRUE.
*
* Returns: %TRUE if the signal has been handled
*/
gboolean