[gtk/matthiasc/for-master: 8/8] docs: Document various entry ::activate signals




commit 5be5f42c329b444485f1023c4604f5ccd758819e
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Sep 28 22:52:35 2020 -0400

    docs: Document various entry ::activate signals

 gtk/gtkentry.c         | 8 ++++++++
 gtk/gtkpasswordentry.c | 8 ++++++++
 gtk/gtksearchentry.c   | 8 ++++++++
 gtk/gtktext.c          | 2 +-
 4 files changed, 25 insertions(+), 1 deletion(-)
---
diff --git a/gtk/gtkentry.c b/gtk/gtkentry.c
index 4c41a3e34e..3d058bad27 100644
--- a/gtk/gtkentry.c
+++ b/gtk/gtkentry.c
@@ -941,6 +941,14 @@ gtk_entry_class_init (GtkEntryClass *class)
   g_object_class_override_property (gobject_class, PROP_EDITING_CANCELED, "editing-canceled");
   gtk_editable_install_properties (gobject_class, PROP_EDITING_CANCELED + 1);
 
+  /**
+   * GtkEntry:activate:
+   * @self: The widget on which the signal is emitted
+   *
+   * The ::activate signal is forwarded from the
+   * #GtkText::activated signal, which is a keybinding
+   * signal for all forms of the Enter key.
+   */
   signals[ACTIVATE] =
     g_signal_new (I_("activate"),
                   G_OBJECT_CLASS_TYPE (gobject_class),
diff --git a/gtk/gtkpasswordentry.c b/gtk/gtkpasswordentry.c
index 216ae2d915..ec8d08b119 100644
--- a/gtk/gtkpasswordentry.c
+++ b/gtk/gtkpasswordentry.c
@@ -452,6 +452,14 @@ gtk_password_entry_class_init (GtkPasswordEntryClass *klass)
   g_object_class_install_properties (object_class, NUM_PROPERTIES, props);
   gtk_editable_install_properties (object_class, NUM_PROPERTIES);
 
+  /**
+   * GtkPasswordEntry:activate:
+   * @self: The widget on which the signal is emitted
+   *
+   * The ::activate signal is forwarded from the
+   * #GtkText::activated signal, which is a keybinding
+   * signal for all forms of the Enter key.
+   */
   signals[ACTIVATE] =
     g_signal_new (I_("activate"),
                   G_OBJECT_CLASS_TYPE (object_class),
diff --git a/gtk/gtksearchentry.c b/gtk/gtksearchentry.c
index 80304901b6..4960c98941 100644
--- a/gtk/gtksearchentry.c
+++ b/gtk/gtksearchentry.c
@@ -295,6 +295,14 @@ gtk_search_entry_class_init (GtkSearchEntryClass *klass)
   g_object_class_install_properties (object_class, NUM_PROPERTIES, props);
   gtk_editable_install_properties (object_class, NUM_PROPERTIES);
 
+  /**
+   * GtkSearchEntry:activate:
+   * @self: The widget on which the signal is emitted
+   *
+   * The ::activate signal is forwarded from the
+   * #GtkText::activated signal, which is a keybinding
+   * signal for all forms of the Enter key.
+   */
   signals[ACTIVATE] =
     g_signal_new (I_("activate"),
                   G_OBJECT_CLASS_TYPE (object_class),
diff --git a/gtk/gtktext.c b/gtk/gtktext.c
index 2d13cd245b..da11cffe9b 100644
--- a/gtk/gtktext.c
+++ b/gtk/gtktext.c
@@ -949,7 +949,7 @@ gtk_text_class_init (GtkTextClass *class)
   
   /**
    * GtkText::activate:
-   * @self: The self on which the signal is emitted
+   * @self: The widget on which the signal is emitted
    *
    * The ::activate signal is emitted when the user hits
    * the Enter key.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]