gtk2/gtk/gtkuimanager.h

172 lines
6.9 KiB
C
Raw Normal View History

2003-08-25 23:13:47 +00:00
/*
* GTK - The GIMP Toolkit
2003-08-25 23:13:47 +00:00
* 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
2012-02-27 13:01:10 +00:00
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
2003-08-25 23:13:47 +00:00
*/
/*
* 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
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
2003-08-25 23:13:47 +00:00
*/
#ifndef __GTK_UI_MANAGER_H__
#define __GTK_UI_MANAGER_H__
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
2003-08-25 23:13:47 +00:00
#include <gtk/gtkaccelgroup.h>
#include <gtk/gtkwidget.h>
#include <gtk/gtkaction.h>
#include <gtk/gtkactiongroup.h>
G_BEGIN_DECLS
2003-08-25 23:13:47 +00:00
#define GTK_TYPE_UI_MANAGER (gtk_ui_manager_get_type ())
#define GTK_UI_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_UI_MANAGER, GtkUIManager))
2003-08-25 23:13:47 +00:00
#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))
#define GTK_IS_UI_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_UI_MANAGER))
2003-08-25 23:13:47 +00:00
#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 >*/
2010-07-13 20:44:53 +00:00
GtkUIManagerPrivate *private_data;
2003-08-25 23:13:47 +00:00
};
struct _GtkUIManagerClass {
GObjectClass parent_class;
/* Signals */
2010-09-21 04:18:11 +00:00
void (* add_widget) (GtkUIManager *manager,
GtkWidget *widget);
2010-09-21 04:18:11 +00:00
void (* actions_changed) (GtkUIManager *manager);
void (* connect_proxy) (GtkUIManager *manager,
GtkAction *action,
GtkWidget *proxy);
2010-09-21 04:18:11 +00:00
void (* disconnect_proxy) (GtkUIManager *manager,
GtkAction *action,
GtkWidget *proxy);
2010-09-21 04:18:11 +00:00
void (* pre_activate) (GtkUIManager *manager,
GtkAction *action);
2010-09-21 04:18:11 +00:00
void (* post_activate) (GtkUIManager *manager,
GtkAction *action);
2003-08-25 23:13:47 +00:00
/* Virtual functions */
GtkWidget * (* get_widget) (GtkUIManager *manager,
const gchar *path);
GtkAction * (* get_action) (GtkUIManager *manager,
const gchar *path);
2003-08-25 23:13:47 +00:00
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
2010-10-19 17:07:36 +00:00
void (*_gtk_reserved3) (void);
void (*_gtk_reserved4) (void);
2003-08-25 23:13:47 +00:00
};
/**
* 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.
*/
typedef enum {
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
} GtkUIManagerItemType;
Mark as const. 2004-11-23 Matthias Clasen <mclasen@redhat.com> * gtk/gtkuimanager.h (gtk_ui_manager_get_type): * gtk/gtktreeview.h (gtk_tree_view_get_type): * gtk/gtktreeviewcolumn.h (gtk_tree_view_column_get_type): * gtk/gtktreestore.h (gtk_tree_store_get_type): * gtk/gtktreeselection.h (gtk_tree_selection_get_type): * gtk/gtktreemodelfilter.h (gtk_tree_model_filter_get_type): * gtk/gtktreemodel.h (gtk_tree_iter_get_type): (gtk_tree_path_get_type): (gtk_tree_row_reference_get_type): * gtk/gtktoolitem.h (gtk_tool_item_get_type): * gtk/gtktoolbutton.h (gtk_tool_button_get_type): * gtk/gtktoggleaction.h (gtk_toggle_action_get_type): * gtk/gtkthemes.h (gtk_theme_engine_get_type): * gtk/gtktextiter.h (gtk_text_iter_get_type): * gtk/gtksettings.h (gtk_settings_get_type): * gtk/gtkselection.h (gtk_selection_data_get_type): * gtk/gtkradioaction.h (gtk_radio_action_get_type): * gtk/gtkmenutoolbutton.h (gtk_menu_tool_button_get_type): * gtk/gtkliststore.h (gtk_list_store_get_type): * gtk/gtkiconview.h (gtk_icon_view_get_type): * gtk/gtkicontheme.h (gtk_icon_info_get_type): * gtk/gtkiconfactory.h (gtk_icon_factory_get_type): (gtk_icon_set_get_type): (gtk_icon_source_get_type): * gtk/gtkfilesystemwin32.h (gtk_file_system_win32_get_type): * gtk/gtkfilesystemunix.h (gtk_file_system_unix_get_type): * gtk/gtkfilesystem.h (gtk_file_folder_get_type): (gtk_file_info_get_type, gtk_file_path_get_type): (gtk_file_system_get_type): * gtk/gtkfilefilter.h (gtk_file_filter_get_type): * gtk/gtkfilechooserwidget.h (gtk_file_chooser_widget_get_type): * gtk/gtkfilechooser.h (gtk_file_chooser_get_type): * gtk/gtkfilechooserdialog.h (gtk_file_chooser_dialog_get_type): * gtk/gtkexpander.h (gtk_expander_get_type): * gtk/gtkentrycompletion.h (gtk_entry_completion_get_type): * gtk/gtkcombobox.h (gtk_combo_box_get_type): * gtk/gtkcomboboxentry.h (gtk_combo_box_entry_get_type): * gtk/gtkclipboard.h (gtk_clipboard_get_type): * gtk/gtkcellview.h (gtk_cell_view_get_type): * gtk/gtkcellrenderertoggle.h (gtk_cell_renderer_toggle_get_type): * gtk/gtkcellrenderertext.h (gtk_cell_renderer_text_get_type): * gtk/gtkcellrendererprogress.h (gtk_cell_renderer_progress_get_type): * gtk/gtkcellrendererpixbuf.h (gtk_cell_renderer_pixbuf_get_type): * gtk/gtkcellrenderercombo.h (gtk_cell_renderer_combo_get_type): * gtk/gtkcelllayout.h (gtk_cell_layout_get_type): * gtk/gtkactiongroup.h (gtk_action_group_get_type): * gtk/gtkaction.h (gtk_action_get_type): * gtk/gtkaccessible.h (gtk_accessible_get_type): * gtk/gtkaccelmap.h (gtk_accel_map_get_type): * gtk/gtkaccelgroup.h (gtk_accel_group_get_type): * gtk/gtkmessagedialog.h (gtk_message_dialog_get_type): Mark as const. * gtk/gtkicontheme.h: Don't mark gtk_icon_theme_error_quark() as const, to be consistent with all the other error_quark functions. (technically they are const, but since these are called only in error paths, giving the compiler better optimization opportunities doesn't matter much) * gtk/gtk.symbols: * gdk/gdk.symbols: Add attribute annotations. * gtk/makegtkalias.pl: * gdk/makegdkalias.pl: Keep attribute annotations, but strip PRIVATE. * gtk/Makefile.am (gtk.def): * gdk/Makefile.am (gdk.def): Strip attribute annotations, but keep PRIVATE.
2004-11-23 20:02:15 +00:00
GType gtk_ui_manager_get_type (void) G_GNUC_CONST;
2003-08-25 23:13:47 +00:00
GtkUIManager *gtk_ui_manager_new (void);
GDK_DEPRECATED_IN_3_4
2010-09-21 04:18:11 +00:00
void gtk_ui_manager_set_add_tearoffs (GtkUIManager *manager,
gboolean add_tearoffs);
GDK_DEPRECATED_IN_3_4
2010-09-21 04:18:11 +00:00
gboolean gtk_ui_manager_get_add_tearoffs (GtkUIManager *manager);
2010-09-21 04:18:11 +00:00
void gtk_ui_manager_insert_action_group (GtkUIManager *manager,
GtkActionGroup *action_group,
gint pos);
2010-09-21 04:18:11 +00:00
void gtk_ui_manager_remove_action_group (GtkUIManager *manager,
GtkActionGroup *action_group);
2010-09-21 04:18:11 +00:00
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,
const gchar *path);
2010-09-21 04:18:11 +00:00
GSList *gtk_ui_manager_get_toplevels (GtkUIManager *manager,
GtkUIManagerItemType types);
2010-09-21 04:18:11 +00:00
GtkAction *gtk_ui_manager_get_action (GtkUIManager *manager,
const gchar *path);
2010-09-21 04:18:11 +00:00
guint gtk_ui_manager_add_ui_from_string (GtkUIManager *manager,
const gchar *buffer,
gssize length,
GError **error);
2010-09-21 04:18:11 +00:00
guint gtk_ui_manager_add_ui_from_file (GtkUIManager *manager,
const gchar *filename,
GError **error);
guint gtk_ui_manager_add_ui_from_resource(GtkUIManager *manager,
const gchar *resource_path,
GError **error);
2010-09-21 04:18:11 +00:00
void gtk_ui_manager_add_ui (GtkUIManager *manager,
guint merge_id,
const gchar *path,
const gchar *name,
const gchar *action,
GtkUIManagerItemType type,
gboolean top);
2010-09-21 04:18:11 +00:00
void gtk_ui_manager_remove_ui (GtkUIManager *manager,
guint merge_id);
2010-09-21 04:18:11 +00:00
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);
G_END_DECLS
2003-08-25 23:13:47 +00:00
#endif /* __GTK_UI_MANAGER_H__ */