Class (GI Struct)

Gtk-3.0 ▶ Gtk ▶ 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 Gtk.StyleContext 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:

{
  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:

{
  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.

Index

Constructors

constructor

Properties

$gtype

Methods

append_for_widget append_type append_with_siblings copy free get_object_type has_parent is_type iter_add_class iter_add_region iter_clear_classes iter_clear_regions iter_get_name iter_get_object_name iter_get_object_type iter_get_sibling_index iter_get_siblings iter_get_state iter_has_class iter_has_name iter_has_qclass iter_has_qname iter_has_qregion iter_has_region iter_list_classes iter_list_regions iter_remove_class iter_remove_region iter_set_name iter_set_object_name iter_set_object_type iter_set_state length prepend_type ref to_string unref new

Constructors

Properties

$gtype: GType<WidgetPath>

Methods

  • Appends the data from widget to the widget hierarchy represented by path. This function is a shortcut for adding information from widget to the given path. This includes setting the name or adding the style classes from widget.

    Parameters

    • widget: Gtk.Widget

      the widget to append to the widget path

    Returns number

    the position where the data was inserted

  • Appends a widget type to the widget hierarchy represented by path.

    Parameters

    • type: GType

      widget type to append

    Returns number

    the position where the element was inserted

  • Appends a widget type with all its siblings to the widget hierarchy represented by path. Using this function instead of gtk_widget_path_append_type() will allow the CSS theming to use sibling matches in selectors and apply :nth-child() pseudo classes. In turn, it requires a lot more care in widget implementations as widgets need to make sure to call gtk_widget_reset_style() on all involved widgets when the siblings path changes.

    Parameters

    • siblings: WidgetPath

      a widget path describing a list of siblings. This path may not contain any siblings itself and it must not be modified afterwards.

    • sibling_index: number

      index into siblings for where the added element is positioned.

    Returns number

    the position where the element was inserted.

  • Decrements the reference count on path, freeing the structure if the reference count reaches 0.

    Returns void

  • Returns true if any of the parents of the widget represented in path is of type type, or any subtype of it.

    Parameters

    • type: GType

      widget type to check in parents

    Returns boolean

    true if any parent is of type type

  • Returns true if the widget type represented by this path is type, or a subtype of it.

    Parameters

    • type: GType

      widget type to match

    Returns boolean

    true if the widget represented by path is of type type

  • Adds the class name to the widget at position pos in the hierarchy defined in path. See gtk_style_context_add_class().

    Parameters

    • pos: number

      position to modify, -1 for the path head

    • name: string

      a class name

    Returns void

  • 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

    • pos: number

      position to modify, -1 for the path head

    • name: string

      region name

    • flags: Gtk.RegionFlags

      flags affecting the region

    Returns void

  • Removes all classes from the widget at position pos in the hierarchy defined in path.

    Parameters

    • pos: number

      position to modify, -1 for the path head

    Returns void

  • Removes all regions from the widget at position pos in the hierarchy defined in path.

    Parameters

    • pos: number

      position to modify, -1 for the path head

    Returns void

  • Returns the name corresponding to the widget found at the position pos in the widget hierarchy defined by path

    Parameters

    • pos: number

      position to get the widget name for, -1 for the path head

    Returns string

    The widget name, or null if none was set.

  • Returns the object name that is at position pos in the widget hierarchy defined in path.

    Parameters

    • pos: number

      position to get the object name for, -1 for the path head

    Returns string

    the name or null

  • Returns the object GObject.GType that is at position pos in the widget hierarchy defined in path.

    Parameters

    • pos: number

      position to get the object type for, -1 for the path head

    Returns GType

    a widget type

  • Returns the index into the list of siblings for the element at pos as returned by gtk_widget_path_iter_get_siblings(). If that function would return null because the element at pos has no siblings, this function will return 0.

    Parameters

    • pos: number

      position to get the sibling index for, -1 for the path head

    Returns number

    0 or the index into the list of siblings for the element at pos.

  • Returns the list of siblings for the element at pos. If the element was not added with siblings, null is returned.

    Parameters

    • pos: number

      position to get the siblings for, -1 for the path head

    Returns WidgetPath

    null or the list of siblings for the element at pos.

  • Returns the state flags corresponding to the widget found at the position pos in the widget hierarchy defined by path

    Parameters

    • pos: number

      position to get the state for, -1 for the path head

    Returns Gtk.StateFlags

    The state flags

  • Returns true if the widget at position pos has the class name defined, false otherwise.

    Parameters

    • pos: number

      position to query, -1 for the path head

    • name: string

      class name

    Returns boolean

    true if the class name is defined for the widget at pos

  • Returns true if the widget at position pos has the name name, false otherwise.

    Parameters

    • pos: number

      position to query, -1 for the path head

    • name: string

      a widget name

    Returns boolean

    true if the widget at pos has this name

  • See gtk_widget_path_iter_has_class(). This is a version that operates with GQuarks.

    Parameters

    • pos: number

      position to query, -1 for the path head

    • qname: number

      class name as a GLib.Quark

    Returns boolean

    true if the widget at pos has the class defined.

  • See gtk_widget_path_iter_has_name(). This is a version that operates on GQuarks.

    Parameters

    • pos: number

      position to query, -1 for the path head

    • qname: number

      widget name as a GLib.Quark

    Returns boolean

    true if the widget at pos has this name

  • See gtk_widget_path_iter_has_region(). This is a version that operates with GQuarks.

    Parameters

    • pos: number

      position to query, -1 for the path head

    • qname: number

      region name as a GLib.Quark

    Returns [boolean, Gtk.RegionFlags]

    true if the widget at pos has the region defined.

  • Returns true if the widget at position pos has the class name defined, false otherwise.

    Parameters

    • pos: number

      position to query, -1 for the path head

    • name: string

      region name

    Returns [boolean, Gtk.RegionFlags]

    true if the class name is defined for the widget at pos

  • Returns a list with all the class names defined for the widget at position pos in the hierarchy defined in path.

    Parameters

    • pos: number

      position to query, -1 for the path head

    Returns string[]

    The list of classes, This is a list of strings, the GLib.SList contents are owned by GTK+, but you should use g_slist_free() to free the list itself.

  • Returns a list with all the region names defined for the widget at position pos in the hierarchy defined in path.

    Parameters

    • pos: number

      position to query, -1 for the path head

    Returns string[]

    The list of regions, This is a list of strings, the GLib.SList contents are owned by GTK+, but you should use g_slist_free() to free the list itself.

  • Removes the class name from the widget at position pos in the hierarchy defined in path.

    Parameters

    • pos: number

      position to modify, -1 for the path head

    • name: string

      class name

    Returns void

  • Removes the region name from the widget at position pos in the hierarchy defined in path.

    Parameters

    • pos: number

      position to modify, -1 for the path head

    • name: string

      region name

    Returns void

  • Sets the widget name for the widget found at position pos in the widget hierarchy defined by path.

    Parameters

    • pos: number

      position to modify, -1 for the path head

    • name: string

      widget name

    Returns void

  • Sets the object name for a given position in the widget hierarchy defined by path.

    When set, the object name overrides the object type when matching CSS.

    Parameters

    • pos: number

      position to modify, -1 for the path head

    • Optionalname: string

      object name to set or null to unset

    Returns void

  • Sets the object type for a given position in the widget hierarchy defined by path.

    Parameters

    • pos: number

      position to modify, -1 for the path head

    • type: GType

      object type to set

    Returns void

  • Sets the widget name for the widget found at position pos in the widget hierarchy defined by path.

    If you want to update just a single state flag, you need to do this manually, as this function updates all state flags.

    gtk_widget_path_iter_set_state (path, pos, gtk_widget_path_iter_get_state (path, pos) | flag);

    gtk_widget_path_iter_set_state (path, pos, gtk_widget_path_iter_get_state (path, pos) & ~flag);

    Parameters

    • pos: number

      position to modify, -1 for the path head

    • state: Gtk.StateFlags

      state flags

    Returns void

  • Returns the number of Gtk.Widget GTypes between the represented widget and its topmost container.

    Returns number

    the number of elements in the path

  • Prepends a widget type to the widget hierachy represented by path.

    Parameters

    • type: GType

      widget type to prepend

    Returns void

  • Dumps the widget path into a string representation. It tries to match the CSS style as closely as possible (Note that there might be paths that cannot be represented in CSS).

    The main use of this code is for debugging purposes, so that you can g_print() the path or dump it in a gdb session.

    Returns string

    A new string describing path.

  • Decrements the reference count on path, freeing the structure if the reference count reaches 0.

    Returns void