summaryrefslogtreecommitdiff
path: root/gtk/gtkicontheme.h
blob: f1a01773bfa1a82c6e1ad8e6858abc14c6ba2048 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/* GtkIconTheme - a loader for icon themes
 * gtk-icon-loader.h Copyright (C) 2002, 2003 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __GTK_ICON_THEME_H__
#define __GTK_ICON_THEME_H__

#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

#include <gdk-pixbuf/gdk-pixbuf.h>
#include <gdk/gdk.h>
#include <gtk/gtkstylecontext.h>
#include <gsk/gsk.h>

G_BEGIN_DECLS

#define GTK_TYPE_ICON              (gtk_icon_get_type ())
#define GTK_ICON(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ICON, GtkIcon))
#define GTK_IS_ICON(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ICON))

#define GTK_TYPE_ICON_THEME        (gtk_icon_theme_get_type ())
#define GTK_ICON_THEME(obj)        (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ICON_THEME, GtkIconTheme))
#define GTK_IS_ICON_THEME(obj)     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ICON_THEME))

typedef struct _GtkIcon         GtkIcon;
typedef struct _GtkIconTheme    GtkIconTheme;

/**
 * GtkIconLookupFlags:
 * @GTK_ICON_LOOKUP_GENERIC_FALLBACK: Try to shorten icon name at '-'
 *   characters before looking at inherited themes. This flag is only
 *   supported in functions that take a single icon name. For more general
 *   fallback, see gtk_icon_theme_choose_icon()
 * @GTK_ICON_LOOKUP_FORCE_SIZE: Always get the icon scaled to the
 *   requested size
 * @GTK_ICON_LOOKUP_FORCE_REGULAR: Try to always load regular icons, even
 *   when symbolic icon names are given
 * @GTK_ICON_LOOKUP_FORCE_SYMBOLIC: Try to always load symbolic icons, even
 *   when regular icon names are given
 *
 * Used to specify options for gtk_icon_theme_lookup_icon()
 */
typedef enum
{
  GTK_ICON_LOOKUP_GENERIC_FALLBACK = 1 << 0,
  GTK_ICON_LOOKUP_FORCE_SIZE       = 1 << 1,
  GTK_ICON_LOOKUP_FORCE_REGULAR    = 1 << 2,
  GTK_ICON_LOOKUP_FORCE_SYMBOLIC   = 1 << 3
} GtkIconLookupFlags;

/**
 * GTK_ICON_THEME_ERROR:
 *
 * The #GQuark used for #GtkIconThemeError errors.
 */
#define GTK_ICON_THEME_ERROR gtk_icon_theme_error_quark ()

/**
 * GtkIconThemeError:
 * @GTK_ICON_THEME_NOT_FOUND: The icon specified does not exist in the theme
 * @GTK_ICON_THEME_FAILED: An unspecified error occurred.
 *
 * Error codes for GtkIconTheme operations.
 **/
typedef enum {
  GTK_ICON_THEME_NOT_FOUND,
  GTK_ICON_THEME_FAILED
} GtkIconThemeError;

GDK_AVAILABLE_IN_ALL
GQuark gtk_icon_theme_error_quark (void);

GDK_AVAILABLE_IN_ALL
GType         gtk_icon_theme_get_type              (void) G_GNUC_CONST;

GDK_AVAILABLE_IN_ALL
GtkIconTheme *gtk_icon_theme_new                   (void);
GDK_AVAILABLE_IN_ALL
GtkIconTheme *gtk_icon_theme_get_for_display       (GdkDisplay                  *display);
GDK_AVAILABLE_IN_ALL
void          gtk_icon_theme_set_display           (GtkIconTheme                *self,
                                                    GdkDisplay                  *display);

GDK_AVAILABLE_IN_ALL
void          gtk_icon_theme_set_search_path       (GtkIconTheme                *self,
                                                    const gchar                 *path[],
                                                    gint                         n_elements);
GDK_AVAILABLE_IN_ALL
void          gtk_icon_theme_get_search_path       (GtkIconTheme                *self,
                                                    gchar                      **path[],
                                                    gint                        *n_elements);
GDK_AVAILABLE_IN_ALL
void          gtk_icon_theme_append_search_path    (GtkIconTheme                *self,
                                                    const gchar                 *path);
GDK_AVAILABLE_IN_ALL
void          gtk_icon_theme_prepend_search_path   (GtkIconTheme                *self,
                                                    const gchar                 *path);

GDK_AVAILABLE_IN_ALL
void          gtk_icon_theme_add_resource_path     (GtkIconTheme                *self,
                                                    const gchar                 *path);

GDK_AVAILABLE_IN_ALL
void          gtk_icon_theme_set_custom_theme      (GtkIconTheme                *self,
                                                    const gchar                 *theme_name);

GDK_AVAILABLE_IN_ALL
gboolean      gtk_icon_theme_has_icon              (GtkIconTheme                *self,
                                                    const gchar                 *icon_name);
GDK_AVAILABLE_IN_ALL
gint         *gtk_icon_theme_get_icon_sizes        (GtkIconTheme                *self,
                                                    const gchar                 *icon_name);
GDK_AVAILABLE_IN_ALL
GtkIcon *    gtk_icon_theme_lookup_icon            (GtkIconTheme                *self,
                                                    const gchar                 *icon_name,
                                                    gint                         size,
                                                    gint                         scale,
                                                    GtkTextDirection             direction,
                                                    GtkIconLookupFlags           flags);
GDK_AVAILABLE_IN_ALL
GtkIcon *    gtk_icon_theme_choose_icon            (GtkIconTheme                *self,
                                                    const gchar                 *icon_names[],
                                                    gint                         size,
                                                    gint                         scale,
                                                    GtkTextDirection             direction,
                                                    GtkIconLookupFlags           flags);
GDK_AVAILABLE_IN_ALL
GtkIcon *   gtk_icon_theme_lookup_by_gicon         (GtkIconTheme                *self,
                                                    GIcon                       *icon,
                                                    gint                         size,
                                                    gint                         scale,
                                                    GtkTextDirection             direction,
                                                    GtkIconLookupFlags           flags);
GDK_AVAILABLE_IN_ALL
GList *       gtk_icon_theme_list_icons            (GtkIconTheme                *self,
                                                    const gchar                 *context);
GDK_AVAILABLE_IN_ALL
gboolean      gtk_icon_theme_rescan_if_needed      (GtkIconTheme                *self);


GDK_AVAILABLE_IN_ALL
GType                 gtk_icon_get_type           (void) G_GNUC_CONST;

GDK_AVAILABLE_IN_ALL
gint                  gtk_icon_get_base_size      (GtkIcon   *self);
GDK_AVAILABLE_IN_ALL
gint                  gtk_icon_get_base_scale     (GtkIcon   *self);
GDK_AVAILABLE_IN_ALL
const gchar *         gtk_icon_get_filename       (GtkIcon   *self);
GDK_AVAILABLE_IN_ALL
gboolean              gtk_icon_is_symbolic        (GtkIcon   *self);
GDK_AVAILABLE_IN_ALL
GdkTexture *          gtk_icon_download_texture   (GtkIcon   *self,
                                                   GError       **error);
GDK_AVAILABLE_IN_ALL
GdkTexture *         gtk_icon_download_colored_texture (GtkIcon *self,
                                                        const GdkRGBA *foreground_color,
                                                        const GdkRGBA *success_color,
                                                        const GdkRGBA *warning_color,
                                                        const GdkRGBA *error_color,
                                                        GError **error);
GDK_AVAILABLE_IN_ALL
void                  gtk_icon_snapshot_with_colors (GtkIcon      *icon,
                                                     GtkSnapshot  *snapshot,
                                                     double        width,
                                                     double        height,
                                                     const GdkRGBA *foreground_color,
                                                     const GdkRGBA *success_color,
                                                     const GdkRGBA *warning_color,
                                                     const GdkRGBA *error_color);

G_END_DECLS

#endif /* __GTK_ICON_THEME_H__ */