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 GtkStyleProperty *prop = key;
331 PropertyData *data = value;
335 id = _gtk_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 /* Property registration functions */
358 * gtk_style_properties_register_property: (skip)
359 * @parse_func: parsing function to use, or %NULL
360 * @pspec: the #GParamSpec for the new property
362 * Registers a property so it can be used in the CSS file format.
363 * This function is the low-level equivalent of
364 * gtk_theming_engine_register_property(), if you are implementing
365 * a theming engine, you want to use that function instead.
370 gtk_style_properties_register_property (GtkStylePropertyParser parse_func,
373 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
375 _gtk_style_property_register (pspec,
384 * gtk_style_properties_lookup_property: (skip)
385 * @property_name: property name to look up
386 * @parse_func: (out): return location for the parse function
387 * @pspec: (out) (transfer none): return location for the #GParamSpec
389 * Returns %TRUE if a property has been registered, if @pspec or
390 * @parse_func are not %NULL, the #GParamSpec and parsing function
391 * will be respectively returned.
393 * Returns: %TRUE if the property is registered, %FALSE otherwise
398 gtk_style_properties_lookup_property (const gchar *property_name,
399 GtkStylePropertyParser *parse_func,
402 GtkStyleProperty *node;
403 gboolean found = FALSE;
405 g_return_val_if_fail (property_name != NULL, FALSE);
407 node = _gtk_style_property_lookup (property_name);
412 *pspec = node->pspec;
415 *parse_func = node->property_parse_func;
423 /* GtkStyleProperties methods */
426 * gtk_style_properties_new:
428 * Returns a newly created #GtkStyleProperties
430 * Returns: a new #GtkStyleProperties
433 gtk_style_properties_new (void)
435 return g_object_new (GTK_TYPE_STYLE_PROPERTIES, NULL);
439 _gtk_style_properties_set_color_lookup_func (GtkStyleProperties *props,
440 GtkSymbolicColorLookupFunc func,
443 GtkStylePropertiesPrivate *priv;
445 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
446 g_return_if_fail (func != NULL);
449 g_return_if_fail (priv->color_map == NULL);
451 priv->color_lookup_func = func;
452 priv->color_lookup_data = data;
456 * gtk_style_properties_map_color:
457 * @props: a #GtkStyleProperties
459 * @color: #GtkSymbolicColor to map @name to
461 * Maps @color so it can be referenced by @name. See
462 * gtk_style_properties_lookup_color()
467 gtk_style_properties_map_color (GtkStyleProperties *props,
469 GtkSymbolicColor *color)
471 GtkStylePropertiesPrivate *priv;
473 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
474 g_return_if_fail (name != NULL);
475 g_return_if_fail (color != NULL);
478 g_return_if_fail (priv->color_lookup_func == NULL);
480 if (G_UNLIKELY (!priv->color_map))
481 priv->color_map = g_hash_table_new_full (g_str_hash,
483 (GDestroyNotify) g_free,
484 (GDestroyNotify) gtk_symbolic_color_unref);
486 g_hash_table_replace (priv->color_map,
488 gtk_symbolic_color_ref (color));
492 * gtk_style_properties_lookup_color:
493 * @props: a #GtkStyleProperties
494 * @name: color name to lookup
496 * Returns the symbolic color that is mapped
499 * Returns: (transfer none): The mapped color
504 gtk_style_properties_lookup_color (GtkStyleProperties *props,
507 GtkStylePropertiesPrivate *priv;
509 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), NULL);
510 g_return_val_if_fail (name != NULL, NULL);
514 if (priv->color_lookup_func)
515 return priv->color_lookup_func (priv->color_lookup_data, name);
517 if (!priv->color_map)
520 return g_hash_table_lookup (priv->color_map, name);
524 _gtk_style_properties_set_property_by_property (GtkStyleProperties *props,
525 GtkStyleProperty *style_prop,
529 GtkStylePropertiesPrivate *priv;
534 prop = g_hash_table_lookup (priv->properties, style_prop);
538 prop = property_data_new ();
539 g_hash_table_insert (priv->properties, (gpointer) style_prop, prop);
542 val = property_data_get_value (prop, state);
544 if (G_VALUE_TYPE (val) == G_VALUE_TYPE (value))
548 if (G_IS_VALUE (val))
551 g_value_init (val, G_VALUE_TYPE (value));
554 g_value_copy (value, val);
555 if (_gtk_style_property_get_value_type (style_prop) == G_VALUE_TYPE (value))
556 g_param_value_validate (style_prop->pspec, val);
560 * gtk_style_properties_set_property:
561 * @props: a #GtkStyleProperties
562 * @property: styling property to set
563 * @state: state to set the value for
564 * @value: new value for the property
566 * Sets a styling property in @props.
571 gtk_style_properties_set_property (GtkStyleProperties *props,
572 const gchar *property,
576 GtkStyleProperty *node;
578 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
579 g_return_if_fail (property != NULL);
580 g_return_if_fail (value != NULL);
582 node = _gtk_style_property_lookup (property);
586 g_warning ("Style property \"%s\" is not registered", property);
589 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
591 g_warning ("Style property \"%s\" is not settable", property);
595 _gtk_style_property_assign (node, props, state, value);
599 * gtk_style_properties_set_valist:
600 * @props: a #GtkStyleProperties
601 * @state: state to set the values for
602 * @args: va_list of property name/value pairs, followed by %NULL
604 * Sets several style properties on @props.
609 gtk_style_properties_set_valist (GtkStyleProperties *props,
613 const gchar *property_name;
615 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
617 property_name = va_arg (args, const gchar *);
619 while (property_name)
621 GtkStyleProperty *node;
624 GValue val = G_VALUE_INIT;
626 node = _gtk_style_property_lookup (property_name);
630 g_warning ("Style property \"%s\" is not registered", property_name);
634 val_type = _gtk_style_property_get_value_type (node);
635 if (val_type == G_TYPE_NONE)
637 g_warning ("Style property \"%s\" is not settable", property_name);
641 G_VALUE_COLLECT_INIT (&val, _gtk_style_property_get_value_type (node),
645 g_warning ("Could not set style property \"%s\": %s", property_name, error);
646 g_value_unset (&val);
651 _gtk_style_property_assign (node, props, state, &val);
652 g_value_unset (&val);
654 property_name = va_arg (args, const gchar *);
659 * gtk_style_properties_set:
660 * @props: a #GtkStyleProperties
661 * @state: state to set the values for
662 * @...: property name/value pairs, followed by %NULL
664 * Sets several style properties on @props.
669 gtk_style_properties_set (GtkStyleProperties *props,
675 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
677 va_start (args, state);
678 gtk_style_properties_set_valist (props, state, args);
683 _gtk_style_properties_peek_property (GtkStyleProperties *props,
684 GtkStyleProperty *property,
687 GtkStylePropertiesPrivate *priv;
690 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
691 g_return_val_if_fail (property != NULL, FALSE);
694 prop = g_hash_table_lookup (priv->properties, property);
698 return property_data_match_state (prop, state);
702 _gtk_style_properties_get_property (GtkStyleProperties *props,
703 const gchar *property,
705 GtkStylePropertyContext *context,
708 GtkStyleProperty *node;
710 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
711 g_return_val_if_fail (property != NULL, FALSE);
712 g_return_val_if_fail (value != NULL, FALSE);
714 node = _gtk_style_property_lookup (property);
717 g_warning ("Style property \"%s\" is not registered", property);
720 if (_gtk_style_property_get_value_type (node) == G_TYPE_NONE)
722 g_warning ("Style property \"%s\" is not gettable", property);
726 _gtk_style_property_query (node, props, state, context, value);
731 * gtk_style_properties_get_property:
732 * @props: a #GtkStyleProperties
733 * @property: style property name
734 * @state: state to retrieve the property value for
735 * @value: (out) (transfer full): return location for the style property value.
737 * Gets a style property from @props for the given state. When done with @value,
738 * g_value_unset() needs to be called to free any allocated memory.
740 * Returns: %TRUE if the property exists in @props, %FALSE otherwise
745 gtk_style_properties_get_property (GtkStyleProperties *props,
746 const gchar *property,
750 GtkStylePropertyContext context = { 100, 100};
752 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
753 g_return_val_if_fail (property != NULL, FALSE);
754 g_return_val_if_fail (value != NULL, FALSE);
756 return _gtk_style_properties_get_property (props,
758 state, &context, value);
762 _gtk_style_properties_get_valist (GtkStyleProperties *props,
764 GtkStylePropertyContext *context,
767 const gchar *property_name;
769 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
771 property_name = va_arg (args, const gchar *);
773 while (property_name)
776 GValue value = G_VALUE_INIT;
778 if (!_gtk_style_properties_get_property (props,
785 G_VALUE_LCOPY (&value, args, 0, &error);
786 g_value_unset (&value);
790 g_warning ("Could not get style property \"%s\": %s", property_name, error);
795 property_name = va_arg (args, const gchar *);
800 * gtk_style_properties_get_valist:
801 * @props: a #GtkStyleProperties
802 * @state: state to retrieve the property values for
803 * @args: va_list of property name/return location pairs, followed by %NULL
805 * Retrieves several style property values from @props for a given state.
810 gtk_style_properties_get_valist (GtkStyleProperties *props,
814 GtkStylePropertyContext context = { 100, 100};
816 return _gtk_style_properties_get_valist (props, state, &context, args);
820 _gtk_style_properties_get (GtkStyleProperties *props,
822 GtkStylePropertyContext *context,
827 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
829 va_start (args, context);
830 _gtk_style_properties_get_valist (props, state, context, args);
835 * gtk_style_properties_get:
836 * @props: a #GtkStyleProperties
837 * @state: state to retrieve the property values for
838 * @...: property name /return value pairs, followed by %NULL
840 * Retrieves several style property values from @props for a
846 gtk_style_properties_get (GtkStyleProperties *props,
852 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
854 va_start (args, state);
855 gtk_style_properties_get_valist (props, state, args);
860 * gtk_style_properties_unset_property:
861 * @props: a #GtkStyleProperties
862 * @property: property to unset
863 * @state: state to unset
865 * Unsets a style property in @props.
870 gtk_style_properties_unset_property (GtkStyleProperties *props,
871 const gchar *property,
874 GtkStylePropertiesPrivate *priv;
875 GtkStyleProperty *node;
879 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
880 g_return_if_fail (property != NULL);
882 node = _gtk_style_property_lookup (property);
886 g_warning ("Style property \"%s\" is not registered", property);
890 if (node->unset_func)
892 node->unset_func (props, state);
897 prop = g_hash_table_lookup (priv->properties, node);
902 if (property_data_find_position (prop, state, &pos))
906 data = &g_array_index (prop->values, ValueData, pos);
908 if (G_IS_VALUE (&data->value))
909 g_value_unset (&data->value);
911 g_array_remove_index (prop->values, pos);
916 * gtk_style_properties_clear:
917 * @props: a #GtkStyleProperties
919 * Clears all style information from @props.
922 gtk_style_properties_clear (GtkStyleProperties *props)
924 GtkStylePropertiesPrivate *priv;
926 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
929 g_hash_table_remove_all (priv->properties);
933 * gtk_style_properties_merge:
934 * @props: a #GtkStyleProperties
935 * @props_to_merge: a second #GtkStyleProperties
936 * @replace: whether to replace values or not
938 * Merges into @props all the style information contained
939 * in @props_to_merge. If @replace is %TRUE, the values
940 * will be overwritten, if it is %FALSE, the older values
946 gtk_style_properties_merge (GtkStyleProperties *props,
947 const GtkStyleProperties *props_to_merge,
950 GtkStylePropertiesPrivate *priv, *priv_to_merge;
954 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
955 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props_to_merge));
958 priv_to_merge = props_to_merge->priv;
960 /* Merge symbolic color map */
961 if (priv_to_merge->color_map)
963 g_hash_table_iter_init (&iter, priv_to_merge->color_map);
965 while (g_hash_table_iter_next (&iter, &key, &value))
968 GtkSymbolicColor *color;
974 g_hash_table_lookup (priv->color_map, name))
977 gtk_style_properties_map_color (props, name, color);
981 /* Merge symbolic style properties */
982 g_hash_table_iter_init (&iter, priv_to_merge->properties);
984 while (g_hash_table_iter_next (&iter, &key, &value))
986 PropertyData *prop_to_merge = value;
990 prop = g_hash_table_lookup (priv->properties, key);
994 prop = property_data_new ();
995 g_hash_table_insert (priv->properties, key, prop);
998 for (i = 0; i < prop_to_merge->values->len; i++)
1003 data = &g_array_index (prop_to_merge->values, ValueData, i);
1005 if (replace && data->state == GTK_STATE_FLAG_NORMAL &&
1006 G_VALUE_TYPE (&data->value) != PANGO_TYPE_FONT_DESCRIPTION)
1008 /* Let normal state override all states
1009 * previously set in the original set
1011 property_data_remove_values (prop);
1014 value = property_data_get_value (prop, data->state);
1016 if (G_VALUE_TYPE (&data->value) == PANGO_TYPE_FONT_DESCRIPTION &&
1019 PangoFontDescription *font_desc;
1020 PangoFontDescription *font_desc_to_merge;
1022 /* Handle merging of font descriptions */
1023 font_desc = g_value_get_boxed (value);
1024 font_desc_to_merge = g_value_get_boxed (&data->value);
1026 pango_font_description_merge (font_desc, font_desc_to_merge, replace);
1028 else if (G_VALUE_TYPE (&data->value) == G_TYPE_PTR_ARRAY &&
1031 GPtrArray *array, *array_to_merge;
1034 /* Append the array, mainly thought
1035 * for the gtk-key-bindings property
1037 array = g_value_get_boxed (value);
1038 array_to_merge = g_value_get_boxed (&data->value);
1040 for (i = 0; i < array_to_merge->len; i++)
1041 g_ptr_array_add (array, g_ptr_array_index (array_to_merge, i));
1043 else if (replace || !G_IS_VALUE (value))
1045 if (!G_IS_VALUE (value))
1046 g_value_init (value, G_VALUE_TYPE (&data->value));
1047 else if (G_VALUE_TYPE (value) != G_VALUE_TYPE (&data->value))
1049 g_value_unset (value);
1050 g_value_init (value, G_VALUE_TYPE (&data->value));
1053 g_value_copy (&data->value, value);