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 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
31 #ifndef __GTK_ICON_FACTORY_H__
32 #define __GTK_ICON_FACTORY_H__
35 #include <gtk/gtkrc.h>
40 #define GTK_TYPE_ICON_FACTORY (gtk_icon_factory_get_type ())
41 #define GTK_ICON_FACTORY(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_ICON_FACTORY, GtkIconFactory))
42 #define GTK_ICON_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ICON_FACTORY, GtkIconFactoryClass))
43 #define GTK_IS_ICON_FACTORY(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_ICON_FACTORY))
44 #define GTK_IS_ICON_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ICON_FACTORY))
45 #define GTK_ICON_FACTORY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ICON_FACTORY, GtkIconFactoryClass))
46 #define GTK_TYPE_ICON_SET (gtk_icon_set_get_type ())
47 #define GTK_TYPE_ICON_SOURCE (gtk_icon_source_get_type ())
49 typedef struct _GtkIconFactoryPrivate GtkIconFactoryPrivate;
50 typedef struct _GtkIconFactoryClass GtkIconFactoryClass;
52 struct _GtkIconFactory
54 GObject parent_instance;
57 GtkIconFactoryPrivate *priv;
60 struct _GtkIconFactoryClass
62 GObjectClass parent_class;
64 /* Padding for future expansion */
65 void (*_gtk_reserved1) (void);
66 void (*_gtk_reserved2) (void);
67 void (*_gtk_reserved3) (void);
68 void (*_gtk_reserved4) (void);
71 GType gtk_icon_factory_get_type (void) G_GNUC_CONST;
72 GtkIconFactory* gtk_icon_factory_new (void);
73 void gtk_icon_factory_add (GtkIconFactory *factory,
74 const gchar *stock_id,
75 GtkIconSet *icon_set);
76 GtkIconSet* gtk_icon_factory_lookup (GtkIconFactory *factory,
77 const gchar *stock_id);
79 /* Manage the default icon factory stack */
81 void gtk_icon_factory_add_default (GtkIconFactory *factory);
82 void gtk_icon_factory_remove_default (GtkIconFactory *factory);
83 GtkIconSet* gtk_icon_factory_lookup_default (const gchar *stock_id);
85 /* Get preferred real size from registered semantic size. Note that
86 * themes SHOULD use this size, but they aren't required to; for size
87 * requests and such, you should get the actual pixbuf from the icon
88 * set and see what size was rendered.
90 * This function is intended for people who are scaling icons,
91 * rather than for people who are displaying already-scaled icons.
92 * That is, if you are displaying an icon, you should get the
93 * size from the rendered pixbuf, not from here.
96 #ifndef GDK_MULTIHEAD_SAFE
97 gboolean gtk_icon_size_lookup (GtkIconSize size,
100 #endif /* GDK_MULTIHEAD_SAFE */
101 gboolean gtk_icon_size_lookup_for_settings (GtkSettings *settings,
106 GtkIconSize gtk_icon_size_register (const gchar *name,
109 void gtk_icon_size_register_alias (const gchar *alias,
111 GtkIconSize gtk_icon_size_from_name (const gchar *name);
112 const gchar* gtk_icon_size_get_name (GtkIconSize size);
116 GType gtk_icon_set_get_type (void) G_GNUC_CONST;
117 GtkIconSet* gtk_icon_set_new (void);
118 GtkIconSet* gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf);
120 GtkIconSet* gtk_icon_set_ref (GtkIconSet *icon_set);
121 void gtk_icon_set_unref (GtkIconSet *icon_set);
122 GtkIconSet* gtk_icon_set_copy (GtkIconSet *icon_set);
124 #if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)
125 /* Get one of the icon variants in the set, creating the variant if
128 GdkPixbuf* gtk_icon_set_render_icon (GtkIconSet *icon_set,
130 GtkTextDirection direction,
134 const gchar *detail);
137 void gtk_icon_set_add_source (GtkIconSet *icon_set,
138 const GtkIconSource *source);
140 void gtk_icon_set_get_sizes (GtkIconSet *icon_set,
144 GType gtk_icon_source_get_type (void) G_GNUC_CONST;
145 GtkIconSource* gtk_icon_source_new (void);
146 GtkIconSource* gtk_icon_source_copy (const GtkIconSource *source);
147 void gtk_icon_source_free (GtkIconSource *source);
149 void gtk_icon_source_set_filename (GtkIconSource *source,
150 const gchar *filename);
151 void gtk_icon_source_set_icon_name (GtkIconSource *source,
152 const gchar *icon_name);
153 void gtk_icon_source_set_pixbuf (GtkIconSource *source,
156 const gchar * gtk_icon_source_get_filename (const GtkIconSource *source);
157 const gchar * gtk_icon_source_get_icon_name (const GtkIconSource *source);
158 GdkPixbuf* gtk_icon_source_get_pixbuf (const GtkIconSource *source);
160 void gtk_icon_source_set_direction_wildcarded (GtkIconSource *source,
162 void gtk_icon_source_set_state_wildcarded (GtkIconSource *source,
164 void gtk_icon_source_set_size_wildcarded (GtkIconSource *source,
166 gboolean gtk_icon_source_get_size_wildcarded (const GtkIconSource *source);
167 gboolean gtk_icon_source_get_state_wildcarded (const GtkIconSource *source);
168 gboolean gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source);
169 void gtk_icon_source_set_direction (GtkIconSource *source,
170 GtkTextDirection direction);
171 void gtk_icon_source_set_state (GtkIconSource *source,
173 void gtk_icon_source_set_size (GtkIconSource *source,
175 GtkTextDirection gtk_icon_source_get_direction (const GtkIconSource *source);
176 GtkStateType gtk_icon_source_get_state (const GtkIconSource *source);
177 GtkIconSize gtk_icon_source_get_size (const GtkIconSource *source);
181 void _gtk_icon_set_invalidate_caches (void);
182 GList* _gtk_icon_factory_list_ids (void);
183 void _gtk_icon_factory_ensure_default_icons (void);
187 #endif /* __GTK_ICON_FACTORY_H__ */