Top |
GtkTextDirection | direction | Read / Write |
GdkFrameClock * | paint-clock | Read / Write |
GtkStyleContext * | parent | Read / Write |
GdkScreen * | screen | Read / Write |
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.
Widgets can add style classes to their context, which can be used to associate different styles by class (see Selectors).
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.
The regions used by GTK+ widgets are:
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 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.
GtkStyleContext *
gtk_style_context_new (void
);
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.
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.
void gtk_style_context_add_provider (GtkStyleContext *context
,GtkStyleProvider *provider
,guint 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()
.
context |
||
provider |
||
priority |
the priority of the style provider. The lower
it is, the earlier it will be used in the style
construction. Typically this will be in the range
between |
Since 3.0
void gtk_style_context_add_provider_for_screen (GdkScreen *screen
,GtkStyleProvider *provider
,guint 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.
screen |
||
provider |
||
priority |
the priority of the style provider. The lower
it is, the earlier it will be used in the style
construction. Typically this will be in the range
between |
Since 3.0
void gtk_style_context_get (GtkStyleContext *context
,GtkStateFlags state
,...
);
Retrieves several style property values from context
for a
given state.
context |
||
state |
state to retrieve the property values for |
|
... |
property name /return value pairs, followed by |
Since 3.0
GtkTextDirection
gtk_style_context_get_direction (GtkStyleContext *context
);
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.
Since 3.0
GtkJunctionSides
gtk_style_context_get_junction_sides (GtkStyleContext *context
);
Returns the sides where rendered elements connect visually with others.
Since 3.0
GtkStyleContext *
gtk_style_context_get_parent (GtkStyleContext *context
);
Gets the parent context set via gtk_style_context_set_parent()
.
See that function for details.
Since 3.4
const GtkWidgetPath *
gtk_style_context_get_path (GtkStyleContext *context
);
Returns the widget path used for style matching.
Since 3.0
void gtk_style_context_get_property (GtkStyleContext *context
,const gchar *property
,GtkStateFlags state
,GValue *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.
context |
||
property |
style property name |
|
state |
state to retrieve the property value for |
|
value |
return location for the style property value. |
[out][transfer full] |
Since 3.0
GdkScreen *
gtk_style_context_get_screen (GtkStyleContext *context
);
Returns the GdkScreen to which context
is attached.
GdkFrameClock *
gtk_style_context_get_frame_clock (GtkStyleContext *context
);
Returns the GdkFrameClock to which context
is attached.
Since 3.8
GtkStateFlags
gtk_style_context_get_state (GtkStyleContext *context
);
Returns the state used when rendering.
Since 3.0
void gtk_style_context_get_style (GtkStyleContext *context
,...
);
Retrieves several widget style properties from context
according to the
current style.
Since 3.0
void gtk_style_context_get_style_property (GtkStyleContext *context
,const gchar *property_name
,GValue *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.
void gtk_style_context_get_style_valist (GtkStyleContext *context
,va_list args
);
Retrieves several widget style properties from context
according to the
current style.
Since 3.0
void gtk_style_context_get_valist (GtkStyleContext *context
,GtkStateFlags state
,va_list args
);
Retrieves several style property values from context
for a given state.
context |
||
state |
state to retrieve the property values for |
|
args |
va_list of property name/return location pairs, followed by |
Since 3.0
GtkCssSection * gtk_style_context_get_section (GtkStyleContext *context
,const gchar *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
.
void gtk_style_context_get_color (GtkStyleContext *context
,GtkStateFlags state
,GdkRGBA *color
);
Gets the foreground color for a given state.
context |
||
state |
state to retrieve the color for |
|
color |
return value for the foreground color. |
[out] |
Since 3.0
void gtk_style_context_get_background_color (GtkStyleContext *context
,GtkStateFlags state
,GdkRGBA *color
);
Gets the background color for a given state.
context |
||
state |
state to retrieve the color for |
|
color |
return value for the background color. |
[out] |
Since 3.0
void gtk_style_context_get_border_color (GtkStyleContext *context
,GtkStateFlags state
,GdkRGBA *color
);
Gets the border color for a given state.
context |
||
state |
state to retrieve the color for |
|
color |
return value for the border color. |
[out] |
Since 3.0
void gtk_style_context_get_border (GtkStyleContext *context
,GtkStateFlags state
,GtkBorder *border
);
Gets the border for a given state as a GtkBorder.
See GTK_STYLE_PROPERTY_BORDER_WIDTH
.
context |
||
state |
state to retrieve the border for |
|
border |
return value for the border settings. |
[out] |
Since 3.0
void gtk_style_context_get_padding (GtkStyleContext *context
,GtkStateFlags state
,GtkBorder *padding
);
Gets the padding for a given state as a GtkBorder.
See GTK_STYLE_PROPERTY_PADDING
.
context |
||
state |
state to retrieve the padding for |
|
padding |
return value for the padding settings. |
[out] |
Since 3.0
void gtk_style_context_get_margin (GtkStyleContext *context
,GtkStateFlags state
,GtkBorder *margin
);
Gets the margin for a given state as a GtkBorder.
See GTK_STYLE_PROPERTY_MARGIN
.
context |
||
state |
state to retrieve the border for |
|
margin |
return value for the margin settings. |
[out] |
Since 3.0
const PangoFontDescription * gtk_style_context_get_font (GtkStyleContext *context
,GtkStateFlags state
);
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.
the PangoFontDescription for the given state. This object is owned by GTK+ and should not be freed.
[transfer none]
Since 3.0
void
gtk_style_context_invalidate (GtkStyleContext *context
);
gtk_style_context_invalidate
has been deprecated since version 3.12 and should not be used in newly-written code.
Style contexts are invalidated automatically.
Invalidates context
style information, so it will be reconstructed
again. It is useful if you modify the context
and need the new
information immediately.
Since 3.0
gboolean gtk_style_context_state_is_running (GtkStyleContext *context
,GtkStateType state
,gdouble *progress
);
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.
Since 3.0
gboolean gtk_style_context_lookup_color (GtkStyleContext *context
,const gchar *color_name
,GdkRGBA *color
);
Looks up and resolves a color name in the context
color map.
GtkIconSet * gtk_style_context_lookup_icon_set (GtkStyleContext *context
,const gchar *stock_id
);
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
.
void gtk_style_context_notify_state_change (GtkStyleContext *context
,GdkWindow *window
,gpointer region_id
,GtkStateType state
,gboolean state_value
);
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 the prelight state:
1 2 3 4 5 |
gtk_style_context_notify_state_change (context, gtk_widget_get_window (widget), NULL, GTK_STATE_PRELIGHT, button->in_button); |
Can be handled in the CSS file like this:
1 2 3 4 5 6 7 8 |
GtkButton { background-color: #f00 } GtkButton:hover { background-color: #fff; transition: 200ms linear } |
This combination will animate the button background from red to white if a pointer enters the button, and back to red if the pointer leaves the button.
Note that state
is used when finding the transition parameters, which
is why the style places the transition under the :hover pseudo-class.
context |
||
window |
||
region_id |
animatable region to notify on, or |
[allow-none] |
state |
state to trigger transition for |
|
state_value |
|
Since 3.0
void
gtk_style_context_pop_animatable_region
(GtkStyleContext *context
);
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()
.
Since 3.0
void gtk_style_context_push_animatable_region (GtkStyleContext *context
,gpointer region_id
);
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 themes
can uniquely identify rendered elements subject to a state transition.
Since 3.0
void gtk_style_context_cancel_animations (GtkStyleContext *context
,gpointer region_id
);
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.
context |
||
region_id |
animatable region to stop, or |
[allow-none] |
Since 3.0
void gtk_style_context_scroll_animations (GtkStyleContext *context
,GdkWindow *window
,gint dx
,gint dy
);
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.
context |
||
window |
a GdkWindow used previously in
|
|
dx |
Amount to scroll in the X axis |
|
dy |
Amount to scroll in the Y axis |
Since 3.0
void gtk_style_context_remove_provider (GtkStyleContext *context
,GtkStyleProvider *provider
);
Removes provider
from the style providers list in context
.
Since 3.0
void gtk_style_context_remove_provider_for_screen (GdkScreen *screen
,GtkStyleProvider *provider
);
Removes provider
from the global style providers list in screen
.
Since 3.0
void
gtk_style_context_reset_widgets (GdkScreen *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.
Since 3.0
void gtk_style_context_set_background (GtkStyleContext *context
,GdkWindow *window
);
Sets the background of window
to the background pattern or
color specified in context
for its current state.
Since 3.0
void
gtk_style_context_restore (GtkStyleContext *context
);
Restores context
state to a previous stage.
See gtk_style_context_save()
.
Since 3.0
void
gtk_style_context_save (GtkStyleContext *context
);
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()
.
Since 3.0
void gtk_style_context_set_direction (GtkStyleContext *context
,GtkTextDirection direction
);
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.
Since 3.0
void gtk_style_context_set_junction_sides (GtkStyleContext *context
,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 themes.
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.
Since 3.0
void gtk_style_context_set_parent (GtkStyleContext *context
,GtkStyleContext *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.
Since 3.4
void gtk_style_context_set_path (GtkStyleContext *context
,GtkWidgetPath *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.
Since 3.0
void gtk_style_context_add_class (GtkStyleContext *context
,const gchar *class_name
);
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” class, would be matched by:
1 |
GtkEntry.entry { ... } |
While any widget defining an “entry” class would be matched by:
1 |
.entry { ... } |
Since 3.0
void gtk_style_context_remove_class (GtkStyleContext *context
,const gchar *class_name
);
Removes class_name
from context
.
Since 3.0
gboolean gtk_style_context_has_class (GtkStyleContext *context
,const gchar *class_name
);
Returns TRUE
if context
currently has defined the
given class name
Since 3.0
GList *
gtk_style_context_list_classes (GtkStyleContext *context
);
Returns the list of classes currently defined in context
.
a GList of
strings with the currently defined classes. The contents
of the list are owned by GTK+, but you must free the list
itself with g_list_free()
when you are done with it.
[transfer container][element-type utf8]
Since 3.0
void gtk_style_context_add_region (GtkStyleContext *context
,const gchar *region_name
,GtkRegionFlags flags
);
gtk_style_context_add_region
has been deprecated since version 3.14 and should not be used in newly-written code.
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” region, would be matched by:
1 |
GtkTreeView row { ... } |
Pseudo-classes are used for matching flags
, so the two
following rules:
1 2 |
GtkTreeView row:nth-child(even) { ... } GtkTreeView row:nth-child(odd) { ... } |
would apply to even and odd rows, respectively.
Region names must only contain lowercase letters and “-”, starting always with a lowercase letter.
Since 3.0
void gtk_style_context_remove_region (GtkStyleContext *context
,const gchar *region_name
);
gtk_style_context_remove_region
has been deprecated since version 3.14 and should not be used in newly-written code.
Removes a region from context
.
Since 3.0
gboolean gtk_style_context_has_region (GtkStyleContext *context
,const gchar *region_name
,GtkRegionFlags *flags_return
);
gtk_style_context_has_region
has been deprecated since version 3.14 and should not be used in newly-written code.
Returns TRUE
if context
has the region defined.
If flags_return
is not NULL
, it is set to the flags
affecting the region.
context |
||
region_name |
a region name |
|
flags_return |
return location for region flags. |
[out][allow-none] |
Since 3.0
GList *
gtk_style_context_list_regions (GtkStyleContext *context
);
gtk_style_context_list_regions
has been deprecated since version 3.14 and should not be used in newly-written code.
Returns the list of regions currently defined in context
.
a GList of
strings with the currently defined regions. The contents
of the list are owned by GTK+, but you must free the list
itself with g_list_free()
when you are done with it.
[transfer container][element-type utf8]
Since 3.0
void gtk_style_context_set_screen (GtkStyleContext *context
,GdkScreen *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.
Since 3.0
void gtk_style_context_set_frame_clock (GtkStyleContext *context
,GdkFrameClock *frame_clock
);
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.
Since 3.8
void gtk_style_context_set_state (GtkStyleContext *context
,GtkStateFlags flags
);
Sets the state to be used when rendering with any of the gtk_render_*() functions.
Since 3.0
void gtk_style_context_set_scale (GtkStyleContext *context
,gint scale
);
Sets the scale to use when getting image assets for the style .
Since 3.10
gint
gtk_style_context_get_scale (GtkStyleContext *context
);
Returns the scale used for assets.
Since 3.10
GtkBorder *
gtk_border_new (void
);
Allocates a new GtkBorder and initializes its elements to zero.
Since 2.14
void gtk_render_arrow (GtkStyleContext *context
,cairo_t *cr
,gdouble angle
,gdouble x
,gdouble y
,gdouble size
);
Renders an arrow pointing to angle
.
Typical arrow rendering at 0, 1⁄2 π, π and 3⁄2 π:
context |
||
cr |
a cairo_t |
|
angle |
arrow angle from 0 to 2 * |
|
x |
X origin of the render area |
|
y |
Y origin of the render area |
|
size |
square side for render area |
Since 3.0
void gtk_render_background (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
);
Renders the background of an element.
Typical background rendering, showing the effect of
background-image
, border-width
and border-radius
:
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since 3.0.
void gtk_render_check (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble 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.
Typical checkmark rendering:
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since 3.0
void gtk_render_expander (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble 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.
Typical expander rendering:
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since 3.0
void gtk_render_extension (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
,GtkPositionType gap_side
);
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
.
Typical extension rendering:
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
|
gap_side |
side where the gap is |
Since 3.0
void gtk_render_focus (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
);
Renders a focus indicator on the rectangle determined by x
, y
, width
, height
.
Typical focus rendering:
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since 3.0
void gtk_render_frame (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
);
Renders a frame around the rectangle defined by x
, y
, width
, height
.
Examples of frame rendering, showing the effect of border-image
,
border-color
, border-width
, border-radius
and junctions:
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since 3.0
void gtk_render_frame_gap (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
,GtkPositionType gap_side
,gdouble xy0_gap
,gdouble 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
.
Typical rendering of a frame with a gap:
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
|
gap_side |
side where the gap is |
|
xy0_gap |
initial coordinate (X or Y depending on |
|
xy1_gap |
end coordinate (X or Y depending on |
Since 3.0
void gtk_render_handle (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
);
Renders a handle (as in GtkHandleBox, GtkPaned and
GtkWindow’s resize grip), in the rectangle
determined by x
, y
, width
, height
.
Handles rendered for the paned and grip classes:
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since 3.0
void gtk_render_layout (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,PangoLayout *layout
);
Renders layout
on the coordinates x
, y
Since 3.0
void gtk_render_line (GtkStyleContext *context
,cairo_t *cr
,gdouble x0
,gdouble y0
,gdouble x1
,gdouble y1
);
Renders a line from (x0, y0) to (x1, y1).
context |
||
cr |
a cairo_t |
|
x0 |
X coordinate for the origin of the line |
|
y0 |
Y coordinate for the origin of the line |
|
x1 |
X coordinate for the end of the line |
|
y1 |
Y coordinate for the end of the line |
Since 3.0
void gtk_render_option (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble 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.
Typical option mark rendering:
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since 3.0
void gtk_render_slider (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble 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.
Typical slider rendering:
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
|
orientation |
orientation of the slider |
Since 3.0
void gtk_render_activity (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
);
Renders an activity indicator (such as in GtkSpinner).
The state GTK_STATE_FLAG_ACTIVE
determines whether there is
activity going on.
context |
||
cr |
a cairo_t |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since 3.0
GdkPixbuf * gtk_render_icon_pixbuf (GtkStyleContext *context
,const GtkIconSource *source
,GtkIconSize size
);
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.
context |
||
source |
the GtkIconSource specifying the icon to render |
|
size |
the size to render the icon at. A size of (GtkIconSize) -1 means render at the size of the source and don’t scale. |
[type int] |
Since 3.0
void gtk_render_icon_surface (GtkStyleContext *context
,cairo_t *cr
,cairo_surface_t *surface
,gdouble x
,gdouble y
);
Renders the icon in surface
at the specified x
and y
coordinates.
context |
||
cr |
a cairo_t |
|
surface |
a cairo_surface_t containing the icon to draw |
|
x |
X position for the |
|
y |
Y position for the |
Since 3.10
void gtk_render_icon (GtkStyleContext *context
,cairo_t *cr
,GdkPixbuf *pixbuf
,gdouble x
,gdouble y
);
Renders the icon in pixbuf
at the specified x
and y
coordinates.
context |
||
cr |
a cairo_t |
|
pixbuf |
a GdkPixbuf containing the icon to draw |
|
x |
X position for the |
|
y |
Y position for the |
Since 3.2
void gtk_render_insertion_cursor (GtkStyleContext *context
,cairo_t *cr
,gdouble x
,gdouble y
,PangoLayout *layout
,int index
,PangoDirection direction
);
Draws a text caret on cr
at the specified index of layout
.
context |
||
cr |
a cairo_t |
|
x |
X origin |
|
y |
Y origin |
|
layout |
the PangoLayout of the text |
|
index |
the index in the PangoLayout |
|
direction |
the PangoDirection of the text |
Since 3.4
#define GTK_STYLE_PROPERTY_BACKGROUND_COLOR "background-color"
A property holding the background color of rendered elements as a GdkRGBA.
#define GTK_STYLE_PROPERTY_COLOR "color"
A property holding the foreground color of rendered elements as a GdkRGBA.
#define GTK_STYLE_PROPERTY_FONT "font"
A property holding the font properties used when rendering text as a PangoFontDescription.
#define GTK_STYLE_PROPERTY_MARGIN "margin"
A property holding the rendered element’s margin as a GtkBorder. The margin is defined as the spacing between the border of the element and its surrounding elements. It is external to GtkWidget's size allocations, and the most external spacing property of the padding/border/margin series.
#define GTK_STYLE_PROPERTY_PADDING "padding"
A property holding the rendered element’s padding as a GtkBorder. The padding is defined as the spacing between the inner part of the element border and its child. It’s the innermost spacing property of the padding/border/margin series.
#define GTK_STYLE_PROPERTY_BORDER_WIDTH "border-width"
A property holding the rendered element’s border width in pixels as a GtkBorder. The border is the intermediary spacing property of the padding/border/margin series.
gtk_render_frame() uses this property to find out the frame line width, so GtkWidgets rendering frames may need to add up this padding when requesting size
#define GTK_STYLE_PROPERTY_BORDER_RADIUS "border-radius"
A property holding the rendered element’s border radius in pixels as a gint.
#define GTK_STYLE_PROPERTY_BORDER_STYLE "border-style"
A property holding the element’s border style as a GtkBorderStyle.
#define GTK_STYLE_PROPERTY_BORDER_COLOR "border-color"
A property holding the element’s border color as a GdkRGBA.
#define GTK_STYLE_PROPERTY_BACKGROUND_IMAGE "background-image"
A property holding the element’s background as a cairo_pattern_t.
Describes how the border of a UI element should be rendered.
No visible border |
||
A single line segment |
||
Looks as if the content is sunken into the canvas |
||
Looks as if the content is coming out of the canvas |
||
Same as |
||
A series of round dots |
||
A series of square-ended dashes |
||
Two parallel lines with some space between them |
||
Looks as if it were carved in the canvas |
||
Looks as if it were coming out of the canvas |
#define GTK_STYLE_CLASS_ACCELERATOR "accelerator"
A CSS class to match an accelerator.
This is used for the accelerator in GtkAccelLabel.
#define GTK_STYLE_CLASS_ARROW "arrow"
A CSS class used when rendering an arrow element.
Note that gtk_render_arrow automatically adds this style class to the style context when rendering an arrow element.
#define GTK_STYLE_CLASS_BACKGROUND "background"
A CSS class to match the window background.
#define GTK_STYLE_CLASS_BOTTOM "bottom"
A CSS class to indicate an area at the bottom of a widget.
This is used by widgets that can render an area in different positions, such as tabs in a GtkNotebook.
#define GTK_STYLE_CLASS_BUTTON "button"
A CSS class to match buttons.
This is used by GtkButton and its subclasses, as well as various other widget pieces that appear like buttons, e.g. the arrows in a GtkCalendar.
#define GTK_STYLE_CLASS_CALENDAR "calendar"
A CSS class to match calendars.
This is not used by GTK+ itself, currently.
#define GTK_STYLE_CLASS_CELL "cell"
A CSS class to match content rendered in cell views.
This is used by cell renderers, e.g. in GtkIconView and GtkTreeView.
#define GTK_STYLE_CLASS_COMBOBOX_ENTRY "combobox-entry"
A CSS class to match combobox entries.
This is used by GtkComboBox.
#define GTK_STYLE_CLASS_CHECK "check"
A CSS class to match check boxes.
This is used in GtkCheckButton, GtkCheckMenuItem and GtkCellRendererToggle.
#define GTK_STYLE_CLASS_CSD "csd"
A CSS class that gets added to windows which have client-side decorations.
Since 3.14
#define GTK_STYLE_CLASS_CURSOR_HANDLE "cursor-handle"
A CSS class used when rendering a drag handle for text selection.
#define GTK_STYLE_CLASS_DEFAULT "default"
A CSS class to match the default widget.
This is used by GtkButton.
#define GTK_STYLE_CLASS_DESTRUCTIVE_ACTION "destructive-action"
A CSS class used when an action (usually a button) is one that is expected to remove or destroy something visible to the user.
Since 3.12
#define GTK_STYLE_CLASS_DIM_LABEL "dim-label"
A CSS class to match dimmed labels.
This should be used for toning down right aligned labels as compared to the entry value.
#define GTK_STYLE_CLASS_DND "dnd"
A CSS class for a drag-and-drop indicator.
This is used when drawing an outline around a potential drop target during DND.
#define GTK_STYLE_CLASS_DOCK "dock"
A CSS class defining a dock area.
This is used by GtkHandleBox.
#define GTK_STYLE_CLASS_ENTRY "entry"
A CSS class to match text entries.
This is used by GtkEntry.
#define GTK_STYLE_CLASS_ERROR "error"
A CSS class for an area displaying an error message, such as those in infobars.
This is used by GtkInfoBar.
#define GTK_STYLE_CLASS_EXPANDER "expander"
A CSS class defining an expander, such as those in treeviews.
Used for drawing expanders in GtkTreeView, GtkExpander and GtkToolItemGroup.
#define GTK_STYLE_CLASS_FRAME "frame"
A CSS class defining a frame delimiting content, such as GtkFrame or the scrolled window frame around the scrollable area.
This is used in GtkFrame and GtkScrollbar.
#define GTK_STYLE_CLASS_FLAT "flat"
A CSS class that is added when widgets that usually have a frame or border (like buttons or entries) should appear without it.
Since 3.14
#define GTK_STYLE_CLASS_GRIP "grip"
A CSS class defining a resize grip.
This is used for the resize grip in GtkWindow.
#define GTK_STYLE_CLASS_HEADER "header"
A CSS class to match a header element.
This is used for the header in GtkCalendar.
#define GTK_STYLE_CLASS_HIGHLIGHT "highlight"
A CSS class defining a highlighted area, such as headings in assistants and calendars.
This is used in GtkAssistant and GtkCalendar.
#define GTK_STYLE_CLASS_HORIZONTAL "horizontal"
A CSS class for horizontally layered widgets.
This is used by widgets implementing GtkOrientable.
#define GTK_STYLE_CLASS_IMAGE "image"
A CSS class defining an image, such as the icon in an entry.
This is used when rendering icons in GtkEntry.
#define GTK_STYLE_CLASS_INFO "info"
A CSS class for an area displaying an informational message, such as those in infobars.
This is used by GtkInfoBar.
#define GTK_STYLE_CLASS_INLINE_TOOLBAR "inline-toolbar"
A CSS class to match inline toolbars.
This should be used for toolbars that are used to hold actions below lists, as seen e.g. in the left pane of the file chooser.
#define GTK_STYLE_CLASS_INSERTION_CURSOR "insertion-cursor"
A CSS class used when rendering a drag handle for the insertion cursor position.
#define GTK_STYLE_CLASS_LEFT "left"
A CSS class to indicate an area at the left of a widget.
This is used by widgets that can render an area in different positions, such as tabs in a GtkNotebook.
#define GTK_STYLE_CLASS_LEVEL_BAR "level-bar"
A CSS class used when rendering a level indicator, such as a battery charge level, or a password strength.
This is used by GtkLevelBar.
#define GTK_STYLE_CLASS_LINKED "linked"
A CSS class to match a linked area, such as a box containing buttons belonging to the same control.
#define GTK_STYLE_CLASS_LIST "list"
A CSS class to match lists.
This is used by GtkListBox.
#define GTK_STYLE_CLASS_LIST_ROW "list-row"
A CSS class to match list rowss.
This is used by GtkListBoxRow.
#define GTK_STYLE_CLASS_MARK "mark"
A CSS class defining marks in a widget, such as in scales.
Used in GtkScale.
#define GTK_STYLE_CLASS_MENU "menu"
A CSS class to match menus.
This is used in GtkMenu.
#define GTK_STYLE_CLASS_MENUBAR "menubar"
A CSS class to menubars.
This is used in GtkMenuBar.
#define GTK_STYLE_CLASS_MENUITEM "menuitem"
A CSS class to match menu items.
This is used in GtkMenuItem and its subclasses.
#define GTK_STYLE_CLASS_MESSAGE_DIALOG "message-dialog"
A CSS class that is added to message dialogs.
Since 3.14
#define GTK_STYLE_CLASS_NEEDS_ATTENTION "needs-attention"
A CSS class used when an element needs the user attention, for instance a button in a stack switcher corresponding to a hidden page that changed state.
Since 3.12
#define GTK_STYLE_CLASS_NOTEBOOK "notebook"
A CSS class defining a notebook.
Used in GtkNotebook.
#define GTK_STYLE_CLASS_OSD "osd"
A CSS class used when rendering an OSD (On Screen Display) element, on top of another container.
#define GTK_STYLE_CLASS_PANE_SEPARATOR "pane-separator"
A CSS class for a pane separator, such as those in GtkPaned.
Used in GtkPaned.
#define GTK_STYLE_CLASS_POPUP "popup"
A CSS class that is added to the toplevel windows used for menus.
Since 3.14
#define GTK_STYLE_CLASS_PRIMARY_TOOLBAR "primary-toolbar"
A CSS class to match primary toolbars.
This should be used for the “main” toolbar of an application, right below its menubar.
#define GTK_STYLE_CLASS_PROGRESSBAR "progressbar"
A CSS class to use when rendering activity as a progressbar.
This is used in GtkProgressBar and when drawing progress inside a GtkEntry or in GtkCellRendererProgress.
#define GTK_STYLE_CLASS_PULSE "pulse"
A CSS class to use when rendering a pulse in an indeterminate progress bar.
This is used by GtkProgressBar and GtkEntry.
#define GTK_STYLE_CLASS_QUESTION "question"
A CSS class for an area displaying a question to the user, such as those in infobars.
This is used by GtkInfoBar.
#define GTK_STYLE_CLASS_RADIO "radio"
A CSS class to match radio buttons.
This is used in GtkRadioButton, GtkRadioMenuItem and GtkCellRendererToggle.
#define GTK_STYLE_CLASS_RAISED "raised"
A CSS class to match a raised control, such as a raised button on a toolbar.
This should be used in conjunction with GTK_STYLE_CLASS_PRIMARY_TOOLBAR.
#define GTK_STYLE_CLASS_RIGHT "right"
A CSS class to indicate an area at the right of a widget.
This is used by widgets that can render an area in different positions, such as tabs in a GtkNotebook.
#define GTK_STYLE_CLASS_RUBBERBAND "rubberband"
A CSS class to match the rubberband selection rectangle.
This is used in GtkIconView and GtkTreeView.
#define GTK_STYLE_CLASS_SCALE "scale"
A CSS class to match scale widgets.
This is used in GtkScale.
#define GTK_STYLE_CLASS_SCALE_HAS_MARKS_ABOVE "scale-has-marks-above"
A CSS class to match scale widgets with marks attached, all the marks are above for horizontal GtkScale. left for vertical GtkScale.
#define GTK_STYLE_CLASS_SCALE_HAS_MARKS_BELOW "scale-has-marks-below"
A CSS class to match scale widgets with marks attached, all the marks are below for horizontal GtkScale, right for vertical GtkScale.
#define GTK_STYLE_CLASS_SCROLLBAR "scrollbar"
A CSS class to match scrollbars.
#define GTK_STYLE_CLASS_SCROLLBARS_JUNCTION "scrollbars-junction"
A CSS class to match the junction area between an horizontal and vertical scrollbar, when they’re both shown.
This is used in GtkScrolledWindow.
#define GTK_STYLE_CLASS_SEPARATOR "separator"
A CSS class for a separator.
This is used in GtkSeparator, GtkSeparatorMenuItem, GtkSeparatorToolItem, and when drawing separators in GtkTreeView.
#define GTK_STYLE_CLASS_SIDEBAR "sidebar"
A CSS class defining a sidebar, such as the left side in a file chooser.
This is used in GtkFileChooser and in GtkAssistant.
#define GTK_STYLE_CLASS_SPINBUTTON "spinbutton"
A CSS class defining an spinbutton.
This is used in GtkSpinButton.
#define GTK_STYLE_CLASS_SPINNER "spinner"
A CSS class to use when rendering activity as a “spinner”.
This is used by GtkSpinner and GtkCellRendererSpinner.
#define GTK_STYLE_CLASS_SUBTITLE "subtitle"
A CSS class used for the subtitle label in a titlebar in a toplevel window.
Since 3.14
#define GTK_STYLE_CLASS_SUGGESTED_ACTION "suggested-action"
A CSS class used when an action (usually a button) is the primary suggested action in a specific context.
Since 3.12
#define GTK_STYLE_CLASS_TITLE "title"
A CSS class used for the title label in a titlebar in a toplevel window.
Since 3.14
#define GTK_STYLE_CLASS_TITLEBAR "titlebar"
A CSS class used when rendering a titlebar in a toplevel window.
#define GTK_STYLE_CLASS_TOOLBAR "toolbar"
A CSS class to match toolbars.
This is used in GtkToolbar.
#define GTK_STYLE_CLASS_TOOLTIP "tooltip"
A CSS class to match tooltip windows.
#define GTK_STYLE_CLASS_TOP "top"
A CSS class to indicate an area at the top of a widget.
This is used by widgets that can render an area in different positions, such as tabs in a GtkNotebook.
#define GTK_STYLE_CLASS_TROUGH "trough"
A CSS class to match troughs, as in scrollbars and progressbars.
This is used in GtkRange and its subclasses, GtkProgressBar and GtkSwitch.
#define GTK_STYLE_CLASS_VERTICAL "vertical"
A CSS class for vertically layered widgets.
This is used by widgets implementing GtkOrientable.
#define GTK_STYLE_CLASS_VIEW "view"
A CSS class defining a view, such as iconviews or treeviews.
This is used in GtkTreeView, GtkIconView, GtkTextView, as well as GtkCalendar.
#define GTK_STYLE_CLASS_WARNING "warning"
A CSS class for an area displaying a warning message, such as those in infobars.
This is used by GtkInfoBar.
#define GTK_STYLE_REGION_COLUMN "column"
A widget region name to define a treeview column.
#define GTK_STYLE_REGION_COLUMN_HEADER "column-header"
A widget region name to define a treeview column header.
#define GTK_STYLE_REGION_ROW "row"
A widget region name to define a treeview row.
#define GTK_STYLE_REGION_TAB "tab"
A widget region name to define a notebook tab.
Describes how a rendered element connects to adjacent elements.
No junctions. |
||
Element connects on the top-left corner. |
||
Element connects on the top-right corner. |
||
Element connects on the bottom-left corner. |
||
Element connects on the bottom-right corner. |
||
Element connects on the top side. |
||
Element connects on the bottom side. |
||
Element connects on the left side. |
||
Element connects on the right side. |
Describes a region within a widget.
“direction”
property“direction” GtkTextDirection
Text direction.
Flags: Read / Write
Default value: GTK_TEXT_DIR_LTR
“paint-clock”
property“paint-clock” GdkFrameClock *
The associated GdkFrameClock.
Flags: Read / Write
“parent”
property“parent” GtkStyleContext *
Sets or gets the style context’s parent. See gtk_style_context_set_parent()
for details.
Flags: Read / Write
Since 3.4
“changed”
signalvoid user_function (GtkStyleContext *stylecontext, gpointer user_data)
Flags: Run First