Style

A #GtkStyle object encapsulates the information that provides the look and feel for a widget.

> In GTK+ 3.0, GtkStyle has been deprecated and replaced by > #GtkStyleContext.

Each #GtkWidget has an associated #GtkStyle object that is used when rendering that widget. Also, a #GtkStyle holds information for the five possible widget states though not every widget supports all five states; see #GtkStateType.

Usually the #GtkStyle for a widget is the same as the default style that is set by GTK+ and modified the theme engine.

Usually applications should not need to use or modify the #GtkStyle of their widgets.

class Style : ObjectG {

protected

GtkStyle* gtkStyle;

GtkStyle* getStyleStruct(bool transferOwnership);

void* getStruct();

this(GtkStyle* gtkStyle, bool ownedRef);

static GType getType();

this();

void applyDefaultBackground(Context cr, Window window, GtkStateType stateType, int x, int y, int width, int height);

Style attach(Window window);

Style copy();

void detach();

void getStyleProperty(GType widgetType, string propertyName, Value value);

void getValist(GType widgetType, string firstPropertyName, void* varArgs);

bool hasContext();

bool lookupColor(string colorName, Color color);

IconSet lookupIconSet(string stockId);

Pixbuf renderIcon(IconSource source, GtkTextDirection direction, GtkStateType state, GtkIconSize size, Widget widget, string detail);

void setBackground(Window window, GtkStateType stateType);

gulong addOnRealize(void delegate(Style) dlg, ConnectFlags connectFlags);

gulong addOnUnrealize(void delegate(Style) dlg, ConnectFlags connectFlags);

static void paintArrow(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, GtkArrowType arrowType, bool fill, int x, int y, int width, int height);

static void paintBox(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height);

static void paintBoxGap(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height, GtkPositionType gapSide, int gapX, int gapWidth);

static void paintCheck(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height);

static void paintDiamond(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height);

static void paintExpander(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, int x, int y, GtkExpanderStyle expanderStyle);

static void paintExtension(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height, GtkPositionType gapSide);

static void paintFlatBox(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height);

static void paintFocus(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, int x, int y, int width, int height);

static void paintHandle(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height, GtkOrientation orientation);

static void paintHline(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, int x1, int x2, int y);

static void paintLayout(Style style, Context cr, GtkStateType stateType, bool useText, Widget widget, string detail, int x, int y, PgLayout layout);

static void paintOption(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height);

static void paintResizeGrip(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, GdkWindowEdge edge, int x, int y, int width, int height);

static void paintShadow(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height);

static void paintShadowGap(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height, GtkPositionType gapSide, int gapX, int gapWidth);

static void paintSlider(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height, GtkOrientation orientation);

static void paintSpinner(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, uint step, int x, int y, int width, int height);

static void paintTab(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height);

static void paintVline(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, int y1, int y2, int x);

}

Constructors

this this(GtkStyle* gtkStyle, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new #GtkStyle.

Members

Functions

addOnRealize gulong addOnRealize(void delegate(Style) dlg, ConnectFlags connectFlags): Emitted when the style has been initialized for a particular visual. Connecting to this signal is probably seldom useful since most of the time applications and widgets only deal with styles that have been already realized.
addOnUnrealize gulong addOnUnrealize(void delegate(Style) dlg, ConnectFlags connectFlags): Emitted when the aspects of the style specific to a particular visual is being cleaned up. A connection to this signal can be useful if a widget wants to cache objects as object data on #GtkStyle. This signal provides a convenient place to free such cached objects.
applyDefaultBackground void applyDefaultBackground(Context cr, Window window, GtkStateType stateType, int x, int y, int width, int height)
attach Style attach(Window window): Attaches a style to a window; this process allocates the colors and creates the GC’s for the style - it specializes it to a particular visual. The process may involve the creation of a new style if the style has already been attached to a window with a different style and visual.
copy Style copy(): Creates a copy of the passed in #GtkStyle object.
detach void detach(): Detaches a style from a window. If the style is not attached to any windows anymore, it is unrealized. See gtk_style_attach().
getStruct void* getStruct(): the main Gtk struct as a void*
getStyleProperty void getStyleProperty(GType widgetType, string propertyName, Value value): Queries the value of a style property corresponding to a widget class is in the given style.
getStyleStruct GtkStyle* getStyleStruct(bool transferOwnership): Get the main Gtk struct
getValist void getValist(GType widgetType, string firstPropertyName, void* varArgs): Non-vararg variant of gtk_style_get(). Used primarily by language bindings.
hasContext bool hasContext(): Returns whether @style has an associated #GtkStyleContext.
lookupColor bool lookupColor(string colorName, Color color): Looks up @color_name in the style’s logical color mappings, filling in @color and returning %TRUE if found, otherwise returning %FALSE. Do not cache the found mapping, because it depends on the #GtkStyle and might change when a theme switch occurs.
lookupIconSet IconSet lookupIconSet(string stockId): Looks up @stock_id in the icon factories associated with @style and the default icon factory, returning an icon set if found, otherwise %NULL.
renderIcon Pixbuf renderIcon(IconSource source, GtkTextDirection direction, GtkStateType state, GtkIconSize size, Widget widget, string detail): Renders the icon specified by @source at the given @size according to the given parameters and returns the result in a pixbuf.
setBackground void setBackground(Window window, GtkStateType stateType): Sets the background of @window to the background color or pixmap specified by @style for the given state.

Static functions

getType GType getType()
paintArrow void paintArrow(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, GtkArrowType arrowType, bool fill, int x, int y, int width, int height): Draws an arrow in the given rectangle on @cr using the given parameters. @arrow_type determines the direction of the arrow.
paintBox void paintBox(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height): Draws a box on @cr with the given parameters.
paintBoxGap void paintBoxGap(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height, GtkPositionType gapSide, int gapX, int gapWidth): Draws a box in @cr using the given style and state and shadow type, leaving a gap in one side.
paintCheck void paintCheck(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height): Draws a check button indicator in the given rectangle on @cr with the given parameters.
paintDiamond void paintDiamond(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height): Draws a diamond in the given rectangle on @window using the given parameters.
paintExpander void paintExpander(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, int x, int y, GtkExpanderStyle expanderStyle): Draws an expander as used in #GtkTreeView. @x and @y specify the center the expander. The size of the expander is determined by the “expander-size” style property of @widget. (If widget is not specified or doesn’t have an “expander-size” property, an unspecified default size will be used, since the caller doesn't have sufficient information to position the expander, this is likely not useful.) The expander is expander_size pixels tall in the collapsed position and expander_size pixels wide in the expanded position.
paintExtension void paintExtension(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height, GtkPositionType gapSide): Draws an extension, i.e. a notebook tab.
paintFlatBox void paintFlatBox(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height): Draws a flat box on @cr with the given parameters.
paintFocus void paintFocus(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, int x, int y, int width, int height): Draws a focus indicator around the given rectangle on @cr using the given style.
paintHandle void paintHandle(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height, GtkOrientation orientation): Draws a handle as used in #GtkHandleBox and #GtkPaned.
paintHline void paintHline(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, int x1, int x2, int y): Draws a horizontal line from (@x1, @y) to (@x2, @y) in @cr using the given style and state.
paintLayout void paintLayout(Style style, Context cr, GtkStateType stateType, bool useText, Widget widget, string detail, int x, int y, PgLayout layout): Draws a layout on @cr using the given parameters.
paintOption void paintOption(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height): Draws a radio button indicator in the given rectangle on @cr with the given parameters.
paintResizeGrip void paintResizeGrip(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, GdkWindowEdge edge, int x, int y, int width, int height): Draws a resize grip in the given rectangle on @cr using the given parameters.
paintShadow void paintShadow(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height): Draws a shadow around the given rectangle in @cr using the given style and state and shadow type.
paintShadowGap void paintShadowGap(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height, GtkPositionType gapSide, int gapX, int gapWidth): Draws a shadow around the given rectangle in @cr using the given style and state and shadow type, leaving a gap in one side.
paintSlider void paintSlider(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height, GtkOrientation orientation): Draws a slider in the given rectangle on @cr using the given style and orientation.
paintSpinner void paintSpinner(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, uint step, int x, int y, int width, int height): Draws a spinner on @window using the given parameters.
paintTab void paintTab(Style style, Context cr, GtkStateType stateType, GtkShadowType shadowType, Widget widget, string detail, int x, int y, int width, int height): Draws an option menu tab (i.e. the up and down pointing arrows) in the given rectangle on @cr using the given parameters.
paintVline void paintVline(Style style, Context cr, GtkStateType stateType, Widget widget, string detail, int y1, int y2, int x): Draws a vertical line from (@x, @y1_) to (@x, @y2_) in @cr using the given style and state.

Variables

gtkStyle GtkStyle* gtkStyle;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
ownedRef bool ownedRef;: Undocumented in source.
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
isGcRoot bool isGcRoot;: Undocumented in source.
signals DClosure[gulong] signals;: Undocumented in source.
destroyNotify void destroyNotify(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
toggleNotify void toggleNotify(ObjectG obj, GObject* object, int isLastRef): Undocumented in source. Be warned that the author may not have intended to support it.
~this ~this(): Undocumented in source.
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
removeGcRoot void removeGcRoot(): Undocumented in source. Be warned that the author may not have intended to support it.
setProperty void setProperty(string propertyName, T value)
unref deprecated void unref(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
doref deprecated ObjectG doref(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
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 #GParamSpec 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 #GParamSpec, but normally g_object_class_override_property() 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 #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 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.
doref alias doref = ref_: Undocumented in source.
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: |[ void object_add_to_user_list (GObject *object, const gchar *new_string) { // the quark, naming the object data GQuark quark_string_list = g_quark_from_static_string ("my-string-list"); // retrive the old string list GList *list = g_object_steal_qdata (object, quark_string_list);
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 g_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.