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_UI_MANAGER_H__
30 #define __GTK_UI_MANAGER_H__
32 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
33 #error "Only <gtk/gtk.h> can be included directly."
36 #include <gtk/gtkaccelgroup.h>
37 #include <gtk/gtkwidget.h>
38 #include <gtk/gtkaction.h>
39 #include <gtk/gtkactiongroup.h>
43 #define GTK_TYPE_UI_MANAGER (gtk_ui_manager_get_type ())
44 #define GTK_UI_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_UI_MANAGER, GtkUIManager))
45 #define GTK_UI_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_UI_MANAGER, GtkUIManagerClass))
46 #define GTK_IS_UI_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_UI_MANAGER))
47 #define GTK_IS_UI_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_UI_MANAGER))
48 #define GTK_UI_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_UI_MANAGER, GtkUIManagerClass))
50 typedef struct _GtkUIManager GtkUIManager;
51 typedef struct _GtkUIManagerClass GtkUIManagerClass;
52 typedef struct _GtkUIManagerPrivate GtkUIManagerPrivate;
55 struct _GtkUIManager {
59 GtkUIManagerPrivate *private_data;
62 struct _GtkUIManagerClass {
63 GObjectClass parent_class;
66 void (* add_widget) (GtkUIManager *manager,
68 void (* actions_changed) (GtkUIManager *manager);
69 void (* connect_proxy) (GtkUIManager *manager,
72 void (* disconnect_proxy) (GtkUIManager *manager,
75 void (* pre_activate) (GtkUIManager *manager,
77 void (* post_activate) (GtkUIManager *manager,
80 /* Virtual functions */
81 GtkWidget * (* get_widget) (GtkUIManager *manager,
83 GtkAction * (* get_action) (GtkUIManager *manager,
86 /* Padding for future expansion */
87 void (*_gtk_reserved1) (void);
88 void (*_gtk_reserved2) (void);
89 void (*_gtk_reserved3) (void);
90 void (*_gtk_reserved4) (void);
94 * GtkUIManagerItemType:
95 * @GTK_UI_MANAGER_AUTO: Pick the type of the UI element according to context.
96 * @GTK_UI_MANAGER_MENUBAR: Create a menubar.
97 * @GTK_UI_MANAGER_MENU: Create a menu.
98 * @GTK_UI_MANAGER_TOOLBAR: Create a toolbar.
99 * @GTK_UI_MANAGER_PLACEHOLDER: Insert a placeholder.
100 * @GTK_UI_MANAGER_POPUP: Create a popup menu.
101 * @GTK_UI_MANAGER_MENUITEM: Create a menuitem.
102 * @GTK_UI_MANAGER_TOOLITEM: Create a toolitem.
103 * @GTK_UI_MANAGER_SEPARATOR: Create a separator.
104 * @GTK_UI_MANAGER_ACCELERATOR: Install an accelerator.
105 * @GTK_UI_MANAGER_POPUP_WITH_ACCELS: Same as %GTK_UI_MANAGER_POPUP, but the
106 * actions' accelerators are shown.
108 * These enumeration values are used by gtk_ui_manager_add_ui() to determine
109 * what UI element to create.
112 GTK_UI_MANAGER_AUTO = 0,
113 GTK_UI_MANAGER_MENUBAR = 1 << 0,
114 GTK_UI_MANAGER_MENU = 1 << 1,
115 GTK_UI_MANAGER_TOOLBAR = 1 << 2,
116 GTK_UI_MANAGER_PLACEHOLDER = 1 << 3,
117 GTK_UI_MANAGER_POPUP = 1 << 4,
118 GTK_UI_MANAGER_MENUITEM = 1 << 5,
119 GTK_UI_MANAGER_TOOLITEM = 1 << 6,
120 GTK_UI_MANAGER_SEPARATOR = 1 << 7,
121 GTK_UI_MANAGER_ACCELERATOR = 1 << 8,
122 GTK_UI_MANAGER_POPUP_WITH_ACCELS = 1 << 9
123 } GtkUIManagerItemType;
125 GType gtk_ui_manager_get_type (void) G_GNUC_CONST;
126 GtkUIManager *gtk_ui_manager_new (void);
127 GDK_DEPRECATED_IN_3_4
128 void gtk_ui_manager_set_add_tearoffs (GtkUIManager *manager,
129 gboolean add_tearoffs);
130 GDK_DEPRECATED_IN_3_4
131 gboolean gtk_ui_manager_get_add_tearoffs (GtkUIManager *manager);
133 void gtk_ui_manager_insert_action_group (GtkUIManager *manager,
134 GtkActionGroup *action_group,
136 void gtk_ui_manager_remove_action_group (GtkUIManager *manager,
137 GtkActionGroup *action_group);
138 GList *gtk_ui_manager_get_action_groups (GtkUIManager *manager);
139 GtkAccelGroup *gtk_ui_manager_get_accel_group (GtkUIManager *manager);
140 GtkWidget *gtk_ui_manager_get_widget (GtkUIManager *manager,
142 GSList *gtk_ui_manager_get_toplevels (GtkUIManager *manager,
143 GtkUIManagerItemType types);
144 GtkAction *gtk_ui_manager_get_action (GtkUIManager *manager,
146 guint gtk_ui_manager_add_ui_from_string (GtkUIManager *manager,
150 guint gtk_ui_manager_add_ui_from_file (GtkUIManager *manager,
151 const gchar *filename,
153 guint gtk_ui_manager_add_ui_from_resource(GtkUIManager *manager,
154 const gchar *resource_path,
156 void gtk_ui_manager_add_ui (GtkUIManager *manager,
161 GtkUIManagerItemType type,
163 void gtk_ui_manager_remove_ui (GtkUIManager *manager,
165 gchar *gtk_ui_manager_get_ui (GtkUIManager *manager);
166 void gtk_ui_manager_ensure_update (GtkUIManager *manager);
167 guint gtk_ui_manager_new_merge_id (GtkUIManager *manager);
171 #endif /* __GTK_UI_MANAGER_H__ */