StyleContext

gtk.style_context.StyleContext stores styling information affecting a widget.

In order to construct the final style information, gtk.style_context.StyleContext queries information from all attached GtkStyleProviders. Style providers can be either attached explicitly to the context through gtk.style_context.StyleContext.addProvider, or to the display through gtk.style_context.StyleContext.addProviderForDisplay. The resulting style is a combination of all providers’ information in priority order.

For GTK widgets, any gtk.style_context.StyleContext returned by gtk.widget.Widget.getStyleContext will already have a gdk.display.Display and RTL/LTR information set. The style context will also be updated automatically if any of these settings change on the widget.

Style Classes

Widgets can add style classes to their context, which can be used to associate different styles by class. The documentation for individual widgets lists which style classes it uses itself, and which style classes may be added by applications to affect their appearance.

Custom styling in UI libraries and applications

If you are developing a library with custom widgets that render differently than standard components, you may need to add a gtk.style_provider.StyleProvider yourself with the GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority, either a gtk.css_provider.CssProvider or a custom object implementing the gtk.style_provider.StyleProvider interface. This way themes may still attempt to style your UI elements in a different way if needed so.

If you are using custom styling on an applications, you probably want then to make your style information prevail to the theme’s, so you must use a gtk.style_provider.StyleProvider with the GTK_STYLE_PROVIDER_PRIORITY_APPLICATION priority, keep in mind that the user settings in XDG_CONFIG_HOME/gtk-4.0/gtk.css will still take precedence over your changes, as it uses the GTK_STYLE_PROVIDER_PRIORITY_USER priority.

More...

Members

Functions

addClass
void addClass(string className)

Adds a style class to context, so later uses of the style context will make use of this new class for styling.

addProvider
void addProvider(gtk.style_provider.StyleProvider provider, uint priority)

Adds a style provider to context, to be used in style construction.

getBorder
void getBorder(gtk.border.Border border)

Gets the border for a given state as a gtk.border.Border.

getColor
void getColor(gdk.rgba.RGBA color)

Gets the foreground color for a given state.

getDisplay
gdk.display.Display getDisplay()

Returns the gdk.display.Display to which context is attached.

getMargin
void getMargin(gtk.border.Border margin)

Gets the margin for a given state as a gtk.border.Border.

getPadding
void getPadding(gtk.border.Border padding)

Gets the padding for a given state as a gtk.border.Border.

getScale
int getScale()

Returns the scale used for assets.

getState
gtk.types.StateFlags getState()

Returns the state used for style matching.

hasClass
bool hasClass(string className)

Returns true if context currently has defined the given class name.

lookupColor
bool lookupColor(string colorName, gdk.rgba.RGBA color)

Looks up and resolves a color name in the context color map.

removeClass
void removeClass(string className)

Removes class_name from context.

removeProvider
void removeProvider(gtk.style_provider.StyleProvider provider)

Removes provider from the style providers list in context.

restore
void restore()

Restores context state to a previous stage.

save
void save()

Saves the context state.

setDisplay
void setDisplay(gdk.display.Display display)

Attaches context to the given display.

setScale
void setScale(int scale)

Sets the scale to use when getting image assets for the style.

setState
void setState(gtk.types.StateFlags flags)

Sets the state to be used for style matching.

toString_
string toString_(gtk.types.StyleContextPrintFlags flags)

Converts the style context into a string representation.

Static functions

addProviderForDisplay
void addProviderForDisplay(gdk.display.Display display, gtk.style_provider.StyleProvider provider, uint priority)

Adds a global style provider to display, which will be used in style construction for all GtkStyleContexts under display.

removeProviderForDisplay
void removeProviderForDisplay(gdk.display.Display display, gtk.style_provider.StyleProvider provider)

Removes provider from the global style providers list in display.

Inherited Members

From ObjectG

setGObject
void setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectG wrapper.

cPtr
void* cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

ref_
void* ref_(void* gObj)

Calls g_object_ref() on a GObject.

unref
unref(void* gObj)

Calls g_object_unref() on a GObject.

getType
GType getType()

Get the GType of an object.

gType
GType gType [@property getter]

GObject GType property.

self
ObjectG self()

Convenience method to return this cast to a type. For use in D with statements.

getDObject
T getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.

Detailed Description

Deprecated: The relevant API has been moved to gtk.widget.Widget where applicable; otherwise, there is no replacement for querying the style machinery. Stylable UI elements should use widgets.