Pileus Git - ~andy/gtk/blob - gtk/gtkicontheme.h

   1 /* GtkIconTheme - a loader for icon themes
   2  * gtk-icon-loader.h Copyright (C) 2002, 2003 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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  21 #error "Only <gtk/gtk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __GTK_ICON_THEME_H__
  25 #define __GTK_ICON_THEME_H__
  26
  27 #include <gdk-pixbuf/gdk-pixbuf.h>
  28 #include <gdk/gdk.h>
  29 #include <gtk/gtkstyle.h>
  30 #include <gtk/gtkstylecontext.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define GTK_TYPE_ICON_INFO              (gtk_icon_info_get_type ())
  35
  36 #define GTK_TYPE_ICON_THEME             (gtk_icon_theme_get_type ())
  37 #define GTK_ICON_THEME(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ICON_THEME, GtkIconTheme))
  38 #define GTK_ICON_THEME_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ICON_THEME, GtkIconThemeClass))
  39 #define GTK_IS_ICON_THEME(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ICON_THEME))
  40 #define GTK_IS_ICON_THEME_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ICON_THEME))
  41 #define GTK_ICON_THEME_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ICON_THEME, GtkIconThemeClass))
  42
  43 typedef struct _GtkIconInfo         GtkIconInfo;
  44 typedef struct _GtkIconTheme        GtkIconTheme;
  45 typedef struct _GtkIconThemeClass   GtkIconThemeClass;
  46 typedef struct _GtkIconThemePrivate GtkIconThemePrivate;
  47
  48 struct _GtkIconTheme
  49 {
  50   /*< private >*/
  51   GObject parent_instance;
  52
  53   GtkIconThemePrivate *priv;
  54 };
  55
  56 struct _GtkIconThemeClass
  57 {
  58   GObjectClass parent_class;
  59
  60   void (* changed)  (GtkIconTheme *icon_theme);
  61 };
  62
  63 /**
  64  * GtkIconLookupFlags:
  65  * @GTK_ICON_LOOKUP_NO_SVG: Never return SVG icons, even if gdk-pixbuf
  66  *   supports them. Cannot be used together with %GTK_ICON_LOOKUP_FORCE_SVG.
  67  * @GTK_ICON_LOOKUP_FORCE_SVG: Return SVG icons, even if gdk-pixbuf
  68  *   doesn't support them.
  69  *   Cannot be used together with %GTK_ICON_LOOKUP_NO_SVG.
  70  * @GTK_ICON_LOOKUP_USE_BUILTIN: When passed to
  71  *   gtk_icon_theme_lookup_icon() includes builtin icons
  72  *   as well as files. For a builtin icon, gtk_icon_info_get_filename()
  73  *   returns %NULL and you need to call gtk_icon_info_get_builtin_pixbuf().
  74  * @GTK_ICON_LOOKUP_GENERIC_FALLBACK: Try to shorten icon name at '-'
  75  *   characters before looking at inherited themes. For more general
  76  *   fallback, see gtk_icon_theme_choose_icon(). Since 2.12.
  77  * @GTK_ICON_LOOKUP_FORCE_SIZE: Always return the icon scaled to the
  78  *   requested size. Since 2.14.
  79  *
  80  * Used to specify options for gtk_icon_theme_lookup_icon()
  81  **/
  82 typedef enum
  83 {
  84   GTK_ICON_LOOKUP_NO_SVG           = 1 << 0,
  85   GTK_ICON_LOOKUP_FORCE_SVG        = 1 << 1,
  86   GTK_ICON_LOOKUP_USE_BUILTIN      = 1 << 2,
  87   GTK_ICON_LOOKUP_GENERIC_FALLBACK = 1 << 3,
  88   GTK_ICON_LOOKUP_FORCE_SIZE       = 1 << 4
  89 } GtkIconLookupFlags;
  90
  91 #define GTK_ICON_THEME_ERROR gtk_icon_theme_error_quark ()
  92
  93 /**
  94  * GtkIconThemeError:
  95  * @GTK_ICON_THEME_NOT_FOUND: The icon specified does not exist in the theme
  96  * @GTK_ICON_THEME_FAILED: An unspecified error occurred.
  97  *
  98  * Error codes for GtkIconTheme operations.
  99  **/
 100 typedef enum {
 101   GTK_ICON_THEME_NOT_FOUND,
 102   GTK_ICON_THEME_FAILED
 103 } GtkIconThemeError;
 104
 105 GQuark gtk_icon_theme_error_quark (void);
 106
 107 GType         gtk_icon_theme_get_type              (void) G_GNUC_CONST;
 108
 109 GtkIconTheme *gtk_icon_theme_new                   (void);
 110 GtkIconTheme *gtk_icon_theme_get_default           (void);
 111 GtkIconTheme *gtk_icon_theme_get_for_screen        (GdkScreen                   *screen);
 112 void          gtk_icon_theme_set_screen            (GtkIconTheme                *icon_theme,
 113                                                     GdkScreen                   *screen);
 114
 115 void          gtk_icon_theme_set_search_path       (GtkIconTheme                *icon_theme,
 116                                                     const gchar                 *path[],
 117                                                     gint                         n_elements);
 118 void          gtk_icon_theme_get_search_path       (GtkIconTheme                *icon_theme,
 119                                                     gchar                      **path[],
 120                                                     gint                        *n_elements);
 121 void          gtk_icon_theme_append_search_path    (GtkIconTheme                *icon_theme,
 122                                                     const gchar                 *path);
 123 void          gtk_icon_theme_prepend_search_path   (GtkIconTheme                *icon_theme,
 124                                                     const gchar                 *path);
 125
 126 void          gtk_icon_theme_set_custom_theme      (GtkIconTheme                *icon_theme,
 127                                                     const gchar                 *theme_name);
 128
 129 gboolean      gtk_icon_theme_has_icon              (GtkIconTheme                *icon_theme,
 130                                                     const gchar                 *icon_name);
 131 gint         *gtk_icon_theme_get_icon_sizes        (GtkIconTheme                *icon_theme,
 132                                                     const gchar                 *icon_name);
 133 GtkIconInfo * gtk_icon_theme_lookup_icon           (GtkIconTheme                *icon_theme,
 134                                                     const gchar                 *icon_name,
 135                                                     gint                         size,
 136                                                     GtkIconLookupFlags           flags);
 137 GtkIconInfo * gtk_icon_theme_choose_icon           (GtkIconTheme                *icon_theme,
 138                                                     const gchar                 *icon_names[],
 139                                                     gint                         size,
 140                                                     GtkIconLookupFlags           flags);
 141 GdkPixbuf *   gtk_icon_theme_load_icon             (GtkIconTheme                *icon_theme,
 142                                                     const gchar                 *icon_name,
 143                                                     gint                         size,
 144                                                     GtkIconLookupFlags           flags,
 145                                                     GError                     **error);
 146
 147 GtkIconInfo * gtk_icon_theme_lookup_by_gicon       (GtkIconTheme                *icon_theme,
 148                                                     GIcon                       *icon,
 149                                                     gint                         size,
 150                                                     GtkIconLookupFlags           flags);
 151
 152 GList *       gtk_icon_theme_list_icons            (GtkIconTheme                *icon_theme,
 153                                                     const gchar                 *context);
 154 GList *       gtk_icon_theme_list_contexts         (GtkIconTheme                *icon_theme);
 155 char *        gtk_icon_theme_get_example_icon_name (GtkIconTheme                *icon_theme);
 156
 157 gboolean      gtk_icon_theme_rescan_if_needed      (GtkIconTheme                *icon_theme);
 158
 159 void          gtk_icon_theme_add_builtin_icon      (const gchar *icon_name,
 160                                                     gint         size,
 161                                                     GdkPixbuf   *pixbuf);
 162
 163 GType                 gtk_icon_info_get_type           (void) G_GNUC_CONST;
 164 GtkIconInfo *         gtk_icon_info_copy               (GtkIconInfo  *icon_info);
 165 void                  gtk_icon_info_free               (GtkIconInfo  *icon_info);
 166
 167 GtkIconInfo *         gtk_icon_info_new_for_pixbuf     (GtkIconTheme  *icon_theme,
 168                                                         GdkPixbuf     *pixbuf);
 169
 170 gint                  gtk_icon_info_get_base_size      (GtkIconInfo   *icon_info);
 171 G_CONST_RETURN gchar *gtk_icon_info_get_filename       (GtkIconInfo   *icon_info);
 172 GdkPixbuf *           gtk_icon_info_get_builtin_pixbuf (GtkIconInfo   *icon_info);
 173 GdkPixbuf *           gtk_icon_info_load_icon          (GtkIconInfo   *icon_info,
 174                                                         GError       **error);
 175 GdkPixbuf *           gtk_icon_info_load_symbolic      (GtkIconInfo   *icon_info,
 176                                                         GdkRGBA       *fg,
 177                                                         GdkRGBA       *success_color,
 178                                                         GdkRGBA       *warning_color,
 179                                                         GdkRGBA       *error_color,
 180                                                         gboolean      *was_symbolic,
 181                                                         GError       **error);
 182 GdkPixbuf *           gtk_icon_info_load_symbolic_for_context (GtkIconInfo      *icon_info,
 183                                                                GtkStyleContext  *context,
 184                                                                gboolean         *was_symbolic,
 185                                                                GError          **error);
 186 GdkPixbuf *           gtk_icon_info_load_symbolic_for_style  (GtkIconInfo   *icon_info,
 187                                                               GtkStyle      *style,
 188                                                               GtkStateType   state,
 189                                                               gboolean      *was_symbolic,
 190                                                               GError       **error);
 191 void                  gtk_icon_info_set_raw_coordinates (GtkIconInfo  *icon_info,
 192                                                          gboolean      raw_coordinates);
 193
 194 gboolean              gtk_icon_info_get_embedded_rect (GtkIconInfo    *icon_info,
 195                                                        GdkRectangle   *rectangle);
 196 gboolean              gtk_icon_info_get_attach_points (GtkIconInfo    *icon_info,
 197                                                        GdkPoint      **points,
 198                                                        gint           *n_points);
 199 G_CONST_RETURN gchar *gtk_icon_info_get_display_name  (GtkIconInfo    *icon_info);
 200
 201 /* Non-public methods */
 202 void _gtk_icon_theme_check_reload                     (GdkDisplay *display);
 203 void _gtk_icon_theme_ensure_builtin_cache             (void);
 204
 205 G_END_DECLS
 206
 207 #endif /* __GTK_ICON_THEME_H__ */