StyleContext

GtkStyleContext is an object that stores styling information affecting a widget defined by GtkWidgetPath.

In order to construct the final style information, GtkStyleContext queries information from all attached GtkStyleProviders. Style providers can be either attached explicitly to the context through gtk_style_context_add_provider(), or to the screen through gtk_style_context_add_provider_for_screen(). The resulting style is a combination of all providers' information in priority order.

For GTK+ widgets, any GtkStyleContext returned by gtk_widget_get_style_context() will already have a GtkWidgetPath, a GdkScreen and RTL/LTR information set. The style context will be also updated automatically if any of these settings change on the widget.

If you are using the theming layer standalone, you will need to set a widget path and a screen yourself to the created style context through gtk_style_context_set_path() and gtk_style_context_set_screen(), as well as updating the context yourself using gtk_style_context_invalidate() whenever any of the conditions change, such as a change in the "gtk-theme-name" setting or a hierarchy change in the rendered widget.

Transition animations

GtkStyleContext has built-in support for state change transitions. Note that these animations respect the "gtk-enable-animations" setting.

For simple widgets where state changes affect the whole widget area, calling gtk_style_context_notify_state_change() with a NULL region is sufficient to trigger the transition animation. And GTK+ already does that when gtk_widget_set_state() or gtk_widget_set_state_flags() are called.

If a widget needs to declare several animatable regions (i.e. not affecting the whole widget area), its "draw" signal handler needs to wrap the render operations for the different regions with calls to gtk_style_context_push_animatable_region() and gtk_style_context_pop_animatable_region(). These functions take an identifier for the region which must be unique within the style context. For simple widgets with a fixed set of animatable regions, using an enumeration works well:

For complex widgets with an arbitrary number of animatable regions, it is up to the implementation to come up with a way to uniquely identify each animatable region. Using pointers to internal structs is one way to achieve this:

The widget also needs to notify the style context about a state change for a given animatable region so the animation is triggered.

gtk_style_context_notify_state_change() accepts NULL region IDs as a special value, in this case, the whole widget area will be updated by the animation.

<hr>

Style classes and regions

Widgets can add style classes to their context, which can be used to associate different styles by class (see the section called “Selectors”). Theme engines can also use style classes to vary their rendering. GTK+ has a number of predefined style classes: GTK_STYLE_CLASS_CELL, GTK_STYLE_CLASS_ENTRY, GTK_STYLE_CLASS_BUTTON, GTK_STYLE_CLASS_COMBOBOX_ENTRY, GTK_STYLE_CLASS_CALENDAR, GTK_STYLE_CLASS_SLIDER, GTK_STYLE_CLASS_BACKGROUND, GTK_STYLE_CLASS_RUBBERBAND, GTK_STYLE_CLASS_TOOLTIP, GTK_STYLE_CLASS_MENU, GTK_STYLE_CLASS_MENUBAR, GTK_STYLE_CLASS_MENUITEM, GTK_STYLE_CLASS_TOOLBAR, GTK_STYLE_CLASS_PRIMARY_TOOLBAR, GTK_STYLE_CLASS_INLINE_TOOLBAR, GTK_STYLE_CLASS_RADIO, GTK_STYLE_CLASS_CHECK, GTK_STYLE_CLASS_TROUGH, GTK_STYLE_CLASS_SCROLLBAR, GTK_STYLE_CLASS_SCALE, GTK_STYLE_CLASS_SCALE_HAS_MARKS_ABOVE, GTK_STYLE_CLASS_SCALE_HAS_MARKS_BELOW, GTK_STYLE_CLASS_HEADER, GTK_STYLE_CLASS_ACCELERATOR, GTK_STYLE_CLASS_GRIP, GTK_STYLE_CLASS_DOCK, GTK_STYLE_CLASS_PROGRESSBAR, GTK_STYLE_CLASS_SPINNER, GTK_STYLE_CLASS_EXPANDER, GTK_STYLE_CLASS_SPINBUTTON, GTK_STYLE_CLASS_NOTEBOOK, GTK_STYLE_CLASS_VIEW, GTK_STYLE_CLASS_SIDEBAR, GTK_STYLE_CLASS_IMAGE, GTK_STYLE_CLASS_HIGHLIGHT, GTK_STYLE_CLASS_FRAME, GTK_STYLE_CLASS_DND, GTK_STYLE_CLASS_PANE_SEPARATOR, GTK_STYLE_CLASS_SEPARATOR, GTK_STYLE_CLASS_INFO, GTK_STYLE_CLASS_WARNING, GTK_STYLE_CLASS_QUESTION, GTK_STYLE_CLASS_ERROR, GTK_STYLE_CLASS_HORIZONTAL, GTK_STYLE_CLASS_VERTICAL, GTK_STYLE_CLASS_TOP, GTK_STYLE_CLASS_BOTTOM, GTK_STYLE_CLASS_LEFT, GTK_STYLE_CLASS_RIGHT,

Widgets can also add regions with flags to their context. The regions used by GTK+ widgets are:

Region Flags Macro Used by

row even, odd GTK_STYLE_REGION_ROW GtkTreeView

column first, last, sorted GTK_STYLE_REGION_COLUMN GtkTreeView

column-header

GTK_STYLE_REGION_COLUMN_HEADER

tab even, odd, first, last GTK_STYLE_REGION_TAB GtkNotebook

<hr>

Custom styling in UI libraries and applications

If you are developing a library with custom GtkWidgets that render differently than standard components, you may need to add a GtkStyleProvider yourself with the GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority, either a GtkCssProvider or a custom object implementing the GtkStyleProvider interface. This way theming engines 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 GtkStyleProvider with the GTK_STYLE_PROVIDER_PRIORITY_APPLICATION priority, keep in mind that the user settings in XDG_CONFIG_HOME/gtk-3.0/gtk.css will still take precedence over your changes, as it uses the GTK_STYLE_PROVIDER_PRIORITY_USER priority.

If a custom theming engine is needed, you probably want to implement a GtkStyleProvider yourself so it points to your GtkThemingEngine implementation, as GtkCssProvider uses gtk_theming_engine_load() which loads the theming engine module from the standard paths.

class StyleContext : ObjectG {}

Constructors

this
this(GtkStyleContext* gtkStyleContext)

Sets our main struct and passes it to the parent class

this
this()

Creates a standalone GtkStyleContext, this style context won't be attached to any widget, so you may want to call gtk_style_context_set_path() yourself. Note This function is only useful when using the theming layer separated from GTK+, if you are using GtkStyleContext to theme GtkWidgets, use gtk_widget_get_style_context() in order to get a style context ready to theme the widget.

Members

Functions

addClass
void addClass(string className)

Adds a style class to context, so posterior calls to gtk_style_context_get() or any of the gtk_render_*() functions will make use of this new class for styling. In the CSS file format, a GtkEntry defining an "entry"

addOnChanged
void addOnChanged(void delegate(StyleContext) dlg, ConnectFlags connectFlags)
addProvider
void addProvider(StyleProviderIF provider, uint priority)

Adds a style provider to context, to be used in style construction. Note that a style provider added by this function only affects the style of the widget to which context belongs. If you want to affect the style of all widgets, use gtk_style_context_add_provider_for_screen(). Note If both priorities are the same, A GtkStyleProvider added through this function takes precedence over another added through gtk_style_context_add_provider_for_screen().

addRegion
void addRegion(string regionName, GtkRegionFlags flags)

Adds a region to context, so posterior calls to gtk_style_context_get() or any of the gtk_render_*() functions will make use of this new region for styling. In the CSS file format, a GtkTreeView defining a "row"

cancelAnimations
void cancelAnimations(void* regionId)

Warning gtk_style_context_cancel_animations has been deprecated since version 3.6 and should not be used in newly-written code. This function does nothing. Stops all running animations for region_id and all animatable regions underneath. A NULL region_id will stop all ongoing animations in context, when dealing with a GtkStyleContext obtained through gtk_widget_get_style_context(), this is normally done for you in all circumstances you would expect all widget to be stopped, so this should be only used in complex widgets with different animatable regions.

getBackgroundColor
void getBackgroundColor(GtkStateFlags state, RGBA color)

Gets the background color for a given state.

getBorder
void getBorder(GtkStateFlags state, GtkBorder border)

Gets the border for a given state as a GtkBorder. See GTK_STYLE_PROPERTY_BORDER_WIDTH.

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()

Warning gtk_style_context_get_direction has been deprecated since version 3.8 and should not be used in newly-written code. Use gtk_style_context_get_state() and check for GTK_STATE_FLAG_DIR_LTR and GTK_STATE_FLAG_DIR_RTL instead. Returns the widget direction used for rendering.

getFont
PgFontDescription getFont(GtkStateFlags state)

Warning gtk_style_context_get_font has been deprecated since version 3.8 and should not be used in newly-written code. Use gtk_style_context_get() for "font" or subproperties instead. Returns the font description for a given state. The returned object is const and will remain valid until the "changed" signal happens.

getFrameClock
FrameClock getFrameClock()

Returns the GdkFrameClock to which context is attached.

getJunctionSides
GtkJunctionSides getJunctionSides()

Returns the sides where rendered elements connect visually with others.

getMargin
void getMargin(GtkStateFlags state, GtkBorder margin)

Gets the margin for a given state as a GtkBorder. See GTK_STYLE_PROPERTY_MARGIN.

getPadding
void getPadding(GtkStateFlags state, GtkBorder padding)

Gets the padding for a given state as a GtkBorder. See GTK_STYLE_PROPERTY_PADDING.

getParent
StyleContext getParent()

Gets the parent context set via gtk_style_context_set_parent(). See that function for details.

getPath
WidgetPath getPath()

Returns the widget path used for style matching.

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

Gets a style property from context for the given state. When value is no longer needed, g_value_unset() must be called to free any allocated memory.

getScale
int getScale()

Returns the scale used for assets.

getScreen
Screen getScreen()

Returns the GdkScreen to which context is attached.

getSection
CssSection getSection(string property)

Queries the location in the CSS where property was defined for the current context. Note that the state to be queried is taken from gtk_style_context_get_state(). If the location is not available, NULL will be returned. The location might not be available for various reasons, such as the property being overridden, property not naming a supported CSS property or tracking of definitions being disabled for performance reasons. Shorthand CSS properties cannot be queried for a location and will always return NULL.

getState
GtkStateFlags getState()

Returns the state used when rendering.

getStruct
void* getStruct()

the main Gtk struct as a void*

getStyleContextStruct
GtkStyleContext* getStyleContextStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStyleProperty
void getStyleProperty(string propertyName, Value value)

Gets the value for a widget style property. When value is no longer needed, g_value_unset() must be called to free any allocated memory.

getStyleValist
void getStyleValist(void* args)

Retrieves several widget style properties from context according to the current style.

getValist
void getValist(GtkStateFlags state, void* args)

Retrieves several style property values from context for a given state.

hasClass
int hasClass(string className)

Returns TRUE if context currently has defined the given class name

hasRegion
int hasRegion(string regionName, GtkRegionFlags* flagsReturn)

Returns TRUE if context has the region defined. If flags_return is not NULL, it is set to the flags affecting the region.

invalidate
void invalidate()

Invalidates context style information, so it will be reconstructed again. If you're using a GtkStyleContext returned from gtk_widget_get_style_context(), you do not need to call this yourself.

listClasses
ListG listClasses()

Returns the list of classes currently defined in context.

listRegions
ListG listRegions()

Returns the list of regions currently defined in context.

lookupColor
int lookupColor(string colorName, RGBA color)

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

lookupIconSet
IconSet lookupIconSet(string stockId)

Warning gtk_style_context_lookup_icon_set has been deprecated since version 3.10 and should not be used in newly-written code. Use gtk_icon_theme_lookup_icon() instead. Looks up stock_id in the icon factories associated to context and the default icon factory, returning an icon set if found, otherwise NULL.

notifyStateChange
void notifyStateChange(Window window, void* regionId, GtkStateType state, int stateValue)

Warning gtk_style_context_notify_state_change has been deprecated since version 3.6 and should not be used in newly-written code. This function does nothing. Notifies a state change on context, so if the current style makes use of transition animations, one will be started so all rendered elements under region_id are animated for state state being set to value state_value. The window parameter is used in order to invalidate the rendered area as the animation runs, so make sure it is the same window that is being rendered on by the gtk_render_*() functions. If region_id is NULL, all rendered elements using context will be affected by this state transition. As a practical example, a GtkButton notifying a state transition on

popAnimatableRegion
void popAnimatableRegion()

Warning gtk_style_context_pop_animatable_region has been deprecated since version 3.6 and should not be used in newly-written code. This function does nothing. Pops an animatable region from context. See gtk_style_context_push_animatable_region().

pushAnimatableRegion
void pushAnimatableRegion(void* regionId)

Warning gtk_style_context_push_animatable_region has been deprecated since version 3.6 and should not be used in newly-written code. This function does nothing. Pushes an animatable region, so all further gtk_render_*() calls between this call and the following gtk_style_context_pop_animatable_region() will potentially show transition animations for this region if gtk_style_context_notify_state_change() is called for a given state, and the current theme/style defines transition animations for state changes. The region_id used must be unique in context so the theming engine can uniquely identify rendered elements subject to a state transition.

removeClass
void removeClass(string className)

Removes class_name from context.

removeProvider
void removeProvider(StyleProviderIF provider)

Removes provider from the style providers list in context.

removeRegion
void removeRegion(string regionName)

Removes a region from context.

renderActivity
void renderActivity(Context cr, double x, double y, double width, double height)

Renders an activity area (Such as in GtkSpinner or the fill line in GtkRange), the state GTK_STATE_FLAG_ACTIVE determines whether there is activity going on.

renderArrow
void renderArrow(Context cr, double angle, double x, double y, double size)

Renders an arrow pointing to angle.

renderBackground
void renderBackground(Context cr, double x, double y, double width, double height)

Renders the background of an element.

renderCheck
void renderCheck(Context cr, double x, double y, double width, double height)

Renders a checkmark (as in a GtkCheckButton). The GTK_STATE_FLAG_ACTIVE state determines whether the check is on or off, and GTK_STATE_FLAG_INCONSISTENT determines whether it should be marked as undefined.

renderExpander
void renderExpander(Context cr, double x, double y, double width, double height)

Renders an expander (as used in GtkTreeView and GtkExpander) in the area defined by x, y, width, height. The state GTK_STATE_FLAG_ACTIVE determines whether the expander is collapsed or expanded.

renderExtension
void renderExtension(Context cr, double x, double y, double width, double height, GtkPositionType gapSide)

Renders a extension (as in a GtkNotebook tab) in the rectangle defined by x, y, width, height. The side where the extension connects to is defined by gap_side.

renderFocus
void renderFocus(Context cr, double x, double y, double width, double height)

Renders a focus indicator on the rectangle determined by x, y, width, height.

renderFrame
void renderFrame(Context cr, double x, double y, double width, double height)

Renders a frame around the rectangle defined by x, y, width, height.

renderFrameGap
void renderFrameGap(Context cr, double x, double y, double width, double height, GtkPositionType gapSide, double xy0_Gap, double xy1_Gap)

Renders a frame around the rectangle defined by (x, y, width, height), leaving a gap on one side. xy0_gap and xy1_gap will mean X coordinates for GTK_POS_TOP and GTK_POS_BOTTOM gap sides, and Y coordinates for GTK_POS_LEFT and GTK_POS_RIGHT.

renderHandle
void renderHandle(Context cr, double x, double y, double width, double height)

Renders a handle (as in GtkHandleBox, GtkPaned and GtkWindow's resize grip), in the rectangle determined by x, y, width, height.

renderIcon
void renderIcon(Context cr, Pixbuf pixbuf, double x, double y)

Renders the icon in pixbuf at the specified x and y coordinates.

renderIconPixbuf
Pixbuf renderIconPixbuf(IconSource source, GtkIconSize size)

Warning gtk_render_icon_pixbuf has been deprecated since version 3.10 and should not be used in newly-written code. Use gtk_icon_theme_load_icon() instead. Renders the icon specified by source at the given size, returning the result in a pixbuf.

renderIconSurface
void renderIconSurface(Context cr, Surface surface, double x, double y)

Renders the icon in surface at the specified x and y coordinates.

renderInsertionCursor
void renderInsertionCursor(Context cr, double x, double y, PgLayout layout, int index, PangoDirection direction)

Draws a text caret on cr at the specified index of layout.

renderLayout
void renderLayout(Context cr, double x, double y, PgLayout layout)

Renders layout on the coordinates x, y

renderLine
void renderLine(Context cr, double x0, double y0, double x1, double y1)

Renders a line from (x0, y0) to (x1, y1).

renderOption
void renderOption(Context cr, double x, double y, double width, double height)

Renders an option mark (as in a GtkRadioButton), the GTK_STATE_FLAG_ACTIVE state will determine whether the option is on or off, and GTK_STATE_FLAG_INCONSISTENT whether it should be marked as undefined.

renderSlider
void renderSlider(Context cr, double x, double y, double width, double height, GtkOrientation orientation)

Renders a slider (as in GtkScale) in the rectangle defined by x, y, width, height. orientation defines whether the slider is vertical or horizontal.

restore
void restore()

Restores context state to a previous stage. See gtk_style_context_save().

save
void save()

Saves the context state, so all modifications done through gtk_style_context_add_class(), gtk_style_context_remove_class(), gtk_style_context_add_region(), gtk_style_context_remove_region() or gtk_style_context_set_junction_sides() can be reverted in one go through gtk_style_context_restore().

scrollAnimations
void scrollAnimations(Window window, int dx, int dy)

Warning gtk_style_context_scroll_animations has been deprecated since version 3.6 and should not be used in newly-written code. This function does nothing. This function is analogous to gdk_window_scroll(), and should be called together with it so the invalidation areas for any ongoing animation are scrolled together with it.

setBackground
void setBackground(Window window)

Sets the background of window to the background pattern or color specified in context for its current state.

setDirection
void setDirection(GtkTextDirection direction)

Warning gtk_style_context_set_direction has been deprecated since version 3.8 and should not be used in newly-written code. Use gtk_style_context_set_state() with GTK_STATE_FLAG_DIR_LTR and GTK_STATE_FLAG_DIR_RTL instead. Sets the reading direction for rendering purposes. If you are using a GtkStyleContext returned from gtk_widget_get_style_context(), you do not need to call this yourself.

setFrameClock
void setFrameClock(FrameClock frameClock)

Attaches context to the given frame clock. The frame clock is used for the timing of animations. If you are using a GtkStyleContext returned from gtk_widget_get_style_context(), you do not need to call this yourself.

setJunctionSides
void setJunctionSides(GtkJunctionSides sides)

Sets the sides where rendered elements (mostly through gtk_render_frame()) will visually connect with other visual elements. This is merely a hint that may or may not be honored by theming engines. Container widgets are expected to set junction hints as appropriate for their children, so it should not normally be necessary to call this function manually.

setParent
void setParent(StyleContext parent)

Sets the parent style context for context. The parent style context is used to implement inheritance of properties. If you are using a GtkStyleContext returned from gtk_widget_get_style_context(), the parent will be set for you.

setPath
void setPath(WidgetPath path)

Sets the GtkWidgetPath used for style matching. As a consequence, the style will be regenerated to match the new given path. If you are using a GtkStyleContext returned from gtk_widget_get_style_context(), you do not need to call this yourself.

setScale
void setScale(int scale)

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

setScreen
void setScreen(Screen screen)

Attaches context to the given screen. The screen is used to add style information from 'global' style providers, such as the screens GtkSettings instance. If you are using a GtkStyleContext returned from gtk_widget_get_style_context(), you do not need to call this yourself.

setState
void setState(GtkStateFlags flags)

Sets the state to be used when rendering with any of the gtk_render_*() functions.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
stateIsRunning
int stateIsRunning(GtkStateType state, double progress)

Warning gtk_style_context_state_is_running has been deprecated since version 3.6 and should not be used in newly-written code. This function always returns FALSE Returns TRUE if there is a transition animation running for the current region (see gtk_style_context_push_animatable_region()). If progress is not NULL, the animation progress will be returned there, 0.0 means the state is closest to being unset, while 1.0 means it's closest to being set. This means transition animation will run from 0 to 1 when state is being set and from 1 to 0 when it's being unset.

Static functions

addProviderForScreen
void addProviderForScreen(Screen screen, StyleProviderIF provider, uint priority)

Adds a global style provider to screen, which will be used in style construction for all GtkStyleContexts under screen. GTK+ uses this to make styling information from GtkSettings available. Note If both priorities are the same, A GtkStyleProvider added through gtk_style_context_add_provider() takes precedence over another added through this function.

callBackChanged
void callBackChanged(GtkStyleContext* stylecontextStruct, StyleContext _styleContext)
Undocumented in source. Be warned that the author may not have intended to support it.
removeProviderForScreen
void removeProviderForScreen(Screen screen, StyleProviderIF provider)

Removes provider from the global style providers list in screen.

resetWidgets
void resetWidgets(Screen screen)

This function recomputes the styles for all widgets under a particular GdkScreen. This is useful when some global parameter has changed that affects the appearance of all widgets, because when a widget gets a new style, it will both redraw and recompute any cached information about its appearance. As an example, it is used when the color scheme changes in the related GtkSettings object.

Variables

connectedSignals
int[string] connectedSignals;
gtkStyleContext
GtkStyleContext* gtkStyleContext;

the main Gtk struct

onChangedListeners
void delegate(StyleContext)[] onChangedListeners;
Undocumented in source.

Inherited Members

From ObjectG

gObject
GObject* gObject;

the main Gtk struct

getObjectGStruct
GObject* getObjectGStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

isGcRoot
bool isGcRoot;
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.
getDObject
RT getDObject(U obj)

Gets a D Object from the objects table of associations.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setProperty
void setProperty(string propertyName, int value)
setProperty
void setProperty(string propertyName, string value)
setProperty
void setProperty(string propertyName, long value)
setProperty
void setProperty(string propertyName, ulong value)
unref
void unref()
Undocumented in source. Be warned that the author may not have intended to support it.
doref
ObjectG doref()
Undocumented in source. Be warned that the author may not have intended to support it.
connectedSignals
int[string] connectedSignals;
Undocumented in source.
onNotifyListeners
void delegate(ParamSpec, ObjectG)[] onNotifyListeners;
Undocumented in source.
addOnNotify
void 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.

callBackNotify
void callBackNotify(GObject* gobjectStruct, GParamSpec* pspec, ObjectG _objectG)
Undocumented in source. Be warned that the author may not have intended to support it.
classInstallProperty
void classInstallProperty(GObjectClass* oclass, uint propertyId, ParamSpec pspec)

Installs a new property. This is usually done in the class initializer. Note that it is possible to redefine a property in a derived class, by installing a property with the same name. This can be useful at times, e.g. to change the range of allowed values or the default value.

classInstallProperties
void classInstallProperties(GObjectClass* oclass, ParamSpec[] pspecs)

Installs new properties from an array of GParamSpecs. This is usually done in the class initializer. The property id of each property is the index of each GParamSpec in the pspecs array. The property id of 0 is treated specially by GObject and it should not be used to store a GParamSpec. This function should be used if you plan to use a static array of GParamSpecs and g_object_notify_by_pspec(). For instance, this Since 2.26

classFindProperty
ParamSpec classFindProperty(GObjectClass* oclass, string propertyName)

Looks up the GParamSpec for a property of a class.

classListProperties
ParamSpec[] classListProperties(GObjectClass* oclass)

Get an array of GParamSpec* for all properties of a class.

classOverrideProperty
void classOverrideProperty(GObjectClass* oclass, uint propertyId, string name)

Registers property_id as referring to a property with the name name in a parent class or in an interface implemented by oclass. This allows this class to override a property implementation in a parent class or to provide the implementation of a property from an interface. Note Internally, overriding is implemented by creating a property of type GParamSpecOverride; generally operations that query the properties of the object class, such as g_object_class_find_property() or g_object_class_list_properties() will return the overridden property. However, in one case, the construct_properties argument of the constructor virtual function, the GParamSpecOverride is passed instead, so that the param_id field of the GParamSpec will be correct. For virtually all uses, this makes no difference. If you need to get the overridden property, you can call g_param_spec_get_redirect_target(). Since 2.4

interfaceInstallProperty
void interfaceInstallProperty(void* iface, 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. This function is meant to be called from the interface's default vtable initialization function (the class_init member of GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface. Since 2.4

interfaceFindProperty
ParamSpec interfaceFindProperty(void* iface, 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(). Since 2.4

interfaceListProperties
ParamSpec[] interfaceListProperties(void* iface)

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(). Since 2.4

doref
void* doref(void* object)

Increases the reference count of object.

unref
void unref(void* object)

Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

refSink
void* refSink(void* object)

Increase the reference count of object, and possibly remove the floating reference, if object has a floating reference. In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one. Since 2.10

clearObject
void clearObject(ObjectG objectPtr)

Clears a reference to a GObject. object_ptr must not be NULL. If the reference is NULL then this function does nothing. Otherwise, the reference count of the object is decreased and the pointer is set to NULL. This function is threadsafe and modifies the pointer atomically, using memory barriers where needed. A macro is also included that allows this function to be used without pointer casts. Since 2.28

isFloating
int isFloating(void* object)

Checks whether object has a floating reference. Since 2.10

forceFloating
void forceFloating()

This function is intended for GObject implementations to re-enforce a floating 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(). Since 2.10

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). Note that the weak references created by this method are not thread-safe: they cannot safely be used in one thread if the object's last g_object_unref() might happen in another thread. Use GWeakRef if thread-safety is required.

weakUnref
void weakUnref(GWeakNotify notify, void* data)

Removes a weak reference callback to an object.

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. Note that as with g_object_weak_ref(), the weak references created by this method are not thread-safe: they cannot safely be used in one thread if the object's last g_object_unref() might happen in another thread. Use GWeakRef if thread-safety is required.

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().

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. This functionality is intended for binding object to a proxy object managed by another memory manager. This is done with two paired references: the strong reference added by g_object_add_toggle_ref() and a reverse reference to the proxy object which is either a strong reference or weak reference. The setup is that when there are no other references to object, only a weak reference is held in the reverse direction from object to the proxy object, but when there are other references held to object, a strong reference is held. The notify callback is called when the reference from object to the proxy object should be toggled from strong to weak (is_last_ref true) or weak to strong (is_last_ref false). Since a (normal) reference must be held to the object before calling g_object_add_toggle_ref(), the initial state of the reverse link is always strong. Multiple toggle references may be added to the same gobject, however if there are multiple toggle references to an object, none of them will ever be notified until all but one are removed. For this reason, you should only ever use a toggle reference if there is important state in the proxy object. Since 2.8

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. Since 2.8

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object. When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

notifyByPspec
void notifyByPspec(ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object. This function omits the property name lookup, hence it is faster than g_object_notify(). One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with Since 2.26

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. This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

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. Duplicate notifications for each property are squashed so that at most one "notify" signal is emitted for each property. It is an error to call this function when the freeze count is zero.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see g_object_set_data()).

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. If the object already had an association with that name, the old association will be destroyed.

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. Note that the destroy callback is not called if data is NULL.

stealData
void* stealData(string key)

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

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. If the key is not set on the object then dup_func will be called with a NULL argument. Note that dup_func is called while user data of object is locked. This function can be useful to avoid races when multiple threads are using object data on the same key on the same object. Since 2.34

replaceData
int 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. This is like a typical atomic compare-and-exchange operation, for user data on an object. If the previous value was replaced then ownership of the old value (oldval) is passed to the caller, including the registered destroy notify for it (passed out in old_destroy). Its up to the caller to free this as he wishes, which may or may not include using old_destroy as sometimes replacement should not destroy the object in the normal way. Return: TRUE if the existing value for key was replaced by newval, FALSE otherwise. Since 2.34

getQdata
void* getQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata().

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.

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

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. If the quark is not set on the object then dup_func will be called with a NULL argument. Note that dup_func is called while user data of object is locked. This function can be useful to avoid races when multiple threads are using object data on the same key on the same object. Since 2.34

replaceQdata
int 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. This is like a typical atomic compare-and-exchange operation, for user data on an object. If the previous value was replaced then ownership of the old value (oldval) is passed to the caller, including the registered destroy notify for it (passed out in old_destroy). Its up to the caller to free this as he wishes, which may or may not include using old_destroy as sometimes replacement should not destroy the object in the normal way. Return: TRUE if the existing value for quark was replaced by newval, FALSE otherwise. Since 2.34

setProperty
void setProperty(string propertyName, Value value)

Sets a property on an object.

getProperty
void getProperty(string propertyName, Value value)

Gets a property of an object. value must have been initialized to the expected type of the property (or a type to which the expected type can be transformed) using g_value_init(). In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset(). Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

setValist
void setValist(string firstPropertyName, void* varArgs)

Sets properties on an object.

getValist
void getValist(string firstPropertyName, void* varArgs)

Gets properties of an object. In general, a copy is made of the property contents and the caller is responsible for freeing the memory in the appropriate manner for the type, for instance by calling g_free() or g_object_unref(). See g_object_get().

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.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles. This functions should only be called from object system implementations.

Meta