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 #define GDK_DISABLE_DEPRECATION_WARNINGS
22 #include "gtkcsscolorvalueprivate.h"
23 #include "gtkcssrgbavalueprivate.h"
24 #include "gtkcssstylepropertyprivate.h"
25 #include "gtkhslaprivate.h"
26 #include "gtkstylepropertyprivate.h"
27 #include "gtksymboliccolorprivate.h"
28 #include "gtkstyleproperties.h"
30 #include "gtkwin32themeprivate.h"
33 * SECTION:gtksymboliccolor
34 * @Short_description: Symbolic colors
35 * @Title: GtkSymbolicColor
37 * GtkSymbolicColor is a boxed type that represents a symbolic color.
38 * It is the result of parsing a
39 * <link linkend="gtkcssprovider-symbolic-colors">color expression</link>.
40 * To obtain the color represented by a GtkSymbolicColor, it has to
41 * be resolved with gtk_symbolic_color_resolve(), which replaces all
42 * symbolic color references by the colors they refer to (in a given
43 * context) and evaluates mix, shade and other expressions, resulting
44 * in a #GdkRGBA value.
46 * It is not normally necessary to deal directly with #GtkSymbolicColors,
47 * since they are mostly used behind the scenes by #GtkStyleContext and
50 * #GtkSymbolicColor is deprecated. Symbolic colors are considered an
51 * implementation detail of GTK+.
54 G_DEFINE_BOXED_TYPE (GtkSymbolicColor, gtk_symbolic_color,
55 gtk_symbolic_color_ref, gtk_symbolic_color_unref)
57 struct _GtkSymbolicColor
63 static GtkSymbolicColor *
64 gtk_symbolic_color_new (GtkCssValue *value)
66 GtkSymbolicColor *symbolic;
68 symbolic = g_slice_new0 (GtkSymbolicColor);
69 symbolic->value = value;
70 symbolic->ref_count = 1;
76 * gtk_symbolic_color_new_literal:
79 * Creates a symbolic color pointing to a literal color.
81 * Returns: a newly created #GtkSymbolicColor
85 * Deprecated: 3.8: #GtkSymbolicColor is deprecated.
88 gtk_symbolic_color_new_literal (const GdkRGBA *color)
90 g_return_val_if_fail (color != NULL, NULL);
92 return gtk_symbolic_color_new (_gtk_css_color_value_new_literal (color));
96 * gtk_symbolic_color_new_name:
99 * Creates a symbolic color pointing to an unresolved named
100 * color. See gtk_style_context_lookup_color() and
101 * gtk_style_properties_lookup_color().
103 * Returns: a newly created #GtkSymbolicColor
107 * Deprecated: 3.8: #GtkSymbolicColor is deprecated.
110 gtk_symbolic_color_new_name (const gchar *name)
112 g_return_val_if_fail (name != NULL, NULL);
114 return gtk_symbolic_color_new (_gtk_css_color_value_new_name (name));
118 * gtk_symbolic_color_new_shade: (constructor)
119 * @color: another #GtkSymbolicColor
120 * @factor: shading factor to apply to @color
122 * Creates a symbolic color defined as a shade of
123 * another color. A factor > 1.0 would resolve to
124 * a brighter color, while < 1.0 would resolve to
127 * Returns: A newly created #GtkSymbolicColor
131 * Deprecated: 3.8: #GtkSymbolicColor is deprecated.
134 gtk_symbolic_color_new_shade (GtkSymbolicColor *color,
137 g_return_val_if_fail (color != NULL, NULL);
139 return gtk_symbolic_color_new (_gtk_css_color_value_new_shade (color->value,
144 * gtk_symbolic_color_new_alpha: (constructor)
145 * @color: another #GtkSymbolicColor
146 * @factor: factor to apply to @color alpha
148 * Creates a symbolic color by modifying the relative alpha
149 * value of @color. A factor < 1.0 would resolve to a more
150 * transparent color, while > 1.0 would resolve to a more
153 * Returns: A newly created #GtkSymbolicColor
157 * Deprecated: 3.8: #GtkSymbolicColor is deprecated.
160 gtk_symbolic_color_new_alpha (GtkSymbolicColor *color,
163 g_return_val_if_fail (color != NULL, NULL);
165 return gtk_symbolic_color_new (_gtk_css_color_value_new_alpha (color->value,
170 * gtk_symbolic_color_new_mix: (constructor)
171 * @color1: color to mix
172 * @color2: another color to mix
173 * @factor: mix factor
175 * Creates a symbolic color defined as a mix of another
176 * two colors. a mix factor of 0 would resolve to @color1,
177 * while a factor of 1 would resolve to @color2.
179 * Returns: A newly created #GtkSymbolicColor
183 * Deprecated: 3.8: #GtkSymbolicColor is deprecated.
186 gtk_symbolic_color_new_mix (GtkSymbolicColor *color1,
187 GtkSymbolicColor *color2,
190 g_return_val_if_fail (color1 != NULL, NULL);
191 g_return_val_if_fail (color1 != NULL, NULL);
193 return gtk_symbolic_color_new (_gtk_css_color_value_new_mix (color1->value,
199 * gtk_symbolic_color_new_win32: (constructor)
200 * @theme_class: The theme class to pull color from
203 * Creates a symbolic color based on the current win32
206 * Note that while this call is available on all platforms
207 * the actual value returned is not reliable on non-win32
210 * Returns: A newly created #GtkSymbolicColor
214 * Deprecated: 3.8: #GtkSymbolicColor is deprecated.
217 gtk_symbolic_color_new_win32 (const gchar *theme_class,
220 g_return_val_if_fail (theme_class != NULL, NULL);
222 return gtk_symbolic_color_new (_gtk_css_color_value_new_win32 (theme_class, id));
226 * gtk_symbolic_color_ref:
227 * @color: a #GtkSymbolicColor
229 * Increases the reference count of @color
231 * Returns: the same @color
235 * Deprecated: 3.8: #GtkSymbolicColor is deprecated.
238 gtk_symbolic_color_ref (GtkSymbolicColor *color)
240 g_return_val_if_fail (color != NULL, NULL);
248 * gtk_symbolic_color_unref:
249 * @color: a #GtkSymbolicColor
251 * Decreases the reference count of @color, freeing its memory if the
252 * reference count reaches 0.
256 * Deprecated: 3.8: #GtkSymbolicColor is deprecated.
259 gtk_symbolic_color_unref (GtkSymbolicColor *color)
261 g_return_if_fail (color != NULL);
263 if (--color->ref_count)
266 _gtk_css_value_unref (color->value);
268 g_slice_free (GtkSymbolicColor, color);
272 * gtk_symbolic_color_resolve:
273 * @color: a #GtkSymbolicColor
274 * @props: (allow-none): #GtkStyleProperties to use when resolving
275 * named colors, or %NULL
276 * @resolved_color: (out): return location for the resolved color
278 * If @color is resolvable, @resolved_color will be filled in
279 * with the resolved color, and %TRUE will be returned. Generally,
280 * if @color can't be resolved, it is due to it being defined on
281 * top of a named color that doesn't exist in @props.
283 * When @props is %NULL, resolving of named colors will fail, so if
284 * your @color is or references such a color, this function will
287 * Returns: %TRUE if the color has been resolved
291 * Deprecated: 3.8: #GtkSymbolicColor is deprecated.
294 gtk_symbolic_color_resolve (GtkSymbolicColor *color,
295 GtkStyleProperties *props,
296 GdkRGBA *resolved_color)
298 GdkRGBA pink = { 1.0, 0.5, 0.5, 1.0 };
299 GtkCssValue *v, *current;
301 g_return_val_if_fail (color != NULL, FALSE);
302 g_return_val_if_fail (resolved_color != NULL, FALSE);
303 g_return_val_if_fail (props == NULL || GTK_IS_STYLE_PROPERTIES (props), FALSE);
305 current = _gtk_css_rgba_value_new_from_rgba (&pink);
306 v = _gtk_css_color_value_resolve (color->value,
307 GTK_STYLE_PROVIDER_PRIVATE (props),
311 _gtk_css_value_unref (current);
315 *resolved_color = *_gtk_css_rgba_value_get_rgba (v);
316 _gtk_css_value_unref (v);
321 * gtk_symbolic_color_to_string:
322 * @color: color to convert to a string
324 * Converts the given @color to a string representation. This is useful
325 * both for debugging and for serialization of strings. The format of
326 * the string may change between different versions of GTK, but it is
327 * guaranteed that the GTK css parser is able to read the string and
328 * create the same symbolic color from it.
330 * Returns: a new string representing @color
332 * Deprecated: 3.8: #GtkSymbolicColor is deprecated.
335 gtk_symbolic_color_to_string (GtkSymbolicColor *color)
337 g_return_val_if_fail (color != NULL, NULL);
339 return _gtk_css_value_to_string (color->value);
343 _gtk_css_symbolic_value_new (GtkCssParser *parser)
347 value = _gtk_css_color_value_parse (parser);
351 return gtk_symbolic_color_new (value);
355 _gtk_symbolic_color_get_css_value (GtkSymbolicColor *symbolic)
357 return symbolic->value;