1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 2000 Red Hat, Inc.
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.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #ifndef __GTK_ICON_FACTORY_H__
28 #define __GTK_ICON_FACTORY_H__
31 #include <gtk/gtkrc.h>
35 #endif /* __cplusplus */
37 typedef struct _GtkIconFactoryClass GtkIconFactoryClass;
39 #define GTK_TYPE_ICON_FACTORY (gtk_icon_factory_get_type ())
40 #define GTK_ICON_FACTORY(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_ICON_FACTORY, GtkIconFactory))
41 #define GTK_ICON_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ICON_FACTORY, GtkIconFactoryClass))
42 #define GTK_IS_ICON_FACTORY(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_ICON_FACTORY))
43 #define GTK_IS_ICON_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ICON_FACTORY))
44 #define GTK_ICON_FACTORY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ICON_FACTORY, GtkIconFactoryClass))
46 struct _GtkIconFactory
48 GObject parent_instance;
53 struct _GtkIconFactoryClass
55 GObjectClass parent_class;
60 GType gtk_icon_factory_get_type (void);
61 GtkIconFactory* gtk_icon_factory_new (void);
62 void gtk_icon_factory_add (GtkIconFactory *factory,
63 const gchar *stock_id,
64 GtkIconSet *icon_set);
65 GtkIconSet* gtk_icon_factory_lookup (GtkIconFactory *factory,
66 const gchar *stock_id);
68 /* Manage the default icon factory stack */
70 void gtk_icon_factory_add_default (GtkIconFactory *factory);
71 void gtk_icon_factory_remove_default (GtkIconFactory *factory);
72 GtkIconSet* gtk_icon_factory_lookup_default (const gchar *stock_id);
74 /* Get preferred real size from registered semantic size. Note that
75 * themes SHOULD use this size, but they aren't required to; for size
76 * requests and such, you should get the actual pixbuf from the icon
77 * set and see what size was rendered.
79 * This function is intended for people who are scaling icons,
80 * rather than for people who are displaying already-scaled icons.
81 * That is, if you are displaying an icon, you should get the
82 * size from the rendered pixbuf, not from here.
85 gboolean gtk_icon_size_lookup (GtkIconSize size,
88 GtkIconSize gtk_icon_size_register (const gchar *name,
91 void gtk_icon_size_register_alias (const gchar *alias,
93 GtkIconSize gtk_icon_size_from_name (const gchar *name);
94 G_CONST_RETURN gchar* gtk_icon_size_get_name (GtkIconSize size);
98 GtkIconSet* gtk_icon_set_new (void);
99 GtkIconSet* gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf);
101 GtkIconSet* gtk_icon_set_ref (GtkIconSet *icon_set);
102 void gtk_icon_set_unref (GtkIconSet *icon_set);
103 GtkIconSet* gtk_icon_set_copy (GtkIconSet *icon_set);
105 /* Get one of the icon variants in the set, creating the variant if
108 GdkPixbuf* gtk_icon_set_render_icon (GtkIconSet *icon_set,
110 GtkTextDirection direction,
117 void gtk_icon_set_add_source (GtkIconSet *icon_set,
118 const GtkIconSource *source);
121 void _gtk_icon_set_invalidate_caches (void);
123 struct _GtkIconSource
125 /* Either filename or pixbuf can be NULL. If both are non-NULL,
126 * the pixbuf is assumed to be the already-loaded contents of the
132 GtkTextDirection direction;
136 /* If TRUE, then the parameter is wildcarded, and the above
137 * fields should be ignored. If FALSE, the parameter is
138 * specified, and the above fields should be valid.
140 guint any_direction : 1;
146 GtkIconSource* gtk_icon_source_copy (const GtkIconSource *source);
147 void gtk_icon_source_free (GtkIconSource *source);
151 #endif /* __cplusplus */
153 #endif /* __GTK_ICON_FACTORY_H__ */