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 Widget.getPath, and the style context returned by Widget.getStyleContext 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.

class WidgetPath {

protected

GtkWidgetPath* gtkWidgetPath;

protected

bool ownedRef;

GtkWidgetPath* getWidgetPathStruct(bool transferOwnership);

void* getStruct();

this(GtkWidgetPath* gtkWidgetPath, bool ownedRef);

static GType getType();

this();

int appendForWidget(Widget widget);

int appendType(GType type);

int appendWithSiblings(WidgetPath siblings, uint siblingIndex);

WidgetPath copy();

void free();

GType getObjectType();

bool hasParent(GType type);

bool isType(GType type);

void iterAddClass(int pos, string name);

void iterAddRegion(int pos, string name, GtkRegionFlags flags);

void iterClearClasses(int pos);

void iterClearRegions(int pos);

string iterGetName(int pos);

string iterGetObjectName(int pos);

GType iterGetObjectType(int pos);

uint iterGetSiblingIndex(int pos);

WidgetPath iterGetSiblings(int pos);

GtkStateFlags iterGetState(int pos);

bool iterHasClass(int pos, string name);

bool iterHasName(int pos, string name);

bool iterHasQclass(int pos, GQuark qname);

bool iterHasQname(int pos, GQuark qname);

bool iterHasQregion(int pos, GQuark qname, GtkRegionFlags flags);

bool iterHasRegion(int pos, string name, GtkRegionFlags flags);

ListSG iterListClasses(int pos);

ListSG iterListRegions(int pos);

void iterRemoveClass(int pos, string name);

void iterRemoveRegion(int pos, string name);

void iterSetName(int pos, string name);

void iterSetObjectName(int pos, string name);

void iterSetObjectType(int pos, GType type);

void iterSetState(int pos, GtkStateFlags state);

int length();

void prependType(GType type);

WidgetPath ref_();

string toString();

void unref();

}

Constructors

this this(GtkWidgetPath* gtkWidgetPath, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Returns an empty widget path.

appendForWidget int appendForWidget(Widget 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.
appendType int appendType(GType type): Appends a widget type to the widget hierarchy represented by path.
appendWithSiblings int appendWithSiblings(WidgetPath siblings, uint siblingIndex): Appends a widget type with all its siblings to the widget hierarchy represented by path. Using this function instead of Widget.pathAppendType 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 Widget.resetStyle on all involved widgets when the siblings path changes.
copy WidgetPath copy(): Returns a copy of path
free void free(): Decrements the reference count on path, freeing the structure if the reference count reaches 0.
getObjectType GType getObjectType(): Returns the topmost object type, that is, the object type this path is representing.
getStruct void* getStruct(): the main Gtk struct as a void*
getWidgetPathStruct GtkWidgetPath* getWidgetPathStruct(bool transferOwnership): Get the main Gtk struct
hasParent bool hasParent(GType type): Returns TRUE if any of the parents of the widget represented in path is of type type, or any subtype of it.
isType bool isType(GType type): Returns TRUE if the widget type represented by this path is type, or a subtype of it.
iterAddClass void iterAddClass(int pos, string name): Adds the class name to the widget at position pos in the hierarchy defined in path. See Style.contextAddClass.
iterAddRegion void iterAddRegion(int pos, string name, GtkRegionFlags flags): Adds the region name to the widget at position pos in the hierarchy defined in path. See Style.contextAddRegion.
iterClearClasses void iterClearClasses(int pos): Removes all classes from the widget at position pos in the hierarchy defined in path.
iterClearRegions void iterClearRegions(int pos): Removes all regions from the widget at position pos in the hierarchy defined in path.
iterGetName string iterGetName(int pos): Returns the name corresponding to the widget found at the position pos in the widget hierarchy defined by path
iterGetObjectName string iterGetObjectName(int pos): Returns the object name that is at position pos in the widget hierarchy defined in path.
iterGetObjectType GType iterGetObjectType(int pos): Returns the object GType that is at position pos in the widget hierarchy defined in path.
iterGetSiblingIndex uint iterGetSiblingIndex(int pos): Returns the index into the list of siblings for the element at pos as returned by Widget.pathIterGetSiblings. If that function would return NULL because the element at pos has no siblings, this function will return 0.
iterGetSiblings WidgetPath iterGetSiblings(int pos): Returns the list of siblings for the element at pos. If the element was not added with siblings, NULL is returned.
iterGetState GtkStateFlags iterGetState(int pos): Returns the state flags corresponding to the widget found at the position pos in the widget hierarchy defined by path
iterHasClass bool iterHasClass(int pos, string name): Returns TRUE if the widget at position pos has the class name defined, FALSE otherwise.
iterHasName bool iterHasName(int pos, string name): Returns TRUE if the widget at position pos has the name name, FALSE otherwise.
iterHasQclass bool iterHasQclass(int pos, GQuark qname): See Widget.pathIterHasClass. This is a version that operates with GQuarks.
iterHasQname bool iterHasQname(int pos, GQuark qname): See Widget.pathIterHasName. This is a version that operates on GQuarks
iterHasQregion bool iterHasQregion(int pos, GQuark qname, GtkRegionFlags flags): See Widget.pathIterHasRegion. This is a version that operates with GQuarks.
iterHasRegion bool iterHasRegion(int pos, string name, GtkRegionFlags flags): Returns TRUE if the widget at position pos has the class name defined, FALSE otherwise.
iterListClasses ListSG iterListClasses(int pos): Returns a list with all the class names defined for the widget at position pos in the hierarchy defined in path.
iterListRegions ListSG iterListRegions(int pos): Returns a list with all the region names defined for the widget at position pos in the hierarchy defined in path.
iterRemoveClass void iterRemoveClass(int pos, string name): Removes the class name from the widget at position pos in the hierarchy defined in path.
iterRemoveRegion void iterRemoveRegion(int pos, string name): Removes the region name from the widget at position pos in the hierarchy defined in path.
iterSetName void iterSetName(int pos, string name): Sets the widget name for the widget found at position pos in the widget hierarchy defined by path.
iterSetObjectName void iterSetObjectName(int pos, string name): Sets the object name for a given position in the widget hierarchy defined by path.
iterSetObjectType void iterSetObjectType(int pos, GType type): Sets the object type for a given position in the widget hierarchy defined by path.
iterSetState void iterSetState(int pos, GtkStateFlags state): Sets the widget name for the widget found at position pos in the widget hierarchy defined by path.
length int length(): Returns the number of gtk.Widget GTypes between the represented widget and its topmost container.
prependType void prependType(GType type): Prepends a widget type to the widget hierachy represented by path.
ref_ WidgetPath ref_(): Increments the reference count on path.
toString string toString(): 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).
unref void unref(): Decrements the reference count on path, freeing the structure if the reference count reaches 0.