diff options
| author | Javier Jardón <jjardon@gnome.org> | 2010-05-13 03:23:30 +0200 |
|---|---|---|
| committer | Javier Jardón <jjardon@gnome.org> | 2010-05-13 03:23:30 +0200 |
| commit | 8319585673632a67ec130de3a9c5c71db1da8c5c (patch) | |
| tree | 47aeb330e950217ac9578235656cfe77c0756383 /gtk/gtktoggleaction.c | |
| parent | 45434cc6994ced9f861981f22103e2e2db0abf01 (diff) | |
| download | gtk+-8319585673632a67ec130de3a9c5c71db1da8c5c.tar.gz | |
Move documentation to inline comments: GtkToggleAction
Diffstat (limited to 'gtk/gtktoggleaction.c')
| -rw-r--r-- | gtk/gtktoggleaction.c | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/gtk/gtktoggleaction.c b/gtk/gtktoggleaction.c index 6e464d72e9..5a144bb42d 100644 --- a/gtk/gtktoggleaction.c +++ b/gtk/gtktoggleaction.c @@ -39,6 +39,17 @@ #include "gtkprivate.h" #include "gtkalias.h" + +/** + * SECTION:gtktoggleaction + * @Short_description: An action which can be toggled between two states + * @Title: GtkToggleAction + * + * A #GtkToggleAction corresponds roughly to a #GtkCheckMenuItem. It has an + * "active" state specifying whether the action has been checked or not. + */ + + enum { TOGGLED, @@ -120,7 +131,13 @@ gtk_toggle_action_class_init (GtkToggleActionClass *klass) P_("If the toggle action should be active in or not"), FALSE, GTK_PARAM_READWRITE)); - + /** + * GtkToggleAction::toggled: + * @toggleaction: the object which received the signal. + * + * Should be connected if you wish to perform an action + * whenever the #GtkToggleAction state is changed. + */ action_signals[TOGGLED] = g_signal_new (I_("toggled"), G_OBJECT_CLASS_TYPE (klass), @@ -275,7 +292,7 @@ gtk_toggle_action_set_active (GtkToggleAction *action, * @action: the action object * * Returns the checked state of the toggle action. - + * * Returns: the checked state of the toggle action * * Since: 2.4 |