Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gtk.UIManager

Class Gtk.UIManager

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkUIManager
Class :	UIManager
Implements:	Gtk.Buildable
Extends:	GObject.Object

Properties
Properties		Defined By
	add_tearoffs : gboolean The "add-tearoffs" property controls whether generated menus have tearoff menu items. 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.	Gtk.UIManager
	parent : GObject.Object read only	Gtk.UIManager
	private_data : Gtk.UIManagerPrivate read only	Gtk.UIManager
	ui : String read only	Gtk.UIManager

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.UIManager (Object *properties) Create a new Gtk.UIManager Create a new Gtk.UIManager Parameters: Object properties*
	add_child (Builder *builder, Object child, String type) : none Adds a child to buildable. Adds a child to buildable. type* is an optional string describing how the child should be added. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder GObject.Object child Required (not null) child to add String type kind of child or NULL Returns: none	Gtk.Buildable
	add_ui (guint32 *merge_id, String path, String name, String action, UIManagerItemType type, gboolean top) : none Adds a UI element to the current contents of manager. 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 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. Parameters: guint32 merge_id Required (not null) the merge id for the merged UI, see gtk_ui_manager_new_merge_id() String path Required (not null) a path String name Required (not null) the name for the added UI element String action the name of the action to be proxied, or NULL to add a separator Gtk.UIManagerItemType type Required (not null) the type of UI element to add. gboolean top Required (not null) if TRUE, the UI element is added before its siblings, otherwise it is added after its siblings. Returns: none	Gtk.UIManager
	add_ui_from_file (String *filename) : guint32 Parses a file containing a UI definition and merges it with the current contents of manager. Parses a file containing a UI definition and merges it with the current contents of manager. to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, the return value is 0. Parameters: String filename* Required (not null) the name of the file to parse Returns: guint32 The merge id for the merged UI. The merge id can be used	Gtk.UIManager
	add_ui_from_string (String *buffer, gint32 length) : guint32 Parses a string containing a UI definition and merges it with the current contents of manager. 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. to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, the return value is 0. Parameters: String buffer* Required (not null) the string to parse gint32 length Required (not null) the length of buffer (may be -1 if buffer is nul-terminated) Returns: guint32 The merge id for the merged UI. The merge id can be used	Gtk.UIManager
	construct_child (Builder *builder, String name) : GObject.Object Constructs a child of buildable* with the name name. Constructs a child of buildable with the name name. GtkBuilder calls this function if a "constructor" has been specified in the UI definition. Parameters: Gtk.Builder builder Required (not null) GtkBuilder used to construct this object String name Required (not null) name of child to construct Returns: GObject.Object the constructed child	Gtk.Buildable
	custom_finished (Builder *builder, Object child, String tagname, void *data) : none This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable. This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder GObject.Object child child object or NULL for non-child tags String tagname Required (not null) the name of the tag void* data Required (not null) user data created in custom_tag_start Returns: none	Gtk.Buildable
	custom_tag_end (Builder *builder, Object child, String tagname, void *data) : none This is called at the end of each custom element handled by the buildable. This is called at the end of each custom element handled by the buildable. Parameters: Gtk.Builder builder* Required (not null) GtkBuilder used to construct this object GObject.Object child child object or NULL for non-child tags String tagname Required (not null) name of tag void* data Required (not null) user data that will be passed in to parser functions Returns: none	Gtk.Buildable
	custom_tag_start (Builder *builder, Object child, String tagname, Object out_values) : gboolean This is called for each unknown element under <child>. This is called for each unknown element under <child>. if it doesn't. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder used to construct this object GObject.Object child child object or NULL for non-child tags String tagname Required (not null) name of tag Object out_values GLib.MarkupParser parser void* data Returns: gboolean TRUE if a object has a custom implementation, FALSE	Gtk.Buildable
	ensure_update () : none Makes sure that all pending updates to the UI have been completed. 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: \|[ 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); ]\| Returns: none	Gtk.UIManager
	get_accel_group () : Gtk.AccelGroup Returns the GtkAccelGroup associated with manager. Returns the GtkAccelGroup associated with manager. Returns: Gtk.AccelGroup the GtkAccelGroup.	Gtk.UIManager
	get_action (String *path) : Gtk.Action Looks up an action by following a path. Looks up an action by following a path. See gtk_ui_manager_get_widget() for more information about paths. or NULL* if no widget was found. Parameters: String path Required (not null) a path Returns: Gtk.Action the action whose proxy widget is found by following the path,	Gtk.UIManager
	get_action_groups () : Array Returns the list of action groups associated with manager. Returns the list of action groups associated with manager. action groups. The list is owned by GTK+ and should not be modified. Returns: Array a GList of	Gtk.UIManager
	get_add_tearoffs () : gboolean Returns whether menus generated by this GtkUIManager will have tearoff menu items. Returns whether menus generated by this GtkUIManager will have tearoff menu items. Returns: gboolean whether tearoff menu items are added	Gtk.UIManager
	get_internal_child (Builder *builder, String childname) : GObject.Object Get the internal child called childname* of the buildable object. Get the internal child called childname of the buildable object. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder String childname Required (not null) name of child Returns: GObject.Object the internal child of the buildable object	Gtk.Buildable
	get_name () : String Gets the name of the buildable object. Gets the name of the buildable object. GtkBuilder sets the name based on the the GtkBuilder UI definition used to construct the buildable. Returns: String the name set with gtk_buildable_set_name()	Gtk.Buildable
	get_toplevels (UIManagerItemType *types) : Array Obtains a list of all toplevel widgets of the requested types. Obtains a list of all toplevel widgets of the requested types. all toplevel widgets of the requested types. Free the returned list with g_slist_free(). Parameters: Gtk.UIManagerItemType types* Required (not null) specifies the types of toplevel widgets to include. Allowed types are GTK_UI_MANAGER_MENUBAR, GTK_UI_MANAGER_TOOLBAR and GTK_UI_MANAGER_POPUP. Returns: Array a newly-allocated GSList of	Gtk.UIManager
	get_ui () : String Creates a UI definition of the merged UI. Creates a UI definition of the merged UI. the merged UI. Returns: String A newly allocated string containing an XML representation of	Gtk.UIManager
	get_widget (String *path) : Gtk.Widget Looks up a widget by following a 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 itmanager. 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. was found. Parameters: String path* Required (not null) a path Returns: Gtk.Widget the widget found by following the path, or NULL if no widget	Gtk.UIManager
	insert_action_group (ActionGroup *action_group, gint32 pos) : none Inserts an action group into the list of action groups associated with manager. 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. Parameters: Gtk.ActionGroup action_group* Required (not null) the action group to be inserted gint32 pos Required (not null) the position at which the group will be inserted. Returns: none	Gtk.UIManager
	new_merge_id () : guint32 Returns an unused merge id, suitable for use with gtk_ui_manager_add_ui(). Returns an unused merge id, suitable for use with gtk_ui_manager_add_ui(). Returns: guint32 an unused merge id.	Gtk.UIManager
	parser_finished (Builder *builder) : none Called when the builder finishes the parsing of a GtkBuilder UI definition. Called when the builder finishes the parsing of a GtkBuilder UI definition. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder Returns: none	Gtk.Buildable
	remove_action_group (ActionGroup *action_group) : none Removes an action group from the list of action groups associated with manager. Removes an action group from the list of action groups associated with manager. Parameters: Gtk.ActionGroup action_group* Required (not null) the action group to be removed Returns: none	Gtk.UIManager
	remove_ui (guint32 *merge_id) : none Unmerges the part of managers content identified by merge_id. Unmerges the part of managers content identified by merge_id. Parameters: guint32 merge_id* Required (not null) a merge id as returned by gtk_ui_manager_add_ui_from_string() Returns: none	Gtk.UIManager
	set_add_tearoffs (gboolean *add_tearoffs) : none Sets the "add_tearoffs" property, which controls whether menus generated by this GtkUIManager* will have tearoff menu items. 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. Parameters: gboolean add_tearoffs Required (not null) whether tearoff menu items are added Returns: none	Gtk.UIManager
	set_buildable_property (Builder *builder, String name, Value value) : none Sets the property name name* to value on the buildable object. Sets the property name name to value on the buildable object. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder String name Required (not null) name of property GObject.Value value Required (not null) value of property Returns: none	Gtk.Buildable
	set_name (String *name) : none Sets the name of the buildable* object. Sets the name of the buildable object. Parameters: String name Required (not null) name to set Returns: none	Gtk.Buildable

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	actions_changed (UIManager *self) : none The ::actions-changed signal is emitted whenever the set of actions changes. The ::actions-changed signal is emitted whenever the set of actions changes. Parameters: Gtk.UIManager self* Returns: {none}	Gtk.UIManager
	add_widget (UIManager *self, Widget widget) : none The ::add-widget signal is emitted for each generated menubar and toolbar. 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(). Parameters: Gtk.UIManager self* Gtk.Widget widget Returns: {none}	Gtk.UIManager
	connect_proxy (UIManager *self, Action action, Widget proxy) : none The ::connect-proxy signal is emitted after connecting a proxy to an action in the group. 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. Parameters: Gtk.UIManager self* Gtk.Action action Gtk.Widget proxy Returns: {none}	Gtk.UIManager
	disconnect_proxy (UIManager *self, Action action, Widget proxy) : none The ::disconnect-proxy signal is emitted after disconnecting a proxy from an action in the group. The ::disconnect-proxy signal is emitted after disconnecting a proxy from an action in the group. Parameters: Gtk.UIManager self* Gtk.Action action Gtk.Widget proxy Returns: {none}	Gtk.UIManager
	post_activate (UIManager *self, Action action) : none The ::post-activate signal is emitted just after the action* is activated. 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. Parameters: Gtk.UIManager self Gtk.Action action Returns: {none}	Gtk.UIManager
	pre_activate (UIManager *self, Action action) : none The ::pre-activate signal is emitted just before the action* is activated. 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. Parameters: Gtk.UIManager self Gtk.Action action Returns: {none}	Gtk.UIManager

Un-official Seed Documentation

Gtk

Classes

Interfaces

Structs

Unions

Enums

Class Gtk.UIManager