UI Definitions

The UI definitions are specified in an XML format which can be roughly described by the following DTD.

1
2
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
28
29
30
31
32
33
34

<!ELEMENT ui          (menubar|toolbar|popup|accelerator)* >
<!ELEMENT menubar     (menuitem|separator|placeholder|menu)* >
<!ELEMENT menu        (menuitem|separator|placeholder|menu)* >
<!ELEMENT popup       (menuitem|separator|placeholder|menu)* >
<!ELEMENT toolbar     (toolitem|separator|placeholder)* >
<!ELEMENT placeholder (menuitem|toolitem|separator|placeholder|menu)* >
<!ELEMENT menuitem     EMPTY >
<!ELEMENT toolitem     (menu?) >
<!ELEMENT separator    EMPTY >
<!ELEMENT accelerator  EMPTY >
<!ATTLIST menubar      name                      #IMPLIED
                       action                    #IMPLIED >
<!ATTLIST toolbar      name                      #IMPLIED
                       action                    #IMPLIED >
<!ATTLIST popup        name                      #IMPLIED
                       action                    #IMPLIED
                       accelerators (true|false) #IMPLIED >
<!ATTLIST placeholder  name                      #IMPLIED
                       action                    #IMPLIED >
<!ATTLIST separator    name                      #IMPLIED
                       action                    #IMPLIED
                       expand       (true|false) #IMPLIED >
<!ATTLIST menu         name                      #IMPLIED
                       action                    #REQUIRED
                       position     (top|bot)    #IMPLIED >
<!ATTLIST menuitem     name                      #IMPLIED
                       action                    #REQUIRED
                       position     (top|bot)    #IMPLIED
                       always-show-image (true|false) #IMPLIED >
<!ATTLIST toolitem     name                      #IMPLIED
                       action                    #REQUIRED
                       position     (top|bot)    #IMPLIED >
<!ATTLIST accelerator  name                      #IMPLIED
                       action                    #REQUIRED >

There are some additional restrictions beyond those specified in the DTD, e.g. every toolitem must have a toolbar in its anchestry and every menuitem must have a menubar or popup in its anchestry. Since a GMarkupParser is used to parse the UI description, it must not only be valid XML, but valid markup.

If a name is not specified, it defaults to the action. If an action is not specified either, the element name is used. The name and action attributes must not contain “/” characters after parsing (since that would mess up path lookup) and must be usable as XML attributes when enclosed in doublequotes, thus they must not “"” characters or references to the " entity.

A UI definition

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

<ui>
  <menubar>
    <menu name="FileMenu" action="FileMenuAction">
      <menuitem name="New" action="New2Action" />
      <placeholder name="FileMenuAdditions" />
    </menu>
    <menu name="JustifyMenu" action="JustifyMenuAction">
      <menuitem name="Left" action="justify-left"/>
      <menuitem name="Centre" action="justify-center"/>
      <menuitem name="Right" action="justify-right"/>
      <menuitem name="Fill" action="justify-fill"/>
    </menu>
  </menubar>
  <toolbar action="toolbar1">
    <placeholder name="JustifyToolItems">
      <separator/>
      <toolitem name="Left" action="justify-left"/>
      <toolitem name="Centre" action="justify-center"/>
      <toolitem name="Right" action="justify-right"/>
      <toolitem name="Fill" action="justify-fill"/>
      <separator/>
    </placeholder>
  </toolbar>
</ui>

The constructed widget hierarchy is very similar to the element tree of the XML, with the exception that placeholders are merged into their parents. The correspondence of XML elements to widgets should be almost obvious:

The “position” attribute determines where a constructed widget is positioned wrt. to its siblings in the partially constructed tree. If it is “top”, the widget is prepended, otherwise it is appended.

UI Merging

The most remarkable feature of GtkUIManager is that it can overlay a set of menuitems and toolitems over another one, and demerge them later.

Merging is done based on the names of the XML elements. Each element is identified by a path which consists of the names of its anchestors, separated by slashes. For example, the menuitem named “Left” in the example above has the path /ui/menubar/JustifyMenu/Left and the toolitem with the same name has path /ui/toolbar1/JustifyToolItems/Left.

Accelerators

Every action has an accelerator path. Accelerators are installed together with menuitem proxies, but they can also be explicitly added with <accelerator> elements in the UI definition. This makes it possible to have accelerators for actions even if they have no visible proxies.

Smart Separators

The separators created by GtkUIManager are “smart”, i.e. they do not show up in the UI unless they end up between two visible menu or tool items. Separators which are located at the very beginning or end of the menu or toolbar containing them, or multiple separators next to each other, are hidden. This is a useful feature, since the merging of UI elements from multiple sources can make it hard or impossible to determine in advance whether a separator will end up in such an unfortunate position.

For separators in toolbars, you can set expand="true" to turn them from a small, visible separator to an expanding, invisible one. Toolitems following an expanding separator are effectively right-aligned.

Empty Menus

Submenus pose similar problems to separators inconnection with merging. It is impossible to know in advance whether they will end up empty after merging. GtkUIManager offers two ways to treat empty submenus:

The behaviour is chosen based on the “hide_if_empty” property of the action to which the submenu is associated.

GtkUIManager as GtkBuildable

The GtkUIManager implementation of the GtkBuildable interface accepts GtkActionGroup objects as <child> elements in UI definitions.

A GtkUIManager UI definition as described above can be embedded in an GtkUIManager <object> element in a GtkBuilder UI definition.

The widgets that are constructed by a GtkUIManager can be embedded in other parts of the constructed user interface with the help of the “constructor” attribute. See the example below.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

<object class="GtkUIManager" id="uiman">
  <child>
    <object class="GtkActionGroup" id="actiongroup">
      <child>
        <object class="GtkAction" id="file">
          <property name="label">_File</property>
        </object>
      </child>
    </object>
  </child>
  <ui>
    <menubar name="menubar1">
      <menu action="file">
      </menu>
    </menubar>
  </ui>
</object>
<object class="GtkWindow" id="main-window">
  <child>
    <object class="GtkMenuBar" id="menubar1" constructor="uiman"/>
  </child>
</object>

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 *manager,
                                 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 *manager);

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 *manager,
                                    GtkActionGroup *action_group,
                                    gint pos);

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

If pos is larger than the number of action groups in manager , or negative, action_group will be inserted at the end of the internal list.

Since 2.4

gtk_ui_manager_remove_action_group ()

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

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

Since 2.4

gtk_ui_manager_get_action_groups ()

GList *
gtk_ui_manager_get_action_groups (GtkUIManager *manager);

Returns the list of action groups associated with manager .

Since 2.4

gtk_ui_manager_get_accel_group ()

GtkAccelGroup *
gtk_ui_manager_get_accel_group (GtkUIManager *manager);

Returns the GtkAccelGroup associated with manager .

Since 2.4

gtk_ui_manager_get_widget ()

GtkWidget *
gtk_ui_manager_get_widget (GtkUIManager *manager,
                           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 it manages.

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 *manager,
                              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 *manager,
                           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_resource ()

guint
gtk_ui_manager_add_ui_from_resource (GtkUIManager *manager,
                                     const gchar *resource_path,
                                     GError **error);

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

Since 3.4

gtk_ui_manager_add_ui_from_string ()

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

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

Since 2.4

gtk_ui_manager_add_ui_from_file ()

guint
gtk_ui_manager_add_ui_from_file (GtkUIManager *manager,
                                 const gchar *filename,
                                 GError **error);

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

Since 2.4

gtk_ui_manager_new_merge_id ()

guint
gtk_ui_manager_new_merge_id (GtkUIManager *manager);

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 *manager,
                       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 manager .

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 *manager,
                          guint merge_id);

Unmerges the part of manager 's content identified by merge_id .

Since 2.4

gtk_ui_manager_get_ui ()

gchar *
gtk_ui_manager_get_ui (GtkUIManager *manager);

Creates a UI definition of the merged UI.

Since 2.4

gtk_ui_manager_ensure_update ()

void
gtk_ui_manager_ensure_update (GtkUIManager *manager);

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;

enum GtkUIManagerItemType

These enumeration values are used by gtk_ui_manager_add_ui() to determine what UI element to create.

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.

Flags: Read / Write

Default value: FALSE

Since 2.4

The “ui” property

  “ui”                       gchar *

An XML string describing the merged UI.

Flags: Read

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

The “actions-changed” signal

void
user_function (GtkUIManager *manager,
               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 *manager,
               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 *manager,
               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 *manager,
               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 *manager,
               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 *manager,
               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