In order to construct the final style information, gtk.StyleContext queries information from all attached GtkStyleProviders Style providers can be either attached explicitly to the context through Style.contextAddProvider, or to the screen through Style.contextAddProviderForScreen. The resulting style is a combination of all providers’ information in priority order.
For GTK+ widgets, any gtk.StyleContext returned by Widget.getStyleContext will already have a gtk.WidgetPath, a gdk.Screen and RTL/LTR information set. The style context will also be 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 Style.contextSetPath and possibly Style.contextSetScreen. See the “Foreign drawing“ example in gtk3-demo.
Widgets can add style classes to their context, which can be used to associate different styles by class. The documentation for individual widgets lists which style classes it uses itself, and which style classes may be added by applications to affect their appearance.
GTK+ defines macros for a number of style classes.
Widgets can also add regions with flags to their context. This feature is deprecated and will be removed in a future GTK+ update. Please use style classes instead.
GTK+ defines macros for a number of style regions.
If you are developing a library with custom gtk.Widgets that render differently than standard components, you may need to add a GtkStyleProvider yourself with the GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority, either a gtk.CssProvider or a custom object implementing the GtkStyleProvider interface. This way themes may still attempt to style your UI elements in a different way if needed so.
If you are using custom styling on an applications, you probably want then to make your style information prevail to the theme’s, so you must use a 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.
Sets our main struct and passes it to the parent class.
Adds a style class to context, so posterior calls to Style.contextGet or any of the gtk_render_*() functions will make use of this new class for styling.
The ::changed signal is emitted when there is a change in the gtk.StyleContext
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 Style.contextAddProviderForScreen.
Adds a region to context, so posterior calls to Style.contextGet or any of the gtk_render_*() functions will make use of this new region for styling.
Stops all running animations for region_id and all animatable regions underneath.
Gets the background color for a given state.
Gets the border for a given state as a gtk.Border
Gets the border color for a given state.
Gets the foreground color for a given state.
Returns the widget direction used for rendering.
Returns the font description for a given state. The returned object is const and will remain valid until the changed signal happens.
Returns the gdk.FrameClock to which context is attached.
Returns the sides where rendered elements connect visually with others.
Gets the parent context set via Style.contextSetParent. See that function for details.
Returns the widget path used for style matching.
Gets a style property from context for the given state.
Returns the scale used for assets.
Returns the gdk.Screen to which context is attached.
Queries the location in the CSS where property was defined for the current context. Note that the state to be queried is taken from Style.contextGetState.
Returns the state used for style matching.
the main Gtk struct as a void*
Get the main Gtk struct
Gets the value for a widget style property.
Retrieves several widget style properties from context according to the current style.
Retrieves several style property values from context for a given state.
Returns TRUE if context currently has defined the given class name.
Returns TRUE if context has the region defined. If flags_return is not NULL, it is set to the flags affecting the region.
Invalidates context style information, so it will be reconstructed again. It is useful if you modify the context and need the new information immediately.
Returns the list of classes currently defined in context.
Returns the list of regions currently defined in context.
Looks up and resolves a color name in the context color map.
Looks up stock_id in the icon factories associated to context and the default icon factory, returning an icon set if found, otherwise NULL.
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.
Pops an animatable region from context. See Style.contextPushAnimatableRegion.
Pushes an animatable region, so all further gtk_render_*() calls between this call and the following Style.contextPopAnimatableRegion will potentially show transition animations for this region if Style.contextNotifyStateChange is called for a given state, and the current theme/style defines transition animations for state changes.
Removes class_name from context.
Removes provider from the style providers list in context.
Removes a region from context.
Restores context state to a previous stage. See Style.contextSave.
This function is analogous to Window.scroll, and should be called together with it so the invalidation areas for any ongoing animation are scrolled together with it.
Sets the background of window to the background pattern or color specified in context for its current state.
Sets the reading direction for rendering purposes.
Attaches context to the given frame clock.
Sets the sides where rendered elements (mostly through gtk_render_frame()) will visually connect with other visual elements.
Sets the parent style context for context. The parent style context is used to implement inheritance
Sets the gtk.WidgetPath used for style matching. As a consequence, the style will be regenerated to match the new given path.
Sets the scale to use when getting image assets for the style.
Attaches context to the given screen.
Sets the state to be used for style matching.
Returns TRUE if there is a transition animation running for the current region (see Style.contextPushAnimatableRegion).
Converts the style context into a string representation.
Adds a global style provider to screen, which will be used in style construction for all gtk.StyleContexts under screen.
Removes provider from the global style providers list in screen.
Renders an activity indicator (such as in gtk.Spinner). The state GTK_STATE_FLAG_CHECKED determines whether there is activity going on.
Renders an arrow pointing to angle.
Renders the background of an element.
Returns the area that will be affected (i.e. drawn to) when calling gtk_render_background() for the given context and rectangle.
Renders a checkmark (as in a gtk.CheckButton).
Renders a extension (as in a gtk.Notebook tab) in the rectangle defined by x, y, width, height. The side where the extension connects to is defined by gap_side.
Renders a focus indicator on the rectangle determined by x, y, width, height.
Renders a frame around the rectangle defined by x, y, width, height.
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.
Renders the icon in pixbuf at the specified x and y coordinates.
Renders the icon specified by source at the given size, returning the result in a pixbuf.
Renders the icon in surface at the specified x and y coordinates.
Draws a text caret on cr at the specified index of layout.
Renders layout on the coordinates x, y
Renders a line from (x0, y0) to (x1, y1).
Renders an option mark (as in a gtk.RadioButton), the GTK_STATE_FLAG_CHECKED state will determine whether the option is on or off, and GTK_STATE_FLAG_INCONSISTENT whether it should be marked as undefined.
Renders a slider (as in gtk.Scale) in the rectangle defined by x, y, width, height. orientation defines whether the slider is vertical or horizontal.
This function recomputes the styles for all widgets under a particular gdk.Screen 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 gtk.Settings object.
the main Gtk struct
the main Gtk struct
Get the main Gtk struct
the main Gtk struct as a void*
Gets a D Object from the objects table of associations.
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.
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().
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.
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().
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.
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.
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:
Complete version of g_object_bind_property().
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.
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.
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.
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.
Gets a named field from the objects table of associations (see g_object_set_data()).
Gets a property of an object.
This function gets back user data pointers stored via g_object_set_qdata().
Gets properties of an object.
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.
Checks whether object has a floating[floating-ref] reference.
Emits a "notify" signal for the property property_name on object.
Emits a "notify" signal for the property specified by pspec on object.
Increases the reference count of object.
Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
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().
Compares the user data for the key key on object with oldval, and if they are the same, replaces oldval with newval.
Compares the user data for the key quark on object with oldval, and if they are the same, replaces oldval with newval.
Releases all references to other objects. This can be used to break reference cycles.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
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.
Sets a property on an object.
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.
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.
Sets properties on an object.
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.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
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:
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.
Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
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.
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).
Removes a weak reference callback to an object.
Clears a reference to a GObject