Class

GtkThemingEngine

Description [src]

class Gtk.ThemingEngine : GObject.Object
{
  priv: GtkThemingEnginePrivate*
}

GtkThemingEngine 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.

GtkThemingEngine 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.

Hierarchy

hierarchy this GtkThemingEngine ancestor_0 GObject ancestor_0--this

Ancestors

Functions

gtk_theming_engine_load

Loads and initializes a theming engine module from the standard directories.

deprecated: 3.14 

gtk_theming_engine_register_property

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.

deprecated: 3.8 since: 3.0

Instance methods

gtk_theming_engine_get

Retrieves several style property values that apply to the currently rendered element.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_background_color

Gets the background color for a given state.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_border

Gets the border for a given state as a GtkBorder.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_border_color

Gets the border color for a given state.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_color

Gets the foreground color for a given state.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_direction

Returns the widget direction used for rendering.

deprecated: 3.8 since: 3.0

gtk_theming_engine_get_font

Returns the font description for a given state.

deprecated: 3.8 since: 3.0

gtk_theming_engine_get_junction_sides

Returns the widget direction used for rendering.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_margin

Gets the margin for a given state as a GtkBorder.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_padding

Gets the padding for a given state as a GtkBorder.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_path

Returns the widget path used for style matching.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_property

Gets a property value as retrieved from the style settings that apply to the currently rendered element.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_screen

Returns the GdkScreen to which engine currently rendering to.

deprecated: 3.14 

gtk_theming_engine_get_state

Returns the state used when rendering.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_style

Retrieves several widget style properties from engine according to the currently rendered content’s style.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_style_property

Gets the value for a widget style property.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_style_valist

Retrieves several widget style properties from engine according to the currently rendered content’s style.

deprecated: 3.14 since: 3.0

gtk_theming_engine_get_valist

Retrieves several style property values that apply to the currently rendered element.

deprecated: 3.14 since: 3.0

gtk_theming_engine_has_class

Returns TRUE if the currently rendered contents have defined the given class name.

deprecated: 3.14 since: 3.0

gtk_theming_engine_has_region

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.

deprecated: 3.14 since: 3.0

gtk_theming_engine_lookup_color

Looks up and resolves a color name in the current style’s color map.

deprecated: 3.14 since: 3.0

gtk_theming_engine_state_is_running

Returns TRUE if there is a transition animation running for the current region (see gtk_style_context_push_animatable_region()).

deprecated: 3.6 since: 3.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Gtk.ThemingEngine:name

The theming engine name, this name will be used when registering custom properties, for a theming engine named “Clearlooks” registering a “glossy” custom property, it could be referenced in the CSS file as.

since: 3.0

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct GtkThemingEngineClass {
  GObjectClass parent_class;
  void (* render_line) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x0,
    gdouble y0,
    gdouble x1,
    gdouble y1
  );
  void (* render_background) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height
  );
  void (* render_frame) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height
  );
  void (* render_frame_gap) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height,
    GtkPositionType gap_side,
    gdouble xy0_gap,
    gdouble xy1_gap
  );
  void (* render_extension) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height,
    GtkPositionType gap_side
  );
  void (* render_check) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height
  );
  void (* render_option) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height
  );
  void (* render_arrow) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble angle,
    gdouble x,
    gdouble y,
    gdouble size
  );
  void (* render_expander) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height
  );
  void (* render_focus) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height
  );
  void (* render_layout) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    PangoLayout* layout
  );
  void (* render_slider) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height,
    GtkOrientation orientation
  );
  void (* render_handle) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height
  );
  void (* render_activity) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    gdouble x,
    gdouble y,
    gdouble width,
    gdouble height
  );
  GdkPixbuf* (* render_icon_pixbuf) (
    GtkThemingEngine* engine,
    const GtkIconSource* source,
    GtkIconSize size
  );
  void (* render_icon) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    GdkPixbuf* pixbuf,
    gdouble x,
    gdouble y
  );
  void (* render_icon_surface) (
    GtkThemingEngine* engine,
    cairo_t* cr,
    cairo_surface_t* surface,
    gdouble x,
    gdouble y
  );
  
}

Base class for theming engines.

Class members
parent_class: GObjectClass

The parent class.

render_line: void (* render_line) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x0, gdouble y0, gdouble x1, gdouble y1 )

Renders a line between two points.

render_background: void (* render_background) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height )

Renders the background area of a widget region.

render_frame: void (* render_frame) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height )

Renders the frame around a widget area.

render_frame_gap: void (* render_frame_gap) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height, GtkPositionType gap_side, gdouble xy0_gap, gdouble xy1_gap )

Renders the frame around a widget area with a gap in it.

render_extension: void (* render_extension) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height, GtkPositionType gap_side )

Renders a extension to a box, usually a notebook tab.

render_check: void (* render_check) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height )

Renders a checkmark, as in GtkCheckButton.

render_option: void (* render_option) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height )

Renders an option, as in GtkRadioButton.

render_arrow: void (* render_arrow) ( GtkThemingEngine* engine, cairo_t* cr, gdouble angle, gdouble x, gdouble y, gdouble size )

Renders an arrow pointing to a certain direction.

render_expander: void (* render_expander) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height )

Renders an element what will expose/expand part of the UI, as in GtkExpander.

render_focus: void (* render_focus) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height )

Renders the focus indicator.

render_layout: void (* render_layout) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, PangoLayout* layout )

Renders a PangoLayout.

render_slider: void (* render_slider) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height, GtkOrientation orientation )

Renders a slider control, as in GtkScale.

render_handle: void (* render_handle) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height )

Renders a handle to drag UI elements, as in GtkPaned.

render_activity: void (* render_activity) ( GtkThemingEngine* engine, cairo_t* cr, gdouble x, gdouble y, gdouble width, gdouble height )

Renders an area displaying activity, such as in GtkSpinner, or GtkProgressBar.

render_icon_pixbuf: GdkPixbuf* (* render_icon_pixbuf) ( GtkThemingEngine* engine, const GtkIconSource* source, GtkIconSize size )

Renders an icon as a GdkPixbuf.

render_icon: void (* render_icon) ( GtkThemingEngine* engine, cairo_t* cr, GdkPixbuf* pixbuf, gdouble x, gdouble y )

Renders an icon given as a GdkPixbuf.

render_icon_surface: void (* render_icon_surface) ( GtkThemingEngine* engine, cairo_t* cr, cairo_surface_t* surface, gdouble x, gdouble y )

Renders an icon given as a #cairo_surface_t.

Virtual methods

Gtk.ThemingEngineClass.render_activity

Renders an area displaying activity, such as in GtkSpinner, or GtkProgressBar.

Gtk.ThemingEngineClass.render_arrow

Renders an arrow pointing to a certain direction.

Gtk.ThemingEngineClass.render_background

Renders the background area of a widget region.

Gtk.ThemingEngineClass.render_check

Renders a checkmark, as in GtkCheckButton.

Gtk.ThemingEngineClass.render_expander

Renders an element what will expose/expand part of the UI, as in GtkExpander.

Gtk.ThemingEngineClass.render_extension

Renders a extension to a box, usually a notebook tab.

Gtk.ThemingEngineClass.render_focus

Renders the focus indicator.

Gtk.ThemingEngineClass.render_frame

Renders the frame around a widget area.

Gtk.ThemingEngineClass.render_frame_gap

Renders the frame around a widget area with a gap in it.

Gtk.ThemingEngineClass.render_handle

Renders a handle to drag UI elements, as in GtkPaned.

Gtk.ThemingEngineClass.render_icon

Renders an icon given as a GdkPixbuf.

Gtk.ThemingEngineClass.render_icon_pixbuf

Renders an icon as a GdkPixbuf.

Gtk.ThemingEngineClass.render_icon_surface

Renders an icon given as a #cairo_surface_t.

Gtk.ThemingEngineClass.render_layout

Renders a PangoLayout.

Gtk.ThemingEngineClass.render_line

Renders a line between two points.

Gtk.ThemingEngineClass.render_option

Renders an option, as in GtkRadioButton.

Gtk.ThemingEngineClass.render_slider

Renders a slider control, as in GtkScale.