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 if (G_IS_VALUE (&value_data->value))
126 g_value_unset (&value_data->value);
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,
198 if (!property_data_find_position (data, state, &pos))
200 ValueData new = { 0 };
203 g_array_insert_val (data->values, pos, new);
206 val_data = &g_array_index (data->values, ValueData, pos);
208 return &val_data->value;
212 property_data_match_state (PropertyData *data,
218 if (property_data_find_position (data, state, &pos))
223 val_data = &g_array_index (data->values, ValueData, pos);
224 return &val_data->value;
227 if (pos >= data->values->len)
228 pos = data->values->len - 1;
230 /* No exact match, go downwards the list to find
231 * the closest match to the given state flags, as
232 * a side effect, there is an implicit precedence
233 * of higher flags over the smaller ones.
235 for (i = pos; i >= 0; i--)
239 val_data = &g_array_index (data->values, ValueData, i);
241 /* Check whether any of the requested
242 * flags are set, and no other flags are.
244 * Also, no flags acts as a wildcard, such
245 * value should be always in the first position
246 * in the array (if present) anyways.
248 if (val_data->state == 0 ||
249 ((val_data->state & state) != 0 &&
250 (val_data->state & ~state) == 0))
251 return &val_data->value;
258 gtk_style_properties_init (GtkStyleProperties *props)
260 GtkStylePropertiesPrivate *priv;
262 priv = props->priv = G_TYPE_INSTANCE_GET_PRIVATE (props,
263 GTK_TYPE_STYLE_PROPERTIES,
264 GtkStylePropertiesPrivate);
266 priv->properties = g_hash_table_new_full (NULL, NULL, NULL,
267 (GDestroyNotify) property_data_free);
271 gtk_style_properties_finalize (GObject *object)
273 GtkStylePropertiesPrivate *priv;
274 GtkStyleProperties *props;
276 props = GTK_STYLE_PROPERTIES (object);
278 g_hash_table_destroy (priv->properties);
281 g_hash_table_destroy (priv->color_map);
283 G_OBJECT_CLASS (gtk_style_properties_parent_class)->finalize (object);
287 gtk_style_properties_get_style (GtkStyleProvider *provider,
290 /* Return style set itself */
291 return g_object_ref (provider);
295 gtk_style_properties_provider_init (GtkStyleProviderIface *iface)
297 iface->get_style = gtk_style_properties_get_style;
300 static GtkSymbolicColor *
301 gtk_style_properties_provider_get_color (GtkStyleProviderPrivate *provider,
304 return gtk_style_properties_lookup_color (GTK_STYLE_PROPERTIES (provider), name);
308 gtk_style_properties_provider_lookup (GtkStyleProviderPrivate *provider,
311 GtkCssLookup *lookup)
313 GtkStyleProperties *props;
314 GtkStylePropertiesPrivate *priv;
318 props = GTK_STYLE_PROPERTIES (provider);
321 /* Merge symbolic style properties */
322 g_hash_table_iter_init (&iter, priv->properties);
324 while (g_hash_table_iter_next (&iter, &key, &value))
326 GtkCssStyleProperty *prop = key;
327 PropertyData *data = value;
331 id = _gtk_css_style_property_get_id (prop);
333 if (!_gtk_css_lookup_is_missing (lookup, id))
336 value = property_data_match_state (data, state);
340 _gtk_css_lookup_set_computed (lookup, id, NULL, value);
345 gtk_style_properties_provider_private_init (GtkStyleProviderPrivateInterface *iface)
347 iface->get_color = gtk_style_properties_provider_get_color;
348 iface->lookup = gtk_style_properties_provider_lookup;
351 /* GtkStyleProperties methods */
354 * gtk_style_properties_new:
356 * Returns a newly created #GtkStyleProperties
358 * Returns: a new #GtkStyleProperties
361 gtk_style_properties_new (void)
363 return g_object_new (GTK_TYPE_STYLE_PROPERTIES, NULL);
367 * gtk_style_properties_map_color:
368 * @props: a #GtkStyleProperties
370 * @color: #GtkSymbolicColor to map @name to
372 * Maps @color so it can be referenced by @name. See
373 * gtk_style_properties_lookup_color()
378 gtk_style_properties_map_color (GtkStyleProperties *props,
380 GtkSymbolicColor *color)
382 GtkStylePropertiesPrivate *priv;
384 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
385 g_return_if_fail (name != NULL);
386 g_return_if_fail (color != NULL);
390 if (G_UNLIKELY (!priv->color_map))
391 priv->color_map = g_hash_table_new_full (g_str_hash,
393 (GDestroyNotify) g_free,
394 (GDestroyNotify) gtk_symbolic_color_unref);
396 g_hash_table_replace (priv->color_map,
398 gtk_symbolic_color_ref (color));
402 * gtk_style_properties_lookup_color:
403 * @props: a #GtkStyleProperties
404 * @name: color name to lookup
406 * Returns the symbolic color that is mapped
409 * Returns: (transfer none): The mapped color
414 gtk_style_properties_lookup_color (GtkStyleProperties *props,
417 GtkStylePropertiesPrivate *priv;
419 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), NULL);
420 g_return_val_if_fail (name != NULL, NULL);
424 if (!priv->color_map)
427 return g_hash_table_lookup (priv->color_map, name);
431 _gtk_style_properties_set_property_by_property (GtkStyleProperties *props,
432 GtkCssStyleProperty *style_prop,
436 GtkStylePropertiesPrivate *priv;
440 g_return_if_fail (G_VALUE_TYPE (value) == _gtk_css_style_property_get_computed_type (style_prop));
443 prop = g_hash_table_lookup (priv->properties, style_prop);
447 prop = property_data_new ();
448 g_hash_table_insert (priv->properties, (gpointer) style_prop, prop);
451 val = property_data_get_value (prop, state);
453 if (G_VALUE_TYPE (val) == G_VALUE_TYPE (value))
457 if (G_IS_VALUE (val))
460 g_value_init (val, G_VALUE_TYPE (value));
463 g_value_copy (value, val);
467 * gtk_style_properties_set_property:
468 * @props: a #GtkStyleProperties
469 * @property: styling property to set
470 * @state: state to set the value for
471 * @value: new value for the property
473 * Sets a styling property in @props.
478 gtk_style_properties_set_property (GtkStyleProperties *props,
479 const gchar *property,
483 GtkStyleProperty *node;
485 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
486 g_return_if_fail (property != NULL);
487 g_return_if_fail (value != NULL);
489 node = _gtk_style_property_lookup (property);
493 g_warning ("Style property \"%s\" is not registered", property);
496 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
498 g_warning ("Style property \"%s\" is not settable", property);
502 _gtk_style_property_assign (node, props, state, value);
506 * gtk_style_properties_set_valist:
507 * @props: a #GtkStyleProperties
508 * @state: state to set the values for
509 * @args: va_list of property name/value pairs, followed by %NULL
511 * Sets several style properties on @props.
516 gtk_style_properties_set_valist (GtkStyleProperties *props,
520 const gchar *property_name;
522 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
524 property_name = va_arg (args, const gchar *);
526 while (property_name)
528 GtkStyleProperty *node;
531 GValue val = G_VALUE_INIT;
533 node = _gtk_style_property_lookup (property_name);
537 g_warning ("Style property \"%s\" is not registered", property_name);
541 val_type = _gtk_style_property_get_value_type (node);
542 if (val_type == G_TYPE_NONE)
544 g_warning ("Style property \"%s\" is not settable", property_name);
548 G_VALUE_COLLECT_INIT (&val, _gtk_style_property_get_value_type (node),
552 g_warning ("Could not set style property \"%s\": %s", property_name, error);
553 g_value_unset (&val);
558 _gtk_style_property_assign (node, props, state, &val);
559 g_value_unset (&val);
561 property_name = va_arg (args, const gchar *);
566 * gtk_style_properties_set:
567 * @props: a #GtkStyleProperties
568 * @state: state to set the values for
569 * @...: property name/value pairs, followed by %NULL
571 * Sets several style properties on @props.
576 gtk_style_properties_set (GtkStyleProperties *props,
582 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
584 va_start (args, state);
585 gtk_style_properties_set_valist (props, state, args);
590 _gtk_style_properties_peek_property (GtkStyleProperties *props,
591 GtkCssStyleProperty *property,
594 GtkStylePropertiesPrivate *priv;
597 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
598 g_return_val_if_fail (property != NULL, FALSE);
601 prop = g_hash_table_lookup (priv->properties, property);
605 return property_data_match_state (prop, state);
609 GtkStyleProperties *props;
613 static const GValue *
614 style_query_func (guint id,
617 StyleQueryData *query = data;
619 return _gtk_style_properties_peek_property (query->props,
620 _gtk_css_style_property_lookup_by_id (id),
625 * gtk_style_properties_get_property:
626 * @props: a #GtkStyleProperties
627 * @property: style property name
628 * @state: state to retrieve the property value for
629 * @value: (out) (transfer full): return location for the style property value.
631 * Gets a style property from @props for the given state. When done with @value,
632 * g_value_unset() needs to be called to free any allocated memory.
634 * Returns: %TRUE if the property exists in @props, %FALSE otherwise
639 gtk_style_properties_get_property (GtkStyleProperties *props,
640 const gchar *property,
644 StyleQueryData query = { props, state };
645 GtkStyleProperty *node;
647 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
648 g_return_val_if_fail (property != NULL, FALSE);
649 g_return_val_if_fail (value != NULL, FALSE);
651 node = _gtk_style_property_lookup (property);
654 g_warning ("Style property \"%s\" is not registered", property);
657 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
659 g_warning ("Style property \"%s\" is not gettable", property);
663 _gtk_style_property_query (node,
671 * gtk_style_properties_get_valist:
672 * @props: a #GtkStyleProperties
673 * @state: state to retrieve the property values for
674 * @args: va_list of property name/return location pairs, followed by %NULL
676 * Retrieves several style property values from @props for a given state.
681 gtk_style_properties_get_valist (GtkStyleProperties *props,
685 const gchar *property_name;
687 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
689 property_name = va_arg (args, const gchar *);
691 while (property_name)
694 GValue value = G_VALUE_INIT;
696 if (!gtk_style_properties_get_property (props,
702 G_VALUE_LCOPY (&value, args, 0, &error);
703 g_value_unset (&value);
707 g_warning ("Could not get style property \"%s\": %s", property_name, error);
712 property_name = va_arg (args, const gchar *);
717 * gtk_style_properties_get:
718 * @props: a #GtkStyleProperties
719 * @state: state to retrieve the property values for
720 * @...: property name /return value pairs, followed by %NULL
722 * Retrieves several style property values from @props for a
728 gtk_style_properties_get (GtkStyleProperties *props,
734 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
736 va_start (args, state);
737 gtk_style_properties_get_valist (props, state, args);
742 * gtk_style_properties_unset_property:
743 * @props: a #GtkStyleProperties
744 * @property: property to unset
745 * @state: state to unset
747 * Unsets a style property in @props.
752 gtk_style_properties_unset_property (GtkStyleProperties *props,
753 const gchar *property,
756 GtkStylePropertiesPrivate *priv;
757 GtkStyleProperty *node;
761 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
762 g_return_if_fail (property != NULL);
764 node = _gtk_style_property_lookup (property);
768 g_warning ("Style property \"%s\" is not registered", property);
771 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
773 g_warning ("Style property \"%s\" is not settable", property);
777 if (GTK_IS_CSS_SHORTHAND_PROPERTY (node))
779 GtkCssShorthandProperty *shorthand = GTK_CSS_SHORTHAND_PROPERTY (node);
781 for (pos = 0; pos < _gtk_css_shorthand_property_get_n_subproperties (shorthand); pos++)
783 GtkCssStyleProperty *sub = _gtk_css_shorthand_property_get_subproperty (shorthand, pos);
784 gtk_style_properties_unset_property (props,
785 _gtk_style_property_get_name (GTK_STYLE_PROPERTY (sub)),
792 prop = g_hash_table_lookup (priv->properties, node);
797 if (property_data_find_position (prop, state, &pos))
801 data = &g_array_index (prop->values, ValueData, pos);
803 if (G_IS_VALUE (&data->value))
804 g_value_unset (&data->value);
806 g_array_remove_index (prop->values, pos);
811 * gtk_style_properties_clear:
812 * @props: a #GtkStyleProperties
814 * Clears all style information from @props.
817 gtk_style_properties_clear (GtkStyleProperties *props)
819 GtkStylePropertiesPrivate *priv;
821 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
824 g_hash_table_remove_all (priv->properties);
828 * gtk_style_properties_merge:
829 * @props: a #GtkStyleProperties
830 * @props_to_merge: a second #GtkStyleProperties
831 * @replace: whether to replace values or not
833 * Merges into @props all the style information contained
834 * in @props_to_merge. If @replace is %TRUE, the values
835 * will be overwritten, if it is %FALSE, the older values
841 gtk_style_properties_merge (GtkStyleProperties *props,
842 const GtkStyleProperties *props_to_merge,
845 GtkStylePropertiesPrivate *priv, *priv_to_merge;
849 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
850 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props_to_merge));
853 priv_to_merge = props_to_merge->priv;
855 /* Merge symbolic color map */
856 if (priv_to_merge->color_map)
858 g_hash_table_iter_init (&iter, priv_to_merge->color_map);
860 while (g_hash_table_iter_next (&iter, &key, &value))
863 GtkSymbolicColor *color;
869 g_hash_table_lookup (priv->color_map, name))
872 gtk_style_properties_map_color (props, name, color);
876 /* Merge symbolic style properties */
877 g_hash_table_iter_init (&iter, priv_to_merge->properties);
879 while (g_hash_table_iter_next (&iter, &key, &value))
881 PropertyData *prop_to_merge = value;
885 prop = g_hash_table_lookup (priv->properties, key);
889 prop = property_data_new ();
890 g_hash_table_insert (priv->properties, key, prop);
893 for (i = 0; i < prop_to_merge->values->len; i++)
898 data = &g_array_index (prop_to_merge->values, ValueData, i);
900 if (replace && data->state == GTK_STATE_FLAG_NORMAL &&
901 G_VALUE_TYPE (&data->value) != PANGO_TYPE_FONT_DESCRIPTION)
903 /* Let normal state override all states
904 * previously set in the original set
906 property_data_remove_values (prop);
909 value = property_data_get_value (prop, data->state);
911 if (G_VALUE_TYPE (&data->value) == PANGO_TYPE_FONT_DESCRIPTION &&
914 PangoFontDescription *font_desc;
915 PangoFontDescription *font_desc_to_merge;
917 /* Handle merging of font descriptions */
918 font_desc = g_value_get_boxed (value);
919 font_desc_to_merge = g_value_get_boxed (&data->value);
921 pango_font_description_merge (font_desc, font_desc_to_merge, replace);
923 else if (G_VALUE_TYPE (&data->value) == G_TYPE_PTR_ARRAY &&
926 GPtrArray *array, *array_to_merge;
929 /* Append the array, mainly thought
930 * for the gtk-key-bindings property
932 array = g_value_get_boxed (value);
933 array_to_merge = g_value_get_boxed (&data->value);
935 for (i = 0; i < array_to_merge->len; i++)
936 g_ptr_array_add (array, g_ptr_array_index (array_to_merge, i));
938 else if (replace || !G_IS_VALUE (value))
940 if (!G_IS_VALUE (value))
941 g_value_init (value, G_VALUE_TYPE (&data->value));
942 else if (G_VALUE_TYPE (value) != G_VALUE_TYPE (&data->value))
944 g_value_unset (value);
945 g_value_init (value, G_VALUE_TYPE (&data->value));
948 g_value_copy (&data->value, value);