gtkactiongroup.h 11.2 KB
Newer Older
1
/*
Cody Russell's avatar
Cody Russell committed
2
 * GTK - The GIMP Toolkit
3 4 5 6 7 8 9 10 11 12 13 14 15 16
 * Copyright (C) 1998, 1999 Red Hat, Inc.
 * All rights reserved.
 *
 * This Library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This Library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Javier Jardón's avatar
Javier Jardón committed
17
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
18 19
 */

20
/*
21 22 23 24 25
 * Author: James Henstridge <james@daa.com.au>
 *
 * Modified by the GTK+ Team and others 2003.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
26
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27
 */
28

29 30 31
#ifndef __GTK_ACTION_GROUP_H__
#define __GTK_ACTION_GROUP_H__

32
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
33 34 35
#error "Only <gtk/gtk.h> can be included directly."
#endif

36 37
#include <gtk/deprecated/gtkaction.h>
#include <gtk/deprecated/gtkstock.h>
38

39 40
G_BEGIN_DECLS

41 42 43 44 45 46 47 48 49 50
#define GTK_TYPE_ACTION_GROUP              (gtk_action_group_get_type ())
#define GTK_ACTION_GROUP(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ACTION_GROUP, GtkActionGroup))
#define GTK_ACTION_GROUP_CLASS(vtable)     (G_TYPE_CHECK_CLASS_CAST ((vtable), GTK_TYPE_ACTION_GROUP, GtkActionGroupClass))
#define GTK_IS_ACTION_GROUP(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ACTION_GROUP))
#define GTK_IS_ACTION_GROUP_CLASS(vtable)  (G_TYPE_CHECK_CLASS_TYPE ((vtable), GTK_TYPE_ACTION_GROUP))
#define GTK_ACTION_GROUP_GET_CLASS(inst)   (G_TYPE_INSTANCE_GET_CLASS ((inst), GTK_TYPE_ACTION_GROUP, GtkActionGroupClass))

typedef struct _GtkActionGroup        GtkActionGroup;
typedef struct _GtkActionGroupPrivate GtkActionGroupPrivate;
typedef struct _GtkActionGroupClass   GtkActionGroupClass;
51
typedef struct _GtkActionEntry        GtkActionEntry;
52
typedef struct _GtkToggleActionEntry  GtkToggleActionEntry;
53
typedef struct _GtkRadioActionEntry   GtkRadioActionEntry;
54 55 56 57 58 59

struct _GtkActionGroup
{
  GObject parent;

  /*< private >*/
60
  GtkActionGroupPrivate *priv;
61 62
};

63 64 65 66 67
/**
 * GtkActionGroupClass:
 * @parent_class: The parent class.
 * @get_action: Looks up an action in the action group by name.
 */
68 69 70 71 72
struct _GtkActionGroupClass
{
  GObjectClass parent_class;

  GtkAction *(* get_action) (GtkActionGroup *action_group,
73
                             const gchar    *action_name);
74

75 76
  /*< private >*/

77 78 79 80 81 82 83
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
};

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
/**
 * GtkActionEntry:
 * @name: The name of the action.
 * @stock_id: The stock id for the action, or the name of an icon from the
 *  icon theme.
 * @label: The label for the action. This field should typically be marked
 *  for translation, see gtk_action_group_set_translation_domain(). If
 *  @label is %NULL, the label of the stock item with id @stock_id is used.
 * @accelerator: The accelerator for the action, in the format understood by
 *  gtk_accelerator_parse().
 * @tooltip: The tooltip for the action. This field should typically be
 *  marked for translation, see gtk_action_group_set_translation_domain().
 * @callback: The function to call when the action is activated.
 *
 * #GtkActionEntry structs are used with gtk_action_group_add_actions() to
 * construct actions.
100 101
 *
 * Deprecated: 3.10
102
 */
103
struct _GtkActionEntry 
104
{
105 106 107 108 109
  const gchar     *name;
  const gchar     *stock_id;
  const gchar     *label;
  const gchar     *accelerator;
  const gchar     *tooltip;
110 111
  GCallback  callback;
};
112

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
/**
 * GtkToggleActionEntry:
 * @name: The name of the action.
 * @stock_id: The stock id for the action, or the name of an icon from the
 *  icon theme.
 * @label: The label for the action. This field should typically be marked
 *  for translation, see gtk_action_group_set_translation_domain().
 * @accelerator: The accelerator for the action, in the format understood by
 *  gtk_accelerator_parse().
 * @tooltip: The tooltip for the action. This field should typically be
 *  marked for translation, see gtk_action_group_set_translation_domain().
 * @callback: The function to call when the action is activated.
 * @is_active: The initial state of the toggle action.
 *
 * #GtkToggleActionEntry structs are used with
 * gtk_action_group_add_toggle_actions() to construct toggle actions.
129 130
 *
 * Deprecated: 3.10
131
 */
132 133
struct _GtkToggleActionEntry 
{
134 135 136 137 138
  const gchar     *name;
  const gchar     *stock_id;
  const gchar     *label;
  const gchar     *accelerator;
  const gchar     *tooltip;
139 140
  GCallback  callback;
  gboolean   is_active;
141 142
};

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
/**
 * GtkRadioActionEntry:
 * @name: The name of the action.
 * @stock_id: The stock id for the action, or the name of an icon from the
 *  icon theme.
 * @label: The label for the action. This field should typically be marked
 *  for translation, see gtk_action_group_set_translation_domain().
 * @accelerator: The accelerator for the action, in the format understood by
 *  gtk_accelerator_parse().
 * @tooltip: The tooltip for the action. This field should typically be
 *  marked for translation, see gtk_action_group_set_translation_domain().
 * @value: The value to set on the radio action. See
 *  gtk_radio_action_get_current_value().
 *
 * #GtkRadioActionEntry structs are used with
 * gtk_action_group_add_radio_actions() to construct groups of radio actions.
159 160
 *
 * Deprecated: 3.10
161
 */
162 163
struct _GtkRadioActionEntry 
{
164 165 166 167 168
  const gchar *name;
  const gchar *stock_id;
  const gchar *label;
  const gchar *accelerator;
  const gchar *tooltip;
169
  gint   value; 
170 171
};

172
GDK_DEPRECATED_IN_3_10
Matthias Clasen's avatar
Matthias Clasen committed
173
GType           gtk_action_group_get_type                (void) G_GNUC_CONST;
174
GDK_DEPRECATED_IN_3_10
175
GtkActionGroup *gtk_action_group_new                     (const gchar                *name);
176
GDK_DEPRECATED_IN_3_10
177
const gchar    *gtk_action_group_get_name                (GtkActionGroup             *action_group);
178
GDK_DEPRECATED_IN_3_10
179
gboolean        gtk_action_group_get_sensitive           (GtkActionGroup             *action_group);
180
GDK_DEPRECATED_IN_3_10
181 182
void            gtk_action_group_set_sensitive           (GtkActionGroup             *action_group,
							  gboolean                    sensitive);
183
GDK_DEPRECATED_IN_3_10
184
gboolean        gtk_action_group_get_visible             (GtkActionGroup             *action_group);
185
GDK_DEPRECATED_IN_3_10
186 187
void            gtk_action_group_set_visible             (GtkActionGroup             *action_group,
							  gboolean                    visible);
188
GDK_DEPRECATED_IN_3_10
189
GtkAccelGroup  *gtk_action_group_get_accel_group         (GtkActionGroup             *action_group);
190
GDK_DEPRECATED_IN_3_10
191 192 193
void            gtk_action_group_set_accel_group         (GtkActionGroup             *action_group,
                                                          GtkAccelGroup              *accel_group);

194
GDK_DEPRECATED_IN_3_10
195 196
GtkAction      *gtk_action_group_get_action              (GtkActionGroup             *action_group,
							  const gchar                *action_name);
197
GDK_DEPRECATED_IN_3_10
198
GList          *gtk_action_group_list_actions            (GtkActionGroup             *action_group);
199
GDK_DEPRECATED_IN_3_10
200 201
void            gtk_action_group_add_action              (GtkActionGroup             *action_group,
							  GtkAction                  *action);
202
GDK_DEPRECATED_IN_3_10
203 204 205
void            gtk_action_group_add_action_with_accel   (GtkActionGroup             *action_group,
							  GtkAction                  *action,
							  const gchar                *accelerator);
206
GDK_DEPRECATED_IN_3_10
207 208
void            gtk_action_group_remove_action           (GtkActionGroup             *action_group,
							  GtkAction                  *action);
209
GDK_DEPRECATED_IN_3_10
210 211 212 213
void            gtk_action_group_add_actions             (GtkActionGroup             *action_group,
							  const GtkActionEntry       *entries,
							  guint                       n_entries,
							  gpointer                    user_data);
214
GDK_DEPRECATED_IN_3_10
215 216 217 218
void            gtk_action_group_add_toggle_actions      (GtkActionGroup             *action_group,
							  const GtkToggleActionEntry *entries,
							  guint                       n_entries,
							  gpointer                    user_data);
219
GDK_DEPRECATED_IN_3_10
220 221 222 223 224 225
void            gtk_action_group_add_radio_actions       (GtkActionGroup             *action_group,
							  const GtkRadioActionEntry  *entries,
							  guint                       n_entries,
							  gint                        value,
							  GCallback                   on_change,
							  gpointer                    user_data);
226
GDK_DEPRECATED_IN_3_10
227 228 229 230 231
void            gtk_action_group_add_actions_full        (GtkActionGroup             *action_group,
							  const GtkActionEntry       *entries,
							  guint                       n_entries,
							  gpointer                    user_data,
							  GDestroyNotify              destroy);
232
GDK_DEPRECATED_IN_3_10
233 234 235 236 237
void            gtk_action_group_add_toggle_actions_full (GtkActionGroup             *action_group,
							  const GtkToggleActionEntry *entries,
							  guint                       n_entries,
							  gpointer                    user_data,
							  GDestroyNotify              destroy);
238
GDK_DEPRECATED_IN_3_10
239 240 241 242 243 244 245
void            gtk_action_group_add_radio_actions_full  (GtkActionGroup             *action_group,
							  const GtkRadioActionEntry  *entries,
							  guint                       n_entries,
							  gint                        value,
							  GCallback                   on_change,
							  gpointer                    user_data,
							  GDestroyNotify              destroy);
246
GDK_DEPRECATED_IN_3_10
247 248 249
void            gtk_action_group_set_translate_func      (GtkActionGroup             *action_group,
							  GtkTranslateFunc            func,
							  gpointer                    data,
250
							  GDestroyNotify              notify);
251
GDK_DEPRECATED_IN_3_10
252 253
void            gtk_action_group_set_translation_domain  (GtkActionGroup             *action_group,
							  const gchar                *domain);
254
GDK_DEPRECATED_IN_3_10
255
const gchar *   gtk_action_group_translate_string        (GtkActionGroup             *action_group,
256
  	                                                  const gchar                *string);
257 258 259 260 261 262 263 264 265 266 267 268

/* Protected for use by GtkAction */
void _gtk_action_group_emit_connect_proxy    (GtkActionGroup *action_group,
                                              GtkAction      *action,
                                              GtkWidget      *proxy);
void _gtk_action_group_emit_disconnect_proxy (GtkActionGroup *action_group,
                                              GtkAction      *action,
                                              GtkWidget      *proxy);
void _gtk_action_group_emit_pre_activate     (GtkActionGroup *action_group,
                                              GtkAction      *action);
void _gtk_action_group_emit_post_activate    (GtkActionGroup *action_group,
                                              GtkAction      *action);
269

270
G_END_DECLS
271

272
#endif  /* __GTK_ACTION_GROUP_H__ */