GtkWidgetPath

Defining a button within a window

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

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

gtk_widget_path_append_type ()

gint
gtk_widget_path_append_type (GtkWidgetPath *path,
                             GType type);

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

Since: 3.0

gtk_widget_path_append_with_siblings ()

gint
gtk_widget_path_append_with_siblings (GtkWidgetPath *path,
                                      GtkWidgetPath *siblings,
                                      guint sibling_index);

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.

Since: 3.2

gtk_widget_path_append_for_widget ()

gint
gtk_widget_path_append_for_widget (GtkWidgetPath *path,
                                   GtkWidget *widget);

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 .

Since: 3.2

gtk_widget_path_copy ()

GtkWidgetPath *
gtk_widget_path_copy (const GtkWidgetPath *path);

Returns a copy of path

Since: 3.0

gtk_widget_path_ref ()

GtkWidgetPath *
gtk_widget_path_ref (GtkWidgetPath *path);

Increments the reference count on path .

Since: 3.2

gtk_widget_path_unref ()

void
gtk_widget_path_unref (GtkWidgetPath *path);

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

Since: 3.2

gtk_widget_path_free ()

void
gtk_widget_path_free (GtkWidgetPath *path);

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

Since: 3.0

gtk_widget_path_get_object_type ()

GType
gtk_widget_path_get_object_type (const GtkWidgetPath *path);

Returns the topmost object type, that is, the object type this path is representing.

Since: 3.0

gtk_widget_path_has_parent ()

gboolean
gtk_widget_path_has_parent (const GtkWidgetPath *path,
                            GType type);

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

Since: 3.0

gtk_widget_path_is_type ()

gboolean
gtk_widget_path_is_type (const GtkWidgetPath *path,
                         GType type);

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

Since: 3.0

gtk_widget_path_iter_add_class ()

void
gtk_widget_path_iter_add_class (GtkWidgetPath *path,
                                gint pos,
                                const gchar *name);

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

Since: 3.0

gtk_widget_path_iter_add_region ()

void
gtk_widget_path_iter_add_region (GtkWidgetPath *path,
                                 gint pos,
                                 const gchar *name,
                                 GtkRegionFlags flags);

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.

Since: 3.0

gtk_widget_path_iter_clear_classes ()

void
gtk_widget_path_iter_clear_classes (GtkWidgetPath *path,
                                    gint pos);

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

Since: 3.0

gtk_widget_path_iter_clear_regions ()

void
gtk_widget_path_iter_clear_regions (GtkWidgetPath *path,
                                    gint pos);

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

Since: 3.0

gtk_widget_path_iter_get_name ()

const gchar *
gtk_widget_path_iter_get_name (const GtkWidgetPath *path,
                               gint pos);

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

gtk_widget_path_iter_get_object_name ()

const char *
gtk_widget_path_iter_get_object_name (const GtkWidgetPath *path,
                                      gint pos);

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

Since: 3.20

gtk_widget_path_iter_get_object_type ()

GType
gtk_widget_path_iter_get_object_type (const GtkWidgetPath *path,
                                      gint pos);

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

Since: 3.0

gtk_widget_path_iter_get_siblings ()

const GtkWidgetPath *
gtk_widget_path_iter_get_siblings (const GtkWidgetPath *path,
                                   gint pos);

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

gtk_widget_path_iter_get_sibling_index ()

guint
gtk_widget_path_iter_get_sibling_index
                               (const GtkWidgetPath *path,
                                gint pos);

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.

gtk_widget_path_iter_get_state ()

GtkStateFlags
gtk_widget_path_iter_get_state (const GtkWidgetPath *path,
                                gint pos);

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

Since: 3.14

gtk_widget_path_iter_has_class ()

gboolean
gtk_widget_path_iter_has_class (const GtkWidgetPath *path,
                                gint pos,
                                const gchar *name);

Returns TRUE if the widget at position pos has the class name defined, FALSE otherwise.

Since: 3.0

gtk_widget_path_iter_has_name ()

gboolean
gtk_widget_path_iter_has_name (const GtkWidgetPath *path,
                               gint pos,
                               const gchar *name);

Returns TRUE if the widget at position pos has the name name , FALSE otherwise.

Since: 3.0

gtk_widget_path_iter_has_qclass ()

gboolean
gtk_widget_path_iter_has_qclass (const GtkWidgetPath *path,
                                 gint pos,
                                 GQuark qname);

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

Since: 3.0

gtk_widget_path_iter_has_qname ()

gboolean
gtk_widget_path_iter_has_qname (const GtkWidgetPath *path,
                                gint pos,
                                GQuark qname);

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

Since: 3.0

gtk_widget_path_iter_has_qregion ()

gboolean
gtk_widget_path_iter_has_qregion (const GtkWidgetPath *path,
                                  gint pos,
                                  GQuark qname,
                                  GtkRegionFlags *flags);

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

Since: 3.0

gtk_widget_path_iter_has_region ()

gboolean
gtk_widget_path_iter_has_region (const GtkWidgetPath *path,
                                 gint pos,
                                 const gchar *name,
                                 GtkRegionFlags *flags);

Returns TRUE if the widget at position pos has the class name defined, FALSE otherwise.

Since: 3.0

gtk_widget_path_iter_list_classes ()

GSList *
gtk_widget_path_iter_list_classes (const GtkWidgetPath *path,
                                   gint pos);

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

Since: 3.0

gtk_widget_path_iter_list_regions ()

GSList *
gtk_widget_path_iter_list_regions (const GtkWidgetPath *path,
                                   gint pos);

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

Since: 3.0

gtk_widget_path_iter_remove_class ()

void
gtk_widget_path_iter_remove_class (GtkWidgetPath *path,
                                   gint pos,
                                   const gchar *name);

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

Since: 3.0

gtk_widget_path_iter_remove_region ()

void
gtk_widget_path_iter_remove_region (GtkWidgetPath *path,
                                    gint pos,
                                    const gchar *name);

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

Since: 3.0

gtk_widget_path_iter_set_name ()

void
gtk_widget_path_iter_set_name (GtkWidgetPath *path,
                               gint pos,
                               const gchar *name);

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

Since: 3.0

gtk_widget_path_iter_set_object_name ()

void
gtk_widget_path_iter_set_object_name (GtkWidgetPath *path,
                                      gint pos,
                                      const char *name);

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.

Since: 3.20

gtk_widget_path_iter_set_object_type ()

void
gtk_widget_path_iter_set_object_type (GtkWidgetPath *path,
                                      gint pos,
                                      GType type);

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

Since: 3.0

gtk_widget_path_iter_set_state ()

void
gtk_widget_path_iter_set_state (GtkWidgetPath *path,
                                gint pos,
                                GtkStateFlags state);

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.

{
  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);
}

Since: 3.14

gtk_widget_path_length ()

gint
gtk_widget_path_length (const GtkWidgetPath *path);

Returns the number of GtkWidget GTypes between the represented widget and its topmost container.

Since: 3.0

gtk_widget_path_new ()

GtkWidgetPath *
gtk_widget_path_new (void);

Returns an empty widget path.

Since: 3.0

gtk_widget_path_prepend_type ()

void
gtk_widget_path_prepend_type (GtkWidgetPath *path,
                              GType type);

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

Since: 3.0

gtk_widget_path_to_string ()

char *
gtk_widget_path_to_string (const GtkWidgetPath *path);

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.

Since: 3.2

GtkWidgetPath

typedef struct _GtkWidgetPath GtkWidgetPath;