2 * GTK - The GIMP Toolkit
3 * Copyright (C) 1998, 1999 Red Hat, Inc.
6 * This Library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public License as
8 * published by the Free Software Foundation; either version 2 of the
9 * License, or (at your option) any later version.
11 * This Library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
21 * Author: James Henstridge <james@daa.com.au>
23 * Modified by the GTK+ Team and others 2003. See the AUTHORS
24 * file for a list of people on the GTK+ Team. See the ChangeLog
25 * files for a list of changes. These files are distributed with
26 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29 #ifndef __GTK_ACTION_GROUP_H__
30 #define __GTK_ACTION_GROUP_H__
32 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
33 #error "Only <gtk/gtk.h> can be included directly."
36 #include <gtk/gtkaction.h>
37 #include <gtk/gtkstock.h>
41 #define GTK_TYPE_ACTION_GROUP (gtk_action_group_get_type ())
42 #define GTK_ACTION_GROUP(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ACTION_GROUP, GtkActionGroup))
43 #define GTK_ACTION_GROUP_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), GTK_TYPE_ACTION_GROUP, GtkActionGroupClass))
44 #define GTK_IS_ACTION_GROUP(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ACTION_GROUP))
45 #define GTK_IS_ACTION_GROUP_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), GTK_TYPE_ACTION_GROUP))
46 #define GTK_ACTION_GROUP_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), GTK_TYPE_ACTION_GROUP, GtkActionGroupClass))
48 typedef struct _GtkActionGroup GtkActionGroup;
49 typedef struct _GtkActionGroupPrivate GtkActionGroupPrivate;
50 typedef struct _GtkActionGroupClass GtkActionGroupClass;
51 typedef struct _GtkActionEntry GtkActionEntry;
52 typedef struct _GtkToggleActionEntry GtkToggleActionEntry;
53 typedef struct _GtkRadioActionEntry GtkRadioActionEntry;
55 struct _GtkActionGroup
60 GtkActionGroupPrivate *priv;
63 struct _GtkActionGroupClass
65 GObjectClass parent_class;
67 GtkAction *(* get_action) (GtkActionGroup *action_group,
68 const gchar *action_name);
70 /* Padding for future expansion */
71 void (*_gtk_reserved1) (void);
72 void (*_gtk_reserved2) (void);
73 void (*_gtk_reserved3) (void);
74 void (*_gtk_reserved4) (void);
79 * @name: The name of the action.
80 * @stock_id: The stock id for the action, or the name of an icon from the
82 * @label: The label for the action. This field should typically be marked
83 * for translation, see gtk_action_group_set_translation_domain(). If
84 * @label is %NULL, the label of the stock item with id @stock_id is used.
85 * @accelerator: The accelerator for the action, in the format understood by
86 * gtk_accelerator_parse().
87 * @tooltip: The tooltip for the action. This field should typically be
88 * marked for translation, see gtk_action_group_set_translation_domain().
89 * @callback: The function to call when the action is activated.
91 * #GtkActionEntry structs are used with gtk_action_group_add_actions() to
94 struct _GtkActionEntry
97 const gchar *stock_id;
99 const gchar *accelerator;
100 const gchar *tooltip;
105 * GtkToggleActionEntry:
106 * @name: The name of the action.
107 * @stock_id: The stock id for the action, or the name of an icon from the
109 * @label: The label for the action. This field should typically be marked
110 * for translation, see gtk_action_group_set_translation_domain().
111 * @accelerator: The accelerator for the action, in the format understood by
112 * gtk_accelerator_parse().
113 * @tooltip: The tooltip for the action. This field should typically be
114 * marked for translation, see gtk_action_group_set_translation_domain().
115 * @callback: The function to call when the action is activated.
116 * @is_active: The initial state of the toggle action.
118 * #GtkToggleActionEntry structs are used with
119 * gtk_action_group_add_toggle_actions() to construct toggle actions.
121 struct _GtkToggleActionEntry
124 const gchar *stock_id;
126 const gchar *accelerator;
127 const gchar *tooltip;
133 * GtkRadioActionEntry:
134 * @name: The name of the action.
135 * @stock_id: The stock id for the action, or the name of an icon from the
137 * @label: The label for the action. This field should typically be marked
138 * for translation, see gtk_action_group_set_translation_domain().
139 * @accelerator: The accelerator for the action, in the format understood by
140 * gtk_accelerator_parse().
141 * @tooltip: The tooltip for the action. This field should typically be
142 * marked for translation, see gtk_action_group_set_translation_domain().
143 * @value: The value to set on the radio action. See
144 * gtk_radio_action_get_current_value().
146 * #GtkRadioActionEntry structs are used with
147 * gtk_action_group_add_radio_actions() to construct groups of radio actions.
149 struct _GtkRadioActionEntry
152 const gchar *stock_id;
154 const gchar *accelerator;
155 const gchar *tooltip;
159 GType gtk_action_group_get_type (void) G_GNUC_CONST;
160 GtkActionGroup *gtk_action_group_new (const gchar *name);
161 const gchar *gtk_action_group_get_name (GtkActionGroup *action_group);
162 gboolean gtk_action_group_get_sensitive (GtkActionGroup *action_group);
163 void gtk_action_group_set_sensitive (GtkActionGroup *action_group,
165 gboolean gtk_action_group_get_visible (GtkActionGroup *action_group);
166 void gtk_action_group_set_visible (GtkActionGroup *action_group,
169 GtkAccelGroup *gtk_action_group_get_accel_group (GtkActionGroup *action_group);
171 void gtk_action_group_set_accel_group (GtkActionGroup *action_group,
172 GtkAccelGroup *accel_group);
174 GtkAction *gtk_action_group_get_action (GtkActionGroup *action_group,
175 const gchar *action_name);
176 GList *gtk_action_group_list_actions (GtkActionGroup *action_group);
177 void gtk_action_group_add_action (GtkActionGroup *action_group,
179 void gtk_action_group_add_action_with_accel (GtkActionGroup *action_group,
181 const gchar *accelerator);
182 void gtk_action_group_remove_action (GtkActionGroup *action_group,
184 void gtk_action_group_add_actions (GtkActionGroup *action_group,
185 const GtkActionEntry *entries,
188 void gtk_action_group_add_toggle_actions (GtkActionGroup *action_group,
189 const GtkToggleActionEntry *entries,
192 void gtk_action_group_add_radio_actions (GtkActionGroup *action_group,
193 const GtkRadioActionEntry *entries,
198 void gtk_action_group_add_actions_full (GtkActionGroup *action_group,
199 const GtkActionEntry *entries,
202 GDestroyNotify destroy);
203 void gtk_action_group_add_toggle_actions_full (GtkActionGroup *action_group,
204 const GtkToggleActionEntry *entries,
207 GDestroyNotify destroy);
208 void gtk_action_group_add_radio_actions_full (GtkActionGroup *action_group,
209 const GtkRadioActionEntry *entries,
214 GDestroyNotify destroy);
215 void gtk_action_group_set_translate_func (GtkActionGroup *action_group,
216 GtkTranslateFunc func,
218 GDestroyNotify notify);
219 void gtk_action_group_set_translation_domain (GtkActionGroup *action_group,
220 const gchar *domain);
221 const gchar * gtk_action_group_translate_string (GtkActionGroup *action_group,
222 const gchar *string);
224 /* Protected for use by GtkAction */
225 void _gtk_action_group_emit_connect_proxy (GtkActionGroup *action_group,
228 void _gtk_action_group_emit_disconnect_proxy (GtkActionGroup *action_group,
231 void _gtk_action_group_emit_pre_activate (GtkActionGroup *action_group,
233 void _gtk_action_group_emit_post_activate (GtkActionGroup *action_group,
238 #endif /* __GTK_ACTION_GROUP_H__ */