1/* GTK - The GIMP Toolkit
2 * Copyright (C) 2000 Red Hat, Inc.
3 *
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.
8 *
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.
13 *
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/>.
16 */
17
18/*
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23 */
24
25#ifndef __GTK_ICON_FACTORY_H__
26#define __GTK_ICON_FACTORY_H__
27
28#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
29#error "Only <gtk/gtk.h> can be included directly."
30#endif
31
32#include <gdk/gdk.h>
33#include <gtk/gtkenums.h>
34#include <gtk/gtktypes.h>
35
36G_BEGIN_DECLS
37
38
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))
45#define GTK_TYPE_ICON_SET (gtk_icon_set_get_type ())
46#define GTK_TYPE_ICON_SOURCE (gtk_icon_source_get_type ())
47
48typedef struct _GtkIconFactory GtkIconFactory;
49typedef struct _GtkIconFactoryPrivate GtkIconFactoryPrivate;
50typedef struct _GtkIconFactoryClass GtkIconFactoryClass;
51
52struct _GtkIconFactory
53{
54 GObject parent_instance;
55
56 /*< private >*/
57 GtkIconFactoryPrivate *priv;
58};
59
60/**
61 * GtkIconFactoryClass:
62 * @parent_class: The parent class.
63 */
64struct _GtkIconFactoryClass
65{
66 GObjectClass parent_class;
67
68 /*< private >*/
69
70 /* Padding for future expansion */
71 void (*_gtk_reserved1) (void);
72 void (*_gtk_reserved2) (void);
73 void (*_gtk_reserved3) (void);
74 void (*_gtk_reserved4) (void);
75};
76
77GDK_DEPRECATED_IN_3_10
78GType gtk_icon_factory_get_type (void) G_GNUC_CONST;
79GDK_DEPRECATED_IN_3_10
80GtkIconFactory* gtk_icon_factory_new (void);
81GDK_DEPRECATED_IN_3_10
82void gtk_icon_factory_add (GtkIconFactory *factory,
83 const gchar *stock_id,
84 GtkIconSet *icon_set);
85GDK_DEPRECATED_IN_3_10
86GtkIconSet* gtk_icon_factory_lookup (GtkIconFactory *factory,
87 const gchar *stock_id);
88
89/* Manage the default icon factory stack */
90
91GDK_DEPRECATED_IN_3_10
92void gtk_icon_factory_add_default (GtkIconFactory *factory);
93GDK_DEPRECATED_IN_3_10
94void gtk_icon_factory_remove_default (GtkIconFactory *factory);
95GDK_DEPRECATED_IN_3_10
96GtkIconSet* gtk_icon_factory_lookup_default (const gchar *stock_id);
97
98/* Get preferred real size from registered semantic size. Note that
99 * themes SHOULD use this size, but they aren’t required to; for size
100 * requests and such, you should get the actual pixbuf from the icon
101 * set and see what size was rendered.
102 *
103 * This function is intended for people who are scaling icons,
104 * rather than for people who are displaying already-scaled icons.
105 * That is, if you are displaying an icon, you should get the
106 * size from the rendered pixbuf, not from here.
107 */
108
109#ifndef GDK_MULTIHEAD_SAFE
110GDK_AVAILABLE_IN_ALL
111gboolean gtk_icon_size_lookup (GtkIconSize size,
112 gint *width,
113 gint *height);
114#endif /* GDK_MULTIHEAD_SAFE */
115GDK_DEPRECATED_IN_3_10_FOR(gtk_icon_size_lookup)
116gboolean gtk_icon_size_lookup_for_settings (GtkSettings *settings,
117 GtkIconSize size,
118 gint *width,
119 gint *height);
120
121GDK_DEPRECATED_IN_3_10
122GtkIconSize gtk_icon_size_register (const gchar *name,
123 gint width,
124 gint height);
125GDK_DEPRECATED_IN_3_10
126void gtk_icon_size_register_alias (const gchar *alias,
127 GtkIconSize target);
128GDK_DEPRECATED_IN_3_10
129GtkIconSize gtk_icon_size_from_name (const gchar *name);
130GDK_DEPRECATED_IN_3_10
131const gchar* gtk_icon_size_get_name (GtkIconSize size);
132
133/* Icon sets */
134
135GDK_DEPRECATED_IN_3_10
136GType gtk_icon_set_get_type (void) G_GNUC_CONST;
137GDK_DEPRECATED_IN_3_10
138GtkIconSet* gtk_icon_set_new (void);
139GDK_DEPRECATED_IN_3_10
140GtkIconSet* gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf);
141
142GDK_DEPRECATED_IN_3_10
143GtkIconSet* gtk_icon_set_ref (GtkIconSet *icon_set);
144GDK_DEPRECATED_IN_3_10
145void gtk_icon_set_unref (GtkIconSet *icon_set);
146GDK_DEPRECATED_IN_3_10
147GtkIconSet* gtk_icon_set_copy (GtkIconSet *icon_set);
148
149GDK_DEPRECATED_IN_3_0_FOR(gtk_icon_set_render_icon_pixbuf)
150GdkPixbuf* gtk_icon_set_render_icon (GtkIconSet *icon_set,
151 GtkStyle *style,
152 GtkTextDirection direction,
153 GtkStateType state,
154 GtkIconSize size,
155 GtkWidget *widget,
156 const gchar *detail);
157
158GDK_DEPRECATED_IN_3_10
159void gtk_icon_set_add_source (GtkIconSet *icon_set,
160 const GtkIconSource *source);
161
162GDK_DEPRECATED_IN_3_10
163void gtk_icon_set_get_sizes (GtkIconSet *icon_set,
164 GtkIconSize **sizes,
165 gint *n_sizes);
166
167GDK_DEPRECATED_IN_3_10
168GType gtk_icon_source_get_type (void) G_GNUC_CONST;
169GDK_DEPRECATED_IN_3_10
170GtkIconSource* gtk_icon_source_new (void);
171GDK_DEPRECATED_IN_3_10
172GtkIconSource* gtk_icon_source_copy (const GtkIconSource *source);
173GDK_DEPRECATED_IN_3_10
174void gtk_icon_source_free (GtkIconSource *source);
175
176GDK_DEPRECATED_IN_3_10
177void gtk_icon_source_set_filename (GtkIconSource *source,
178 const gchar *filename);
179GDK_DEPRECATED_IN_3_10
180void gtk_icon_source_set_icon_name (GtkIconSource *source,
181 const gchar *icon_name);
182GDK_DEPRECATED_IN_3_10
183void gtk_icon_source_set_pixbuf (GtkIconSource *source,
184 GdkPixbuf *pixbuf);
185
186GDK_DEPRECATED_IN_3_10
187const gchar * gtk_icon_source_get_filename (const GtkIconSource *source);
188GDK_DEPRECATED_IN_3_10
189const gchar * gtk_icon_source_get_icon_name (const GtkIconSource *source);
190GDK_DEPRECATED_IN_3_10
191GdkPixbuf* gtk_icon_source_get_pixbuf (const GtkIconSource *source);
192
193GDK_DEPRECATED_IN_3_10
194void gtk_icon_source_set_direction_wildcarded (GtkIconSource *source,
195 gboolean setting);
196GDK_DEPRECATED_IN_3_10
197void gtk_icon_source_set_state_wildcarded (GtkIconSource *source,
198 gboolean setting);
199GDK_DEPRECATED_IN_3_10
200void gtk_icon_source_set_size_wildcarded (GtkIconSource *source,
201 gboolean setting);
202GDK_DEPRECATED_IN_3_10
203gboolean gtk_icon_source_get_size_wildcarded (const GtkIconSource *source);
204GDK_DEPRECATED_IN_3_10
205gboolean gtk_icon_source_get_state_wildcarded (const GtkIconSource *source);
206GDK_DEPRECATED_IN_3_10
207gboolean gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source);
208GDK_DEPRECATED_IN_3_10
209void gtk_icon_source_set_direction (GtkIconSource *source,
210 GtkTextDirection direction);
211GDK_DEPRECATED_IN_3_10
212void gtk_icon_source_set_state (GtkIconSource *source,
213 GtkStateType state);
214GDK_DEPRECATED_IN_3_10
215void gtk_icon_source_set_size (GtkIconSource *source,
216 GtkIconSize size);
217GDK_DEPRECATED_IN_3_10
218GtkTextDirection gtk_icon_source_get_direction (const GtkIconSource *source);
219GDK_DEPRECATED_IN_3_10
220GtkStateType gtk_icon_source_get_state (const GtkIconSource *source);
221GDK_DEPRECATED_IN_3_10
222GtkIconSize gtk_icon_source_get_size (const GtkIconSource *source);
223
224G_END_DECLS
225
226#endif /* __GTK_ICON_FACTORY_H__ */
227