gtkuimanager.h 6.87 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 17 18 19 20 21 22 23 24 25 26 27
 * 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
 * License along with the Gnome Library; see the file COPYING.LIB.  If not,
 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * 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
28
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29
 */
30

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

35 36 37 38 39 40 41 42
#ifndef __GTK_UI_MANAGER_H__
#define __GTK_UI_MANAGER_H__

#include <gtk/gtkaccelgroup.h>
#include <gtk/gtkwidget.h>
#include <gtk/gtkaction.h>
#include <gtk/gtkactiongroup.h>

43 44
G_BEGIN_DECLS

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 48
#define GTK_UI_MANAGER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_UI_MANAGER, GtkUIManagerClass))
#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 51 52 53 54 55 56 57 58 59 60
#define GTK_UI_MANAGER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_UI_MANAGER, GtkUIManagerClass))

typedef struct _GtkUIManager      GtkUIManager;
typedef struct _GtkUIManagerClass GtkUIManagerClass;
typedef struct _GtkUIManagerPrivate GtkUIManagerPrivate;


struct _GtkUIManager {
  GObject parent;

  /*< private >*/
61
  GtkUIManagerPrivate *private_data;
62 63 64 65 66
};

struct _GtkUIManagerClass {
  GObjectClass parent_class;

67
  /* Signals */
68
  void (* add_widget)       (GtkUIManager *manager,
69
                             GtkWidget    *widget);
70 71
  void (* actions_changed)  (GtkUIManager *manager);
  void (* connect_proxy)    (GtkUIManager *manager,
72 73
			     GtkAction    *action,
			     GtkWidget    *proxy);
74
  void (* disconnect_proxy) (GtkUIManager *manager,
75 76
			     GtkAction    *action,
			     GtkWidget    *proxy);
77
  void (* pre_activate)     (GtkUIManager *manager,
78
			     GtkAction    *action);
79
  void (* post_activate)    (GtkUIManager *manager,
80
			     GtkAction    *action);
81

82 83 84 85 86 87
  /* Virtual functions */
  GtkWidget * (* get_widget) (GtkUIManager *manager,
                              const gchar  *path);
  GtkAction * (* get_action) (GtkUIManager *manager,
                              const gchar  *path);

88 89 90
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
91 92
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
93 94
};

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
/**
 * GtkUIManagerItemType:
 * @GTK_UI_MANAGER_AUTO: Pick the type of the UI element according to context.
 * @GTK_UI_MANAGER_MENUBAR: Create a menubar.
 * @GTK_UI_MANAGER_MENU: Create a menu.
 * @GTK_UI_MANAGER_TOOLBAR: Create a toolbar.
 * @GTK_UI_MANAGER_PLACEHOLDER: Insert a placeholder.
 * @GTK_UI_MANAGER_POPUP: Create a popup menu.
 * @GTK_UI_MANAGER_MENUITEM: Create a menuitem.
 * @GTK_UI_MANAGER_TOOLITEM: Create a toolitem.
 * @GTK_UI_MANAGER_SEPARATOR: Create a separator.
 * @GTK_UI_MANAGER_ACCELERATOR: Install an accelerator.
 * @GTK_UI_MANAGER_POPUP_WITH_ACCELS: Same as %GTK_UI_MANAGER_POPUP, but the
 *   actions' accelerators are shown.
 *
 * These enumeration values are used by gtk_ui_manager_add_ui() to determine
 * what UI element to create.
 */
113
typedef enum {
114 115 116 117 118 119 120 121 122 123 124
  GTK_UI_MANAGER_AUTO              = 0,
  GTK_UI_MANAGER_MENUBAR           = 1 << 0,
  GTK_UI_MANAGER_MENU              = 1 << 1,
  GTK_UI_MANAGER_TOOLBAR           = 1 << 2,
  GTK_UI_MANAGER_PLACEHOLDER       = 1 << 3,
  GTK_UI_MANAGER_POPUP             = 1 << 4,
  GTK_UI_MANAGER_MENUITEM          = 1 << 5,
  GTK_UI_MANAGER_TOOLITEM          = 1 << 6,
  GTK_UI_MANAGER_SEPARATOR         = 1 << 7,
  GTK_UI_MANAGER_ACCELERATOR       = 1 << 8,
  GTK_UI_MANAGER_POPUP_WITH_ACCELS = 1 << 9
125 126
} GtkUIManagerItemType;

Matthias Clasen's avatar
Matthias Clasen committed
127
GType          gtk_ui_manager_get_type            (void) G_GNUC_CONST;
128
GtkUIManager  *gtk_ui_manager_new                 (void);
129
GDK_DEPRECATED
130
void           gtk_ui_manager_set_add_tearoffs    (GtkUIManager          *manager,
131 132
                                                   gboolean               add_tearoffs);
GDK_DEPRECATED
133
gboolean       gtk_ui_manager_get_add_tearoffs    (GtkUIManager          *manager);
134

135
void           gtk_ui_manager_insert_action_group (GtkUIManager          *manager,
136 137
						   GtkActionGroup        *action_group,
						   gint                   pos);
138
void           gtk_ui_manager_remove_action_group (GtkUIManager          *manager,
139
						   GtkActionGroup        *action_group);
140 141 142
GList         *gtk_ui_manager_get_action_groups   (GtkUIManager          *manager);
GtkAccelGroup *gtk_ui_manager_get_accel_group     (GtkUIManager          *manager);
GtkWidget     *gtk_ui_manager_get_widget          (GtkUIManager          *manager,
143
						   const gchar           *path);
144
GSList        *gtk_ui_manager_get_toplevels       (GtkUIManager          *manager,
145
						   GtkUIManagerItemType   types);
146
GtkAction     *gtk_ui_manager_get_action          (GtkUIManager          *manager,
147
						   const gchar           *path);
148
guint          gtk_ui_manager_add_ui_from_string  (GtkUIManager          *manager,
149 150 151
						   const gchar           *buffer,
						   gssize                 length,
						   GError               **error);
152
guint          gtk_ui_manager_add_ui_from_file    (GtkUIManager          *manager,
153 154
						   const gchar           *filename,
						   GError               **error);
155
void           gtk_ui_manager_add_ui              (GtkUIManager          *manager,
156 157 158 159 160 161
						   guint                  merge_id,
						   const gchar           *path,
						   const gchar           *name,
						   const gchar           *action,
						   GtkUIManagerItemType   type,
						   gboolean               top);
162
void           gtk_ui_manager_remove_ui           (GtkUIManager          *manager,
163
						   guint                  merge_id);
164 165 166
gchar         *gtk_ui_manager_get_ui              (GtkUIManager          *manager);
void           gtk_ui_manager_ensure_update       (GtkUIManager          *manager);
guint          gtk_ui_manager_new_merge_id        (GtkUIManager          *manager);
167

168
G_END_DECLS
169

170
#endif /* __GTK_UI_MANAGER_H__ */