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 the Gnome Library; see the file COPYING.LIB. If not,
18 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 * Author: James Henstridge <james@daa.com.au>
25 * Modified by the GTK+ Team and others 2003. See the AUTHORS
26 * file for a list of people on the GTK+ Team. See the ChangeLog
27 * files for a list of changes. These files are distributed with
28 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
32 #error "Only <gtk/gtk.h> can be included directly."
35 #ifndef __GTK_UI_MANAGER_H__
36 #define __GTK_UI_MANAGER_H__
38 #include <gtk/gtkaccelgroup.h>
39 #include <gtk/gtkwidget.h>
40 #include <gtk/gtkaction.h>
41 #include <gtk/gtkactiongroup.h>
45 #define GTK_TYPE_UI_MANAGER (gtk_ui_manager_get_type ())
46 #define GTK_UI_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_UI_MANAGER, GtkUIManager))
47 #define GTK_UI_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_UI_MANAGER, GtkUIManagerClass))
48 #define GTK_IS_UI_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_UI_MANAGER))
49 #define GTK_IS_UI_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_UI_MANAGER))
50 #define GTK_UI_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_UI_MANAGER, GtkUIManagerClass))
52 typedef struct _GtkUIManager GtkUIManager;
53 typedef struct _GtkUIManagerClass GtkUIManagerClass;
54 typedef struct _GtkUIManagerPrivate GtkUIManagerPrivate;
57 struct _GtkUIManager {
61 GtkUIManagerPrivate *private_data;
64 struct _GtkUIManagerClass {
65 GObjectClass parent_class;
68 void (* add_widget) (GtkUIManager *manager,
70 void (* actions_changed) (GtkUIManager *manager);
71 void (* connect_proxy) (GtkUIManager *manager,
74 void (* disconnect_proxy) (GtkUIManager *manager,
77 void (* pre_activate) (GtkUIManager *manager,
79 void (* post_activate) (GtkUIManager *manager,
82 /* Virtual functions */
83 GtkWidget * (* get_widget) (GtkUIManager *manager,
85 GtkAction * (* get_action) (GtkUIManager *manager,
88 /* Padding for future expansion */
89 void (*_gtk_reserved1) (void);
90 void (*_gtk_reserved2) (void);
91 void (*_gtk_reserved3) (void);
92 void (*_gtk_reserved4) (void);
96 * GtkUIManagerItemType:
97 * @GTK_UI_MANAGER_AUTO: Pick the type of the UI element according to context.
98 * @GTK_UI_MANAGER_MENUBAR: Create a menubar.
99 * @GTK_UI_MANAGER_MENU: Create a menu.
100 * @GTK_UI_MANAGER_TOOLBAR: Create a toolbar.
101 * @GTK_UI_MANAGER_PLACEHOLDER: Insert a placeholder.
102 * @GTK_UI_MANAGER_POPUP: Create a popup menu.
103 * @GTK_UI_MANAGER_MENUITEM: Create a menuitem.
104 * @GTK_UI_MANAGER_TOOLITEM: Create a toolitem.
105 * @GTK_UI_MANAGER_SEPARATOR: Create a separator.
106 * @GTK_UI_MANAGER_ACCELERATOR: Install an accelerator.
107 * @GTK_UI_MANAGER_POPUP_WITH_ACCELS: Same as %GTK_UI_MANAGER_POPUP, but the
108 * actions' accelerators are shown.
110 * These enumeration values are used by gtk_ui_manager_add_ui() to determine
111 * what UI element to create.
114 GTK_UI_MANAGER_AUTO = 0,
115 GTK_UI_MANAGER_MENUBAR = 1 << 0,
116 GTK_UI_MANAGER_MENU = 1 << 1,
117 GTK_UI_MANAGER_TOOLBAR = 1 << 2,
118 GTK_UI_MANAGER_PLACEHOLDER = 1 << 3,
119 GTK_UI_MANAGER_POPUP = 1 << 4,
120 GTK_UI_MANAGER_MENUITEM = 1 << 5,
121 GTK_UI_MANAGER_TOOLITEM = 1 << 6,
122 GTK_UI_MANAGER_SEPARATOR = 1 << 7,
123 GTK_UI_MANAGER_ACCELERATOR = 1 << 8,
124 GTK_UI_MANAGER_POPUP_WITH_ACCELS = 1 << 9
125 } GtkUIManagerItemType;
127 GType gtk_ui_manager_get_type (void) G_GNUC_CONST;
128 GtkUIManager *gtk_ui_manager_new (void);
130 void gtk_ui_manager_set_add_tearoffs (GtkUIManager *manager,
131 gboolean add_tearoffs);
133 gboolean gtk_ui_manager_get_add_tearoffs (GtkUIManager *manager);
135 void gtk_ui_manager_insert_action_group (GtkUIManager *manager,
136 GtkActionGroup *action_group,
138 void gtk_ui_manager_remove_action_group (GtkUIManager *manager,
139 GtkActionGroup *action_group);
140 GList *gtk_ui_manager_get_action_groups (GtkUIManager *manager);
141 GtkAccelGroup *gtk_ui_manager_get_accel_group (GtkUIManager *manager);
142 GtkWidget *gtk_ui_manager_get_widget (GtkUIManager *manager,
144 GSList *gtk_ui_manager_get_toplevels (GtkUIManager *manager,
145 GtkUIManagerItemType types);
146 GtkAction *gtk_ui_manager_get_action (GtkUIManager *manager,
148 guint gtk_ui_manager_add_ui_from_string (GtkUIManager *manager,
152 guint gtk_ui_manager_add_ui_from_file (GtkUIManager *manager,
153 const gchar *filename,
155 guint gtk_ui_manager_add_ui_from_resource(GtkUIManager *manager,
156 const gchar *resource_path,
158 void gtk_ui_manager_add_ui (GtkUIManager *manager,
163 GtkUIManagerItemType type,
165 void gtk_ui_manager_remove_ui (GtkUIManager *manager,
167 gchar *gtk_ui_manager_get_ui (GtkUIManager *manager);
168 void gtk_ui_manager_ensure_update (GtkUIManager *manager);
169 guint gtk_ui_manager_new_merge_id (GtkUIManager *manager);
173 #endif /* __GTK_UI_MANAGER_H__ */