package Manager_Item_Type_Properties is new Generic_Internal_Discrete_Property (Manager_Item_Type);
package Implements_Gtk_Buildable is new Glib.Types.Implements (Gtk.Buildable.Gtk_Buildable, Gtk_UI_Manager_Record, Gtk_UI_Manager);
type Gtk_UI_Manager_Record is new GObject_Record with null record;
type Gtk_UI_Manager is access all Gtk_UI_Manager_Record'Class;
type Property_Manager_Item_Type is new Manager_Item_Type_Properties.Property;
type Cb_Gtk_UI_Manager_Void is not null access procedure (Self : access Gtk_UI_Manager_Record'Class);
type Cb_GObject_Void is not null access procedure (Self : access Glib.Object.GObject_Record'Class);
type Cb_Gtk_UI_Manager_Gtk_Widget_Void is not null access procedure (Self : access Gtk_UI_Manager_Record'Class; Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class);
type Cb_GObject_Gtk_Widget_Void is not null access procedure (Self : access Glib.Object.GObject_Record'Class; Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class);
type Cb_Gtk_UI_Manager_Gtk_Action_Gtk_Widget_Void is not null access procedure (Self : access Gtk_UI_Manager_Record'Class; Action : not null access Gtk.Action.Gtk_Action_Record'Class; Proxy : not null access Gtk.Widget.Gtk_Widget_Record'Class);
type Cb_GObject_Gtk_Action_Gtk_Widget_Void is not null access procedure (Self : access Glib.Object.GObject_Record'Class; Action : not null access Gtk.Action.Gtk_Action_Record'Class; Proxy : not null access Gtk.Widget.Gtk_Widget_Record'Class);
type Cb_Gtk_UI_Manager_Gtk_Action_Void is not null access procedure (Self : access Gtk_UI_Manager_Record'Class; Action : not null access Gtk.Action.Gtk_Action_Record'Class);
type Cb_GObject_Gtk_Action_Void is not null access procedure (Self : access Glib.Object.GObject_Record'Class; Action : not null access Gtk.Action.Gtk_Action_Record'Class);
Manager_Auto : constant Manager_Item_Type := 0;
Manager_Menubar : constant Manager_Item_Type := 1;
Manager_Menu : constant Manager_Item_Type := 2;
Manager_Toolbar : constant Manager_Item_Type := 4;
Manager_Placeholder : constant Manager_Item_Type := 8;
Manager_Popup : constant Manager_Item_Type := 16;
Manager_Menuitem : constant Manager_Item_Type := 32;
Manager_Toolitem : constant Manager_Item_Type := 64;
Manager_Separator : constant Manager_Item_Type := 128;
Manager_Accelerator : constant Manager_Item_Type := 256;
Manager_Popup_With_Accels : constant Manager_Item_Type := 512;
Add_Tearoffs_Property : constant Glib.Properties.Property_Boolean;
Ui_Property : constant Glib.Properties.Property_String;
Signal_Actions_Changed : constant Glib.Signal_Name := "actions-changed";
Signal_Add_Widget : constant Glib.Signal_Name := "add-widget";
Signal_Connect_Proxy : constant Glib.Signal_Name := "connect-proxy";
Signal_Disconnect_Proxy : constant Glib.Signal_Name := "disconnect-proxy";
Signal_Post_Activate : constant Glib.Signal_Name := "post-activate";
Signal_Pre_Activate : constant Glib.Signal_Name := "pre-activate";
procedure Gtk_New
( | Self | : out Gtk_UI_Manager); |
procedure Initialize
( | Self | : not null access Gtk_UI_Manager_Record'Class); |
function Gtk_UI_Manager_New return Gtk_UI_Manager;
function Get_Type return Glib.GType;
procedure Add_UI
( | Self | : not null access Gtk_UI_Manager_Record; |
Merge_Id | : Guint; | |
Path | : UTF8_String; | |
Name | : UTF8_String; | |
Action | : UTF8_String := ""; | |
The_Type | : Manager_Item_Type := Manager_Auto; | |
Top | : Boolean := False); |
function Add_UI_From_File
( | Self | : not null access Gtk_UI_Manager_Record; |
Filename | : UTF8_String; | |
Error | : access Glib.Error.GError) return Guint; |
function Add_UI_From_Resource
( | Self | : not null access Gtk_UI_Manager_Record; |
Resource_Path | : UTF8_String; | |
Error | : access Glib.Error.GError) return Guint; |
function Add_UI_From_String
( | Self | : not null access Gtk_UI_Manager_Record; |
Buffer | : UTF8_String; | |
Error | : access Glib.Error.GError) return Guint; |
procedure Ensure_Update
( | Self | : not null access Gtk_UI_Manager_Record); |
function Get_Accel_Group
( | Self | : not null access Gtk_UI_Manager_Record) return Gtk.Accel_Group.Gtk_Accel_Group; |
function Get_Action
( | Self | : not null access Gtk_UI_Manager_Record; |
Path | : UTF8_String) return Gtk.Action.Gtk_Action; |
function Get_Action_Groups
( | Self | : not null access Gtk_UI_Manager_Record) return Glib.Object.Object_Simple_List.Glist; |
function Get_Add_Tearoffs
( | Self | : not null access Gtk_UI_Manager_Record) return Boolean; |
procedure Set_Add_Tearoffs
( | Self | : not null access Gtk_UI_Manager_Record; |
Add_Tearoffs | : Boolean); |
function Get_Toplevels
( | Self | : not null access Gtk_UI_Manager_Record; |
Types | : Manager_Item_Type) return Gtk.Widget.Widget_SList.GSlist; |
function Get_Ui
( | Self | : not null access Gtk_UI_Manager_Record) return UTF8_String; |
function Get_Widget
( | Self | : not null access Gtk_UI_Manager_Record; |
Path | : UTF8_String) return Gtk.Widget.Gtk_Widget; |
procedure Insert_Action_Group
( | Self | : not null access Gtk_UI_Manager_Record; |
Action_Group | : not null access Gtk.Action_Group.Gtk_Action_Group_Record'Class; | |
Pos | : Gint); |
function New_Merge_Id
( | Self | : not null access Gtk_UI_Manager_Record) return Guint; |
procedure Remove_Action_Group
( | Self | : not null access Gtk_UI_Manager_Record; |
Action_Group | : not null access Gtk.Action_Group.Gtk_Action_Group_Record'Class); |
procedure Remove_UI
( | Self | : not null access Gtk_UI_Manager_Record; |
Merge_Id | : Guint); |
procedure On_Actions_Changed
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_Gtk_UI_Manager_Void; | |
After | : Boolean := False); |
procedure On_Actions_Changed
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_GObject_Void; | |
Slot | : not null access Glib.Object.GObject_Record'Class; | |
After | : Boolean := False); |
procedure On_Add_Widget
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_Gtk_UI_Manager_Gtk_Widget_Void; | |
After | : Boolean := False); |
procedure On_Add_Widget
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_GObject_Gtk_Widget_Void; | |
Slot | : not null access Glib.Object.GObject_Record'Class; | |
After | : Boolean := False); |
procedure On_Connect_Proxy
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_Gtk_UI_Manager_Gtk_Action_Gtk_Widget_Void; | |
After | : Boolean := False); |
procedure On_Connect_Proxy
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_GObject_Gtk_Action_Gtk_Widget_Void; | |
Slot | : not null access Glib.Object.GObject_Record'Class; | |
After | : Boolean := False); |
procedure On_Disconnect_Proxy
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_Gtk_UI_Manager_Gtk_Action_Gtk_Widget_Void; | |
After | : Boolean := False); |
procedure On_Disconnect_Proxy
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_GObject_Gtk_Action_Gtk_Widget_Void; | |
Slot | : not null access Glib.Object.GObject_Record'Class; | |
After | : Boolean := False); |
procedure On_Post_Activate
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_Gtk_UI_Manager_Gtk_Action_Void; | |
After | : Boolean := False); |
procedure On_Post_Activate
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_GObject_Gtk_Action_Void; | |
Slot | : not null access Glib.Object.GObject_Record'Class; | |
After | : Boolean := False); |
procedure On_Pre_Activate
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_Gtk_UI_Manager_Gtk_Action_Void; | |
After | : Boolean := False); |
procedure On_Pre_Activate
( | Self | : not null access Gtk_UI_Manager_Record; |
Call | : Cb_GObject_Gtk_Action_Void; | |
Slot | : not null access Glib.Object.GObject_Record'Class; | |
After | : Boolean := False); |
function "+"
( | Widget | : access Gtk_UI_Manager_Record'Class) return Gtk.Buildable.Gtk_Buildable renames Implements_Gtk_Buildable.To_Interface; |
function "-"
( | Interf | : Gtk.Buildable.Gtk_Buildable) return Gtk_UI_Manager renames Implements_Gtk_Buildable.To_Object; |
A Gtk.UI_Manager.Gtk_UI_Manager constructs a user interface (menus and toolbars) from one or more UI definitions, which reference actions from one or more action groups. == UI Definitions == The UI definitions are specified in an XML format which can be roughly described by the following DTD.
Note: Do not confuse the GtkUIManager UI Definitions described here with the similarly named <link linkend="BUILDER-UI">GtkBuilder UI Definitions</link>. <!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 GMarkup parser is used to parse the UI description, it must not only be valid XML, but valid GMarkup.
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 == <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: 'menubar' * a Gtk.Menu_Bar.Gtk_Menu_Bar 'toolbar' * a Gtk.Toolbar.Gtk_Toolbar 'popup' * a toplevel Gtk.Menu.Gtk_Menu 'menu' * a Gtk.Menu.Gtk_Menu attached to a menuitem 'menuitem' * a Gtk.Menu_Item.Gtk_Menu_Item subclass, the exact type depends on the action 'toolitem' * a Gtk.Tool_Item.Gtk_Tool_Item subclass, the exact type depends on the action. Note that toolitem elements may contain a menu element, but only if their associated action specifies a Gtk.Menu_Tool_Button.Gtk_Menu_Tool_Button as proxy. 'separator' * a Gtk.Separator_Menu_Item.Gtk_Separator_Menu_Item or Gtk.Separator_Tool_Item.Gtk_Separator_Tool_Item 'accelerator' * a keyboard accelerator 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 Gtk.UI_Manager.Gtk_UI_Manager 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 Gtk.UI_Manager.Gtk_UI_Manager 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. Gtk.UI_Manager.Gtk_UI_Manager offers two ways to treat empty submenus: * make them disappear by hiding the menu item they're attached to * add an insensitive "Empty" item 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. == An embedded GtkUIManager UI definition == <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>