CssProvider

GtkCssProvider is an object implementing the #GtkStyleProvider interface. It is able to parse [CSS-like][css-overview] input in order to style widgets.

An application can make GTK+ parse a specific CSS style sheet by calling gtk.css_provider.CssProvider.loadFromFile or gtk.css_provider.CssProvider.loadFromResource and adding the provider with gtk.style_context.StyleContext.addProvider or gtk.style_context.StyleContext.addProviderForScreen.

In addition, certain files will be read when GTK+ is initialized. First, the file $XDG_CONFIG_HOME/gtk-3.0/gtk.css is loaded if it exists. Then, GTK+ loads the first existing file among XDG_DATA_HOME/themes/THEME/gtk-VERSION/gtk.css, $HOME/.themes/THEME/gtk-VERSION/gtk.css, $XDG_DATA_DIRS/themes/THEME/gtk-VERSION/gtk.css and DATADIR/share/themes/THEME/gtk-VERSION/gtk.css, where THEME is the name of the current theme (see the #GtkSettings:gtk-theme-name setting), DATADIR is the prefix configured when GTK+ was compiled (unless overridden by the GTK_DATA_PREFIX environment variable), and VERSION is the GTK+ version number. If no file is found for the current version, GTK+ tries older versions all the way back to 3.0.

In the same way, GTK+ tries to load a gtk-keys.css file for the current key theme, as defined by #GtkSettings:gtk-key-theme-name.

class CssProvider : ObjectWrap , StyleProvider {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

CssProvider self();

static CssProviderGidBuilder builder();

this();

static gtk.css_provider.CssProvider getDefault();

static gtk.css_provider.CssProvider getNamed(string name, string variant);

bool loadFromData(ubyte[] data);

bool loadFromFile(gio.file.File file);

bool loadFromPath(string path);

void loadFromResource(string resourcePath);

string toString_();

gulong connectParsingError(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Returns a newly created #GtkCssProvider.

Members

Functions

connectParsingError gulong connectParsingError(T callback, Flag!"After" after): Connect to ParsingError signal.
loadFromData bool loadFromData(ubyte[] data): Loads data into css_provider, and by doing so clears any previously loaded information.
loadFromFile bool loadFromFile(gio.file.File file): Loads the data contained in file into css_provider, making it clear any previously loaded information.
loadFromPath bool loadFromPath(string path): Loads the data contained in path into css_provider, making it clear any previously loaded information.
loadFromResource void loadFromResource(string resourcePath): Loads the data contained in the resource at resource_path into the #GtkCssProvider, clearing any previously loaded information.
self CssProvider self(): Returns this, for use in with statements.
toString_ string toString_(): Converts the provider into a string representation in CSS format.

Properties

_gType GType _gType [@property getter]

Static functions

_getGType GType _getGType()
builder CssProviderGidBuilder builder(): Get builder for gtk.css_provider.CssProvider
getDefault gtk.css_provider.CssProvider getDefault(): Returns the provider containing the style settings used as a fallback for all widgets.
getNamed gtk.css_provider.CssProvider getNamed(string name, string variant): Loads a theme from the usual theme paths

Mixed In Members

From `mixin StyleProviderT!()`

getIconFactory gtk.icon_factory.IconFactory getIconFactory(gtk.widget_path.WidgetPath path): Returns the #GtkIconFactory defined to be in use for path, or null if none is defined.
getStyle gtk.style_properties.StyleProperties getStyle(gtk.widget_path.WidgetPath path): Returns the style settings affecting a widget defined by path, or null if provider doesn’t contemplate styling path.
getStyleProperty bool getStyleProperty(gtk.widget_path.WidgetPath path, gtk.types.StateFlags state, gobject.param_spec.ParamSpec pspec, gobject.value.Value value): Looks up a widget style property as defined by provider for the widget represented by path.

Inherited Members

From ObjectWrap

_setGObject void _setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectWrap 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.
_getGType GType _getGType(): Get the GType of an object.
_gType GType _gType [@property getter]: GObject GType property.
self ObjectWrap 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 gulong 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.ObjectWrap 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.ObjectWrap 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.ObjectWrap.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.ObjectWrap.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.ObjectWrap.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.ObjectWrap 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.ObjectWrap.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.ObjectWrap.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.ObjectWrap.ref_ and gobject.object.ObjectWrap.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 gulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

From StyleProvider

_getGType GType _getGType()
getIconFactory gtk.icon_factory.IconFactory getIconFactory(gtk.widget_path.WidgetPath path): Returns the #GtkIconFactory defined to be in use for path, or null if none is defined.
getStyle gtk.style_properties.StyleProperties getStyle(gtk.widget_path.WidgetPath path): Returns the style settings affecting a widget defined by path, or null if provider doesn’t contemplate styling path.
getStyleProperty bool getStyleProperty(gtk.widget_path.WidgetPath path, gtk.types.StateFlags state, gobject.param_spec.ParamSpec pspec, gobject.value.Value value): Looks up a widget style property as defined by provider for the widget represented by path.

gtk css_provider classes

CssProvider

From mixin StyleProviderT!()

From `mixin StyleProviderT!()`