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 typedef struct _GtkIconFactoryClass GtkIconFactoryClass;
37 #define GTK_TYPE_ICON_FACTORY (gtk_icon_factory_get_type ())
38 #define GTK_ICON_FACTORY(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_ICON_FACTORY, GtkIconFactory))
39 #define GTK_ICON_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ICON_FACTORY, GtkIconFactoryClass))
40 #define GTK_IS_ICON_FACTORY(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_ICON_FACTORY))
41 #define GTK_IS_ICON_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ICON_FACTORY))
42 #define GTK_ICON_FACTORY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ICON_FACTORY, GtkIconFactoryClass))
43 #define GTK_TYPE_ICON_SET (gtk_icon_set_get_type ())
44 #define GTK_TYPE_ICON_SOURCE (gtk_icon_source_get_type ())
46 struct _GtkIconFactory
48 GObject parent_instance;
53 struct _GtkIconFactoryClass
55 GObjectClass parent_class;
57 /* Padding for future expansion */
58 void (*_gtk_reserved1) (void);
59 void (*_gtk_reserved2) (void);
60 void (*_gtk_reserved3) (void);
61 void (*_gtk_reserved4) (void);
65 /* Reserve old names for DLL ABI backward compatibility */
66 #define gtk_icon_source_set_filename gtk_icon_source_set_filename_utf8
67 #define gtk_icon_source_get_filename gtk_icon_source_get_filename_utf8
70 GType gtk_icon_factory_get_type (void) G_GNUC_CONST;
71 GtkIconFactory* gtk_icon_factory_new (void);
72 void gtk_icon_factory_add (GtkIconFactory *factory,
73 const gchar *stock_id,
74 GtkIconSet *icon_set);
75 GtkIconSet* gtk_icon_factory_lookup (GtkIconFactory *factory,
76 const gchar *stock_id);
78 /* Manage the default icon factory stack */
80 void gtk_icon_factory_add_default (GtkIconFactory *factory);
81 void gtk_icon_factory_remove_default (GtkIconFactory *factory);
82 GtkIconSet* gtk_icon_factory_lookup_default (const gchar *stock_id);
84 /* Get preferred real size from registered semantic size. Note that
85 * themes SHOULD use this size, but they aren't required to; for size
86 * requests and such, you should get the actual pixbuf from the icon
87 * set and see what size was rendered.
89 * This function is intended for people who are scaling icons,
90 * rather than for people who are displaying already-scaled icons.
91 * That is, if you are displaying an icon, you should get the
92 * size from the rendered pixbuf, not from here.
95 #ifndef GDK_MULTIHEAD_SAFE
96 gboolean gtk_icon_size_lookup (GtkIconSize size,
99 #endif /* GDK_MULTIHEAD_SAFE */
100 gboolean gtk_icon_size_lookup_for_settings (GtkSettings *settings,
105 GtkIconSize gtk_icon_size_register (const gchar *name,
108 void gtk_icon_size_register_alias (const gchar *alias,
110 GtkIconSize gtk_icon_size_from_name (const gchar *name);
111 G_CONST_RETURN gchar* gtk_icon_size_get_name (GtkIconSize size);
115 GType gtk_icon_set_get_type (void) G_GNUC_CONST;
116 GtkIconSet* gtk_icon_set_new (void);
117 GtkIconSet* gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf);
119 GtkIconSet* gtk_icon_set_ref (GtkIconSet *icon_set);
120 void gtk_icon_set_unref (GtkIconSet *icon_set);
121 GtkIconSet* gtk_icon_set_copy (GtkIconSet *icon_set);
123 /* Get one of the icon variants in the set, creating the variant if
126 GdkPixbuf* gtk_icon_set_render_icon (GtkIconSet *icon_set,
128 GtkTextDirection direction,
135 void gtk_icon_set_add_source (GtkIconSet *icon_set,
136 const GtkIconSource *source);
138 void gtk_icon_set_get_sizes (GtkIconSet *icon_set,
142 GType gtk_icon_source_get_type (void) G_GNUC_CONST;
143 GtkIconSource* gtk_icon_source_new (void);
144 GtkIconSource* gtk_icon_source_copy (const GtkIconSource *source);
145 void gtk_icon_source_free (GtkIconSource *source);
147 void gtk_icon_source_set_filename (GtkIconSource *source,
148 const gchar *filename);
149 void gtk_icon_source_set_icon_name (GtkIconSource *source,
150 const gchar *icon_name);
151 void gtk_icon_source_set_pixbuf (GtkIconSource *source,
154 G_CONST_RETURN gchar* gtk_icon_source_get_filename (const GtkIconSource *source);
155 G_CONST_RETURN gchar* gtk_icon_source_get_icon_name (const GtkIconSource *source);
156 GdkPixbuf* gtk_icon_source_get_pixbuf (const GtkIconSource *source);
158 void gtk_icon_source_set_direction_wildcarded (GtkIconSource *source,
160 void gtk_icon_source_set_state_wildcarded (GtkIconSource *source,
162 void gtk_icon_source_set_size_wildcarded (GtkIconSource *source,
164 gboolean gtk_icon_source_get_size_wildcarded (const GtkIconSource *source);
165 gboolean gtk_icon_source_get_state_wildcarded (const GtkIconSource *source);
166 gboolean gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source);
167 void gtk_icon_source_set_direction (GtkIconSource *source,
168 GtkTextDirection direction);
169 void gtk_icon_source_set_state (GtkIconSource *source,
171 void gtk_icon_source_set_size (GtkIconSource *source,
173 GtkTextDirection gtk_icon_source_get_direction (const GtkIconSource *source);
174 GtkStateType gtk_icon_source_get_state (const GtkIconSource *source);
175 GtkIconSize gtk_icon_source_get_size (const GtkIconSource *source);
179 void _gtk_icon_set_invalidate_caches (void);
180 GSList* _gtk_icon_factory_list_ids (void);
181 void _gtk_icon_factory_ensure_default_icons (void);
185 #endif /* __GTK_ICON_FACTORY_H__ */