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

docs: Clarify gtk_widget_activate()

Browse Source 
We need to tell people what signal will be emitted when calling
gtk_widget_activate(), and that the shortcuts API might be more
appropriate to what they are looking for.
This commit is contained in:
Emmanuele Bassi 2020-12-06 15:13:57 +00:00
parent c352fe9ab0
commit d8c9a67d20
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
gtk/gtkwidget.c
View File

@ -4659,9 +4659,18 @@ gtk_widget_class_set_activate_signal_from_name (GtkWidgetClass *widget_class,
* @widget: a #GtkWidget that’s activatable
*
* For widgets that can be “activated” (buttons, menu items, etc.)
* this function activates them. Activation is what happens when you
* press Enter on a widget during key navigation. If @widget isn't
* activatable, the function returns %FALSE.
* this function activates them. The activation will emit the signal
* set using gtk_widget_class_set_activate_signal() during class
* initialization.
*
* Activation is what happens when you press Enter on a widget during
* key navigation.
*
* If you wish to handle the activation keybinding yourself, it is
* recommended to use gtk_widget_class_add_shortcut() with an action
* created with gtk_signal_action_new().
*
* If @widget isn't activatable, the function returns %FALSE.
*
* Returns: %TRUE if the widget was activatable
**/