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, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
22 #include "gtkstylepropertiesprivate.h"
25 #include <gobject/gvaluecollector.h>
26 #include <cairo-gobject.h>
28 #include "gtkstyleprovider.h"
29 #include "gtksymboliccolor.h"
30 #include "gtkthemingengine.h"
31 #include "gtkanimationdescription.h"
32 #include "gtkgradient.h"
33 #include "gtkshadowprivate.h"
34 #include "gtkcssshorthandpropertyprivate.h"
35 #include "gtkcsstypesprivate.h"
36 #include "gtkborderimageprivate.h"
38 #include "gtkprivatetypebuiltins.h"
39 #include "gtkstylepropertyprivate.h"
40 #include "gtkstyleproviderprivate.h"
43 #include "gtkwin32themeprivate.h"
46 * SECTION:gtkstyleproperties
47 * @Short_description: Store for style property information
48 * @Title: GtkStyleProperties
50 * GtkStyleProperties provides the storage for style information
51 * that is used by #GtkStyleContext and other #GtkStyleProvider
54 * Before style properties can be stored in GtkStyleProperties, they
55 * must be registered with gtk_style_properties_register_property().
57 * Unless you are writing a #GtkStyleProvider implementation, you
58 * are unlikely to use this API directly, as gtk_style_context_get()
59 * and its variants are the preferred way to access styling information
60 * from widget implementations and theming engine implementations
61 * should use the APIs provided by #GtkThemingEngine instead.
64 typedef struct PropertyData PropertyData;
65 typedef struct ValueData ValueData;
78 struct _GtkStylePropertiesPrivate
80 GHashTable *color_map;
81 GHashTable *properties;
82 GtkSymbolicColorLookupFunc color_lookup_func;
83 gpointer color_lookup_data;
86 static void gtk_style_properties_provider_init (GtkStyleProviderIface *iface);
87 static void gtk_style_properties_provider_private_init (GtkStyleProviderPrivateInterface *iface);
88 static void gtk_style_properties_finalize (GObject *object);
91 G_DEFINE_TYPE_EXTENDED (GtkStyleProperties, gtk_style_properties, G_TYPE_OBJECT, 0,
92 G_IMPLEMENT_INTERFACE (GTK_TYPE_STYLE_PROVIDER,
93 gtk_style_properties_provider_init)
94 G_IMPLEMENT_INTERFACE (GTK_TYPE_STYLE_PROVIDER_PRIVATE,
95 gtk_style_properties_provider_private_init));
98 gtk_style_properties_class_init (GtkStylePropertiesClass *klass)
100 GObjectClass *object_class = G_OBJECT_CLASS (klass);
102 object_class->finalize = gtk_style_properties_finalize;
104 g_type_class_add_private (object_class, sizeof (GtkStylePropertiesPrivate));
107 static PropertyData *
108 property_data_new (void)
112 data = g_slice_new0 (PropertyData);
113 data->values = g_array_new (FALSE, FALSE, sizeof (ValueData));
119 property_data_remove_values (PropertyData *data)
123 for (i = 0; i < data->values->len; i++)
125 ValueData *value_data;
127 value_data = &g_array_index (data->values, ValueData, i);
129 if (G_IS_VALUE (&value_data->value))
130 g_value_unset (&value_data->value);
133 if (data->values->len > 0)
134 g_array_remove_range (data->values, 0, data->values->len);
138 property_data_free (PropertyData *data)
140 property_data_remove_values (data);
141 g_array_free (data->values, TRUE);
142 g_slice_free (PropertyData, data);
146 property_data_find_position (PropertyData *data,
151 gboolean found = FALSE;
157 if (data->values->len == 0)
160 /* Find position for the given state, or the position where
161 * it would be if not found, the array is ordered by the
165 max = data->values->len - 1;
169 ValueData *value_data;
171 mid = (min + max) / 2;
172 value_data = &g_array_index (data->values, ValueData, mid);
174 if (value_data->state == state)
179 else if (value_data->state < state)
180 position = min = mid + 1;
187 while (!found && min <= max);
196 property_data_get_value (PropertyData *data,
202 if (!property_data_find_position (data, state, &pos))
204 ValueData new = { 0 };
207 g_array_insert_val (data->values, pos, new);
210 val_data = &g_array_index (data->values, ValueData, pos);
212 return &val_data->value;
216 property_data_match_state (PropertyData *data,
222 if (property_data_find_position (data, state, &pos))
227 val_data = &g_array_index (data->values, ValueData, pos);
228 return &val_data->value;
231 if (pos >= data->values->len)
232 pos = data->values->len - 1;
234 /* No exact match, go downwards the list to find
235 * the closest match to the given state flags, as
236 * a side effect, there is an implicit precedence
237 * of higher flags over the smaller ones.
239 for (i = pos; i >= 0; i--)
243 val_data = &g_array_index (data->values, ValueData, i);
245 /* Check whether any of the requested
246 * flags are set, and no other flags are.
248 * Also, no flags acts as a wildcard, such
249 * value should be always in the first position
250 * in the array (if present) anyways.
252 if (val_data->state == 0 ||
253 ((val_data->state & state) != 0 &&
254 (val_data->state & ~state) == 0))
255 return &val_data->value;
262 gtk_style_properties_init (GtkStyleProperties *props)
264 GtkStylePropertiesPrivate *priv;
266 priv = props->priv = G_TYPE_INSTANCE_GET_PRIVATE (props,
267 GTK_TYPE_STYLE_PROPERTIES,
268 GtkStylePropertiesPrivate);
270 priv->properties = g_hash_table_new_full (NULL, NULL, NULL,
271 (GDestroyNotify) property_data_free);
275 gtk_style_properties_finalize (GObject *object)
277 GtkStylePropertiesPrivate *priv;
278 GtkStyleProperties *props;
280 props = GTK_STYLE_PROPERTIES (object);
282 g_hash_table_destroy (priv->properties);
285 g_hash_table_destroy (priv->color_map);
287 G_OBJECT_CLASS (gtk_style_properties_parent_class)->finalize (object);
291 gtk_style_properties_get_style (GtkStyleProvider *provider,
294 /* Return style set itself */
295 return g_object_ref (provider);
299 gtk_style_properties_provider_init (GtkStyleProviderIface *iface)
301 iface->get_style = gtk_style_properties_get_style;
304 static GtkSymbolicColor *
305 gtk_style_properties_provider_get_color (GtkStyleProviderPrivate *provider,
308 return gtk_style_properties_lookup_color (GTK_STYLE_PROPERTIES (provider), name);
312 gtk_style_properties_provider_lookup (GtkStyleProviderPrivate *provider,
315 GtkCssLookup *lookup)
317 GtkStyleProperties *props;
318 GtkStylePropertiesPrivate *priv;
322 props = GTK_STYLE_PROPERTIES (provider);
325 /* Merge symbolic style properties */
326 g_hash_table_iter_init (&iter, priv->properties);
328 while (g_hash_table_iter_next (&iter, &key, &value))
330 GtkCssStyleProperty *prop = key;
331 PropertyData *data = value;
335 id = _gtk_css_style_property_get_id (prop);
337 if (!_gtk_css_lookup_is_missing (lookup, id))
340 value = property_data_match_state (data, state);
344 _gtk_css_lookup_set (lookup, id, value);
349 gtk_style_properties_provider_private_init (GtkStyleProviderPrivateInterface *iface)
351 iface->get_color = gtk_style_properties_provider_get_color;
352 iface->lookup = gtk_style_properties_provider_lookup;
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_set_color_lookup_func (GtkStyleProperties *props,
372 GtkSymbolicColorLookupFunc func,
375 GtkStylePropertiesPrivate *priv;
377 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
378 g_return_if_fail (func != NULL);
381 g_return_if_fail (priv->color_map == NULL);
383 priv->color_lookup_func = func;
384 priv->color_lookup_data = data;
388 * gtk_style_properties_map_color:
389 * @props: a #GtkStyleProperties
391 * @color: #GtkSymbolicColor to map @name to
393 * Maps @color so it can be referenced by @name. See
394 * gtk_style_properties_lookup_color()
399 gtk_style_properties_map_color (GtkStyleProperties *props,
401 GtkSymbolicColor *color)
403 GtkStylePropertiesPrivate *priv;
405 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
406 g_return_if_fail (name != NULL);
407 g_return_if_fail (color != NULL);
410 g_return_if_fail (priv->color_lookup_func == NULL);
412 if (G_UNLIKELY (!priv->color_map))
413 priv->color_map = g_hash_table_new_full (g_str_hash,
415 (GDestroyNotify) g_free,
416 (GDestroyNotify) gtk_symbolic_color_unref);
418 g_hash_table_replace (priv->color_map,
420 gtk_symbolic_color_ref (color));
424 * gtk_style_properties_lookup_color:
425 * @props: a #GtkStyleProperties
426 * @name: color name to lookup
428 * Returns the symbolic color that is mapped
431 * Returns: (transfer none): The mapped color
436 gtk_style_properties_lookup_color (GtkStyleProperties *props,
439 GtkStylePropertiesPrivate *priv;
441 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), NULL);
442 g_return_val_if_fail (name != NULL, NULL);
446 if (priv->color_lookup_func)
447 return priv->color_lookup_func (priv->color_lookup_data, name);
449 if (!priv->color_map)
452 return g_hash_table_lookup (priv->color_map, name);
456 _gtk_style_properties_set_property_by_property (GtkStyleProperties *props,
457 GtkCssStyleProperty *style_prop,
461 GtkStylePropertiesPrivate *priv;
466 prop = g_hash_table_lookup (priv->properties, style_prop);
470 prop = property_data_new ();
471 g_hash_table_insert (priv->properties, (gpointer) style_prop, prop);
474 val = property_data_get_value (prop, state);
476 if (G_VALUE_TYPE (val) == G_VALUE_TYPE (value))
480 if (G_IS_VALUE (val))
483 g_value_init (val, G_VALUE_TYPE (value));
486 g_value_copy (value, val);
487 if (_gtk_style_property_get_value_type (GTK_STYLE_PROPERTY (style_prop)) == G_VALUE_TYPE (value))
488 g_param_value_validate (GTK_STYLE_PROPERTY (style_prop)->pspec, val);
492 * gtk_style_properties_set_property:
493 * @props: a #GtkStyleProperties
494 * @property: styling property to set
495 * @state: state to set the value for
496 * @value: new value for the property
498 * Sets a styling property in @props.
503 gtk_style_properties_set_property (GtkStyleProperties *props,
504 const gchar *property,
508 GtkStyleProperty *node;
510 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
511 g_return_if_fail (property != NULL);
512 g_return_if_fail (value != NULL);
514 node = _gtk_style_property_lookup (property);
518 g_warning ("Style property \"%s\" is not registered", property);
521 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
523 g_warning ("Style property \"%s\" is not settable", property);
527 _gtk_style_property_assign (node, props, state, value);
531 * gtk_style_properties_set_valist:
532 * @props: a #GtkStyleProperties
533 * @state: state to set the values for
534 * @args: va_list of property name/value pairs, followed by %NULL
536 * Sets several style properties on @props.
541 gtk_style_properties_set_valist (GtkStyleProperties *props,
545 const gchar *property_name;
547 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
549 property_name = va_arg (args, const gchar *);
551 while (property_name)
553 GtkStyleProperty *node;
556 GValue val = G_VALUE_INIT;
558 node = _gtk_style_property_lookup (property_name);
562 g_warning ("Style property \"%s\" is not registered", property_name);
566 val_type = _gtk_style_property_get_value_type (node);
567 if (val_type == G_TYPE_NONE)
569 g_warning ("Style property \"%s\" is not settable", property_name);
573 G_VALUE_COLLECT_INIT (&val, _gtk_style_property_get_value_type (node),
577 g_warning ("Could not set style property \"%s\": %s", property_name, error);
578 g_value_unset (&val);
583 _gtk_style_property_assign (node, props, state, &val);
584 g_value_unset (&val);
586 property_name = va_arg (args, const gchar *);
591 * gtk_style_properties_set:
592 * @props: a #GtkStyleProperties
593 * @state: state to set the values for
594 * @...: property name/value pairs, followed by %NULL
596 * Sets several style properties on @props.
601 gtk_style_properties_set (GtkStyleProperties *props,
607 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
609 va_start (args, state);
610 gtk_style_properties_set_valist (props, state, args);
615 _gtk_style_properties_peek_property (GtkStyleProperties *props,
616 GtkCssStyleProperty *property,
619 GtkStylePropertiesPrivate *priv;
622 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
623 g_return_val_if_fail (property != NULL, FALSE);
626 prop = g_hash_table_lookup (priv->properties, property);
630 return property_data_match_state (prop, state);
634 _gtk_style_properties_get_property (GtkStyleProperties *props,
635 const gchar *property,
637 GtkStylePropertyContext *context,
640 GtkStyleProperty *node;
642 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
643 g_return_val_if_fail (property != NULL, FALSE);
644 g_return_val_if_fail (value != NULL, FALSE);
646 node = _gtk_style_property_lookup (property);
649 g_warning ("Style property \"%s\" is not registered", property);
652 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
654 g_warning ("Style property \"%s\" is not gettable", property);
658 _gtk_style_property_query (node, props, state, context, value);
663 * gtk_style_properties_get_property:
664 * @props: a #GtkStyleProperties
665 * @property: style property name
666 * @state: state to retrieve the property value for
667 * @value: (out) (transfer full): return location for the style property value.
669 * Gets a style property from @props for the given state. When done with @value,
670 * g_value_unset() needs to be called to free any allocated memory.
672 * Returns: %TRUE if the property exists in @props, %FALSE otherwise
677 gtk_style_properties_get_property (GtkStyleProperties *props,
678 const gchar *property,
682 GtkStylePropertyContext context = { 100, 100};
684 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
685 g_return_val_if_fail (property != NULL, FALSE);
686 g_return_val_if_fail (value != NULL, FALSE);
688 return _gtk_style_properties_get_property (props,
690 state, &context, value);
694 _gtk_style_properties_get_valist (GtkStyleProperties *props,
696 GtkStylePropertyContext *context,
699 const gchar *property_name;
701 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
703 property_name = va_arg (args, const gchar *);
705 while (property_name)
708 GValue value = G_VALUE_INIT;
710 if (!_gtk_style_properties_get_property (props,
717 G_VALUE_LCOPY (&value, args, 0, &error);
718 g_value_unset (&value);
722 g_warning ("Could not get style property \"%s\": %s", property_name, error);
727 property_name = va_arg (args, const gchar *);
732 * gtk_style_properties_get_valist:
733 * @props: a #GtkStyleProperties
734 * @state: state to retrieve the property values for
735 * @args: va_list of property name/return location pairs, followed by %NULL
737 * Retrieves several style property values from @props for a given state.
742 gtk_style_properties_get_valist (GtkStyleProperties *props,
746 GtkStylePropertyContext context = { 100, 100};
748 return _gtk_style_properties_get_valist (props, state, &context, args);
752 _gtk_style_properties_get (GtkStyleProperties *props,
754 GtkStylePropertyContext *context,
759 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
761 va_start (args, context);
762 _gtk_style_properties_get_valist (props, state, context, args);
767 * gtk_style_properties_get:
768 * @props: a #GtkStyleProperties
769 * @state: state to retrieve the property values for
770 * @...: property name /return value pairs, followed by %NULL
772 * Retrieves several style property values from @props for a
778 gtk_style_properties_get (GtkStyleProperties *props,
784 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
786 va_start (args, state);
787 gtk_style_properties_get_valist (props, state, args);
792 * gtk_style_properties_unset_property:
793 * @props: a #GtkStyleProperties
794 * @property: property to unset
795 * @state: state to unset
797 * Unsets a style property in @props.
802 gtk_style_properties_unset_property (GtkStyleProperties *props,
803 const gchar *property,
806 GtkStylePropertiesPrivate *priv;
807 GtkStyleProperty *node;
811 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
812 g_return_if_fail (property != NULL);
814 node = _gtk_style_property_lookup (property);
818 g_warning ("Style property \"%s\" is not registered", property);
821 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
823 g_warning ("Style property \"%s\" is not settable", property);
827 if (GTK_IS_CSS_SHORTHAND_PROPERTY (node))
829 GtkCssShorthandProperty *shorthand = GTK_CSS_SHORTHAND_PROPERTY (node);
831 for (pos = 0; pos < _gtk_css_shorthand_property_get_n_subproperties (shorthand); pos++)
833 GtkCssStyleProperty *sub = _gtk_css_shorthand_property_get_subproperty (shorthand, pos);
834 gtk_style_properties_unset_property (props,
835 _gtk_style_property_get_name (GTK_STYLE_PROPERTY (sub)),
842 prop = g_hash_table_lookup (priv->properties, node);
847 if (property_data_find_position (prop, state, &pos))
851 data = &g_array_index (prop->values, ValueData, pos);
853 if (G_IS_VALUE (&data->value))
854 g_value_unset (&data->value);
856 g_array_remove_index (prop->values, pos);
861 * gtk_style_properties_clear:
862 * @props: a #GtkStyleProperties
864 * Clears all style information from @props.
867 gtk_style_properties_clear (GtkStyleProperties *props)
869 GtkStylePropertiesPrivate *priv;
871 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
874 g_hash_table_remove_all (priv->properties);
878 * gtk_style_properties_merge:
879 * @props: a #GtkStyleProperties
880 * @props_to_merge: a second #GtkStyleProperties
881 * @replace: whether to replace values or not
883 * Merges into @props all the style information contained
884 * in @props_to_merge. If @replace is %TRUE, the values
885 * will be overwritten, if it is %FALSE, the older values
891 gtk_style_properties_merge (GtkStyleProperties *props,
892 const GtkStyleProperties *props_to_merge,
895 GtkStylePropertiesPrivate *priv, *priv_to_merge;
899 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
900 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props_to_merge));
903 priv_to_merge = props_to_merge->priv;
905 /* Merge symbolic color map */
906 if (priv_to_merge->color_map)
908 g_hash_table_iter_init (&iter, priv_to_merge->color_map);
910 while (g_hash_table_iter_next (&iter, &key, &value))
913 GtkSymbolicColor *color;
919 g_hash_table_lookup (priv->color_map, name))
922 gtk_style_properties_map_color (props, name, color);
926 /* Merge symbolic style properties */
927 g_hash_table_iter_init (&iter, priv_to_merge->properties);
929 while (g_hash_table_iter_next (&iter, &key, &value))
931 PropertyData *prop_to_merge = value;
935 prop = g_hash_table_lookup (priv->properties, key);
939 prop = property_data_new ();
940 g_hash_table_insert (priv->properties, key, prop);
943 for (i = 0; i < prop_to_merge->values->len; i++)
948 data = &g_array_index (prop_to_merge->values, ValueData, i);
950 if (replace && data->state == GTK_STATE_FLAG_NORMAL &&
951 G_VALUE_TYPE (&data->value) != PANGO_TYPE_FONT_DESCRIPTION)
953 /* Let normal state override all states
954 * previously set in the original set
956 property_data_remove_values (prop);
959 value = property_data_get_value (prop, data->state);
961 if (G_VALUE_TYPE (&data->value) == PANGO_TYPE_FONT_DESCRIPTION &&
964 PangoFontDescription *font_desc;
965 PangoFontDescription *font_desc_to_merge;
967 /* Handle merging of font descriptions */
968 font_desc = g_value_get_boxed (value);
969 font_desc_to_merge = g_value_get_boxed (&data->value);
971 pango_font_description_merge (font_desc, font_desc_to_merge, replace);
973 else if (G_VALUE_TYPE (&data->value) == G_TYPE_PTR_ARRAY &&
976 GPtrArray *array, *array_to_merge;
979 /* Append the array, mainly thought
980 * for the gtk-key-bindings property
982 array = g_value_get_boxed (value);
983 array_to_merge = g_value_get_boxed (&data->value);
985 for (i = 0; i < array_to_merge->len; i++)
986 g_ptr_array_add (array, g_ptr_array_index (array_to_merge, i));
988 else if (replace || !G_IS_VALUE (value))
990 if (!G_IS_VALUE (value))
991 g_value_init (value, G_VALUE_TYPE (&data->value));
992 else if (G_VALUE_TYPE (value) != G_VALUE_TYPE (&data->value))
994 g_value_unset (value);
995 g_value_init (value, G_VALUE_TYPE (&data->value));
998 g_value_copy (&data->value, value);