1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
23 #include <gobject/gvaluecollector.h>
25 #include "gtkstylecontextprivate.h"
26 #include "gtkcontainerprivate.h"
27 #include "gtkcssanimatedvaluesprivate.h"
28 #include "gtkcssenginevalueprivate.h"
29 #include "gtkcssnumbervalueprivate.h"
30 #include "gtkcssrgbavalueprivate.h"
32 #include "gtkstylepropertiesprivate.h"
33 #include "gtktypebuiltins.h"
34 #include "gtkthemingengineprivate.h"
36 #include "gtkwidget.h"
37 #include "gtkwindow.h"
38 #include "gtkprivate.h"
39 #include "gtksymboliccolorprivate.h"
40 #include "gtkiconfactory.h"
41 #include "gtkwidgetpath.h"
42 #include "gtkwidgetprivate.h"
43 #include "gtkstylecascadeprivate.h"
44 #include "gtkstyleproviderprivate.h"
45 #include "gtksettings.h"
46 #include "gtksettingsprivate.h"
49 * SECTION:gtkstylecontext
50 * @Short_description: Rendering UI elements
51 * @Title: GtkStyleContext
53 * #GtkStyleContext is an object that stores styling information affecting
54 * a widget defined by #GtkWidgetPath.
56 * In order to construct the final style information, #GtkStyleContext
57 * queries information from all attached #GtkStyleProviders. Style providers
58 * can be either attached explicitly to the context through
59 * gtk_style_context_add_provider(), or to the screen through
60 * gtk_style_context_add_provider_for_screen(). The resulting style is a
61 * combination of all providers' information in priority order.
63 * For GTK+ widgets, any #GtkStyleContext returned by
64 * gtk_widget_get_style_context() will already have a #GtkWidgetPath, a
65 * #GdkScreen and RTL/LTR information set. The style context will be also
66 * updated automatically if any of these settings change on the widget.
68 * If you are using the theming layer standalone, you will need to set a
69 * widget path and a screen yourself to the created style context through
70 * gtk_style_context_set_path() and gtk_style_context_set_screen(), as well
71 * as updating the context yourself using gtk_style_context_invalidate()
72 * whenever any of the conditions change, such as a change in the
73 * #GtkSettings:gtk-theme-name setting or a hierarchy change in the rendered
76 * <refsect2 id="gtkstylecontext-animations">
77 * <title>Transition animations</title>
79 * #GtkStyleContext has built-in support for state change transitions.
80 * Note that these animations respect the #GtkSettings:gtk-enable-animations
84 * For simple widgets where state changes affect the whole widget area,
85 * calling gtk_style_context_notify_state_change() with a %NULL region
86 * is sufficient to trigger the transition animation. And GTK+ already
87 * does that when gtk_widget_set_state() or gtk_widget_set_state_flags()
91 * If a widget needs to declare several animatable regions (i.e. not
92 * affecting the whole widget area), its #GtkWidget::draw signal handler
93 * needs to wrap the render operations for the different regions with
94 * calls to gtk_style_context_push_animatable_region() and
95 * gtk_style_context_pop_animatable_region(). These functions take an
96 * identifier for the region which must be unique within the style context.
97 * For simple widgets with a fixed set of animatable regions, using an
98 * enumeration works well:
101 * <title>Using an enumeration to identify animatable regions</title>
112 * spin_button_draw (GtkWidget *widget,
115 * GtkStyleContext *context;
117 * context = gtk_widget_get_style_context (widget);
119 * gtk_style_context_push_animatable_region (context,
120 * GUINT_TO_POINTER (REGION_ENTRY));
122 * gtk_render_background (cr, 0, 0, 100, 30);
123 * gtk_render_frame (cr, 0, 0, 100, 30);
125 * gtk_style_context_pop_animatable_region (context);
132 * For complex widgets with an arbitrary number of animatable regions, it
133 * is up to the implementation to come up with a way to uniquely identify
134 * each animatable region. Using pointers to internal structs is one way
138 * <title>Using struct pointers to identify animatable regions</title>
141 * notebook_draw_tab (GtkWidget *widget,
142 * NotebookPage *page,
145 * gtk_style_context_push_animatable_region (context, page);
146 * gtk_render_extension (cr, page->x, page->y, page->width, page->height);
147 * gtk_style_context_pop_animatable_region (context);
152 * The widget also needs to notify the style context about a state change
153 * for a given animatable region so the animation is triggered.
156 * <title>Triggering a state change animation on a region</title>
159 * notebook_motion_notify (GtkWidget *widget,
160 * GdkEventMotion *event)
162 * GtkStyleContext *context;
163 * NotebookPage *page;
165 * context = gtk_widget_get_style_context (widget);
166 * page = find_page_under_pointer (widget, event);
167 * gtk_style_context_notify_state_change (context,
168 * gtk_widget_get_window (widget),
170 * GTK_STATE_PRELIGHT,
177 * gtk_style_context_notify_state_change() accepts %NULL region IDs as a
178 * special value, in this case, the whole widget area will be updated
182 * <refsect2 id="gtkstylecontext-classes">
183 * <title>Style classes and regions</title>
185 * Widgets can add style classes to their context, which can be used
186 * to associate different styles by class (see <xref linkend="gtkcssprovider-selectors"/>). Theme engines can also use style classes to vary their
187 * rendering. GTK+ has a number of predefined style classes:
188 * #GTK_STYLE_CLASS_CELL,
189 * #GTK_STYLE_CLASS_ENTRY,
190 * #GTK_STYLE_CLASS_BUTTON,
191 * #GTK_STYLE_CLASS_COMBOBOX_ENTRY,
192 * #GTK_STYLE_CLASS_CALENDAR,
193 * #GTK_STYLE_CLASS_SLIDER,
194 * #GTK_STYLE_CLASS_BACKGROUND,
195 * #GTK_STYLE_CLASS_RUBBERBAND,
196 * #GTK_STYLE_CLASS_TOOLTIP,
197 * #GTK_STYLE_CLASS_MENU,
198 * #GTK_STYLE_CLASS_MENUBAR,
199 * #GTK_STYLE_CLASS_MENUITEM,
200 * #GTK_STYLE_CLASS_TOOLBAR,
201 * #GTK_STYLE_CLASS_PRIMARY_TOOLBAR,
202 * #GTK_STYLE_CLASS_INLINE_TOOLBAR,
203 * #GTK_STYLE_CLASS_RADIO,
204 * #GTK_STYLE_CLASS_CHECK,
205 * #GTK_STYLE_CLASS_TROUGH,
206 * #GTK_STYLE_CLASS_SCROLLBAR,
207 * #GTK_STYLE_CLASS_SCALE,
208 * #GTK_STYLE_CLASS_SCALE_HAS_MARKS_ABOVE,
209 * #GTK_STYLE_CLASS_SCALE_HAS_MARKS_BELOW,
210 * #GTK_STYLE_CLASS_HEADER,
211 * #GTK_STYLE_CLASS_ACCELERATOR,
212 * #GTK_STYLE_CLASS_GRIP,
213 * #GTK_STYLE_CLASS_DOCK,
214 * #GTK_STYLE_CLASS_PROGRESSBAR,
215 * #GTK_STYLE_CLASS_SPINNER,
216 * #GTK_STYLE_CLASS_EXPANDER,
217 * #GTK_STYLE_CLASS_SPINBUTTON,
218 * #GTK_STYLE_CLASS_NOTEBOOK,
219 * #GTK_STYLE_CLASS_VIEW,
220 * #GTK_STYLE_CLASS_SIDEBAR,
221 * #GTK_STYLE_CLASS_IMAGE,
222 * #GTK_STYLE_CLASS_HIGHLIGHT,
223 * #GTK_STYLE_CLASS_FRAME,
224 * #GTK_STYLE_CLASS_DND,
225 * #GTK_STYLE_CLASS_PANE_SEPARATOR,
226 * #GTK_STYLE_CLASS_SEPARATOR,
227 * #GTK_STYLE_CLASS_INFO,
228 * #GTK_STYLE_CLASS_WARNING,
229 * #GTK_STYLE_CLASS_QUESTION,
230 * #GTK_STYLE_CLASS_ERROR,
231 * #GTK_STYLE_CLASS_HORIZONTAL,
232 * #GTK_STYLE_CLASS_VERTICAL,
233 * #GTK_STYLE_CLASS_TOP,
234 * #GTK_STYLE_CLASS_BOTTOM,
235 * #GTK_STYLE_CLASS_LEFT,
236 * #GTK_STYLE_CLASS_RIGHT,
239 * Widgets can also add regions with flags to their context.
240 * The regions used by GTK+ widgets are:
245 * <entry>Region</entry>
246 * <entry>Flags</entry>
247 * <entry>Macro</entry>
248 * <entry>Used by</entry>
254 * <entry>even, odd</entry>
255 * <entry>GTK_STYLE_REGION_ROW</entry>
256 * <entry>#GtkTreeView</entry>
259 * <entry>column</entry>
260 * <entry>first, last, sorted</entry>
261 * <entry>GTK_STYLE_REGION_COLUMN</entry>
262 * <entry>#GtkTreeView</entry>
265 * <entry>column-header</entry>
267 * <entry>GTK_STYLE_REGION_COLUMN_HEADER</entry>
272 * <entry>even, odd, first, last</entry>
273 * <entry>GTK_STYLE_REGION_TAB</entry>
274 * <entry>#GtkNotebook</entry>
281 * <refsect2 id="gtkstylecontext-custom-styling">
282 * <title>Custom styling in UI libraries and applications</title>
284 * If you are developing a library with custom #GtkWidget<!-- -->s that
285 * render differently than standard components, you may need to add a
286 * #GtkStyleProvider yourself with the %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK
287 * priority, either a #GtkCssProvider or a custom object implementing the
288 * #GtkStyleProvider interface. This way theming engines may still attempt
289 * to style your UI elements in a different way if needed so.
292 * If you are using custom styling on an applications, you probably want then
293 * to make your style information prevail to the theme's, so you must use
294 * a #GtkStyleProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
295 * priority, keep in mind that the user settings in
296 * <filename><replaceable>XDG_CONFIG_HOME</replaceable>/gtk-3.0/gtk.css</filename> will
297 * still take precedence over your changes, as it uses the
298 * %GTK_STYLE_PROVIDER_PRIORITY_USER priority.
301 * If a custom theming engine is needed, you probably want to implement a
302 * #GtkStyleProvider yourself so it points to your #GtkThemingEngine
303 * implementation, as #GtkCssProvider uses gtk_theming_engine_load()
304 * which loads the theming engine module from the standard paths.
309 /* When these change we do a full restyling. Otherwise we try to figure out
310 * if we need to change things. */
311 #define GTK_STYLE_CONTEXT_RADICAL_CHANGE (GTK_CSS_CHANGE_NAME | GTK_CSS_CHANGE_CLASS | GTK_CSS_CHANGE_SOURCE)
312 /* When these change we don't clear the cache. This takes more memory but makes
313 * things go faster. */
314 #define GTK_STYLE_CONTEXT_CACHED_CHANGE (GTK_CSS_CHANGE_STATE)
316 typedef struct GtkStyleInfo GtkStyleInfo;
317 typedef struct GtkRegion GtkRegion;
318 typedef struct PropertyValue PropertyValue;
319 typedef struct StyleData StyleData;
324 GtkRegionFlags flags;
338 GArray *style_classes;
340 GtkJunctionSides junction_sides;
341 GtkStateFlags state_flags;
347 GtkCssComputedValues *store;
348 GArray *property_cache;
352 struct _GtkStyleContextPrivate
356 GtkStyleCascade *cascade;
358 GtkStyleContext *animation_list_prev;
359 GtkStyleContext *animation_list_next;
361 GtkStyleContext *parent;
364 GtkWidgetPath *widget_path;
365 GHashTable *style_data;
368 GtkTextDirection direction;
370 GtkCssChange relevant_changes;
371 GtkCssChange pending_changes;
373 guint invalidating_context : 1;
389 static guint signals[LAST_SIGNAL] = { 0 };
390 static GtkStyleContext *_running_animations = NULL;
391 guint _running_animations_timer_id = 0;
393 static void gtk_style_context_finalize (GObject *object);
395 static void gtk_style_context_impl_set_property (GObject *object,
399 static void gtk_style_context_impl_get_property (GObject *object,
403 static GtkSymbolicColor *
404 gtk_style_context_color_lookup_func (gpointer contextp,
408 G_DEFINE_TYPE (GtkStyleContext, gtk_style_context, G_TYPE_OBJECT)
411 gtk_style_context_real_changed (GtkStyleContext *context)
413 GtkStyleContextPrivate *priv = context->priv;
416 _gtk_widget_style_context_invalidated (priv->widget);
420 gtk_style_context_class_init (GtkStyleContextClass *klass)
422 GObjectClass *object_class = G_OBJECT_CLASS (klass);
424 object_class->finalize = gtk_style_context_finalize;
425 object_class->set_property = gtk_style_context_impl_set_property;
426 object_class->get_property = gtk_style_context_impl_get_property;
428 klass->changed = gtk_style_context_real_changed;
431 g_signal_new (I_("changed"),
432 G_TYPE_FROM_CLASS (object_class),
434 G_STRUCT_OFFSET (GtkStyleContextClass, changed),
436 g_cclosure_marshal_VOID__VOID,
439 g_object_class_install_property (object_class,
441 g_param_spec_object ("screen",
443 P_("The associated GdkScreen"),
445 GTK_PARAM_READWRITE));
446 g_object_class_install_property (object_class,
448 g_param_spec_enum ("direction",
450 P_("Text direction"),
451 GTK_TYPE_TEXT_DIRECTION,
453 GTK_PARAM_READWRITE));
455 * GtkStyleContext:parent:
457 * Sets or gets the style context's parent. See gtk_style_context_set_parent()
462 g_object_class_install_property (object_class,
464 g_param_spec_object ("parent",
466 P_("The parent style context"),
467 GTK_TYPE_STYLE_CONTEXT,
468 GTK_PARAM_READWRITE));
470 g_type_class_add_private (object_class, sizeof (GtkStyleContextPrivate));
474 style_data_new (void)
478 data = g_slice_new0 (StyleData);
485 clear_property_cache (StyleData *data)
489 if (!data->property_cache)
492 for (i = 0; i < data->property_cache->len; i++)
494 PropertyValue *node = &g_array_index (data->property_cache, PropertyValue, i);
496 g_param_spec_unref (node->pspec);
497 g_value_unset (&node->value);
500 g_array_free (data->property_cache, TRUE);
501 data->property_cache = NULL;
505 style_data_ref (StyleData *style_data)
507 style_data->ref_count++;
513 style_data_unref (StyleData *data)
517 if (data->ref_count > 0)
520 g_object_unref (data->store);
521 clear_property_cache (data);
523 g_slice_free (StyleData, data);
527 style_data_is_animating (StyleData *style_data)
529 return GTK_IS_CSS_ANIMATED_VALUES (style_data->store);
532 static GtkStyleInfo *
533 style_info_new (void)
537 info = g_slice_new0 (GtkStyleInfo);
538 info->style_classes = g_array_new (FALSE, FALSE, sizeof (GQuark));
539 info->regions = g_array_new (FALSE, FALSE, sizeof (GtkRegion));
545 style_info_set_data (GtkStyleInfo *info,
548 if (info->data == data)
552 style_data_ref (data);
555 style_data_unref (info->data);
561 style_info_free (GtkStyleInfo *info)
563 style_info_set_data (info, NULL);
564 g_array_free (info->style_classes, TRUE);
565 g_array_free (info->regions, TRUE);
566 g_slice_free (GtkStyleInfo, info);
569 static GtkStyleInfo *
570 style_info_pop (GtkStyleInfo *info)
572 GtkStyleInfo *next = info->next;
574 style_info_free (info);
579 static GtkStyleInfo *
580 style_info_copy (GtkStyleInfo *info)
584 copy = style_info_new ();
585 g_array_insert_vals (copy->style_classes, 0,
586 info->style_classes->data,
587 info->style_classes->len);
589 g_array_insert_vals (copy->regions, 0,
594 copy->junction_sides = info->junction_sides;
595 copy->state_flags = info->state_flags;
596 style_info_set_data (copy, info->data);
602 style_info_hash (gconstpointer elem)
604 const GtkStyleInfo *info;
609 for (i = 0; i < info->style_classes->len; i++)
611 hash += g_array_index (info->style_classes, GQuark, i);
615 for (i = 0; i < info->regions->len; i++)
619 region = &g_array_index (info->regions, GtkRegion, i);
620 hash += region->class_quark;
621 hash += region->flags;
625 return hash ^ info->state_flags;
629 style_info_equal (gconstpointer elem1,
632 const GtkStyleInfo *info1, *info2;
637 if (info1->state_flags != info2->state_flags)
640 if (info1->junction_sides != info2->junction_sides)
643 if (info1->style_classes->len != info2->style_classes->len)
646 if (memcmp (info1->style_classes->data,
647 info2->style_classes->data,
648 info1->style_classes->len * sizeof (GQuark)) != 0)
651 if (info1->regions->len != info2->regions->len)
654 if (memcmp (info1->regions->data,
655 info2->regions->data,
656 info1->regions->len * sizeof (GtkRegion)) != 0)
663 gtk_style_context_cascade_changed (GtkStyleCascade *cascade,
664 GtkStyleContext *context)
666 _gtk_style_context_queue_invalidate (context, GTK_CSS_CHANGE_SOURCE);
670 gtk_style_context_set_cascade (GtkStyleContext *context,
671 GtkStyleCascade *cascade)
673 GtkStyleContextPrivate *priv;
675 priv = context->priv;
677 if (priv->cascade == cascade)
682 g_object_ref (cascade);
683 g_signal_connect (cascade,
684 "-gtk-private-changed",
685 G_CALLBACK (gtk_style_context_cascade_changed),
691 g_signal_handlers_disconnect_by_func (priv->cascade,
692 gtk_style_context_cascade_changed,
694 g_object_unref (priv->cascade);
697 priv->cascade = cascade;
700 gtk_style_context_cascade_changed (cascade, context);
704 gtk_style_context_init (GtkStyleContext *style_context)
706 GtkStyleContextPrivate *priv;
708 priv = style_context->priv = G_TYPE_INSTANCE_GET_PRIVATE (style_context,
709 GTK_TYPE_STYLE_CONTEXT,
710 GtkStyleContextPrivate);
712 priv->style_data = g_hash_table_new_full (style_info_hash,
714 (GDestroyNotify) style_info_free,
715 (GDestroyNotify) style_data_unref);
717 priv->direction = GTK_TEXT_DIR_LTR;
719 priv->screen = gdk_screen_get_default ();
720 priv->relevant_changes = GTK_CSS_CHANGE_ANY;
722 /* Create default info store */
723 priv->info = style_info_new ();
725 gtk_style_context_set_cascade (style_context,
726 _gtk_style_cascade_get_for_screen (priv->screen));
730 gtk_style_context_do_animations (gpointer unused)
732 GtkStyleContext *context;
734 for (context = _running_animations;
736 context = context->priv->animation_list_next)
738 _gtk_style_context_queue_invalidate (context, GTK_CSS_CHANGE_ANIMATE);
745 gtk_style_context_is_animating (GtkStyleContext *context)
747 GtkStyleContextPrivate *priv = context->priv;
749 return priv->animation_list_prev != NULL
750 || _running_animations == context;
754 gtk_style_context_stop_animating (GtkStyleContext *context)
756 GtkStyleContextPrivate *priv = context->priv;
758 if (!gtk_style_context_is_animating (context))
761 if (priv->animation_list_prev == NULL)
763 _running_animations = priv->animation_list_next;
765 if (_running_animations == NULL)
767 /* we were the last animation */
768 g_source_remove (_running_animations_timer_id);
769 _running_animations_timer_id = 0;
773 priv->animation_list_prev->priv->animation_list_next = priv->animation_list_next;
775 if (priv->animation_list_next)
776 priv->animation_list_next->priv->animation_list_prev = priv->animation_list_prev;
778 priv->animation_list_next = NULL;
779 priv->animation_list_prev = NULL;
783 gtk_style_context_start_animating (GtkStyleContext *context)
785 GtkStyleContextPrivate *priv = context->priv;
787 if (gtk_style_context_is_animating (context))
790 if (_running_animations == NULL)
792 _running_animations_timer_id = gdk_threads_add_timeout (25,
793 gtk_style_context_do_animations,
795 _running_animations = context;
799 priv->animation_list_next = _running_animations;
800 _running_animations->priv->animation_list_prev = context;
801 _running_animations = context;
806 gtk_style_context_finalize (GObject *object)
808 GtkStyleContextPrivate *priv;
809 GtkStyleContext *style_context;
811 style_context = GTK_STYLE_CONTEXT (object);
812 priv = style_context->priv;
814 _gtk_style_context_stop_animations (style_context);
816 /* children hold a reference to us */
817 g_assert (priv->children == NULL);
819 gtk_style_context_set_parent (style_context, NULL);
821 gtk_style_context_set_cascade (style_context, NULL);
823 if (priv->widget_path)
824 gtk_widget_path_free (priv->widget_path);
826 g_hash_table_destroy (priv->style_data);
829 priv->info = style_info_pop (priv->info);
831 G_OBJECT_CLASS (gtk_style_context_parent_class)->finalize (object);
835 gtk_style_context_impl_set_property (GObject *object,
840 GtkStyleContext *style_context;
842 style_context = GTK_STYLE_CONTEXT (object);
847 gtk_style_context_set_screen (style_context,
848 g_value_get_object (value));
851 gtk_style_context_set_direction (style_context,
852 g_value_get_enum (value));
855 gtk_style_context_set_parent (style_context,
856 g_value_get_object (value));
859 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
865 gtk_style_context_impl_get_property (GObject *object,
870 GtkStyleContext *style_context;
871 GtkStyleContextPrivate *priv;
873 style_context = GTK_STYLE_CONTEXT (object);
874 priv = style_context->priv;
879 g_value_set_object (value, priv->screen);
882 g_value_set_enum (value, priv->direction);
885 g_value_set_object (value, priv->parent);
888 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
894 build_properties (GtkStyleContext *context,
895 StyleData *style_data,
899 GtkStyleContextPrivate *priv;
900 GtkCssMatcher matcher;
901 GtkCssLookup *lookup;
903 priv = context->priv;
905 lookup = _gtk_css_lookup_new ();
907 if (_gtk_css_matcher_init (&matcher, path, state))
908 _gtk_style_provider_private_lookup (GTK_STYLE_PROVIDER_PRIVATE (priv->cascade),
912 style_data->store = _gtk_css_computed_values_new ();
913 _gtk_css_lookup_resolve (lookup, context, style_data->store);
914 _gtk_css_lookup_free (lookup);
917 static GtkWidgetPath *
918 create_query_path (GtkStyleContext *context)
920 GtkStyleContextPrivate *priv;
925 priv = context->priv;
926 path = priv->widget ? _gtk_widget_create_path (priv->widget) : gtk_widget_path_copy (priv->widget_path);
927 pos = gtk_widget_path_length (path) - 1;
931 /* Set widget regions */
932 for (i = 0; i < info->regions->len; i++)
936 region = &g_array_index (info->regions, GtkRegion, i);
937 gtk_widget_path_iter_add_region (path, pos,
938 g_quark_to_string (region->class_quark),
942 /* Set widget classes */
943 for (i = 0; i < info->style_classes->len; i++)
947 quark = g_array_index (info->style_classes, GQuark, i);
948 gtk_widget_path_iter_add_class (path, pos,
949 g_quark_to_string (quark));
956 style_data_lookup (GtkStyleContext *context)
958 GtkStyleContextPrivate *priv;
963 priv = context->priv;
966 /* Current data in use is cached, just return it */
970 g_assert (priv->widget != NULL || priv->widget_path != NULL);
972 data = g_hash_table_lookup (priv->style_data, info);
975 style_info_set_data (info, data);
979 path = create_query_path (context);
981 data = style_data_new ();
982 style_info_set_data (info, data);
983 g_hash_table_insert (priv->style_data,
984 style_info_copy (info),
987 build_properties (context, data, path, info->state_flags);
989 gtk_widget_path_free (path);
995 style_data_lookup_for_state (GtkStyleContext *context,
1000 if (context->priv->info->state_flags == state)
1001 return style_data_lookup (context);
1003 gtk_style_context_save (context);
1004 gtk_style_context_set_state (context, state);
1005 data = style_data_lookup (context);
1006 gtk_style_context_restore (context);
1012 gtk_style_context_set_invalid (GtkStyleContext *context,
1015 GtkStyleContextPrivate *priv;
1017 priv = context->priv;
1019 if (priv->invalid == invalid)
1022 priv->invalid = invalid;
1027 gtk_style_context_set_invalid (priv->parent, TRUE);
1028 else if (GTK_IS_RESIZE_CONTAINER (priv->widget))
1029 _gtk_container_queue_restyle (GTK_CONTAINER (priv->widget));
1033 /* returns TRUE if someone called gtk_style_context_save() but hasn't
1034 * called gtk_style_context_restore() yet.
1035 * In those situations we don't invalidate the context when somebody
1036 * changes state/regions/classes.
1039 gtk_style_context_is_saved (GtkStyleContext *context)
1041 return context->priv->info->next != NULL;
1045 gtk_style_context_queue_invalidate_internal (GtkStyleContext *context,
1046 GtkCssChange change)
1048 GtkStyleContextPrivate *priv = context->priv;
1049 GtkStyleInfo *info = priv->info;
1051 if (gtk_style_context_is_saved (context))
1053 style_info_set_data (info, NULL);
1057 _gtk_style_context_queue_invalidate (context, GTK_CSS_CHANGE_STATE);
1058 /* XXX: We need to invalidate siblings here somehow */
1063 * gtk_style_context_new:
1065 * Creates a standalone #GtkStyleContext, this style context
1066 * won't be attached to any widget, so you may want
1067 * to call gtk_style_context_set_path() yourself.
1070 * This function is only useful when using the theming layer
1071 * separated from GTK+, if you are using #GtkStyleContext to
1072 * theme #GtkWidget<!-- -->s, use gtk_widget_get_style_context()
1073 * in order to get a style context ready to theme the widget.
1076 * Returns: A newly created #GtkStyleContext.
1079 gtk_style_context_new (void)
1081 return g_object_new (GTK_TYPE_STYLE_CONTEXT, NULL);
1085 _gtk_style_context_set_widget (GtkStyleContext *context,
1088 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1089 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
1091 context->priv->widget = widget;
1093 _gtk_style_context_stop_animations (context);
1095 _gtk_style_context_queue_invalidate (context, GTK_CSS_CHANGE_ANY_SELF);
1099 * gtk_style_context_add_provider:
1100 * @context: a #GtkStyleContext
1101 * @provider: a #GtkStyleProvider
1102 * @priority: the priority of the style provider. The lower
1103 * it is, the earlier it will be used in the style
1104 * construction. Typically this will be in the range
1105 * between %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and
1106 * %GTK_STYLE_PROVIDER_PRIORITY_USER
1108 * Adds a style provider to @context, to be used in style construction.
1109 * Note that a style provider added by this function only affects
1110 * the style of the widget to which @context belongs. If you want
1111 * to affect the style of all widgets, use
1112 * gtk_style_context_add_provider_for_screen().
1114 * <note><para>If both priorities are the same, A #GtkStyleProvider
1115 * added through this function takes precedence over another added
1116 * through gtk_style_context_add_provider_for_screen().</para></note>
1121 gtk_style_context_add_provider (GtkStyleContext *context,
1122 GtkStyleProvider *provider,
1125 GtkStyleContextPrivate *priv;
1127 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1128 g_return_if_fail (GTK_IS_STYLE_PROVIDER (provider));
1130 priv = context->priv;
1132 if (priv->cascade == _gtk_style_cascade_get_for_screen (priv->screen))
1134 GtkStyleCascade *new_cascade;
1136 new_cascade = _gtk_style_cascade_new ();
1137 _gtk_style_cascade_set_parent (new_cascade, priv->cascade);
1138 _gtk_style_cascade_add_provider (new_cascade, provider, priority);
1139 gtk_style_context_set_cascade (context, new_cascade);
1140 g_object_unref (new_cascade);
1144 _gtk_style_cascade_add_provider (priv->cascade, provider, priority);
1149 * gtk_style_context_remove_provider:
1150 * @context: a #GtkStyleContext
1151 * @provider: a #GtkStyleProvider
1153 * Removes @provider from the style providers list in @context.
1158 gtk_style_context_remove_provider (GtkStyleContext *context,
1159 GtkStyleProvider *provider)
1161 GtkStyleContextPrivate *priv;
1163 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1164 g_return_if_fail (GTK_IS_STYLE_PROVIDER (provider));
1166 priv = context->priv;
1168 if (priv->cascade == _gtk_style_cascade_get_for_screen (priv->screen))
1171 _gtk_style_cascade_remove_provider (priv->cascade, provider);
1175 * gtk_style_context_reset_widgets:
1176 * @screen: a #GdkScreen
1178 * This function recomputes the styles for all widgets under a particular
1179 * #GdkScreen. This is useful when some global parameter has changed that
1180 * affects the appearance of all widgets, because when a widget gets a new
1181 * style, it will both redraw and recompute any cached information about
1182 * its appearance. As an example, it is used when the color scheme changes
1183 * in the related #GtkSettings object.
1188 gtk_style_context_reset_widgets (GdkScreen *screen)
1190 GList *list, *toplevels;
1192 _gtk_icon_set_invalidate_caches ();
1194 toplevels = gtk_window_list_toplevels ();
1195 g_list_foreach (toplevels, (GFunc) g_object_ref, NULL);
1197 for (list = toplevels; list; list = list->next)
1199 if (gtk_widget_get_screen (list->data) == screen)
1200 gtk_widget_reset_style (list->data);
1202 g_object_unref (list->data);
1205 g_list_free (toplevels);
1209 * gtk_style_context_add_provider_for_screen:
1210 * @screen: a #GdkScreen
1211 * @provider: a #GtkStyleProvider
1212 * @priority: the priority of the style provider. The lower
1213 * it is, the earlier it will be used in the style
1214 * construction. Typically this will be in the range
1215 * between %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and
1216 * %GTK_STYLE_PROVIDER_PRIORITY_USER
1218 * Adds a global style provider to @screen, which will be used
1219 * in style construction for all #GtkStyleContexts under @screen.
1221 * GTK+ uses this to make styling information from #GtkSettings
1224 * <note><para>If both priorities are the same, A #GtkStyleProvider
1225 * added through gtk_style_context_add_provider() takes precedence
1226 * over another added through this function.</para></note>
1231 gtk_style_context_add_provider_for_screen (GdkScreen *screen,
1232 GtkStyleProvider *provider,
1235 GtkStyleCascade *cascade;
1237 g_return_if_fail (GDK_IS_SCREEN (screen));
1238 g_return_if_fail (GTK_IS_STYLE_PROVIDER (provider));
1239 g_return_if_fail (!GTK_IS_SETTINGS (provider) || _gtk_settings_get_screen (GTK_SETTINGS (provider)) == screen);
1241 cascade = _gtk_style_cascade_get_for_screen (screen);
1242 _gtk_style_cascade_add_provider (cascade, provider, priority);
1246 * gtk_style_context_remove_provider_for_screen:
1247 * @screen: a #GdkScreen
1248 * @provider: a #GtkStyleProvider
1250 * Removes @provider from the global style providers list in @screen.
1255 gtk_style_context_remove_provider_for_screen (GdkScreen *screen,
1256 GtkStyleProvider *provider)
1258 GtkStyleCascade *cascade;
1260 g_return_if_fail (GDK_IS_SCREEN (screen));
1261 g_return_if_fail (GTK_IS_STYLE_PROVIDER (provider));
1262 g_return_if_fail (!GTK_IS_SETTINGS (provider));
1264 cascade = _gtk_style_cascade_get_for_screen (screen);
1265 _gtk_style_cascade_remove_provider (cascade, provider);
1269 * gtk_style_context_get_section:
1270 * @context: a #GtkStyleContext
1271 * @property: style property name
1273 * Queries the location in the CSS where @property was defined for the
1274 * current @context. Note that the state to be queried is taken from
1275 * gtk_style_context_get_state().
1277 * If the location is not available, %NULL will be returned. The
1278 * location might not be available for various reasons, such as the
1279 * property being overridden, @property not naming a supported CSS
1280 * property or tracking of definitions being disabled for performance
1283 * Shorthand CSS properties cannot be queried for a location and will
1284 * always return %NULL.
1286 * Returns: %NULL or the section where value was defined
1289 gtk_style_context_get_section (GtkStyleContext *context,
1290 const gchar *property)
1292 GtkStyleContextPrivate *priv;
1293 GtkStyleProperty *prop;
1296 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL);
1297 g_return_val_if_fail (property != NULL, NULL);
1299 priv = context->priv;
1300 g_return_val_if_fail (priv->widget != NULL || priv->widget_path != NULL, NULL);
1302 prop = _gtk_style_property_lookup (property);
1303 if (!GTK_IS_CSS_STYLE_PROPERTY (prop))
1306 data = style_data_lookup (context);
1307 return _gtk_css_computed_values_get_section (data->store, _gtk_css_style_property_get_id (GTK_CSS_STYLE_PROPERTY (prop)));
1310 static GtkCssValue *
1311 gtk_style_context_query_func (guint id,
1314 return _gtk_css_computed_values_get_value (values, id);
1318 * gtk_style_context_get_property:
1319 * @context: a #GtkStyleContext
1320 * @property: style property name
1321 * @state: state to retrieve the property value for
1322 * @value: (out) (transfer full): return location for the style property value
1324 * Gets a style property from @context for the given state.
1326 * When @value is no longer needed, g_value_unset() must be called
1327 * to free any allocated memory.
1332 gtk_style_context_get_property (GtkStyleContext *context,
1333 const gchar *property,
1334 GtkStateFlags state,
1337 GtkStyleContextPrivate *priv;
1338 GtkStyleProperty *prop;
1341 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1342 g_return_if_fail (property != NULL);
1343 g_return_if_fail (value != NULL);
1345 priv = context->priv;
1346 g_return_if_fail (priv->widget != NULL || priv->widget_path != NULL);
1348 prop = _gtk_style_property_lookup (property);
1351 g_warning ("Style property \"%s\" is not registered", property);
1354 if (_gtk_style_property_get_value_type (prop) == G_TYPE_NONE)
1356 g_warning ("Style property \"%s\" is not gettable", property);
1360 data = style_data_lookup_for_state (context, state);
1361 _gtk_style_property_query (prop, value, gtk_style_context_query_func, data->store);
1365 * gtk_style_context_get_valist:
1366 * @context: a #GtkStyleContext
1367 * @state: state to retrieve the property values for
1368 * @args: va_list of property name/return location pairs, followed by %NULL
1370 * Retrieves several style property values from @context for a given state.
1375 gtk_style_context_get_valist (GtkStyleContext *context,
1376 GtkStateFlags state,
1379 const gchar *property_name;
1381 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1383 property_name = va_arg (args, const gchar *);
1385 while (property_name)
1387 gchar *error = NULL;
1388 GValue value = G_VALUE_INIT;
1390 gtk_style_context_get_property (context,
1395 G_VALUE_LCOPY (&value, args, 0, &error);
1396 g_value_unset (&value);
1400 g_warning ("Could not get style property \"%s\": %s", property_name, error);
1405 property_name = va_arg (args, const gchar *);
1410 * gtk_style_context_get:
1411 * @context: a #GtkStyleContext
1412 * @state: state to retrieve the property values for
1413 * @...: property name /return value pairs, followed by %NULL
1415 * Retrieves several style property values from @context for a
1421 gtk_style_context_get (GtkStyleContext *context,
1422 GtkStateFlags state,
1427 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1429 va_start (args, state);
1430 gtk_style_context_get_valist (context, state, args);
1435 * gtk_style_context_set_state:
1436 * @context: a #GtkStyleContext
1437 * @flags: state to represent
1439 * Sets the state to be used when rendering with any
1440 * of the gtk_render_*() functions.
1445 gtk_style_context_set_state (GtkStyleContext *context,
1446 GtkStateFlags flags)
1448 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1450 context->priv->info->state_flags = flags;
1452 gtk_style_context_queue_invalidate_internal (context, GTK_CSS_CHANGE_STATE);
1456 * gtk_style_context_get_state:
1457 * @context: a #GtkStyleContext
1459 * Returns the state used when rendering.
1461 * Returns: the state flags
1466 gtk_style_context_get_state (GtkStyleContext *context)
1468 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), 0);
1470 return context->priv->info->state_flags;
1474 * gtk_style_context_state_is_running:
1475 * @context: a #GtkStyleContext
1476 * @state: a widget state
1477 * @progress: (out): return location for the transition progress
1479 * Returns %TRUE if there is a transition animation running for the
1480 * current region (see gtk_style_context_push_animatable_region()).
1482 * If @progress is not %NULL, the animation progress will be returned
1483 * there, 0.0 means the state is closest to being unset, while 1.0 means
1484 * it's closest to being set. This means transition animation will
1485 * run from 0 to 1 when @state is being set and from 1 to 0 when
1488 * Returns: %TRUE if there is a running transition animation for @state.
1492 * Deprecated: 3.6: This function always returns %FALSE
1495 gtk_style_context_state_is_running (GtkStyleContext *context,
1499 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), FALSE);
1505 * gtk_style_context_set_path:
1506 * @context: a #GtkStyleContext
1507 * @path: a #GtkWidgetPath
1509 * Sets the #GtkWidgetPath used for style matching. As a
1510 * consequence, the style will be regenerated to match
1511 * the new given path.
1513 * If you are using a #GtkStyleContext returned from
1514 * gtk_widget_get_style_context(), you do not need to call
1520 gtk_style_context_set_path (GtkStyleContext *context,
1521 GtkWidgetPath *path)
1523 GtkStyleContextPrivate *priv;
1525 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1526 g_return_if_fail (path != NULL);
1528 priv = context->priv;
1529 g_return_if_fail (priv->widget == NULL);
1531 if (priv->widget_path)
1533 gtk_widget_path_free (priv->widget_path);
1534 priv->widget_path = NULL;
1538 priv->widget_path = gtk_widget_path_copy (path);
1540 _gtk_style_context_queue_invalidate (context, GTK_CSS_CHANGE_ANY);
1544 * gtk_style_context_get_path:
1545 * @context: a #GtkStyleContext
1547 * Returns the widget path used for style matching.
1549 * Returns: (transfer none): A #GtkWidgetPath
1553 const GtkWidgetPath *
1554 gtk_style_context_get_path (GtkStyleContext *context)
1556 GtkStyleContextPrivate *priv;
1558 priv = context->priv;
1560 return gtk_widget_get_path (priv->widget);
1562 return priv->widget_path;
1566 * gtk_style_context_set_parent:
1567 * @context: a #GtkStyleContext
1568 * @parent: (allow-none): the new parent or %NULL
1570 * Sets the parent style context for @context. The parent style
1571 * context is used to implement
1572 * <ulink url="http://www.w3.org/TR/css3-cascade/#inheritance">inheritance</ulink>
1575 * If you are using a #GtkStyleContext returned from
1576 * gtk_widget_get_style_context(), the parent will be set for you.
1581 gtk_style_context_set_parent (GtkStyleContext *context,
1582 GtkStyleContext *parent)
1584 GtkStyleContextPrivate *priv;
1586 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1587 g_return_if_fail (parent == NULL || GTK_IS_STYLE_CONTEXT (parent));
1589 priv = context->priv;
1591 if (priv->parent == parent)
1596 parent->priv->children = g_slist_prepend (parent->priv->children, context);
1597 g_object_ref (parent);
1599 gtk_style_context_set_invalid (parent, TRUE);
1604 priv->parent->priv->children = g_slist_remove (priv->parent->priv->children, context);
1605 g_object_unref (priv->parent);
1608 priv->parent = parent;
1610 g_object_notify (G_OBJECT (context), "parent");
1611 _gtk_style_context_queue_invalidate (context, GTK_CSS_CHANGE_ANY_PARENT | GTK_CSS_CHANGE_ANY_SIBLING);
1615 * gtk_style_context_get_parent:
1616 * @context: a #GtkStyleContext
1618 * Gets the parent context set via gtk_style_context_set_parent().
1619 * See that function for details.
1621 * Returns: (transfer none): the parent context or %NULL
1626 gtk_style_context_get_parent (GtkStyleContext *context)
1628 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL);
1630 return context->priv->parent;
1634 * gtk_style_context_save:
1635 * @context: a #GtkStyleContext
1637 * Saves the @context state, so all modifications done through
1638 * gtk_style_context_add_class(), gtk_style_context_remove_class(),
1639 * gtk_style_context_add_region(), gtk_style_context_remove_region()
1640 * or gtk_style_context_set_junction_sides() can be reverted in one
1641 * go through gtk_style_context_restore().
1646 gtk_style_context_save (GtkStyleContext *context)
1648 GtkStyleContextPrivate *priv;
1650 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1652 priv = context->priv;
1654 priv->info = style_info_copy (priv->info);
1655 /* Need to unset animations here because we can not know what style
1656 * class potential transitions came from once we save().
1658 if (priv->info->data && style_data_is_animating (priv->info->data))
1659 style_info_set_data (priv->info, NULL);
1663 * gtk_style_context_restore:
1664 * @context: a #GtkStyleContext
1666 * Restores @context state to a previous stage.
1667 * See gtk_style_context_save().
1672 gtk_style_context_restore (GtkStyleContext *context)
1674 GtkStyleContextPrivate *priv;
1676 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1678 priv = context->priv;
1680 priv->info = style_info_pop (priv->info);
1684 g_warning ("Unpaired gtk_style_context_restore() call");
1686 /* Create default region */
1687 priv->info = style_info_new ();
1692 style_class_find (GArray *array,
1697 gboolean found = FALSE;
1703 if (!array || array->len == 0)
1707 max = array->len - 1;
1713 mid = (min + max) / 2;
1714 item = g_array_index (array, GQuark, mid);
1716 if (class_quark == item)
1721 else if (class_quark > item)
1722 min = pos = mid + 1;
1729 while (!found && min <= max);
1738 region_find (GArray *array,
1743 gboolean found = FALSE;
1749 if (!array || array->len == 0)
1753 max = array->len - 1;
1759 mid = (min + max) / 2;
1760 region = &g_array_index (array, GtkRegion, mid);
1762 if (region->class_quark == class_quark)
1767 else if (region->class_quark > class_quark)
1768 min = pos = mid + 1;
1775 while (!found && min <= max);
1784 * gtk_style_context_add_class:
1785 * @context: a #GtkStyleContext
1786 * @class_name: class name to use in styling
1788 * Adds a style class to @context, so posterior calls to
1789 * gtk_style_context_get() or any of the gtk_render_*()
1790 * functions will make use of this new class for styling.
1792 * In the CSS file format, a #GtkEntry defining an "entry"
1793 * class, would be matched by:
1796 * GtkEntry.entry { ... }
1799 * While any widget defining an "entry" class would be
1808 gtk_style_context_add_class (GtkStyleContext *context,
1809 const gchar *class_name)
1811 GtkStyleContextPrivate *priv;
1816 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1817 g_return_if_fail (class_name != NULL);
1819 priv = context->priv;
1820 class_quark = g_quark_from_string (class_name);
1824 if (!style_class_find (info->style_classes, class_quark, &position))
1826 g_array_insert_val (info->style_classes, position, class_quark);
1828 gtk_style_context_queue_invalidate_internal (context, GTK_CSS_CHANGE_CLASS);
1833 * gtk_style_context_remove_class:
1834 * @context: a #GtkStyleContext
1835 * @class_name: class name to remove
1837 * Removes @class_name from @context.
1842 gtk_style_context_remove_class (GtkStyleContext *context,
1843 const gchar *class_name)
1845 GtkStyleContextPrivate *priv;
1850 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
1851 g_return_if_fail (class_name != NULL);
1853 class_quark = g_quark_try_string (class_name);
1858 priv = context->priv;
1862 if (style_class_find (info->style_classes, class_quark, &position))
1864 g_array_remove_index (info->style_classes, position);
1866 gtk_style_context_queue_invalidate_internal (context, GTK_CSS_CHANGE_CLASS);
1871 * gtk_style_context_has_class:
1872 * @context: a #GtkStyleContext
1873 * @class_name: a class name
1875 * Returns %TRUE if @context currently has defined the
1878 * Returns: %TRUE if @context has @class_name defined
1883 gtk_style_context_has_class (GtkStyleContext *context,
1884 const gchar *class_name)
1886 GtkStyleContextPrivate *priv;
1890 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), FALSE);
1891 g_return_val_if_fail (class_name != NULL, FALSE);
1893 class_quark = g_quark_try_string (class_name);
1898 priv = context->priv;
1902 if (style_class_find (info->style_classes, class_quark, NULL))
1909 * gtk_style_context_list_classes:
1910 * @context: a #GtkStyleContext
1912 * Returns the list of classes currently defined in @context.
1914 * Returns: (transfer container) (element-type utf8): a #GList of
1915 * strings with the currently defined classes. The contents
1916 * of the list are owned by GTK+, but you must free the list
1917 * itself with g_list_free() when you are done with it.
1922 gtk_style_context_list_classes (GtkStyleContext *context)
1924 GtkStyleContextPrivate *priv;
1926 GList *classes = NULL;
1929 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL);
1931 priv = context->priv;
1935 for (i = 0; i < info->style_classes->len; i++)
1939 quark = g_array_index (info->style_classes, GQuark, i);
1940 classes = g_list_prepend (classes, (gchar *) g_quark_to_string (quark));
1947 * gtk_style_context_list_regions:
1948 * @context: a #GtkStyleContext
1950 * Returns the list of regions currently defined in @context.
1952 * Returns: (transfer container) (element-type utf8): a #GList of
1953 * strings with the currently defined regions. The contents
1954 * of the list are owned by GTK+, but you must free the list
1955 * itself with g_list_free() when you are done with it.
1960 gtk_style_context_list_regions (GtkStyleContext *context)
1962 GtkStyleContextPrivate *priv;
1964 GList *classes = NULL;
1967 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL);
1969 priv = context->priv;
1973 for (i = 0; i < info->regions->len; i++)
1976 const gchar *class_name;
1978 region = &g_array_index (info->regions, GtkRegion, i);
1980 class_name = g_quark_to_string (region->class_quark);
1981 classes = g_list_prepend (classes, (gchar *) class_name);
1988 _gtk_style_context_check_region_name (const gchar *str)
1990 g_return_val_if_fail (str != NULL, FALSE);
1992 if (!g_ascii_islower (str[0]))
1998 !g_ascii_islower (*str))
2008 * gtk_style_context_add_region:
2009 * @context: a #GtkStyleContext
2010 * @region_name: region name to use in styling
2011 * @flags: flags that apply to the region
2013 * Adds a region to @context, so posterior calls to
2014 * gtk_style_context_get() or any of the gtk_render_*()
2015 * functions will make use of this new region for styling.
2017 * In the CSS file format, a #GtkTreeView defining a "row"
2018 * region, would be matched by:
2021 * GtkTreeView row { ... }
2024 * Pseudo-classes are used for matching @flags, so the two
2027 * GtkTreeView row:nth-child(even) { ... }
2028 * GtkTreeView row:nth-child(odd) { ... }
2031 * would apply to even and odd rows, respectively.
2033 * <note><para>Region names must only contain lowercase letters
2034 * and '-', starting always with a lowercase letter.</para></note>
2039 gtk_style_context_add_region (GtkStyleContext *context,
2040 const gchar *region_name,
2041 GtkRegionFlags flags)
2043 GtkStyleContextPrivate *priv;
2045 GQuark region_quark;
2048 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2049 g_return_if_fail (region_name != NULL);
2050 g_return_if_fail (_gtk_style_context_check_region_name (region_name));
2052 priv = context->priv;
2053 region_quark = g_quark_from_string (region_name);
2057 if (!region_find (info->regions, region_quark, &position))
2061 region.class_quark = region_quark;
2062 region.flags = flags;
2064 g_array_insert_val (info->regions, position, region);
2066 gtk_style_context_queue_invalidate_internal (context, GTK_CSS_CHANGE_REGION);
2071 * gtk_style_context_remove_region:
2072 * @context: a #GtkStyleContext
2073 * @region_name: region name to unset
2075 * Removes a region from @context.
2080 gtk_style_context_remove_region (GtkStyleContext *context,
2081 const gchar *region_name)
2083 GtkStyleContextPrivate *priv;
2085 GQuark region_quark;
2088 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2089 g_return_if_fail (region_name != NULL);
2091 region_quark = g_quark_try_string (region_name);
2096 priv = context->priv;
2100 if (region_find (info->regions, region_quark, &position))
2102 g_array_remove_index (info->regions, position);
2104 gtk_style_context_queue_invalidate_internal (context, GTK_CSS_CHANGE_REGION);
2109 * gtk_style_context_has_region:
2110 * @context: a #GtkStyleContext
2111 * @region_name: a region name
2112 * @flags_return: (out) (allow-none): return location for region flags
2114 * Returns %TRUE if @context has the region defined.
2115 * If @flags_return is not %NULL, it is set to the flags
2116 * affecting the region.
2118 * Returns: %TRUE if region is defined
2123 gtk_style_context_has_region (GtkStyleContext *context,
2124 const gchar *region_name,
2125 GtkRegionFlags *flags_return)
2127 GtkStyleContextPrivate *priv;
2129 GQuark region_quark;
2132 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), FALSE);
2133 g_return_val_if_fail (region_name != NULL, FALSE);
2138 region_quark = g_quark_try_string (region_name);
2143 priv = context->priv;
2147 if (region_find (info->regions, region_quark, &position))
2153 region = &g_array_index (info->regions, GtkRegion, position);
2154 *flags_return = region->flags;
2163 style_property_values_cmp (gconstpointer bsearch_node1,
2164 gconstpointer bsearch_node2)
2166 const PropertyValue *val1 = bsearch_node1;
2167 const PropertyValue *val2 = bsearch_node2;
2169 if (val1->widget_type != val2->widget_type)
2170 return val1->widget_type < val2->widget_type ? -1 : 1;
2172 if (val1->pspec != val2->pspec)
2173 return val1->pspec < val2->pspec ? -1 : 1;
2175 if (val1->state != val2->state)
2176 return val1->state < val2->state ? -1 : 1;
2182 _gtk_style_context_peek_property (GtkStyleContext *context,
2185 StyleData *data = style_data_lookup (context);
2187 return _gtk_css_computed_values_get_value (data->store, property_id);
2191 _gtk_style_context_get_number (GtkStyleContext *context,
2193 double one_hundred_percent)
2197 value = _gtk_style_context_peek_property (context, property_id);
2198 return _gtk_css_number_value_get (value, one_hundred_percent);
2202 _gtk_style_context_peek_style_property (GtkStyleContext *context,
2204 GtkStateFlags state,
2207 GtkStyleContextPrivate *priv;
2208 PropertyValue *pcache, key = { 0 };
2212 priv = context->priv;
2214 data = style_data_lookup_for_state (context, state);
2216 key.widget_type = widget_type;
2220 /* need value cache array */
2221 if (!data->property_cache)
2222 data->property_cache = g_array_new (FALSE, FALSE, sizeof (PropertyValue));
2225 pcache = bsearch (&key,
2226 data->property_cache->data, data->property_cache->len,
2227 sizeof (PropertyValue), style_property_values_cmp);
2229 return &pcache->value;
2233 while (i < data->property_cache->len &&
2234 style_property_values_cmp (&key, &g_array_index (data->property_cache, PropertyValue, i)) >= 0)
2237 g_array_insert_val (data->property_cache, i, key);
2238 pcache = &g_array_index (data->property_cache, PropertyValue, i);
2240 /* cache miss, initialize value type, then set contents */
2241 g_param_spec_ref (pcache->pspec);
2242 g_value_init (&pcache->value, G_PARAM_SPEC_VALUE_TYPE (pspec));
2244 if (priv->widget || priv->widget_path)
2246 GtkWidgetPath *widget_path = priv->widget ? _gtk_widget_create_path (priv->widget) : priv->widget_path;
2248 if (gtk_style_provider_get_style_property (GTK_STYLE_PROVIDER (priv->cascade),
2250 state, pspec, &pcache->value))
2252 /* Resolve symbolic colors to GdkColor/GdkRGBA */
2253 if (G_VALUE_TYPE (&pcache->value) == GTK_TYPE_SYMBOLIC_COLOR)
2255 GtkSymbolicColor *color;
2258 color = g_value_dup_boxed (&pcache->value);
2260 g_value_unset (&pcache->value);
2262 if (G_PARAM_SPEC_VALUE_TYPE (pspec) == GDK_TYPE_RGBA)
2263 g_value_init (&pcache->value, GDK_TYPE_RGBA);
2265 g_value_init (&pcache->value, GDK_TYPE_COLOR);
2267 if (_gtk_style_context_resolve_color (context, color, &rgba))
2269 if (G_PARAM_SPEC_VALUE_TYPE (pspec) == GDK_TYPE_RGBA)
2270 g_value_set_boxed (&pcache->value, &rgba);
2275 rgb.red = rgba.red * 65535. + 0.5;
2276 rgb.green = rgba.green * 65535. + 0.5;
2277 rgb.blue = rgba.blue * 65535. + 0.5;
2279 g_value_set_boxed (&pcache->value, &rgb);
2283 g_param_value_set_default (pspec, &pcache->value);
2285 gtk_symbolic_color_unref (color);
2289 gtk_widget_path_free (widget_path);
2291 return &pcache->value;
2295 gtk_widget_path_free (widget_path);
2298 /* not supplied by any provider, revert to default */
2299 g_param_value_set_default (pspec, &pcache->value);
2301 return &pcache->value;
2305 * gtk_style_context_get_style_property:
2306 * @context: a #GtkStyleContext
2307 * @property_name: the name of the widget style property
2308 * @value: Return location for the property value
2310 * Gets the value for a widget style property.
2312 * When @value is no longer needed, g_value_unset() must be called
2313 * to free any allocated memory.
2316 gtk_style_context_get_style_property (GtkStyleContext *context,
2317 const gchar *property_name,
2320 GtkStyleContextPrivate *priv;
2321 GtkWidgetClass *widget_class;
2322 GtkStateFlags state;
2324 const GValue *peek_value;
2327 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2328 g_return_if_fail (property_name != NULL);
2329 g_return_if_fail (value != NULL);
2331 priv = context->priv;
2335 widget_type = G_OBJECT_TYPE (priv->widget);
2339 if (!priv->widget_path)
2342 widget_type = gtk_widget_path_get_object_type (priv->widget_path);
2344 if (!g_type_is_a (widget_type, GTK_TYPE_WIDGET))
2346 g_warning ("%s: can't get style properties for non-widget class `%s'",
2348 g_type_name (widget_type));
2353 widget_class = g_type_class_ref (widget_type);
2354 pspec = gtk_widget_class_find_style_property (widget_class, property_name);
2355 g_type_class_unref (widget_class);
2359 g_warning ("%s: widget class `%s' has no style property named `%s'",
2361 g_type_name (widget_type),
2366 state = gtk_style_context_get_state (context);
2367 peek_value = _gtk_style_context_peek_style_property (context, widget_type,
2370 if (G_VALUE_TYPE (value) == G_VALUE_TYPE (peek_value))
2371 g_value_copy (peek_value, value);
2372 else if (g_value_type_transformable (G_VALUE_TYPE (peek_value), G_VALUE_TYPE (value)))
2373 g_value_transform (peek_value, value);
2375 g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
2377 G_VALUE_TYPE_NAME (peek_value),
2378 G_VALUE_TYPE_NAME (value));
2382 * gtk_style_context_get_style_valist:
2383 * @context: a #GtkStyleContext
2384 * @args: va_list of property name/return location pairs, followed by %NULL
2386 * Retrieves several widget style properties from @context according to the
2392 gtk_style_context_get_style_valist (GtkStyleContext *context,
2395 GtkStyleContextPrivate *priv;
2396 const gchar *prop_name;
2397 GtkStateFlags state;
2400 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2402 prop_name = va_arg (args, const gchar *);
2403 priv = context->priv;
2407 widget_type = G_OBJECT_TYPE (priv->widget);
2411 if (!priv->widget_path)
2414 widget_type = gtk_widget_path_get_object_type (priv->widget_path);
2416 if (!g_type_is_a (widget_type, GTK_TYPE_WIDGET))
2418 g_warning ("%s: can't get style properties for non-widget class `%s'",
2420 g_type_name (widget_type));
2425 state = gtk_style_context_get_state (context);
2429 GtkWidgetClass *widget_class;
2431 const GValue *peek_value;
2434 widget_class = g_type_class_ref (widget_type);
2435 pspec = gtk_widget_class_find_style_property (widget_class, prop_name);
2436 g_type_class_unref (widget_class);
2440 g_warning ("%s: widget class `%s' has no style property named `%s'",
2442 g_type_name (widget_type),
2447 peek_value = _gtk_style_context_peek_style_property (context, widget_type,
2450 G_VALUE_LCOPY (peek_value, args, 0, &error);
2454 g_warning ("can't retrieve style property `%s' of type `%s': %s",
2456 G_VALUE_TYPE_NAME (peek_value),
2462 prop_name = va_arg (args, const gchar *);
2467 * gtk_style_context_get_style:
2468 * @context: a #GtkStyleContext
2469 * @...: property name /return value pairs, followed by %NULL
2471 * Retrieves several widget style properties from @context according to the
2477 gtk_style_context_get_style (GtkStyleContext *context,
2482 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2484 va_start (args, context);
2485 gtk_style_context_get_style_valist (context, args);
2491 * gtk_style_context_lookup_icon_set:
2492 * @context: a #GtkStyleContext
2493 * @stock_id: an icon name
2495 * Looks up @stock_id in the icon factories associated to @context and
2496 * the default icon factory, returning an icon set if found, otherwise
2499 * Returns: (transfer none): The looked up %GtkIconSet, or %NULL
2502 gtk_style_context_lookup_icon_set (GtkStyleContext *context,
2503 const gchar *stock_id)
2505 GtkStyleContextPrivate *priv;
2507 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL);
2508 g_return_val_if_fail (stock_id != NULL, NULL);
2510 priv = context->priv;
2511 g_return_val_if_fail (priv->widget != NULL || priv->widget_path != NULL, NULL);
2513 return gtk_icon_factory_lookup_default (stock_id);
2517 * gtk_style_context_set_screen:
2518 * @context: a #GtkStyleContext
2519 * @screen: a #GdkScreen
2521 * Attaches @context to the given screen.
2523 * The screen is used to add style information from 'global' style
2524 * providers, such as the screens #GtkSettings instance.
2526 * If you are using a #GtkStyleContext returned from
2527 * gtk_widget_get_style_context(), you do not need to
2528 * call this yourself.
2533 gtk_style_context_set_screen (GtkStyleContext *context,
2536 GtkStyleContextPrivate *priv;
2538 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2539 g_return_if_fail (GDK_IS_SCREEN (screen));
2541 priv = context->priv;
2542 if (priv->screen == screen)
2545 if (priv->cascade == _gtk_style_cascade_get_for_screen (priv->screen))
2547 gtk_style_context_set_cascade (context, _gtk_style_cascade_get_for_screen (screen));
2551 _gtk_style_cascade_set_parent (priv->cascade, _gtk_style_cascade_get_for_screen (screen));
2554 priv->screen = screen;
2556 g_object_notify (G_OBJECT (context), "screen");
2560 * gtk_style_context_get_screen:
2561 * @context: a #GtkStyleContext
2563 * Returns the #GdkScreen to which @context is attached.
2565 * Returns: (transfer none): a #GdkScreen.
2568 gtk_style_context_get_screen (GtkStyleContext *context)
2570 GtkStyleContextPrivate *priv;
2572 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL);
2574 priv = context->priv;
2575 return priv->screen;
2579 * gtk_style_context_set_direction:
2580 * @context: a #GtkStyleContext
2581 * @direction: the new direction.
2583 * Sets the reading direction for rendering purposes.
2585 * If you are using a #GtkStyleContext returned from
2586 * gtk_widget_get_style_context(), you do not need to
2587 * call this yourself.
2592 gtk_style_context_set_direction (GtkStyleContext *context,
2593 GtkTextDirection direction)
2595 GtkStyleContextPrivate *priv;
2597 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2599 priv = context->priv;
2600 priv->direction = direction;
2602 g_object_notify (G_OBJECT (context), "direction");
2606 * gtk_style_context_get_direction:
2607 * @context: a #GtkStyleContext
2609 * Returns the widget direction used for rendering.
2611 * Returns: the widget direction
2616 gtk_style_context_get_direction (GtkStyleContext *context)
2618 GtkStyleContextPrivate *priv;
2620 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), GTK_TEXT_DIR_LTR);
2622 priv = context->priv;
2623 return priv->direction;
2627 * gtk_style_context_set_junction_sides:
2628 * @context: a #GtkStyleContext
2629 * @sides: sides where rendered elements are visually connected to
2632 * Sets the sides where rendered elements (mostly through
2633 * gtk_render_frame()) will visually connect with other visual elements.
2635 * This is merely a hint that may or may not be honored
2636 * by theming engines.
2638 * Container widgets are expected to set junction hints as appropriate
2639 * for their children, so it should not normally be necessary to call
2640 * this function manually.
2645 gtk_style_context_set_junction_sides (GtkStyleContext *context,
2646 GtkJunctionSides sides)
2648 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2650 context->priv->info->junction_sides = sides;
2654 * gtk_style_context_get_junction_sides:
2655 * @context: a #GtkStyleContext
2657 * Returns the sides where rendered elements connect visually with others.
2659 * Returns: the junction sides
2664 gtk_style_context_get_junction_sides (GtkStyleContext *context)
2666 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), 0);
2668 return context->priv->info->junction_sides;
2671 static GtkSymbolicColor *
2672 gtk_style_context_color_lookup_func (gpointer contextp,
2675 GtkStyleContext *context = contextp;
2677 return _gtk_style_provider_private_get_color (GTK_STYLE_PROVIDER_PRIVATE (context->priv->cascade), name);
2681 _gtk_style_context_resolve_color_value (GtkStyleContext *context,
2682 GtkCssValue *current,
2685 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), FALSE);
2686 g_return_val_if_fail (current != NULL, FALSE);
2687 g_return_val_if_fail (color != NULL, FALSE);
2689 return _gtk_symbolic_color_resolve_full ((GtkSymbolicColor *) color,
2691 gtk_style_context_color_lookup_func,
2697 _gtk_style_context_resolve_color (GtkStyleContext *context,
2698 GtkSymbolicColor *color,
2703 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), FALSE);
2704 g_return_val_if_fail (color != NULL, FALSE);
2705 g_return_val_if_fail (result != NULL, FALSE);
2707 val = _gtk_symbolic_color_resolve_full (color,
2708 _gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_COLOR),
2709 gtk_style_context_color_lookup_func,
2714 *result = *_gtk_css_rgba_value_get_rgba (val);
2715 _gtk_css_value_unref (val);
2720 * gtk_style_context_lookup_color:
2721 * @context: a #GtkStyleContext
2722 * @color_name: color name to lookup
2723 * @color: (out): Return location for the looked up color
2725 * Looks up and resolves a color name in the @context color map.
2727 * Returns: %TRUE if @color_name was found and resolved, %FALSE otherwise
2730 gtk_style_context_lookup_color (GtkStyleContext *context,
2731 const gchar *color_name,
2734 GtkSymbolicColor *sym_color;
2736 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), FALSE);
2737 g_return_val_if_fail (color_name != NULL, FALSE);
2738 g_return_val_if_fail (color != NULL, FALSE);
2740 sym_color = gtk_style_context_color_lookup_func (context, color_name);
2741 if (sym_color == NULL)
2744 return _gtk_style_context_resolve_color (context, sym_color, color);
2748 * gtk_style_context_notify_state_change:
2749 * @context: a #GtkStyleContext
2750 * @window: a #GdkWindow
2751 * @region_id: (allow-none): animatable region to notify on, or %NULL.
2752 * See gtk_style_context_push_animatable_region()
2753 * @state: state to trigger transition for
2754 * @state_value: %TRUE if @state is the state we are changing to,
2755 * %FALSE if we are changing away from it
2757 * Notifies a state change on @context, so if the current style makes use
2758 * of transition animations, one will be started so all rendered elements
2759 * under @region_id are animated for state @state being set to value
2762 * The @window parameter is used in order to invalidate the rendered area
2763 * as the animation runs, so make sure it is the same window that is being
2764 * rendered on by the gtk_render_*() functions.
2766 * If @region_id is %NULL, all rendered elements using @context will be
2767 * affected by this state transition.
2769 * As a practical example, a #GtkButton notifying a state transition on
2770 * the prelight state:
2772 * gtk_style_context_notify_state_change (context,
2773 * gtk_widget_get_window (widget),
2775 * GTK_STATE_PRELIGHT,
2776 * button->in_button);
2779 * Can be handled in the CSS file like this:
2782 * background-color: #f00
2786 * background-color: #fff;
2787 * transition: 200ms linear
2791 * This combination will animate the button background from red to white
2792 * if a pointer enters the button, and back to red if the pointer leaves
2795 * Note that @state is used when finding the transition parameters, which
2796 * is why the style places the transition under the :hover pseudo-class.
2800 * Deprecated: 3.6: This function does nothing.
2803 gtk_style_context_notify_state_change (GtkStyleContext *context,
2807 gboolean state_value)
2809 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2810 g_return_if_fail (GDK_IS_WINDOW (window));
2811 g_return_if_fail (state > GTK_STATE_NORMAL && state <= GTK_STATE_FOCUSED);
2812 g_return_if_fail (context->priv->widget != NULL || context->priv->widget_path != NULL);
2816 * gtk_style_context_cancel_animations:
2817 * @context: a #GtkStyleContext
2818 * @region_id: (allow-none): animatable region to stop, or %NULL.
2819 * See gtk_style_context_push_animatable_region()
2821 * Stops all running animations for @region_id and all animatable
2822 * regions underneath.
2824 * A %NULL @region_id will stop all ongoing animations in @context,
2825 * when dealing with a #GtkStyleContext obtained through
2826 * gtk_widget_get_style_context(), this is normally done for you
2827 * in all circumstances you would expect all widget to be stopped,
2828 * so this should be only used in complex widgets with different
2829 * animatable regions.
2833 * Deprecated: 3.6: This function does nothing.
2836 gtk_style_context_cancel_animations (GtkStyleContext *context,
2839 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2843 * gtk_style_context_scroll_animations:
2844 * @context: a #GtkStyleContext
2845 * @window: a #GdkWindow used previously in
2846 * gtk_style_context_notify_state_change()
2847 * @dx: Amount to scroll in the X axis
2848 * @dy: Amount to scroll in the Y axis
2850 * This function is analogous to gdk_window_scroll(), and
2851 * should be called together with it so the invalidation
2852 * areas for any ongoing animation are scrolled together
2857 * Deprecated: 3.6: This function does nothing.
2860 gtk_style_context_scroll_animations (GtkStyleContext *context,
2865 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2866 g_return_if_fail (GDK_IS_WINDOW (window));
2870 * gtk_style_context_push_animatable_region:
2871 * @context: a #GtkStyleContext
2872 * @region_id: unique identifier for the animatable region
2874 * Pushes an animatable region, so all further gtk_render_*() calls between
2875 * this call and the following gtk_style_context_pop_animatable_region()
2876 * will potentially show transition animations for this region if
2877 * gtk_style_context_notify_state_change() is called for a given state,
2878 * and the current theme/style defines transition animations for state
2881 * The @region_id used must be unique in @context so the theming engine
2882 * can uniquely identify rendered elements subject to a state transition.
2886 * Deprecated: 3.6: This function does nothing.
2889 gtk_style_context_push_animatable_region (GtkStyleContext *context,
2892 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2893 g_return_if_fail (region_id != NULL);
2897 * gtk_style_context_pop_animatable_region:
2898 * @context: a #GtkStyleContext
2900 * Pops an animatable region from @context.
2901 * See gtk_style_context_push_animatable_region().
2905 * Deprecated: 3.6: This function does nothing.
2908 gtk_style_context_pop_animatable_region (GtkStyleContext *context)
2910 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2914 gtk_style_context_clear_cache (GtkStyleContext *context)
2916 GtkStyleContextPrivate *priv;
2919 priv = context->priv;
2921 for (info = priv->info; info; info = info->next)
2923 style_info_set_data (info, NULL);
2925 g_hash_table_remove_all (priv->style_data);
2929 gtk_style_context_do_invalidate (GtkStyleContext *context)
2931 GtkStyleContextPrivate *priv;
2933 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2935 priv = context->priv;
2937 /* Avoid reentrancy */
2938 if (priv->invalidating_context)
2941 priv->invalidating_context = TRUE;
2943 g_signal_emit (context, signals[CHANGED], 0);
2945 priv->invalidating_context = FALSE;
2949 _gtk_style_context_stop_animations (GtkStyleContext *context)
2951 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
2953 if (!gtk_style_context_is_animating (context))
2956 style_info_set_data (context->priv->info, NULL);
2958 gtk_style_context_stop_animating (context);
2962 gtk_style_context_update_animations (GtkStyleContext *context,
2965 GtkBitmask *differences;
2966 StyleData *style_data;
2968 style_data = style_data_lookup (context);
2970 differences = _gtk_css_animated_values_advance (GTK_CSS_ANIMATED_VALUES (style_data->store),
2973 if (_gtk_css_animated_values_is_finished (GTK_CSS_ANIMATED_VALUES (style_data->store)))
2974 _gtk_style_context_stop_animations (context);
2980 gtk_style_context_should_animate (GtkStyleContext *context)
2982 GtkStyleContextPrivate *priv;
2985 priv = context->priv;
2987 if (priv->widget == NULL)
2990 if (!gtk_widget_get_mapped (priv->widget))
2993 g_object_get (gtk_widget_get_settings (context->priv->widget),
2994 "gtk-enable-animations", &animate,
3001 gtk_style_context_start_animations (GtkStyleContext *context,
3002 GtkCssComputedValues *previous,
3005 StyleData *animated;
3007 if (!gtk_style_context_should_animate (context))
3009 gtk_style_context_stop_animating (context);
3013 animated = style_data_new ();
3014 animated->store = _gtk_css_animated_values_new (style_data_lookup (context)->store,
3018 if (_gtk_css_animated_values_is_finished (GTK_CSS_ANIMATED_VALUES (animated->store)))
3020 style_data_unref (animated);
3021 gtk_style_context_stop_animating (context);
3025 style_info_set_data (context->priv->info, animated);
3026 style_data_unref (animated);
3027 gtk_style_context_start_animating (context);
3031 _gtk_style_context_validate (GtkStyleContext *context,
3033 GtkCssChange change)
3035 GtkStyleContextPrivate *priv;
3036 GtkBitmask *changes;
3039 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3041 priv = context->priv;
3043 change |= priv->pending_changes;
3045 /* If you run your application with
3046 * GTK_DEBUG=no-css-cache
3047 * every invalidation will purge the cache and completely query
3048 * everything anew form the cache. This is slow (in particular
3049 * when animating), but useful for figuring out bugs.
3051 * We achieve that by pretending that everything that could have
3052 * changed has and so we of course totally need to redo everything.
3054 * Note that this also completely revalidates child widgets all
3057 if (G_UNLIKELY (gtk_get_debug_flags () & GTK_DEBUG_NO_CSS_CACHE))
3058 change = GTK_CSS_CHANGE_ANY;
3060 if (!priv->invalid && change == 0)
3063 priv->pending_changes = 0;
3064 gtk_style_context_set_invalid (context, FALSE);
3066 /* Try to avoid invalidating if we can */
3067 if (change & GTK_STYLE_CONTEXT_RADICAL_CHANGE)
3069 priv->relevant_changes = GTK_CSS_CHANGE_ANY;
3073 if (priv->relevant_changes == GTK_CSS_CHANGE_ANY)
3075 GtkWidgetPath *path;
3076 GtkCssMatcher matcher;
3078 path = create_query_path (context);
3079 if (_gtk_css_matcher_init (&matcher, path, priv->info->state_flags))
3080 priv->relevant_changes = _gtk_style_provider_private_get_change (GTK_STYLE_PROVIDER_PRIVATE (priv->cascade),
3083 priv->relevant_changes = 0;
3085 priv->relevant_changes &= ~GTK_STYLE_CONTEXT_RADICAL_CHANGE;
3087 gtk_widget_path_unref (path);
3091 if (priv->relevant_changes & change)
3093 GtkStyleInfo *info = priv->info;
3097 current = style_data_ref (info->data);
3101 if ((priv->relevant_changes & change) & ~GTK_STYLE_CONTEXT_CACHED_CHANGE)
3102 gtk_style_context_clear_cache (context);
3104 style_info_set_data (info, NULL);
3110 gtk_style_context_start_animations (context, current->store, timestamp);
3111 change &= ~GTK_CSS_CHANGE_ANIMATE;
3113 data = style_data_lookup (context);
3115 changes = _gtk_css_computed_values_get_difference (data->store, current->store);
3117 style_data_unref (current);
3121 changes = _gtk_bitmask_new ();
3122 changes = _gtk_bitmask_invert_range (changes, 0, _gtk_css_style_property_get_n_properties ());
3126 changes = _gtk_bitmask_new ();
3128 if (change & GTK_CSS_CHANGE_ANIMATE &&
3129 gtk_style_context_is_animating (context))
3131 GtkBitmask *animation_changes;
3133 animation_changes = gtk_style_context_update_animations (context, timestamp);
3134 changes = _gtk_bitmask_union (changes, animation_changes);
3135 _gtk_bitmask_free (animation_changes);
3138 if (!_gtk_bitmask_is_empty (changes))
3139 gtk_style_context_do_invalidate (context);
3141 change = _gtk_css_change_for_child (change);
3142 for (list = priv->children; list; list = list->next)
3144 _gtk_style_context_validate (list->data, timestamp, change);
3147 _gtk_bitmask_free (changes);
3151 _gtk_style_context_queue_invalidate (GtkStyleContext *context,
3152 GtkCssChange change)
3154 GtkStyleContextPrivate *priv;
3156 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3157 g_return_if_fail (change != 0);
3159 priv = context->priv;
3161 if (priv->widget != NULL)
3163 priv->pending_changes |= change;
3164 gtk_style_context_set_invalid (context, TRUE);
3166 else if (priv->widget_path == NULL)
3168 gtk_style_context_invalidate (context);
3173 * gtk_style_context_invalidate:
3174 * @context: a #GtkStyleContext.
3176 * Invalidates @context style information, so it will be reconstructed
3179 * If you're using a #GtkStyleContext returned from
3180 * gtk_widget_get_style_context(), you do not need to
3181 * call this yourself.
3186 gtk_style_context_invalidate (GtkStyleContext *context)
3188 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3190 gtk_style_context_clear_cache (context);
3191 gtk_style_context_do_invalidate (context);
3195 * gtk_style_context_set_background:
3196 * @context: a #GtkStyleContext
3197 * @window: a #GdkWindow
3199 * Sets the background of @window to the background pattern or
3200 * color specified in @context for its current state.
3205 gtk_style_context_set_background (GtkStyleContext *context,
3208 GtkStateFlags state;
3209 cairo_pattern_t *pattern;
3212 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3213 g_return_if_fail (GDK_IS_WINDOW (window));
3215 state = gtk_style_context_get_state (context);
3216 gtk_style_context_get (context, state,
3217 "background-image", &pattern,
3221 gdk_window_set_background_pattern (window, pattern);
3222 cairo_pattern_destroy (pattern);
3226 gtk_style_context_get (context, state,
3227 "background-color", &color,
3231 gdk_window_set_background_rgba (window, color);
3232 gdk_rgba_free (color);
3237 * gtk_style_context_get_color:
3238 * @context: a #GtkStyleContext
3239 * @state: state to retrieve the color for
3240 * @color: (out): return value for the foreground color
3242 * Gets the foreground color for a given state.
3247 gtk_style_context_get_color (GtkStyleContext *context,
3248 GtkStateFlags state,
3253 g_return_if_fail (color != NULL);
3254 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3256 gtk_style_context_get (context,
3266 * gtk_style_context_get_background_color:
3267 * @context: a #GtkStyleContext
3268 * @state: state to retrieve the color for
3269 * @color: (out): return value for the background color
3271 * Gets the background color for a given state.
3276 gtk_style_context_get_background_color (GtkStyleContext *context,
3277 GtkStateFlags state,
3282 g_return_if_fail (color != NULL);
3283 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3285 gtk_style_context_get (context,
3287 "background-color", &c,
3295 * gtk_style_context_get_border_color:
3296 * @context: a #GtkStyleContext
3297 * @state: state to retrieve the color for
3298 * @color: (out): return value for the border color
3300 * Gets the border color for a given state.
3305 gtk_style_context_get_border_color (GtkStyleContext *context,
3306 GtkStateFlags state,
3311 g_return_if_fail (color != NULL);
3312 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3314 gtk_style_context_get (context,
3324 * gtk_style_context_get_border:
3325 * @context: a #GtkStyleContext
3326 * @state: state to retrieve the border for
3327 * @border: (out): return value for the border settings
3329 * Gets the border for a given state as a #GtkBorder.
3330 * See %GTK_STYLE_PROPERTY_BORDER_WIDTH.
3335 gtk_style_context_get_border (GtkStyleContext *context,
3336 GtkStateFlags state,
3339 int top, left, bottom, right;
3341 g_return_if_fail (border != NULL);
3342 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3344 gtk_style_context_get (context,
3346 "border-top-width", &top,
3347 "border-left-width", &left,
3348 "border-bottom-width", &bottom,
3349 "border-right-width", &right,
3353 border->left = left;
3354 border->bottom = bottom;
3355 border->right = right;
3359 * gtk_style_context_get_padding:
3360 * @context: a #GtkStyleContext
3361 * @state: state to retrieve the padding for
3362 * @padding: (out): return value for the padding settings
3364 * Gets the padding for a given state as a #GtkBorder.
3365 * See %GTK_STYLE_PROPERTY_PADDING.
3370 gtk_style_context_get_padding (GtkStyleContext *context,
3371 GtkStateFlags state,
3374 int top, left, bottom, right;
3376 g_return_if_fail (padding != NULL);
3377 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3379 gtk_style_context_get (context,
3381 "padding-top", &top,
3382 "padding-left", &left,
3383 "padding-bottom", &bottom,
3384 "padding-right", &right,
3388 padding->left = left;
3389 padding->bottom = bottom;
3390 padding->right = right;
3394 * gtk_style_context_get_margin:
3395 * @context: a #GtkStyleContext
3396 * @state: state to retrieve the border for
3397 * @margin: (out): return value for the margin settings
3399 * Gets the margin for a given state as a #GtkBorder.
3400 * See %GTK_STYLE_PROPERTY_MARGIN.
3405 gtk_style_context_get_margin (GtkStyleContext *context,
3406 GtkStateFlags state,
3409 int top, left, bottom, right;
3411 g_return_if_fail (margin != NULL);
3412 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3414 gtk_style_context_get (context,
3417 "margin-left", &left,
3418 "margin-bottom", &bottom,
3419 "margin-right", &right,
3423 margin->left = left;
3424 margin->bottom = bottom;
3425 margin->right = right;
3429 * gtk_style_context_get_font:
3430 * @context: a #GtkStyleContext
3431 * @state: state to retrieve the font for
3433 * Returns the font description for a given state. The returned
3434 * object is const and will remain valid until the
3435 * #GtkStyleContext::changed signal happens.
3437 * Returns: (transfer none): the #PangoFontDescription for the given
3438 * state. This object is owned by GTK+ and should not be
3443 const PangoFontDescription *
3444 gtk_style_context_get_font (GtkStyleContext *context,
3445 GtkStateFlags state)
3447 GtkStyleContextPrivate *priv;
3449 PangoFontDescription *description;
3451 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL);
3453 priv = context->priv;
3454 g_return_val_if_fail (priv->widget != NULL || priv->widget_path != NULL, NULL);
3456 data = style_data_lookup_for_state (context, state);
3458 /* Yuck, fonts are created on-demand but we don't return a ref.
3459 * Do bad things to achieve this requirement */
3460 description = g_object_get_data (G_OBJECT (data->store), "font-cache-for-get_font");
3461 if (description == NULL)
3463 gtk_style_context_get (context, state, "font", &description, NULL);
3464 g_object_set_data_full (G_OBJECT (data->store),
3465 "font-cache-for-get_font",
3467 (GDestroyNotify) pango_font_description_free);
3473 get_cursor_color (GtkStyleContext *context,
3477 GdkColor *style_color;
3479 gtk_style_context_get_style (context,
3480 primary ? "cursor-color" : "secondary-cursor-color",
3486 color->red = style_color->red / 65535.0;
3487 color->green = style_color->green / 65535.0;
3488 color->blue = style_color->blue / 65535.0;
3491 gdk_color_free (style_color);
3495 gtk_style_context_get_color (context, GTK_STATE_FLAG_NORMAL, color);
3501 gtk_style_context_get_background_color (context, GTK_STATE_FLAG_NORMAL, &bg);
3503 color->red = (color->red + bg.red) * 0.5;
3504 color->green = (color->green + bg.green) * 0.5;
3505 color->blue = (color->blue + bg.blue) * 0.5;
3511 _gtk_style_context_get_cursor_color (GtkStyleContext *context,
3512 GdkRGBA *primary_color,
3513 GdkRGBA *secondary_color)
3516 get_cursor_color (context, TRUE, primary_color);
3518 if (secondary_color)
3519 get_cursor_color (context, FALSE, secondary_color);
3526 * @context: a #GtkStyleContext
3528 * @x: X origin of the rectangle
3529 * @y: Y origin of the rectangle
3530 * @width: rectangle width
3531 * @height: rectangle height
3533 * Renders a checkmark (as in a #GtkCheckButton).
3535 * The %GTK_STATE_FLAG_ACTIVE state determines whether the check is
3536 * on or off, and %GTK_STATE_FLAG_INCONSISTENT determines whether it
3537 * should be marked as undefined.
3540 * <title>Typical checkmark rendering</title>
3541 * <inlinegraphic fileref="checks.png" format="PNG"/>
3547 gtk_render_check (GtkStyleContext *context,
3554 GtkThemingEngineClass *engine_class;
3555 GtkThemingEngine *engine;
3557 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3558 g_return_if_fail (cr != NULL);
3560 if (width <= 0 || height <= 0)
3563 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
3564 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
3569 _gtk_theming_engine_set_context (engine, context);
3570 engine_class->render_check (engine, cr,
3571 x, y, width, height);
3577 * gtk_render_option:
3578 * @context: a #GtkStyleContext
3580 * @x: X origin of the rectangle
3581 * @y: Y origin of the rectangle
3582 * @width: rectangle width
3583 * @height: rectangle height
3585 * Renders an option mark (as in a #GtkRadioButton), the %GTK_STATE_FLAG_ACTIVE
3586 * state will determine whether the option is on or off, and
3587 * %GTK_STATE_FLAG_INCONSISTENT whether it should be marked as undefined.
3590 * <title>Typical option mark rendering</title>
3591 * <inlinegraphic fileref="options.png" format="PNG"/>
3597 gtk_render_option (GtkStyleContext *context,
3604 GtkThemingEngineClass *engine_class;
3605 GtkThemingEngine *engine;
3607 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3608 g_return_if_fail (cr != NULL);
3610 if (width <= 0 || height <= 0)
3613 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
3614 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
3618 _gtk_theming_engine_set_context (engine, context);
3619 engine_class->render_option (engine, cr,
3620 x, y, width, height);
3627 * @context: a #GtkStyleContext
3629 * @angle: arrow angle from 0 to 2 * %G_PI, being 0 the arrow pointing to the north
3630 * @x: X origin of the render area
3631 * @y: Y origin of the render area
3632 * @size: square side for render area
3634 * Renders an arrow pointing to @angle.
3637 * <title>Typical arrow rendering at 0, 1&solidus;2 π, π and 3&solidus;2 π</title>
3638 * <inlinegraphic fileref="arrows.png" format="PNG"/>
3644 gtk_render_arrow (GtkStyleContext *context,
3651 GtkThemingEngineClass *engine_class;
3652 GtkThemingEngine *engine;
3654 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3655 g_return_if_fail (cr != NULL);
3660 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
3661 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
3665 gtk_style_context_save (context);
3666 gtk_style_context_add_class (context, GTK_STYLE_CLASS_ARROW);
3668 _gtk_theming_engine_set_context (engine, context);
3669 engine_class->render_arrow (engine, cr,
3672 gtk_style_context_restore (context);
3677 * gtk_render_background:
3678 * @context: a #GtkStyleContext
3680 * @x: X origin of the rectangle
3681 * @y: Y origin of the rectangle
3682 * @width: rectangle width
3683 * @height: rectangle height
3685 * Renders the background of an element.
3688 * <title>Typical background rendering, showing the effect of
3689 * <parameter>background-image</parameter>,
3690 * <parameter>border-width</parameter> and
3691 * <parameter>border-radius</parameter></title>
3692 * <inlinegraphic fileref="background.png" format="PNG"/>
3698 gtk_render_background (GtkStyleContext *context,
3705 GtkThemingEngineClass *engine_class;
3706 GtkThemingEngine *engine;
3708 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3709 g_return_if_fail (cr != NULL);
3711 if (width <= 0 || height <= 0)
3714 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
3715 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
3719 _gtk_theming_engine_set_context (engine, context);
3720 engine_class->render_background (engine, cr, x, y, width, height);
3727 * @context: a #GtkStyleContext
3729 * @x: X origin of the rectangle
3730 * @y: Y origin of the rectangle
3731 * @width: rectangle width
3732 * @height: rectangle height
3734 * Renders a frame around the rectangle defined by @x, @y, @width, @height.
3737 * <title>Examples of frame rendering, showing the effect of
3738 * <parameter>border-image</parameter>,
3739 * <parameter>border-color</parameter>,
3740 * <parameter>border-width</parameter>,
3741 * <parameter>border-radius</parameter> and
3743 * <inlinegraphic fileref="frames.png" format="PNG"/>
3749 gtk_render_frame (GtkStyleContext *context,
3756 GtkThemingEngineClass *engine_class;
3757 GtkThemingEngine *engine;
3759 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3760 g_return_if_fail (cr != NULL);
3762 if (width <= 0 || height <= 0)
3765 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
3766 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
3770 _gtk_theming_engine_set_context (engine, context);
3771 engine_class->render_frame (engine, cr, x, y, width, height);
3777 * gtk_render_expander:
3778 * @context: a #GtkStyleContext
3780 * @x: X origin of the rectangle
3781 * @y: Y origin of the rectangle
3782 * @width: rectangle width
3783 * @height: rectangle height
3785 * Renders an expander (as used in #GtkTreeView and #GtkExpander) in the area
3786 * defined by @x, @y, @width, @height. The state %GTK_STATE_FLAG_ACTIVE
3787 * determines whether the expander is collapsed or expanded.
3790 * <title>Typical expander rendering</title>
3791 * <inlinegraphic fileref="expanders.png" format="PNG"/>
3797 gtk_render_expander (GtkStyleContext *context,
3804 GtkThemingEngineClass *engine_class;
3805 GtkThemingEngine *engine;
3807 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3808 g_return_if_fail (cr != NULL);
3810 if (width <= 0 || height <= 0)
3813 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
3814 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
3818 _gtk_theming_engine_set_context (engine, context);
3819 engine_class->render_expander (engine, cr, x, y, width, height);
3826 * @context: a #GtkStyleContext
3828 * @x: X origin of the rectangle
3829 * @y: Y origin of the rectangle
3830 * @width: rectangle width
3831 * @height: rectangle height
3833 * Renders a focus indicator on the rectangle determined by @x, @y, @width, @height.
3835 * <title>Typical focus rendering</title>
3836 * <inlinegraphic fileref="focus.png" format="PNG"/>
3842 gtk_render_focus (GtkStyleContext *context,
3849 GtkThemingEngineClass *engine_class;
3850 GtkThemingEngine *engine;
3852 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3853 g_return_if_fail (cr != NULL);
3855 if (width <= 0 || height <= 0)
3858 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
3859 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
3863 _gtk_theming_engine_set_context (engine, context);
3864 engine_class->render_focus (engine, cr, x, y, width, height);
3870 * gtk_render_layout:
3871 * @context: a #GtkStyleContext
3875 * @layout: the #PangoLayout to render
3877 * Renders @layout on the coordinates @x, @y
3882 gtk_render_layout (GtkStyleContext *context,
3886 PangoLayout *layout)
3888 GtkThemingEngineClass *engine_class;
3889 GtkThemingEngine *engine;
3890 PangoRectangle extents;
3892 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3893 g_return_if_fail (PANGO_IS_LAYOUT (layout));
3894 g_return_if_fail (cr != NULL);
3896 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
3897 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
3901 pango_layout_get_extents (layout, &extents, NULL);
3903 _gtk_theming_engine_set_context (engine, context);
3904 engine_class->render_layout (engine, cr, x, y, layout);
3911 * @context: a #GtkStyleContext
3913 * @x0: X coordinate for the origin of the line
3914 * @y0: Y coordinate for the origin of the line
3915 * @x1: X coordinate for the end of the line
3916 * @y1: Y coordinate for the end of the line
3918 * Renders a line from (x0, y0) to (x1, y1).
3923 gtk_render_line (GtkStyleContext *context,
3930 GtkThemingEngineClass *engine_class;
3931 GtkThemingEngine *engine;
3933 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3934 g_return_if_fail (cr != NULL);
3936 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
3937 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
3941 _gtk_theming_engine_set_context (engine, context);
3942 engine_class->render_line (engine, cr, x0, y0, x1, y1);
3948 * gtk_render_slider:
3949 * @context: a #GtkStyleContext
3951 * @x: X origin of the rectangle
3952 * @y: Y origin of the rectangle
3953 * @width: rectangle width
3954 * @height: rectangle height
3955 * @orientation: orientation of the slider
3957 * Renders a slider (as in #GtkScale) in the rectangle defined by @x, @y,
3958 * @width, @height. @orientation defines whether the slider is vertical
3962 * <title>Typical slider rendering</title>
3963 * <inlinegraphic fileref="sliders.png" format="PNG"/>
3969 gtk_render_slider (GtkStyleContext *context,
3975 GtkOrientation orientation)
3977 GtkThemingEngineClass *engine_class;
3978 GtkThemingEngine *engine;
3980 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
3981 g_return_if_fail (cr != NULL);
3983 if (width <= 0 || height <= 0)
3986 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
3987 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
3991 _gtk_theming_engine_set_context (engine, context);
3992 engine_class->render_slider (engine, cr, x, y, width, height, orientation);
3998 * gtk_render_frame_gap:
3999 * @context: a #GtkStyleContext
4001 * @x: X origin of the rectangle
4002 * @y: Y origin of the rectangle
4003 * @width: rectangle width
4004 * @height: rectangle height
4005 * @gap_side: side where the gap is
4006 * @xy0_gap: initial coordinate (X or Y depending on @gap_side) for the gap
4007 * @xy1_gap: end coordinate (X or Y depending on @gap_side) for the gap
4009 * Renders a frame around the rectangle defined by (@x, @y, @width, @height),
4010 * leaving a gap on one side. @xy0_gap and @xy1_gap will mean X coordinates
4011 * for %GTK_POS_TOP and %GTK_POS_BOTTOM gap sides, and Y coordinates for
4012 * %GTK_POS_LEFT and %GTK_POS_RIGHT.
4015 * <title>Typical rendering of a frame with a gap</title>
4016 * <inlinegraphic fileref="frame-gap.png" format="PNG"/>
4022 gtk_render_frame_gap (GtkStyleContext *context,
4028 GtkPositionType gap_side,
4032 GtkThemingEngineClass *engine_class;
4033 GtkThemingEngine *engine;
4035 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
4036 g_return_if_fail (cr != NULL);
4037 g_return_if_fail (xy0_gap <= xy1_gap);
4038 g_return_if_fail (xy0_gap >= 0);
4040 if (width <= 0 || height <= 0)
4043 if (gap_side == GTK_POS_LEFT ||
4044 gap_side == GTK_POS_RIGHT)
4045 g_return_if_fail (xy1_gap <= height);
4047 g_return_if_fail (xy1_gap <= width);
4049 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
4050 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
4054 _gtk_theming_engine_set_context (engine, context);
4055 engine_class->render_frame_gap (engine, cr,
4056 x, y, width, height, gap_side,
4063 * gtk_render_extension:
4064 * @context: a #GtkStyleContext
4066 * @x: X origin of the rectangle
4067 * @y: Y origin of the rectangle
4068 * @width: rectangle width
4069 * @height: rectangle height
4070 * @gap_side: side where the gap is
4072 * Renders a extension (as in a #GtkNotebook tab) in the rectangle
4073 * defined by @x, @y, @width, @height. The side where the extension
4074 * connects to is defined by @gap_side.
4077 * <title>Typical extension rendering</title>
4078 * <inlinegraphic fileref="extensions.png" format="PNG"/>
4084 gtk_render_extension (GtkStyleContext *context,
4090 GtkPositionType gap_side)
4092 GtkThemingEngineClass *engine_class;
4093 GtkThemingEngine *engine;
4095 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
4096 g_return_if_fail (cr != NULL);
4098 if (width <= 0 || height <= 0)
4101 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
4102 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
4106 _gtk_theming_engine_set_context (engine, context);
4107 engine_class->render_extension (engine, cr, x, y, width, height, gap_side);
4113 * gtk_render_handle:
4114 * @context: a #GtkStyleContext
4116 * @x: X origin of the rectangle
4117 * @y: Y origin of the rectangle
4118 * @width: rectangle width
4119 * @height: rectangle height
4121 * Renders a handle (as in #GtkHandleBox, #GtkPaned and
4122 * #GtkWindow<!-- -->'s resize grip), in the rectangle
4123 * determined by @x, @y, @width, @height.
4126 * <title>Handles rendered for the paned and grip classes</title>
4127 * <inlinegraphic fileref="handles.png" format="PNG"/>
4133 gtk_render_handle (GtkStyleContext *context,
4140 GtkThemingEngineClass *engine_class;
4141 GtkThemingEngine *engine;
4143 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
4144 g_return_if_fail (cr != NULL);
4146 if (width <= 0 || height <= 0)
4149 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
4150 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
4154 _gtk_theming_engine_set_context (engine, context);
4155 engine_class->render_handle (engine, cr, x, y, width, height);
4161 * gtk_render_activity:
4162 * @context: a #GtkStyleContext
4164 * @x: X origin of the rectangle
4165 * @y: Y origin of the rectangle
4166 * @width: rectangle width
4167 * @height: rectangle height
4169 * Renders an activity area (Such as in #GtkSpinner or the
4170 * fill line in #GtkRange), the state %GTK_STATE_FLAG_ACTIVE
4171 * determines whether there is activity going on.
4176 gtk_render_activity (GtkStyleContext *context,
4183 GtkThemingEngineClass *engine_class;
4184 GtkThemingEngine *engine;
4186 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
4187 g_return_if_fail (cr != NULL);
4189 if (width <= 0 || height <= 0)
4192 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
4193 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
4197 _gtk_theming_engine_set_context (engine, context);
4198 engine_class->render_activity (engine, cr, x, y, width, height);
4204 * gtk_render_icon_pixbuf:
4205 * @context: a #GtkStyleContext
4206 * @source: the #GtkIconSource specifying the icon to render
4207 * @size: (type int): the size to render the icon at. A size of (GtkIconSize) -1
4208 * means render at the size of the source and don't scale.
4210 * Renders the icon specified by @source at the given @size, returning the result
4213 * Returns: (transfer full): a newly-created #GdkPixbuf containing the rendered icon
4218 gtk_render_icon_pixbuf (GtkStyleContext *context,
4219 const GtkIconSource *source,
4222 GtkThemingEngineClass *engine_class;
4223 GtkThemingEngine *engine;
4225 g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL);
4226 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID || size == -1, NULL);
4227 g_return_val_if_fail (source != NULL, NULL);
4229 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
4230 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
4232 _gtk_theming_engine_set_context (engine, context);
4233 return engine_class->render_icon_pixbuf (engine, source, size);
4238 * @context: a #GtkStyleContext
4240 * @pixbuf: a #GdkPixbuf containing the icon to draw
4241 * @x: X position for the @pixbuf
4242 * @y: Y position for the @pixbuf
4244 * Renders the icon in @pixbuf at the specified @x and @y coordinates.
4249 gtk_render_icon (GtkStyleContext *context,
4255 GtkThemingEngineClass *engine_class;
4256 GtkThemingEngine *engine;
4258 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
4259 g_return_if_fail (cr != NULL);
4261 engine = _gtk_css_engine_value_get_engine (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_ENGINE));
4262 engine_class = GTK_THEMING_ENGINE_GET_CLASS (engine);
4266 _gtk_theming_engine_set_context (engine, context);
4267 engine_class->render_icon (engine, cr, pixbuf, x, y);
4273 draw_insertion_cursor (GtkStyleContext *context,
4278 gboolean is_primary,
4279 PangoDirection direction,
4280 gboolean draw_arrow)
4283 GdkRGBA primary_color;
4284 GdkRGBA secondary_color;
4285 gfloat cursor_aspect_ratio;
4291 _gtk_style_context_get_cursor_color (context, &primary_color, &secondary_color);
4292 gdk_cairo_set_source_rgba (cr, is_primary ? &primary_color : &secondary_color);
4294 /* When changing the shape or size of the cursor here,
4295 * propagate the changes to gtktextview.c:text_window_invalidate_cursors().
4298 gtk_style_context_get_style (context,
4299 "cursor-aspect-ratio", &cursor_aspect_ratio,
4302 stem_width = height * cursor_aspect_ratio + 1;
4304 /* put (stem_width % 2) on the proper side of the cursor */
4305 if (direction == PANGO_DIRECTION_LTR)
4306 offset = stem_width / 2;
4308 offset = stem_width - stem_width / 2;
4310 cairo_rectangle (cr, x - offset, y, stem_width, height);
4318 arrow_width = stem_width + 1;
4320 if (direction == PANGO_DIRECTION_RTL)
4322 ax = x - offset - 1;
4323 ay = y + height - arrow_width * 2 - arrow_width + 1;
4325 cairo_move_to (cr, ax, ay + 1);
4326 cairo_line_to (cr, ax - arrow_width, ay + arrow_width);
4327 cairo_line_to (cr, ax, ay + 2 * arrow_width);
4330 else if (direction == PANGO_DIRECTION_LTR)
4332 ax = x + stem_width - offset;
4333 ay = y + height - arrow_width * 2 - arrow_width + 1;
4335 cairo_move_to (cr, ax, ay + 1);
4336 cairo_line_to (cr, ax + arrow_width, ay + arrow_width);
4337 cairo_line_to (cr, ax, ay + 2 * arrow_width);
4341 g_assert_not_reached();
4348 * gtk_render_insertion_cursor:
4349 * @context: a #GtkStyleContext
4353 * @layout: the #PangoLayout of the text
4354 * @index: the index in the #PangoLayout
4355 * @direction: the #PangoDirection of the text
4357 * Draws a text caret on @cr at the specified index of @layout.
4362 gtk_render_insertion_cursor (GtkStyleContext *context,
4366 PangoLayout *layout,
4368 PangoDirection direction)
4370 GtkStyleContextPrivate *priv;
4371 gboolean split_cursor;
4372 PangoRectangle strong_pos, weak_pos;
4373 PangoRectangle *cursor1, *cursor2;
4374 PangoDirection keymap_direction;
4375 PangoDirection direction2;
4377 g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));
4378 g_return_if_fail (cr != NULL);
4379 g_return_if_fail (PANGO_IS_LAYOUT (layout));
4380 g_return_if_fail (index >= 0);
4382 priv = context->priv;
4384 g_object_get (gtk_settings_get_for_screen (priv->screen),
4385 "gtk-split-cursor", &split_cursor,
4388 keymap_direction = gdk_keymap_get_direction (gdk_keymap_get_for_display (gdk_screen_get_display (priv->screen)));
4390 pango_layout_get_cursor_pos (layout, index, &strong_pos, &weak_pos);
4392 direction2 = PANGO_DIRECTION_NEUTRAL;
4396 cursor1 = &strong_pos;
4398 if (strong_pos.x != weak_pos.x || strong_pos.y != weak_pos.y)
4400 direction2 = (direction == PANGO_DIRECTION_LTR) ? PANGO_DIRECTION_RTL : PANGO_DIRECTION_LTR;
4401 cursor2 = &weak_pos;
4406 if (keymap_direction == direction)
4407 cursor1 = &strong_pos;
4409 cursor1 = &weak_pos;
4412 draw_insertion_cursor (context,
4414 x + PANGO_PIXELS (cursor1->x),
4415 y + PANGO_PIXELS (cursor1->y),
4416 PANGO_PIXELS (cursor1->height),
4419 direction2 != PANGO_DIRECTION_NEUTRAL);
4421 if (direction2 != PANGO_DIRECTION_NEUTRAL)
4423 draw_insertion_cursor (context,
4425 x + PANGO_PIXELS (cursor2->x),
4426 y + PANGO_PIXELS (cursor2->y),
4427 PANGO_PIXELS (cursor2->height),
4435 * gtk_draw_insertion_cursor:
4436 * @widget: a #GtkWidget
4437 * @cr: cairo context to draw to
4438 * @location: location where to draw the cursor (@location->width is ignored)
4439 * @is_primary: if the cursor should be the primary cursor color.
4440 * @direction: whether the cursor is left-to-right or
4441 * right-to-left. Should never be #GTK_TEXT_DIR_NONE
4442 * @draw_arrow: %TRUE to draw a directional arrow on the
4443 * cursor. Should be %FALSE unless the cursor is split.
4445 * Draws a text caret on @cr at @location. This is not a style function
4446 * but merely a convenience function for drawing the standard cursor shape.
4449 * Deprecated: 3.4: Use gtk_render_insertion_cursor() instead.
4452 gtk_draw_insertion_cursor (GtkWidget *widget,
4454 const GdkRectangle *location,
4455 gboolean is_primary,
4456 GtkTextDirection direction,
4457 gboolean draw_arrow)
4459 GtkStyleContext *context;
4461 g_return_if_fail (GTK_IS_WIDGET (widget));
4462 g_return_if_fail (cr != NULL);
4463 g_return_if_fail (location != NULL);
4464 g_return_if_fail (direction != GTK_TEXT_DIR_NONE);
4466 context = gtk_widget_get_style_context (widget);
4468 draw_insertion_cursor (context, cr,
4469 location->x, location->y, location->height,
4471 (direction == GTK_TEXT_DIR_RTL) ? PANGO_DIRECTION_RTL : PANGO_DIRECTION_LTR,
4475 static AtkAttributeSet *
4476 add_attribute (AtkAttributeSet *attributes,
4477 AtkTextAttribute attr,
4482 at = g_new (AtkAttribute, 1);
4483 at->name = g_strdup (atk_text_attribute_get_name (attr));
4484 at->value = g_strdup (value);
4486 return g_slist_prepend (attributes, at);
4490 * _gtk_style_context_get_attributes:
4491 * @attributes: a #AtkAttributeSet to add attributes to
4492 * @context: the #GtkStyleContext to get attributes from
4493 * @flags: the state to use with @context
4495 * Adds the foreground and background color from @context to
4496 * @attributes, after translating them to ATK attributes.
4498 * This is a convenience function that can be used in
4499 * implementing the #AtkText interface in widgets.
4501 * Returns: the modified #AtkAttributeSet
4504 _gtk_style_context_get_attributes (AtkAttributeSet *attributes,
4505 GtkStyleContext *context,
4506 GtkStateFlags flags)
4511 gtk_style_context_get_background_color (context, flags, &color);
4512 value = g_strdup_printf ("%u,%u,%u",
4513 (guint) ceil (color.red * 65536 - color.red),
4514 (guint) ceil (color.green * 65536 - color.green),
4515 (guint) ceil (color.blue * 65536 - color.blue));
4516 attributes = add_attribute (attributes, ATK_TEXT_ATTR_BG_COLOR, value);
4519 gtk_style_context_get_color (context, flags, &color);
4520 value = g_strdup_printf ("%u,%u,%u",
4521 (guint) ceil (color.red * 65536 - color.red),
4522 (guint) ceil (color.green * 65536 - color.green),
4523 (guint) ceil (color.blue * 65536 - color.blue));
4524 attributes = add_attribute (attributes, ATK_TEXT_ATTR_FG_COLOR, value);