Document signals. (#163319, Murray Cumming)

2005-01-10  Matthias Clasen  <mclasen@redhat.com>

	* gtk/gtkaccelgroup.c (gtk_accel_group_class_init): Document
	signals.  (#163319, Murray Cumming)

diff --git a/ChangeLog b/ChangeLog
index d0dd954630298a192edfc5343978daae23d825d3..ba3a18068a09fe9dd5b5ea4c5760469caff8bb89 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2005-01-10  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_class_init): Document
+       signals.  (#163319, Murray Cumming)
+
 2005-01-09  Tor Lillqvist  <tlillqvist@novell.com>
 
        * gdk/win32/gdkwindow-win32.c (gdk_window_set_cursor): Set current

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index d0dd954630298a192edfc5343978daae23d825d3..ba3a18068a09fe9dd5b5ea4c5760469caff8bb89 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,8 @@
+2005-01-10  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_class_init): Document
+       signals.  (#163319, Murray Cumming)
+
 2005-01-09  Tor Lillqvist  <tlillqvist@novell.com>
 
        * gdk/win32/gdkwindow-win32.c (gdk_window_set_cursor): Set current

diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index d0dd954630298a192edfc5343978daae23d825d3..ba3a18068a09fe9dd5b5ea4c5760469caff8bb89 100644 (file)
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,3 +1,8 @@
+2005-01-10  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_class_init): Document
+       signals.  (#163319, Murray Cumming)
+
 2005-01-09  Tor Lillqvist  <tlillqvist@novell.com>
 
        * gdk/win32/gdkwindow-win32.c (gdk_window_set_cursor): Set current

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index d0dd954630298a192edfc5343978daae23d825d3..ba3a18068a09fe9dd5b5ea4c5760469caff8bb89 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,8 @@
+2005-01-10  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_class_init): Document
+       signals.  (#163319, Murray Cumming)
+
 2005-01-09  Tor Lillqvist  <tlillqvist@novell.com>
 
        * gdk/win32/gdkwindow-win32.c (gdk_window_set_cursor): Set current

diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c
index 038d73179ebaf458862336ad03f672d83f0d639b..49c5e29c3b437b3311ced9cddc06de95f5b89843 100644 (file)
--- a/gtk/gtkaccelgroup.c
+++ b/gtk/gtkaccelgroup.c
@@ -97,6 +97,19 @@ gtk_accel_group_class_init (GtkAccelGroupClass *class)
   object_class->finalize = gtk_accel_group_finalize;
 
   class->accel_changed = NULL;
+
+  /**
+   * GtkAccelGroup::accel-activate:
+   * @accel_group: the #GtkAccelGroup which received the signal
+   * @acceleratable: the object on which the accelerator was activated
+   * @keyval: the accelerator keyval
+   * @modifier: the modifier combination of the accelerator
+   *
+   * The accel-activate signal is an implementation detail of
+   * #GtkAccelGroup and not meant to be used by applications.
+   * 
+   * Returns: %TRUE if the accelerator was activated
+   */
   signal_accel_activate =
     g_signal_new ("accel_activate",
                  G_OBJECT_CLASS_TYPE (class),
@@ -108,6 +121,20 @@ gtk_accel_group_class_init (GtkAccelGroupClass *class)
                  G_TYPE_OBJECT,
                  G_TYPE_UINT,
                  GDK_TYPE_MODIFIER_TYPE);
+  /**
+   * GtkAccelGroup::accel-changed:
+   * @accel_group: the #GtkAccelGroup which received the signal
+   * @keyval: the accelerator keyval
+   * @modifier: the modifier combination of the accelerator
+   * @accel_closure: the #GClosure of the accelerator
+   *
+   * The accel-changed signal is emitted when a #GtkAccelGroupEntry
+   * is added to or removed from the accel group. 
+   *
+   * Widgets like #GtkAccelLabel which display an associated 
+   * accelerator should connect to this signal, and rebuild 
+   * their visual representation if the @accel_closure is theirs.
+   */
   signal_accel_changed =
     g_signal_new ("accel_changed",
                  G_OBJECT_CLASS_TYPE (class),