1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
27 #include "gthemedicon.h"
35 * @short_description: Icon theming support
37 * @see_also: #GIcon, #GLoadableIcon
39 * #GThemedIcon is an implementation of #GIcon that supports icon themes.
40 * #GThemedIcon contains a list of all of the icons present in an icon
41 * theme, so that icons can be looked up quickly. #GThemedIcon does
42 * not provide actual pixmaps for icons, just the icon names.
43 * Ideally something like gtk_icon_theme_choose_icon() should be used to
44 * resolve the list of names so that fallback icons work nicely with
45 * themes that inherit other themes.
48 static void g_themed_icon_icon_iface_init (GIconIface
*iface
);
52 GObject parent_instance
;
55 gboolean use_default_fallbacks
;
58 struct _GThemedIconClass
60 GObjectClass parent_class
;
68 PROP_USE_DEFAULT_FALLBACKS
71 G_DEFINE_TYPE_WITH_CODE (GThemedIcon
, g_themed_icon
, G_TYPE_OBJECT
,
72 G_IMPLEMENT_INTERFACE (G_TYPE_ICON
,
73 g_themed_icon_icon_iface_init
))
76 g_themed_icon_get_property (GObject
*object
,
81 GThemedIcon
*icon
= G_THEMED_ICON (object
);
86 g_value_set_boxed (value
, icon
->names
);
89 case PROP_USE_DEFAULT_FALLBACKS
:
90 g_value_set_boolean (value
, icon
->use_default_fallbacks
);
94 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
99 g_themed_icon_set_property (GObject
*object
,
104 GThemedIcon
*icon
= G_THEMED_ICON (object
);
111 name
= g_value_get_string (value
);
117 g_strfreev (icon
->names
);
119 icon
->names
= g_new (char *, 2);
120 icon
->names
[0] = g_strdup (name
);
121 icon
->names
[1] = NULL
;
125 names
= g_value_dup_boxed (value
);
131 g_strfreev (icon
->names
);
136 case PROP_USE_DEFAULT_FALLBACKS
:
137 icon
->use_default_fallbacks
= g_value_get_boolean (value
);
141 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
146 g_themed_icon_constructed (GObject
*object
)
148 GThemedIcon
*themed
= G_THEMED_ICON (object
);
150 g_return_if_fail (themed
->names
!= NULL
&& themed
->names
[0] != NULL
);
152 if (themed
->use_default_fallbacks
)
154 int i
= 0, dashes
= 0;
159 p
= themed
->names
[0];
167 last
= g_strdup (themed
->names
[0]);
169 g_strfreev (themed
->names
);
171 themed
->names
= g_new (char *, dashes
+ 1 + 1);
172 themed
->names
[i
++] = last
;
174 while ((dashp
= strrchr (last
, '-')) != NULL
)
175 themed
->names
[i
++] = last
= g_strndup (last
, dashp
- last
);
177 themed
->names
[i
++] = NULL
;
182 g_themed_icon_finalize (GObject
*object
)
186 themed
= G_THEMED_ICON (object
);
188 g_strfreev (themed
->names
);
190 G_OBJECT_CLASS (g_themed_icon_parent_class
)->finalize (object
);
194 g_themed_icon_class_init (GThemedIconClass
*klass
)
196 GObjectClass
*gobject_class
= G_OBJECT_CLASS (klass
);
198 gobject_class
->finalize
= g_themed_icon_finalize
;
199 gobject_class
->constructed
= g_themed_icon_constructed
;
200 gobject_class
->set_property
= g_themed_icon_set_property
;
201 gobject_class
->get_property
= g_themed_icon_get_property
;
208 g_object_class_install_property (gobject_class
, PROP_NAME
,
209 g_param_spec_string ("name",
211 P_("The name of the icon"),
213 G_PARAM_CONSTRUCT_ONLY
| G_PARAM_WRITABLE
| G_PARAM_STATIC_NAME
| G_PARAM_STATIC_BLURB
| G_PARAM_STATIC_NICK
));
218 * A %NULL-terminated array of icon names.
220 g_object_class_install_property (gobject_class
, PROP_NAMES
,
221 g_param_spec_boxed ("names",
223 P_("An array containing the icon names"),
225 G_PARAM_CONSTRUCT_ONLY
| G_PARAM_READWRITE
| G_PARAM_STATIC_NAME
| G_PARAM_STATIC_BLURB
| G_PARAM_STATIC_NICK
));
228 * GThemedIcon:use-default-fallbacks:
230 * Whether to use the default fallbacks found by shortening the icon name
231 * at '-' characters. If the "names" array has more than one element,
232 * ignores any past the first.
234 * For example, if the icon name was "gnome-dev-cdrom-audio", the array
238 * "gnome-dev-cdrom-audio",
246 g_object_class_install_property (gobject_class
, PROP_USE_DEFAULT_FALLBACKS
,
247 g_param_spec_boolean ("use-default-fallbacks",
248 P_("use default fallbacks"),
249 P_("Whether to use default fallbacks found by shortening the name at '-' characters. Ignores names after the first if multiple names are given."),
251 G_PARAM_CONSTRUCT_ONLY
| G_PARAM_READWRITE
| G_PARAM_STATIC_NAME
| G_PARAM_STATIC_BLURB
| G_PARAM_STATIC_NICK
));
255 g_themed_icon_init (GThemedIcon
*themed
)
257 themed
->names
= NULL
;
262 * @iconname: a string containing an icon name.
264 * Creates a new themed icon for @iconname.
266 * Returns: (transfer full) (type GThemedIcon): a new #GThemedIcon.
269 g_themed_icon_new (const char *iconname
)
271 g_return_val_if_fail (iconname
!= NULL
, NULL
);
273 return G_ICON (g_object_new (G_TYPE_THEMED_ICON
, "name", iconname
, NULL
));
277 * g_themed_icon_new_from_names:
278 * @iconnames: (array length=len): an array of strings containing icon names.
279 * @len: the length of the @iconnames array, or -1 if @iconnames is
282 * Creates a new themed icon for @iconnames.
284 * Returns: (transfer full) (type GThemedIcon): a new #GThemedIcon
287 g_themed_icon_new_from_names (char **iconnames
,
292 g_return_val_if_fail (iconnames
!= NULL
, NULL
);
299 names
= g_new (char *, len
+ 1);
301 for (i
= 0; i
< len
; i
++)
302 names
[i
] = iconnames
[i
];
306 icon
= G_ICON (g_object_new (G_TYPE_THEMED_ICON
, "names", names
, NULL
));
311 icon
= G_ICON (g_object_new (G_TYPE_THEMED_ICON
, "names", iconnames
, NULL
));
317 * g_themed_icon_new_with_default_fallbacks:
318 * @iconname: a string containing an icon name
320 * Creates a new themed icon for @iconname, and all the names
321 * that can be created by shortening @iconname at '-' characters.
323 * In the following example, @icon1 and @icon2 are equivalent:
325 * const char *names[] = {
326 * "gnome-dev-cdrom-audio",
332 * icon1 = g_themed_icon_new_from_names (names, 4);
333 * icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
336 * Returns: (transfer full) (type GThemedIcon): a new #GThemedIcon.
339 g_themed_icon_new_with_default_fallbacks (const char *iconname
)
341 g_return_val_if_fail (iconname
!= NULL
, NULL
);
343 return G_ICON (g_object_new (G_TYPE_THEMED_ICON
, "name", iconname
, "use-default-fallbacks", TRUE
, NULL
));
348 * g_themed_icon_get_names:
349 * @icon: a #GThemedIcon.
351 * Gets the names of icons from within @icon.
353 * Returns: (transfer none): a list of icon names.
356 g_themed_icon_get_names (GThemedIcon
*icon
)
358 g_return_val_if_fail (G_IS_THEMED_ICON (icon
), NULL
);
359 return (const char * const *)icon
->names
;
363 * g_themed_icon_append_name:
364 * @icon: a #GThemedIcon
365 * @iconname: name of icon to append to list of icons from within @icon.
367 * Append a name to the list of icons from within @icon.
370 * Note that doing so invalidates the hash computed by prior calls
375 g_themed_icon_append_name (GThemedIcon
*icon
,
376 const char *iconname
)
380 g_return_if_fail (G_IS_THEMED_ICON (icon
));
381 g_return_if_fail (iconname
!= NULL
);
383 num_names
= g_strv_length (icon
->names
);
384 icon
->names
= g_realloc (icon
->names
, sizeof (char*) * (num_names
+ 2));
385 icon
->names
[num_names
] = g_strdup (iconname
);
386 icon
->names
[num_names
+ 1] = NULL
;
388 g_object_notify (G_OBJECT (icon
), "names");
392 * g_themed_icon_prepend_name:
393 * @icon: a #GThemedIcon
394 * @iconname: name of icon to prepend to list of icons from within @icon.
396 * Prepend a name to the list of icons from within @icon.
399 * Note that doing so invalidates the hash computed by prior calls
406 g_themed_icon_prepend_name (GThemedIcon
*icon
,
407 const char *iconname
)
413 g_return_if_fail (G_IS_THEMED_ICON (icon
));
414 g_return_if_fail (iconname
!= NULL
);
416 num_names
= g_strv_length (icon
->names
);
417 names
= g_new (char*, num_names
+ 2);
418 for (i
= 0; icon
->names
[i
]; i
++)
419 names
[i
+ 1] = icon
->names
[i
];
420 names
[0] = g_strdup (iconname
);
421 names
[num_names
+ 1] = NULL
;
423 g_free (icon
->names
);
426 g_object_notify (G_OBJECT (icon
), "names");
430 g_themed_icon_hash (GIcon
*icon
)
432 GThemedIcon
*themed
= G_THEMED_ICON (icon
);
438 for (i
= 0; themed
->names
[i
] != NULL
; i
++)
439 hash
^= g_str_hash (themed
->names
[i
]);
445 g_themed_icon_equal (GIcon
*icon1
,
448 GThemedIcon
*themed1
= G_THEMED_ICON (icon1
);
449 GThemedIcon
*themed2
= G_THEMED_ICON (icon2
);
452 for (i
= 0; themed1
->names
[i
] != NULL
&& themed2
->names
[i
] != NULL
; i
++)
454 if (!g_str_equal (themed1
->names
[i
], themed2
->names
[i
]))
458 return themed1
->names
[i
] == NULL
&& themed2
->names
[i
] == NULL
;
463 g_themed_icon_to_tokens (GIcon
*icon
,
467 GThemedIcon
*themed_icon
= G_THEMED_ICON (icon
);
470 g_return_val_if_fail (out_version
!= NULL
, FALSE
);
474 for (n
= 0; themed_icon
->names
[n
] != NULL
; n
++)
475 g_ptr_array_add (tokens
,
476 g_strdup (themed_icon
->names
[n
]));
482 g_themed_icon_from_tokens (gchar
**tokens
,
497 G_IO_ERROR_INVALID_ARGUMENT
,
498 _("Can't handle version %d of GThemedIcon encoding"),
503 names
= g_new0 (gchar
*, num_tokens
+ 1);
504 for (n
= 0; n
< num_tokens
; n
++)
505 names
[n
] = tokens
[n
];
508 icon
= g_themed_icon_new_from_names (names
, num_tokens
);
516 g_themed_icon_icon_iface_init (GIconIface
*iface
)
518 iface
->hash
= g_themed_icon_hash
;
519 iface
->equal
= g_themed_icon_equal
;
520 iface
->to_tokens
= g_themed_icon_to_tokens
;
521 iface
->from_tokens
= g_themed_icon_from_tokens
;