GtkThemingEngine

gtk_theming_engine_get ()

void
gtk_theming_engine_get (GtkThemingEngine *engine,
                        GtkStateFlags state,
                        ...);

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

Since: 3.0

gtk_theming_engine_get_direction ()

GtkTextDirection
gtk_theming_engine_get_direction (GtkThemingEngine *engine);

Returns the widget direction used for rendering.

Since: 3.0

gtk_theming_engine_get_junction_sides ()

GtkJunctionSides
gtk_theming_engine_get_junction_sides (GtkThemingEngine *engine);

Returns the widget direction used for rendering.

Since: 3.0

gtk_theming_engine_get_path ()

const GtkWidgetPath *
gtk_theming_engine_get_path (GtkThemingEngine *engine);

Returns the widget path used for style matching.

Since: 3.0

gtk_theming_engine_get_property ()

void
gtk_theming_engine_get_property (GtkThemingEngine *engine,
                                 const gchar *property,
                                 GtkStateFlags state,
                                 GValue *value);

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

Since: 3.0

gtk_theming_engine_get_screen ()

GdkScreen *
gtk_theming_engine_get_screen (GtkThemingEngine *engine);

Returns the GdkScreen to which engine currently rendering to.

gtk_theming_engine_get_state ()

GtkStateFlags
gtk_theming_engine_get_state (GtkThemingEngine *engine);

returns the state used when rendering.

Since: 3.0

gtk_theming_engine_get_style ()

void
gtk_theming_engine_get_style (GtkThemingEngine *engine,
                              ...);

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

Since: 3.0

gtk_theming_engine_get_style_property ()

void
gtk_theming_engine_get_style_property (GtkThemingEngine *engine,
                                       const gchar *property_name,
                                       GValue *value);

Gets the value for a widget style property.

Since: 3.0

gtk_theming_engine_get_style_valist ()

void
gtk_theming_engine_get_style_valist (GtkThemingEngine *engine,
                                     va_list args);

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

Since: 3.0

gtk_theming_engine_get_valist ()

void
gtk_theming_engine_get_valist (GtkThemingEngine *engine,
                               GtkStateFlags state,
                               va_list args);

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

Since: 3.0

gtk_theming_engine_get_color ()

void
gtk_theming_engine_get_color (GtkThemingEngine *engine,
                              GtkStateFlags state,
                              GdkRGBA *color);

Gets the foreground color for a given state.

Since: 3.0

gtk_theming_engine_get_background_color ()

void
gtk_theming_engine_get_background_color
                               (GtkThemingEngine *engine,
                                GtkStateFlags state,
                                GdkRGBA *color);

Gets the background color for a given state.

Since: 3.0

gtk_theming_engine_get_border_color ()

void
gtk_theming_engine_get_border_color (GtkThemingEngine *engine,
                                     GtkStateFlags state,
                                     GdkRGBA *color);

Gets the border color for a given state.

Since: 3.0

gtk_theming_engine_get_border ()

void
gtk_theming_engine_get_border (GtkThemingEngine *engine,
                               GtkStateFlags state,
                               GtkBorder *border);

Gets the border for a given state as a GtkBorder.

Since: 3.0

gtk_theming_engine_get_padding ()

void
gtk_theming_engine_get_padding (GtkThemingEngine *engine,
                                GtkStateFlags state,
                                GtkBorder *padding);

Gets the padding for a given state as a GtkBorder.

Since: 3.0

gtk_theming_engine_get_margin ()

void
gtk_theming_engine_get_margin (GtkThemingEngine *engine,
                               GtkStateFlags state,
                               GtkBorder *margin);

Gets the margin for a given state as a GtkBorder.

Since: 3.0

gtk_theming_engine_get_font ()

const PangoFontDescription *
gtk_theming_engine_get_font (GtkThemingEngine *engine,
                             GtkStateFlags state);

Returns the font description for a given state.

Since: 3.0

gtk_theming_engine_has_class ()

gboolean
gtk_theming_engine_has_class (GtkThemingEngine *engine,
                              const gchar *style_class);

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

Since: 3.0

gtk_theming_engine_has_region ()

gboolean
gtk_theming_engine_has_region (GtkThemingEngine *engine,
                               const gchar *style_region,
                               GtkRegionFlags *flags);

Returns TRUE if the currently rendered contents have the region defined. If flags_return is not NULL, it is set to the flags affecting the region.

Since: 3.0

gtk_theming_engine_lookup_color ()

gboolean
gtk_theming_engine_lookup_color (GtkThemingEngine *engine,
                                 const gchar *color_name,
                                 GdkRGBA *color);

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

Since: 3.0

gtk_theming_engine_state_is_running ()

gboolean
gtk_theming_engine_state_is_running (GtkThemingEngine *engine,
                                     GtkStateType state,
                                     gdouble *progress);

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 FALSE, while 1.0 means it’s closest to being TRUE. This means transition animations will run from 0 to 1 when state is being set to TRUE and from 1 to 0 when it’s being set to FALSE.

Since: 3.0

gtk_theming_engine_load ()

GtkThemingEngine *
gtk_theming_engine_load (const gchar *name);

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

gtk_theming_engine_register_property ()

void
gtk_theming_engine_register_property (const gchar *name_space,
                                      GtkStylePropertyParser parse_func,
                                      GParamSpec *pspec);

Registers a property so it can be used in the CSS file format, on the CSS file the property will look like "-${name_space }-${property_name}". being ${property_name} the given to pspec . name_space will usually be the theme engine name.

For any type a parse_func may be provided, being this function used for turning any property value (between “:” and “;”) in CSS to the GValue needed. For basic types there is already builtin parsing support, so NULL may be provided for these cases.

Engines must ensure property registration happens exactly once, usually GTK+ deals with theming engines as singletons, so this should be guaranteed to happen once, but bear this in mind when creating GtkThemeEngines yourself.

In order to make use of the custom registered properties in the CSS file, make sure the engine is loaded first by specifying the engine property, either in a previous rule or within the same one.

[skip]

Since: 3.0

struct GtkThemingEngineClass

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.

struct GtkThemingEngine

struct GtkThemingEngine;

The “name” property

  “name”                     char *

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

* {
    engine: someengine;
    -SomeEngine-custom-property: 2;
}

Owner: GtkThemingEngine

Flags: Read / Write / Construct Only

Default value: NULL

Since: 3.0