gtk_ui_manager_new ()

GtkUIManager *
gtk_ui_manager_new (void);

Creates a new ui manager object.

Since: 2.4

gtk_ui_manager_set_add_tearoffs ()

void
gtk_ui_manager_set_add_tearoffs (GtkUIManager *self,
                                 gboolean add_tearoffs);

Sets the "add_tearoffs" property, which controls whether menus generated by this GtkUIManager will have tearoff menu items.

Note that this only affects regular menus. Generated popup menus never have tearoff menu items.

Since: 2.4

gtk_ui_manager_get_add_tearoffs ()

gboolean
gtk_ui_manager_get_add_tearoffs (GtkUIManager *self);

Returns whether menus generated by this GtkUIManager will have tearoff menu items.

Since: 2.4

gtk_ui_manager_insert_action_group ()

void
gtk_ui_manager_insert_action_group (GtkUIManager *self,
                                    GtkActionGroup *action_group,
                                    gint pos);

Inserts an action group into the list of action groups associated with self . Actions in earlier groups hide actions with the same name in later groups.

Since: 2.4

gtk_ui_manager_remove_action_group ()

void
gtk_ui_manager_remove_action_group (GtkUIManager *self,
                                    GtkActionGroup *action_group);

Removes an action group from the list of action groups associated with self .

Since: 2.4

gtk_ui_manager_get_action_groups ()

GList *
gtk_ui_manager_get_action_groups (GtkUIManager *self);

Returns the list of action groups associated with self .

Since: 2.4

gtk_ui_manager_get_accel_group ()

GtkAccelGroup *
gtk_ui_manager_get_accel_group (GtkUIManager *self);

Returns the GtkAccelGroup associated with self .

Since: 2.4

gtk_ui_manager_get_widget ()

GtkWidget *
gtk_ui_manager_get_widget (GtkUIManager *self,
                           const gchar *path);

Looks up a widget by following a path. The path consists of the names specified in the XML description of the UI. separated by '/'. Elements which don't have a name or action attribute in the XML (e.g. <popup>) can be addressed by their XML element name (e.g. "popup"). The root element ("/ui") can be omitted in the path.

Note that the widget found by following a path that ends in a <menu> element is the menuitem to which the menu is attached, not the menu itself.

Also note that the widgets constructed by a ui manager are not tied to the lifecycle of the ui manager. If you add the widgets returned by this function to some container or explicitly ref them, they will survive the destruction of the ui manager.

Since: 2.4

gtk_ui_manager_get_toplevels ()

GSList *
gtk_ui_manager_get_toplevels (GtkUIManager *self,
                              GtkUIManagerItemType types);

Obtains a list of all toplevel widgets of the requested types.

Since: 2.4

gtk_ui_manager_get_action ()

GtkAction *
gtk_ui_manager_get_action (GtkUIManager *self,
                           const gchar *path);

Looks up an action by following a path. See gtk_ui_manager_get_widget() for more information about paths.

Since: 2.4

gtk_ui_manager_add_ui_from_string ()

guint
gtk_ui_manager_add_ui_from_string (GtkUIManager *self,
                                   const gchar *buffer,
                                   gssize length,
                                   GError **error);

Parses a string containing a UI definition and merges it with the current contents of self . An enclosing <ui> element is added if it is missing.

Since: 2.4

gtk_ui_manager_new_merge_id ()

guint
gtk_ui_manager_new_merge_id (GtkUIManager *self);

Returns an unused merge id, suitable for use with gtk_ui_manager_add_ui().

Since: 2.4

gtk_ui_manager_add_ui ()

void
gtk_ui_manager_add_ui (GtkUIManager *self,
                       guint merge_id,
                       const gchar *path,
                       const gchar *name,
                       const gchar *action,
                       GtkUIManagerItemType type,
                       gboolean top);

Adds a UI element to the current contents of self .

If type is GTK_UI_MANAGER_AUTO, GTK+ inserts a menuitem, toolitem or separator if such an element can be inserted at the place determined by path . Otherwise type must indicate an element that can be inserted at the place determined by path .

If path points to a menuitem or toolitem, the new element will be inserted before or after this item, depending on top .

Since: 2.4

gtk_ui_manager_remove_ui ()

void
gtk_ui_manager_remove_ui (GtkUIManager *self,
                          guint merge_id);

Unmerges the part of self s content identified by merge_id .

Since: 2.4

gtk_ui_manager_get_ui ()

gchar *
gtk_ui_manager_get_ui (GtkUIManager *self);

Creates a UI definition of the merged UI.

Since: 2.4

gtk_ui_manager_ensure_update ()

void
gtk_ui_manager_ensure_update (GtkUIManager *self);

Makes sure that all pending updates to the UI have been completed.

This may occasionally be necessary, since GtkUIManager updates the UI in an idle function. A typical example where this function is useful is to enforce that the menubar and toolbar have been added to the main window before showing it:

1
2
3
4
5
6
7

gtk_container_add (GTK_CONTAINER (window), vbox); 
g_signal_connect (merge, "add-widget", 
                  G_CALLBACK (add_widget), vbox);
gtk_ui_manager_add_ui_from_file (merge, "my-menus");
gtk_ui_manager_add_ui_from_file (merge, "my-toolbars");
gtk_ui_manager_ensure_update (merge);  
gtk_widget_show (window);

Since: 2.4

struct GtkUIManager

struct GtkUIManager;

gtk_ui_manager_add_ui_from_file

#define gtk_ui_manager_add_ui_from_file gtk_ui_manager_add_ui_from_file_utf8

Parses a file containing a UI definition and merges it with the current contents of self .

Since: 2.4

enum GtkUIManagerItemType

The “add-tearoffs” property

  “add-tearoffs”             gboolean

The "add-tearoffs" property controls whether generated menus have tearoff menu items.

Note that this only affects regular menus. Generated popup menus never have tearoff menu items.

Owner: GtkUIManager

Flags: Read / Write

Default value: FALSE

Since: 2.4

The “ui” property

  “ui”                       char *

An XML string describing the merged UI.

Owner: GtkUIManager

Flags: Read

Default value: "<ui>\n</ui>\n"

The “actions-changed” signal

void
user_function (GtkUIManager *merge,
               gpointer      user_data)

The "actions-changed" signal is emitted whenever the set of actions changes.

Flags: No Recursion

Since: 2.4

The “add-widget” signal

void
user_function (GtkUIManager *merge,
               GtkWidget    *widget,
               gpointer      user_data)

The add_widget signal is emitted for each generated menubar and toolbar. It is not emitted for generated popup menus, which can be obtained by gtk_ui_manager_get_widget().

Flags: No Recursion

Since: 2.4

The “connect-proxy” signal

void
user_function (GtkUIManager *uimanager,
               GtkAction    *action,
               GtkWidget    *proxy,
               gpointer      user_data)

The connect_proxy signal is emitted after connecting a proxy to an action in the group.

This is intended for simple customizations for which a custom action class would be too clumsy, e.g. showing tooltips for menuitems in the statusbar.

Flags: No Recursion

Since: 2.4

The “disconnect-proxy” signal

void
user_function (GtkUIManager *uimanager,
               GtkAction    *action,
               GtkWidget    *proxy,
               gpointer      user_data)

The disconnect_proxy signal is emitted after disconnecting a proxy from an action in the group.

Flags: No Recursion

Since: 2.4

The “post-activate” signal

void
user_function (GtkUIManager *uimanager,
               GtkAction    *action,
               gpointer      user_data)

The post_activate signal is emitted just after the action is activated.

This is intended for applications to get notification just after any action is activated.

Flags: No Recursion

Since: 2.4

The “pre-activate” signal

void
user_function (GtkUIManager *uimanager,
               GtkAction    *action,
               gpointer      user_data)

The pre_activate signal is emitted just before the action is activated.

This is intended for applications to get notification just before any action is activated.

Flags: No Recursion

Since: 2.4