Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

Struct Gtk.WidgetPath

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkWidgetPath
Struct :	WidgetPath

GtkWidgetPath is a boxed type that represents a widget hierarchy from
the topmost widget, typically a toplevel, to any child. This widget
path abstraction is used in GtkStyleContext on behalf of the real
widget in order to query style information.
If you are using GTK+ widgets, you probably will not need to use
this API directly, as there is gtk_widget_get_path(), and the style
context returned by gtk_widget_get_style_context() will be automatically
updated on widget hierarchy changes.
The widget path generation is generally simple:

Defining a button within a window

{
GtkWidgetPath *path;
path = gtk_widget_path_new ();
gtk_widget_path_append_type (path, GTK_TYPE_WINDOW);
gtk_widget_path_append_type (path, GTK_TYPE_BUTTON);
}

Although more complex information, such as widget names, or
different classes (property that may be used by other widget
types) and intermediate regions may be included:

Defining the first tab widget in a notebook

{
GtkWidgetPath *path;
guint pos;
path = gtk_widget_path_new ();
pos = gtk_widget_path_append_type (path, GTK_TYPE_NOTEBOOK);
gtk_widget_path_iter_add_region (path, pos, "tab", GTK_REGION_EVEN | GTK_REGION_FIRST);
pos = gtk_widget_path_append_type (path, GTK_TYPE_LABEL);
gtk_widget_path_iter_set_name (path, pos, "first tab label");
}

All this information will be used to match the style information
that applies to the described widget.

Properties
None

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.WidgetPath.c_new () : Gtk.WidgetPath Create a new Gtk.WidgetPath Create a new Gtk.WidgetPath Returns: Gtk.WidgetPath A newly created, empty, GtkWidgetPath
	append_type (Number *type) : gint32 Appends a widget type to the widget hierachy represented by path. Appends a widget type to the widget hierachy represented by path. Parameters: Number type* Required (not null) widget type to append Returns: gint32 the position where the element was inserted	Gtk.WidgetPath
	copy () : Gtk.WidgetPath Returns a copy of path Returns a copy of path Returns: Gtk.WidgetPath a copy of path	Gtk.WidgetPath
	free () : none Frees a GtkWidgetPath. Frees a GtkWidgetPath. Returns: none	Gtk.WidgetPath
	get_object_type () : Number Returns the topmost object type, that is, the object type this path is representing. Returns the topmost object type, that is, the object type this path is representing. Returns: Number The object type	Gtk.WidgetPath
	has_parent (Number *type) : gboolean Returns TRUE* if any of the parents of the widget represented in path is of type type, or any subtype of it. Returns TRUE if any of the parents of the widget represented in path is of type type, or any subtype of it. Parameters: Number type Required (not null) widget type to check in parents Returns: gboolean TRUE if any parent is of type type	Gtk.WidgetPath
	is_type (Number *type) : gboolean Returns TRUE* if the widget type represented by this path is type, or a subtype of it. Returns TRUE if the widget type represented by this path is type, or a subtype of it. Parameters: Number type Required (not null) widget type to match Returns: gboolean TRUE if the widget represented by path is of type type	Gtk.WidgetPath
	iter_add_class (gint32 *pos, String name) : none Adds the class name* to the widget at position pos in the hierarchy defined in path. Adds the class name to the widget at position pos in the hierarchy defined in path. See gtk_style_context_add_class(). Parameters: gint32 pos Required (not null) position to modify, -1 for the path head String name Required (not null) a class name Returns: none	Gtk.WidgetPath
	iter_add_region (gint32 *pos, String name, RegionFlags flags) : none Adds the region name* to the widget at position pos in the hierarchy defined in path. Adds the region name to the widget at position pos in the hierarchy defined in path. See gtk_style_context_add_region(). Region names must only contain lowercase letters and '-', starting always with a lowercase letter. Parameters: gint32 pos Required (not null) position to modify, -1 for the path head String name Required (not null) region name Gtk.RegionFlags flags Required (not null) flags affecting the region Returns: none	Gtk.WidgetPath
	iter_clear_classes (gint32 *pos) : none Removes all classes from the widget at position pos* in the hierarchy defined in path. Removes all classes from the widget at position pos in the hierarchy defined in path. Parameters: gint32 pos Required (not null) position to modify, -1 for the path head Returns: none	Gtk.WidgetPath
	iter_clear_regions (gint32 *pos) : none Removes all regions from the widget at position pos* in the hierarchy defined in path. Removes all regions from the widget at position pos in the hierarchy defined in path. Parameters: gint32 pos Required (not null) position to modify, -1 for the path head Returns: none	Gtk.WidgetPath
	iter_get_name (gint32 *pos) : String Returns the name corresponding to the widget found at the position pos* in the widget hierarchy defined by Returns the name corresponding to the widget found at the position pos in the widget hierarchy defined by Parameters: gint32 pos Required (not null) position to get the widget name for, -1 for the path head Returns: String The widget name, or NULL if none was set.	Gtk.WidgetPath
	iter_get_object_type (gint32 *pos) : Number Returns the object GType* that is at position pos in the widget hierarchy defined in path. Returns the object GType that is at position pos in the widget hierarchy defined in path. Parameters: gint32 pos Required (not null) position to get the object type for, -1 for the path head Returns: Number a widget type	Gtk.WidgetPath
	iter_has_class (gint32 *pos, String name) : gboolean Returns TRUE* if the widget at position pos has the class name defined, FALSE otherwise. Returns TRUE if the widget at position pos has the class name defined, FALSE otherwise. Parameters: gint32 pos Required (not null) position to query, -1 for the path head String name Required (not null) class name Returns: gboolean TRUE if the class name is defined for the widget at pos	Gtk.WidgetPath
	iter_has_name (gint32 *pos, String name) : gboolean Returns TRUE* if the widget at position pos has the name name, FALSE otherwise. Returns TRUE if the widget at position pos has the name name, FALSE otherwise. Parameters: gint32 pos Required (not null) position to query, -1 for the path head String name Required (not null) a widget name Returns: gboolean TRUE if the widget at pos has this name	Gtk.WidgetPath
	iter_has_qclass (gint32 *pos, guint32 qname) : gboolean See gtk_widget_path_iter_has_class(). See gtk_widget_path_iter_has_class(). This is a version that operates with GQuarks. Parameters: gint32 pos* Required (not null) position to query, -1 for the path head guint32 qname Required (not null) class name as a GQuark Returns: gboolean TRUE if the widget at pos has the class defined.	Gtk.WidgetPath
	iter_has_qname (gint32 *pos, guint32 qname) : gboolean See gtk_widget_path_iter_has_name(). See gtk_widget_path_iter_has_name(). This is a version that operates on GQuarks. Parameters: gint32 pos* Required (not null) position to query, -1 for the path head guint32 qname Required (not null) widget name as a GQuark Returns: gboolean TRUE if the widget at pos has this name	Gtk.WidgetPath
	iter_has_qregion (gint32 *pos, guint32 qname, Object out_values) : gboolean See gtk_widget_path_iter_has_region(). See gtk_widget_path_iter_has_region(). This is a version that operates with GQuarks. Parameters: gint32 pos* Required (not null) position to query, -1 for the path head guint32 qname Required (not null) region name as a GQuark Object out_values Gtk.RegionFlags flags Returns: gboolean TRUE if the widget at pos has the region defined.	Gtk.WidgetPath
	iter_has_region (gint32 *pos, String name, Object out_values) : gboolean Returns TRUE* if the widget at position pos has the class name defined, FALSE otherwise. Returns TRUE if the widget at position pos has the class name defined, FALSE otherwise. Parameters: gint32 pos Required (not null) position to query, -1 for the path head String name Required (not null) region name Object out_values Gtk.RegionFlags flags Returns: gboolean TRUE if the class name is defined for the widget at pos	Gtk.WidgetPath
	iter_list_classes (gint32 *pos) : Array Returns a list with all the class names defined for the widget at position pos* in the hierarchy defined in path. Returns a list with all the class names defined for the widget at position pos in the hierarchy defined in path. classes, This is a list of strings, the GSList contents are owned by GTK+, but you should use g_slist_free() to free the list itself. Parameters: gint32 pos Required (not null) position to query, -1 for the path head Returns: Array The list of	Gtk.WidgetPath
	iter_list_regions (gint32 *pos) : Array Returns a list with all the region names defined for the widget at position pos* in the hierarchy defined in path. Returns a list with all the region names defined for the widget at position pos in the hierarchy defined in path. regions, This is a list of strings, the GSList contents are owned by GTK+, but you should use g_slist_free() to free the list itself. Parameters: gint32 pos Required (not null) position to query, -1 for the path head Returns: Array The list of	Gtk.WidgetPath
	iter_remove_class (gint32 *pos, String name) : none Removes the class name* from the widget at position pos in the hierarchy defined in path. Removes the class name from the widget at position pos in the hierarchy defined in path. Parameters: gint32 pos Required (not null) position to modify, -1 for the path head String name Required (not null) class name Returns: none	Gtk.WidgetPath
	iter_remove_region (gint32 *pos, String name) : none Removes the region name* from the widget at position pos in the hierarchy defined in path. Removes the region name from the widget at position pos in the hierarchy defined in path. Parameters: gint32 pos Required (not null) position to modify, -1 for the path head String name Required (not null) region name Returns: none	Gtk.WidgetPath
	iter_set_name (gint32 *pos, String name) : none Sets the widget name for the widget found at position pos* in the widget hierarchy defined by path. Sets the widget name for the widget found at position pos in the widget hierarchy defined by path. Parameters: gint32 pos Required (not null) position to modify, -1 for the path head String name Required (not null) widget name Returns: none	Gtk.WidgetPath
	iter_set_object_type (gint32 *pos, Number type) : none Sets the object type for a given position in the widget hierarchy defined by path. Sets the object type for a given position in the widget hierarchy defined by path. Parameters: gint32 pos* Required (not null) position to modify, -1 for the path head Number type Required (not null) object type to set Returns: none	Gtk.WidgetPath
	length () : gint32 Returns the number of GtkWidget GTypes between the represented widget and its topmost container. Returns the number of GtkWidget GTypes between the represented widget and its topmost container. Returns: gint32 the number of elements in the path	Gtk.WidgetPath
	prepend_type (Number *type) : none Prepends a widget type to the widget hierachy represented by path. Prepends a widget type to the widget hierachy represented by path. Parameters: Number type* Required (not null) widget type to prepend Returns: none	Gtk.WidgetPath

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gtk.Container Method	get_path_for_child (Widget *child) : Gtk.WidgetPath Returns a newly created widget path representing all the widget hierarchy from the toplevel down to child* (this one not being included).
Gtk.StyleContext Method	get_path () : Gtk.WidgetPath Returns the widget path used for style matching.
Gtk.StyleContext Method	set_path (WidgetPath *path) : none Sets the GtkWidgetPath* used for style matching.
Gtk.StyleProvider Method	get_icon_factory (WidgetPath *path) : Gtk.IconFactory Returns the GtkIconFactory* defined to be in use for path, or NULL if none is defined.
Gtk.StyleProvider Method	get_style (WidgetPath *path) : Gtk.StyleProperties Returns the style settings affecting a widget defined by path, or NULL* if style settings affecting path
Gtk.StyleProvider Method	get_style_property (WidgetPath *path, StateFlags state, ParamSpec pspec, Object out_values) : gboolean Looks up a widget style property as defined by provider* for the widget represented by path.
Gtk.ThemingEngine Method	get_path () : Gtk.WidgetPath Returns the widget path used for style matching.
Gtk.Widget Method	get_path () : Gtk.WidgetPath Returns the GtkWidgetPath representing widget, if the widget is not connected to a toplevel widget, a partial path will be created.