ListBox: Avoid ::row-activated/Row::activate ambig

…uity, by adding a doc comment to Row::activate explaining what it does
and why it is probably not what the user reading that is looking for.

https://bugzilla.gnome.org/show_bug.cgi?id=794008
This commit is contained in:
Daniel Boles 2018-03-12 16:08:29 +00:00
parent d0757f6436
commit 2072953375

View File

@ -3409,6 +3409,14 @@ gtk_list_box_row_class_init (GtkListBoxRowClass *klass)
klass->activate = gtk_list_box_row_activate; klass->activate = gtk_list_box_row_activate;
/**
* GtkListBoxRow::activate:
*
* This is a keybinding signal, which will cause this row to be activated.
*
* If you want to be notified when the user activates a row (by key or not),
* use the #GtkListBox::row-activated signal on the rows parent #GtkListBox.
*/
row_signals[ROW__ACTIVATE] = row_signals[ROW__ACTIVATE] =
g_signal_new (I_("activate"), g_signal_new (I_("activate"),
G_OBJECT_CLASS_TYPE (object_class), G_OBJECT_CLASS_TYPE (object_class),