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/>.
20 #include "gtkstylepropertiesprivate.h"
23 #include <gobject/gvaluecollector.h>
24 #include <cairo-gobject.h>
26 #include "gtkstyleprovider.h"
27 #include "gtksymboliccolor.h"
28 #include "gtkthemingengine.h"
29 #include "gtkanimationdescription.h"
30 #include "gtkgradient.h"
31 #include "gtkshadowprivate.h"
32 #include "gtkcssshorthandpropertyprivate.h"
33 #include "gtkcsstypesprivate.h"
34 #include "gtkborderimageprivate.h"
36 #include "gtkprivatetypebuiltins.h"
37 #include "gtkstylepropertyprivate.h"
38 #include "gtkstyleproviderprivate.h"
41 #include "gtkwin32themeprivate.h"
44 * SECTION:gtkstyleproperties
45 * @Short_description: Store for style property information
46 * @Title: GtkStyleProperties
48 * GtkStyleProperties provides the storage for style information
49 * that is used by #GtkStyleContext and other #GtkStyleProvider
52 * Before style properties can be stored in GtkStyleProperties, they
53 * must be registered with gtk_style_properties_register_property().
55 * Unless you are writing a #GtkStyleProvider implementation, you
56 * are unlikely to use this API directly, as gtk_style_context_get()
57 * and its variants are the preferred way to access styling information
58 * from widget implementations and theming engine implementations
59 * should use the APIs provided by #GtkThemingEngine instead.
62 typedef struct PropertyData PropertyData;
63 typedef struct ValueData ValueData;
76 struct _GtkStylePropertiesPrivate
78 GHashTable *color_map;
79 GHashTable *properties;
82 static void gtk_style_properties_provider_init (GtkStyleProviderIface *iface);
83 static void gtk_style_properties_provider_private_init (GtkStyleProviderPrivateInterface *iface);
84 static void gtk_style_properties_finalize (GObject *object);
87 G_DEFINE_TYPE_EXTENDED (GtkStyleProperties, gtk_style_properties, G_TYPE_OBJECT, 0,
88 G_IMPLEMENT_INTERFACE (GTK_TYPE_STYLE_PROVIDER,
89 gtk_style_properties_provider_init)
90 G_IMPLEMENT_INTERFACE (GTK_TYPE_STYLE_PROVIDER_PRIVATE,
91 gtk_style_properties_provider_private_init));
94 gtk_style_properties_class_init (GtkStylePropertiesClass *klass)
96 GObjectClass *object_class = G_OBJECT_CLASS (klass);
98 object_class->finalize = gtk_style_properties_finalize;
100 g_type_class_add_private (object_class, sizeof (GtkStylePropertiesPrivate));
103 static PropertyData *
104 property_data_new (void)
108 data = g_slice_new0 (PropertyData);
109 data->values = g_array_new (FALSE, FALSE, sizeof (ValueData));
115 property_data_remove_values (PropertyData *data)
119 for (i = 0; i < data->values->len; i++)
121 ValueData *value_data;
123 value_data = &g_array_index (data->values, ValueData, i);
125 _gtk_css_value_unref (value_data->value);
126 value_data->value = NULL;
129 if (data->values->len > 0)
130 g_array_remove_range (data->values, 0, data->values->len);
134 property_data_free (PropertyData *data)
136 property_data_remove_values (data);
137 g_array_free (data->values, TRUE);
138 g_slice_free (PropertyData, data);
142 property_data_find_position (PropertyData *data,
147 gboolean found = FALSE;
153 if (data->values->len == 0)
156 /* Find position for the given state, or the position where
157 * it would be if not found, the array is ordered by the
161 max = data->values->len - 1;
165 ValueData *value_data;
167 mid = (min + max) / 2;
168 value_data = &g_array_index (data->values, ValueData, mid);
170 if (value_data->state == state)
175 else if (value_data->state < state)
176 position = min = mid + 1;
183 while (!found && min <= max);
192 property_data_get_value (PropertyData *data,
197 if (!property_data_find_position (data, state, &pos))
199 ValueData new = { 0 };
202 g_array_insert_val (data->values, pos, new);
205 return &g_array_index (data->values, ValueData, pos);
209 property_data_match_state (PropertyData *data,
215 if (property_data_find_position (data, state, &pos))
220 val_data = &g_array_index (data->values, ValueData, pos);
221 return val_data->value;
224 if (pos >= data->values->len)
225 pos = data->values->len - 1;
227 /* No exact match, go downwards the list to find
228 * the closest match to the given state flags, as
229 * a side effect, there is an implicit precedence
230 * of higher flags over the smaller ones.
232 for (i = pos; i >= 0; i--)
236 val_data = &g_array_index (data->values, ValueData, i);
238 /* Check whether any of the requested
239 * flags are set, and no other flags are.
241 * Also, no flags acts as a wildcard, such
242 * value should be always in the first position
243 * in the array (if present) anyways.
245 if (val_data->state == 0 ||
246 ((val_data->state & state) != 0 &&
247 (val_data->state & ~state) == 0))
248 return val_data->value;
255 gtk_style_properties_init (GtkStyleProperties *props)
257 GtkStylePropertiesPrivate *priv;
259 priv = props->priv = G_TYPE_INSTANCE_GET_PRIVATE (props,
260 GTK_TYPE_STYLE_PROPERTIES,
261 GtkStylePropertiesPrivate);
263 priv->properties = g_hash_table_new_full (NULL, NULL, NULL,
264 (GDestroyNotify) property_data_free);
268 gtk_style_properties_finalize (GObject *object)
270 GtkStylePropertiesPrivate *priv;
271 GtkStyleProperties *props;
273 props = GTK_STYLE_PROPERTIES (object);
275 g_hash_table_destroy (priv->properties);
278 g_hash_table_destroy (priv->color_map);
280 G_OBJECT_CLASS (gtk_style_properties_parent_class)->finalize (object);
284 gtk_style_properties_get_style (GtkStyleProvider *provider,
287 /* Return style set itself */
288 return g_object_ref (provider);
292 gtk_style_properties_provider_init (GtkStyleProviderIface *iface)
294 iface->get_style = gtk_style_properties_get_style;
297 static GtkSymbolicColor *
298 gtk_style_properties_provider_get_color (GtkStyleProviderPrivate *provider,
301 return gtk_style_properties_lookup_color (GTK_STYLE_PROPERTIES (provider), name);
305 gtk_style_properties_provider_lookup (GtkStyleProviderPrivate *provider,
306 const GtkCssMatcher *matcher,
307 GtkCssLookup *lookup)
309 GtkStyleProperties *props;
310 GtkStylePropertiesPrivate *priv;
314 props = GTK_STYLE_PROPERTIES (provider);
317 /* Merge symbolic style properties */
318 g_hash_table_iter_init (&iter, priv->properties);
320 while (g_hash_table_iter_next (&iter, &key, &value))
322 GtkCssStyleProperty *prop = key;
323 PropertyData *data = value;
327 id = _gtk_css_style_property_get_id (prop);
329 if (!_gtk_css_lookup_is_missing (lookup, id))
332 value = property_data_match_state (data, _gtk_css_matcher_get_state (matcher));
336 _gtk_css_lookup_set_computed (lookup, id, NULL, value);
341 gtk_style_properties_provider_get_change (GtkStyleProviderPrivate *provider,
342 const GtkCssMatcher *matcher)
344 return GTK_CSS_CHANGE_STATE;
348 gtk_style_properties_provider_private_init (GtkStyleProviderPrivateInterface *iface)
350 iface->get_color = gtk_style_properties_provider_get_color;
351 iface->lookup = gtk_style_properties_provider_lookup;
352 iface->get_change = gtk_style_properties_provider_get_change;
355 /* GtkStyleProperties methods */
358 * gtk_style_properties_new:
360 * Returns a newly created #GtkStyleProperties
362 * Returns: a new #GtkStyleProperties
365 gtk_style_properties_new (void)
367 return g_object_new (GTK_TYPE_STYLE_PROPERTIES, NULL);
371 * gtk_style_properties_map_color:
372 * @props: a #GtkStyleProperties
374 * @color: #GtkSymbolicColor to map @name to
376 * Maps @color so it can be referenced by @name. See
377 * gtk_style_properties_lookup_color()
382 gtk_style_properties_map_color (GtkStyleProperties *props,
384 GtkSymbolicColor *color)
386 GtkStylePropertiesPrivate *priv;
388 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
389 g_return_if_fail (name != NULL);
390 g_return_if_fail (color != NULL);
394 if (G_UNLIKELY (!priv->color_map))
395 priv->color_map = g_hash_table_new_full (g_str_hash,
397 (GDestroyNotify) g_free,
398 (GDestroyNotify) gtk_symbolic_color_unref);
400 g_hash_table_replace (priv->color_map,
402 gtk_symbolic_color_ref (color));
406 * gtk_style_properties_lookup_color:
407 * @props: a #GtkStyleProperties
408 * @name: color name to lookup
410 * Returns the symbolic color that is mapped
413 * Returns: (transfer none): The mapped color
418 gtk_style_properties_lookup_color (GtkStyleProperties *props,
421 GtkStylePropertiesPrivate *priv;
423 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), NULL);
424 g_return_val_if_fail (name != NULL, NULL);
428 if (!priv->color_map)
431 return g_hash_table_lookup (priv->color_map, name);
435 _gtk_style_properties_set_property_by_property (GtkStyleProperties *props,
436 GtkCssStyleProperty *style_prop,
440 GtkStylePropertiesPrivate *priv;
444 g_return_if_fail (_gtk_css_value_holds (value, _gtk_css_style_property_get_computed_type (style_prop)));
447 prop = g_hash_table_lookup (priv->properties, style_prop);
451 prop = property_data_new ();
452 g_hash_table_insert (priv->properties, (gpointer) style_prop, prop);
455 val = property_data_get_value (prop, state);
457 _gtk_css_value_unref (val->value);
458 val->value = _gtk_css_value_ref (value);
462 * gtk_style_properties_set_property:
463 * @props: a #GtkStyleProperties
464 * @property: styling property to set
465 * @state: state to set the value for
466 * @value: new value for the property
468 * Sets a styling property in @props.
473 gtk_style_properties_set_property (GtkStyleProperties *props,
474 const gchar *property,
478 GtkStyleProperty *node;
480 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
481 g_return_if_fail (property != NULL);
482 g_return_if_fail (value != NULL);
484 node = _gtk_style_property_lookup (property);
488 g_warning ("Style property \"%s\" is not registered", property);
491 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
493 g_warning ("Style property \"%s\" is not settable", property);
497 _gtk_style_property_assign (node, props, state, value);
501 * gtk_style_properties_set_valist:
502 * @props: a #GtkStyleProperties
503 * @state: state to set the values for
504 * @args: va_list of property name/value pairs, followed by %NULL
506 * Sets several style properties on @props.
511 gtk_style_properties_set_valist (GtkStyleProperties *props,
515 const gchar *property_name;
517 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
519 property_name = va_arg (args, const gchar *);
521 while (property_name)
523 GtkStyleProperty *node;
526 GValue val = G_VALUE_INIT;
528 node = _gtk_style_property_lookup (property_name);
532 g_warning ("Style property \"%s\" is not registered", property_name);
536 val_type = _gtk_style_property_get_value_type (node);
537 if (val_type == G_TYPE_NONE)
539 g_warning ("Style property \"%s\" is not settable", property_name);
543 G_VALUE_COLLECT_INIT (&val, _gtk_style_property_get_value_type (node),
547 g_warning ("Could not set style property \"%s\": %s", property_name, error);
548 g_value_unset (&val);
553 _gtk_style_property_assign (node, props, state, &val);
554 g_value_unset (&val);
556 property_name = va_arg (args, const gchar *);
561 * gtk_style_properties_set:
562 * @props: a #GtkStyleProperties
563 * @state: state to set the values for
564 * @...: property name/value pairs, followed by %NULL
566 * Sets several style properties on @props.
571 gtk_style_properties_set (GtkStyleProperties *props,
577 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
579 va_start (args, state);
580 gtk_style_properties_set_valist (props, state, args);
585 _gtk_style_properties_peek_property (GtkStyleProperties *props,
586 GtkCssStyleProperty *property,
589 GtkStylePropertiesPrivate *priv;
592 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
593 g_return_val_if_fail (property != NULL, FALSE);
596 prop = g_hash_table_lookup (priv->properties, property);
600 return property_data_match_state (prop, state);
604 GtkStyleProperties *props;
609 style_query_func (guint id,
612 StyleQueryData *query = data;
614 return _gtk_style_properties_peek_property (query->props,
615 _gtk_css_style_property_lookup_by_id (id),
620 * gtk_style_properties_get_property:
621 * @props: a #GtkStyleProperties
622 * @property: style property name
623 * @state: state to retrieve the property value for
624 * @value: (out) (transfer full): return location for the style property value.
626 * Gets a style property from @props for the given state. When done with @value,
627 * g_value_unset() needs to be called to free any allocated memory.
629 * Returns: %TRUE if the property exists in @props, %FALSE otherwise
634 gtk_style_properties_get_property (GtkStyleProperties *props,
635 const gchar *property,
639 StyleQueryData query = { props, state };
640 GtkStyleProperty *node;
643 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
644 g_return_val_if_fail (property != NULL, FALSE);
645 g_return_val_if_fail (value != NULL, FALSE);
647 node = _gtk_style_property_lookup (property);
650 g_warning ("Style property \"%s\" is not registered", property);
653 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
655 g_warning ("Style property \"%s\" is not gettable", property);
659 v = _gtk_style_property_query (node,
662 _gtk_css_value_init_gvalue (v, value);
663 _gtk_css_value_unref (v);
669 * gtk_style_properties_get_valist:
670 * @props: a #GtkStyleProperties
671 * @state: state to retrieve the property values for
672 * @args: va_list of property name/return location pairs, followed by %NULL
674 * Retrieves several style property values from @props for a given state.
679 gtk_style_properties_get_valist (GtkStyleProperties *props,
683 const gchar *property_name;
685 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
687 property_name = va_arg (args, const gchar *);
689 while (property_name)
692 GValue value = G_VALUE_INIT;
694 if (!gtk_style_properties_get_property (props,
700 G_VALUE_LCOPY (&value, args, 0, &error);
701 g_value_unset (&value);
705 g_warning ("Could not get style property \"%s\": %s", property_name, error);
710 property_name = va_arg (args, const gchar *);
715 * gtk_style_properties_get:
716 * @props: a #GtkStyleProperties
717 * @state: state to retrieve the property values for
718 * @...: property name /return value pairs, followed by %NULL
720 * Retrieves several style property values from @props for a
726 gtk_style_properties_get (GtkStyleProperties *props,
732 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
734 va_start (args, state);
735 gtk_style_properties_get_valist (props, state, args);
740 * gtk_style_properties_unset_property:
741 * @props: a #GtkStyleProperties
742 * @property: property to unset
743 * @state: state to unset
745 * Unsets a style property in @props.
750 gtk_style_properties_unset_property (GtkStyleProperties *props,
751 const gchar *property,
754 GtkStylePropertiesPrivate *priv;
755 GtkStyleProperty *node;
759 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
760 g_return_if_fail (property != NULL);
762 node = _gtk_style_property_lookup (property);
766 g_warning ("Style property \"%s\" is not registered", property);
769 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
771 g_warning ("Style property \"%s\" is not settable", property);
775 if (GTK_IS_CSS_SHORTHAND_PROPERTY (node))
777 GtkCssShorthandProperty *shorthand = GTK_CSS_SHORTHAND_PROPERTY (node);
779 for (pos = 0; pos < _gtk_css_shorthand_property_get_n_subproperties (shorthand); pos++)
781 GtkCssStyleProperty *sub = _gtk_css_shorthand_property_get_subproperty (shorthand, pos);
782 gtk_style_properties_unset_property (props,
783 _gtk_style_property_get_name (GTK_STYLE_PROPERTY (sub)),
790 prop = g_hash_table_lookup (priv->properties, node);
795 if (property_data_find_position (prop, state, &pos))
799 data = &g_array_index (prop->values, ValueData, pos);
801 _gtk_css_value_unref (data->value);
804 g_array_remove_index (prop->values, pos);
809 * gtk_style_properties_clear:
810 * @props: a #GtkStyleProperties
812 * Clears all style information from @props.
815 gtk_style_properties_clear (GtkStyleProperties *props)
817 GtkStylePropertiesPrivate *priv;
819 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
822 g_hash_table_remove_all (priv->properties);
826 * gtk_style_properties_merge:
827 * @props: a #GtkStyleProperties
828 * @props_to_merge: a second #GtkStyleProperties
829 * @replace: whether to replace values or not
831 * Merges into @props all the style information contained
832 * in @props_to_merge. If @replace is %TRUE, the values
833 * will be overwritten, if it is %FALSE, the older values
839 gtk_style_properties_merge (GtkStyleProperties *props,
840 const GtkStyleProperties *props_to_merge,
843 GtkStylePropertiesPrivate *priv, *priv_to_merge;
847 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
848 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props_to_merge));
851 priv_to_merge = props_to_merge->priv;
853 /* Merge symbolic color map */
854 if (priv_to_merge->color_map)
856 g_hash_table_iter_init (&iter, priv_to_merge->color_map);
858 while (g_hash_table_iter_next (&iter, &key, &value))
861 GtkSymbolicColor *color;
867 g_hash_table_lookup (priv->color_map, name))
870 gtk_style_properties_map_color (props, name, color);
874 /* Merge symbolic style properties */
875 g_hash_table_iter_init (&iter, priv_to_merge->properties);
877 while (g_hash_table_iter_next (&iter, &key, &value))
879 PropertyData *prop_to_merge = value;
883 prop = g_hash_table_lookup (priv->properties, key);
887 prop = property_data_new ();
888 g_hash_table_insert (priv->properties, key, prop);
891 for (i = 0; i < prop_to_merge->values->len; i++)
896 data = &g_array_index (prop_to_merge->values, ValueData, i);
898 if (replace && data->state == GTK_STATE_FLAG_NORMAL &&
899 _gtk_css_value_holds (data->value, PANGO_TYPE_FONT_DESCRIPTION))
901 /* Let normal state override all states
902 * previously set in the original set
904 property_data_remove_values (prop);
907 value = property_data_get_value (prop, data->state);
909 if (_gtk_css_value_holds (data->value, PANGO_TYPE_FONT_DESCRIPTION) &&
910 value->value != NULL)
912 PangoFontDescription *font_desc;
913 PangoFontDescription *font_desc_to_merge;
915 /* Handle merging of font descriptions */
916 font_desc = _gtk_css_value_get_font_description (value->value);
917 font_desc_to_merge = _gtk_css_value_get_font_description (data->value);
919 pango_font_description_merge (font_desc, font_desc_to_merge, replace);
921 else if (_gtk_css_value_holds (data->value, G_TYPE_PTR_ARRAY) &&
922 value->value != NULL)
924 GPtrArray *array, *array_to_merge;
927 /* Append the array, mainly thought
928 * for the gtk-key-bindings property
930 array = _gtk_css_value_get_boxed (value->value);
931 array_to_merge = _gtk_css_value_get_boxed (data->value);
933 for (i = 0; i < array_to_merge->len; i++)
934 g_ptr_array_add (array, g_ptr_array_index (array_to_merge, i));
936 else if (replace || value->value == NULL)
938 _gtk_css_value_unref (value->value);
939 value->value = _gtk_css_value_ref (data->value);