ThemingEngine

gtk.ThemingEngine was the object used for rendering themed content in GTK+ widgets. It used to allow overriding GTK+'s default implementation of rendering functions by allowing engines to be loaded as modules.

gtk.ThemingEngine has been deprecated in GTK+ 3.14 and will be ignored for rendering. The advancements in CSS theming are good enough to allow themers to achieve their goals without the need to modify source code.

class ThemingEngine : ObjectG {

protected

GtkThemingEngine* gtkThemingEngine;

GtkThemingEngine* getThemingEngineStruct(bool transferOwnership);

void* getStruct();

this(GtkThemingEngine* gtkThemingEngine, bool ownedRef);

static GType getType();

static ThemingEngine load(string name);

static void registerProperty(string nameSpace, GtkStylePropertyParser parseFunc, ParamSpec pspec);

void getBackgroundColor(GtkStateFlags state, RGBA color);

void getBorder(GtkStateFlags state, Border border);

void getBorderColor(GtkStateFlags state, RGBA color);

void getColor(GtkStateFlags state, RGBA color);

GtkTextDirection getDirection();

PgFontDescription getFont(GtkStateFlags state);

GtkJunctionSides getJunctionSides();

void getMargin(GtkStateFlags state, Border margin);

void getPadding(GtkStateFlags state, Border padding);

WidgetPath getPath();

void getProperty(string property, GtkStateFlags state, Value value);

Screen getScreen();

GtkStateFlags getState();

void getStyleProperty(string propertyName, Value value);

void getStyleValist(void* args);

void getValist(GtkStateFlags state, void* args);

bool hasClass(string styleClass);

bool hasRegion(string styleRegion, GtkRegionFlags flags);

bool lookupColor(string colorName, RGBA color);

bool stateIsRunning(GtkStateType state, double progress);

}

Constructors

this this(GtkThemingEngine* gtkThemingEngine, bool ownedRef): Sets our main struct and passes it to the parent class.

Members

Functions

getBackgroundColor void getBackgroundColor(GtkStateFlags state, RGBA color): Gets the background color for a given state.
getBorder void getBorder(GtkStateFlags state, Border border): Gets the border for a given state as a gtk.Border
getBorderColor void getBorderColor(GtkStateFlags state, RGBA color): Gets the border color for a given state.
getColor void getColor(GtkStateFlags state, RGBA color): Gets the foreground color for a given state.
getDirection GtkTextDirection getDirection(): Returns the widget direction used for rendering.
getFont PgFontDescription getFont(GtkStateFlags state): Returns the font description for a given state.
getJunctionSides GtkJunctionSides getJunctionSides(): Returns the widget direction used for rendering.
getMargin void getMargin(GtkStateFlags state, Border margin): Gets the margin for a given state as a gtk.Border
getPadding void getPadding(GtkStateFlags state, Border padding): Gets the padding for a given state as a gtk.Border
getPath WidgetPath getPath(): Returns the widget path used for style matching.
getProperty void getProperty(string property, GtkStateFlags state, Value value): Gets a property value as retrieved from the style settings that apply to the currently rendered element.
getScreen Screen getScreen(): Returns the gdk.Screen to which engine currently rendering to.
getState GtkStateFlags getState(): returns the state used when rendering.
getStruct void* getStruct(): the main Gtk struct as a void*
getStyleProperty void getStyleProperty(string propertyName, Value value): Gets the value for a widget style property.
getStyleValist void getStyleValist(void* args): Retrieves several widget style properties from engine according to the currently rendered content’s style.
getThemingEngineStruct GtkThemingEngine* getThemingEngineStruct(bool transferOwnership): Get the main Gtk struct
getValist void getValist(GtkStateFlags state, void* args): Retrieves several style property values that apply to the currently rendered element.
hasClass bool hasClass(string styleClass): Returns TRUE if the currently rendered contents have defined the given class name.
hasRegion bool hasRegion(string styleRegion, GtkRegionFlags flags): Returns TRUE if the currently rendered contents have the region defined. If flags_return is not NULL, it is set to the flags affecting the region.
lookupColor bool lookupColor(string colorName, RGBA color): Looks up and resolves a color name in the current style’s color map.
stateIsRunning bool stateIsRunning(GtkStateType state, double progress): Returns TRUE if there is a transition animation running for the current region (see Style.contextPushAnimatableRegion).

Static functions

getType GType getType()
load ThemingEngine load(string name): Loads and initializes a theming engine module from the standard directories.
registerProperty void registerProperty(string nameSpace, GtkStylePropertyParser parseFunc, ParamSpec pspec): Registers a property so it can be used in the CSS file format, on the CSS file the property will look like "-${`name_space`}-${property_name}". being ${property_name} the given to pspec. name_space will usually be the theme engine name.

Variables

gtkThemingEngine GtkThemingEngine* gtkThemingEngine;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
setProperty void setProperty(string propertyName, T value)
addOnNotify gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags): The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
getType GType getType()
compatControl size_t compatControl(size_t what, void* data)
interfaceFindProperty ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName): Find the gobject.ParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
interfaceInstallProperty void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec): Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created gobject.ParamSpec, but normally ObjectClass.overrideProperty will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
interfaceListProperties ParamSpec[] interfaceListProperties(TypeInterface gIface): Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
addToggleRef void addToggleRef(GToggleNotify notify, void* data): Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
addWeakPointer void addWeakPointer(void* weakPointerLocation): Adds a weak reference from weak_pointer to object to indicate that the pointer located at weak_pointer_location is only valid during the lifetime of object. When the object is finalized, weak_pointer will be set to NULL.
bindProperty Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags): Creates a binding between source_property on source and target_property on target. Whenever the source_property is changed the target_property is updated using the same value. For instance:
bindPropertyFull Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify): Complete version of g_object_bind_property().
bindPropertyWithClosures Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, 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.
dupData void* dupData(string key, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_data() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
dupQdata void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
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 g_object_ref_sink().
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 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 g_object_set_data()).
getProperty void getProperty(string propertyName, Value value): Gets a property of an object.
getQdata void* getQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata().
getValist void getValist(string firstPropertyName, void* varArgs): Gets properties of an object.
getv void getv(string[] names, 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(ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
ref_ ObjectG ref_(): Increases the reference count of object.
refSink ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
removeToggleRef void removeToggleRef(GToggleNotify notify, void* data): Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
removeWeakPointer void removeWeakPointer(void* weakPointerLocation): Removes a weak reference from object that was previously added using g_object_add_weak_pointer(). The weak_pointer_location has to match the one used with g_object_add_weak_pointer().
replaceData bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key key on object with oldval, and if they are the same, replaces oldval with newval.
replaceQdata bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key quark on object with oldval, and if they are the same, replaces oldval with newval.
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.
setDataFull void setDataFull(string key, void* data, GDestroyNotify destroy): Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
setProperty void setProperty(string propertyName, Value value): Sets a property on an object.
setQdata void setQdata(GQuark quark, void* data): This sets an opaque, named pointer on an object. The name is specified through a GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the object with g_object_get_qdata() until the object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.
setQdataFull void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy): This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same quark.
setValist void setValist(string firstPropertyName, void* varArgs): Sets properties on an object.
setv void setv(string[] names, Value[] values): Sets n_properties properties for an object. Properties to be set will be taken from values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
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(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata() 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 g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
unref void unref(): Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
watchClosure void watchClosure(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 Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_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.
weakRef void weakRef(GWeakNotify notify, void* data): Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakUnref void weakUnref(GWeakNotify notify, void* data): Removes a weak reference callback to an object.
clearObject void clearObject(ObjectG objectPtr): Clears a reference to a GObject

gtk ThemingEngine classes

ThemingEngine