type Gtk_UI_Manager_Record is new Glib.Object.GObject_Record with null record;
type Gtk_UI_Manager is access all Gtk_UI_Manager_Record'Class;
Manager_Auto : constant Manager_Item_Type := 2 ** 0;
Manager_Menubar : constant Manager_Item_Type := 2 ** 1;
Manager_Menu : constant Manager_Item_Type := 2 ** 2;
Manager_Toolbar : constant Manager_Item_Type := 2 ** 3;
Manager_Placeholder : constant Manager_Item_Type := 2 ** 4;
Manager_Popup : constant Manager_Item_Type := 2 ** 5;
Manager_Menuitem : constant Manager_Item_Type := 2 ** 6;
Manager_Toolitem : constant Manager_Item_Type := 2 ** 7;
Manager_Separator : constant Manager_Item_Type := 2 ** 8;
Manager_Accelerator : constant Manager_Item_Type := 2 ** 9;
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
( | UI | : out Gtk_UI_Manager); |
procedure Initialize
( | UI | : access Gtk_UI_Manager_Record'Class); |
function Get_Type return GType;
function New_Merge_Id
( | Self | : access Gtk_UI_Manager_Record) return Guint; |
procedure Ensure_Update
( | Self | : access Gtk_UI_Manager_Record); |
procedure Add_UI
( | Self | : access Gtk_UI_Manager_Record; |
Merge_Id | : Guint; | |
Path | : String; | |
Name | : String; | |
Action | : String := ""; | |
Typ | : Manager_Item_Type := Manager_Auto; | |
Top | : Boolean := False); |
procedure Remove_UI
( | Self | : access Gtk_UI_Manager_Record; |
Merge_Id | : Guint); |
function Add_UI_From_File
( | Self | : access Gtk_UI_Manager_Record; |
Filename | : String; | |
Error | : Glib.Error.GError_Access := null) return Guint; |
function Add_UI_From_String
( | Self | : access Gtk_UI_Manager_Record; |
Buffer | : String; | |
Error | : Glib.Error.GError_Access := null) return Guint; |
procedure Insert_Action_Group
( | Self | : access Gtk_UI_Manager_Record; |
Action_Group | : access Gtk.Action_Group.Gtk_Action_Group_Record'Class; | |
Pos | : Gint); |
procedure Remove_Action_Group
( | Self | : access Gtk_UI_Manager_Record; |
Action_Group | : access Gtk.Action_Group.Gtk_Action_Group_Record'Class); |
function Get_Accel_Group
( | Self | : access Gtk_UI_Manager_Record) return Gtk.Accel_Group.Gtk_Accel_Group; |
function Get_Action
( | Self | : access Gtk_UI_Manager_Record; |
Path | : String) return Gtk.Action.Gtk_Action; |
function Get_Action_Groups
( | Self | : access Gtk_UI_Manager_Record) return Glib.Object.Object_Simple_List.Glist; |
procedure Set_Add_Tearoffs
( | Self | : access Gtk_UI_Manager_Record; |
Add_Tearoffs | : Boolean); |
function Get_Add_Tearoffs
( | Self | : access Gtk_UI_Manager_Record) return Boolean; |
function Get_Toplevels
( | Self | : access Gtk_UI_Manager_Record; |
Types | : Manager_Item_Type) return Gtk.Widget.Widget_SList.GSlist; |
function Get_UI
( | Self | : access Gtk_UI_Manager_Record) return String; |
function Get_Widget
( | Self | : access Gtk_UI_Manager_Record; |
Path | : String) return Gtk.Widget.Gtk_Widget; |
A 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. - <!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 > - <!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 > - <!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 ancestry and every menuitem must have a menubar or popup in its ancestry. 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.
Here is an example:
The correspondence of XML elements to widgets should be almost obvious:
- menubar : a Gtk_Menu_Bar
- toolbar : a Gtk_Toolbar
- popup : a toplevel Gtk_Menu
- menu : a Gtk_Menu attached to a menuitem
- menuitem : a Gtk_Menu_Item subclass, the exact type depends on the action
- toolitem : a Gtk_Tool_Item subclass, exact type depends on the action. This may contain a menu element only if the associated action specifies a Gtk_Menu_Tool_Button as proxy
- separator : a Gtk_Separator_Menu_Item or 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 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 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 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.
Binding from C File version 2.8.17