Update docs for GtkEntry::activate
authorMatthias Clasen <mclasen@redhat.com>
Mon, 11 Jun 2012 23:27:25 +0000 (19:27 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 11 Jun 2012 23:27:25 +0000 (19:27 -0400)
Remove the 'you shall not connect' message from this signal.
While it is a keybinding signal, using it from applications is
fine and, in fact, expected.

gtk/gtkentry.c

index 9d9f5edf1cf533187d2cfdeef83a48bb86a4fd4e..2e81fcf521ab647f83eb70f1d4ed6bd111183660 100644 (file)
@@ -1441,12 +1441,12 @@ gtk_entry_class_init (GtkEntryClass *class)
    * GtkEntry::activate:
    * @entry: The entry on which the signal is emitted
    *
-   * A  <link linkend="keybinding-signals">keybinding signal</link>
-   * which gets emitted when the user activates the entry.
-   * 
-   * Applications should not connect to it, but may emit it with
-   * g_signal_emit_by_name() if they need to control activation 
-   * programmatically.
+   * The ::activate signal is emitted when the the user hits
+   * the Enter key.
+   *
+   * While this signal is used as a <link linkend="keybinding-signals">keybinding signal</link>,
+   * it is also commonly used by applications to intercept
+   * activation of entries.
    *
    * The default bindings for this signal are all forms of the Enter key.
    */