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 #ifndef __GTK_ICON_THEME_H__
  21 #define __GTK_ICON_THEME_H__
  22
  23 #include <glib-object.h>
  24 #include <gdk-pixbuf/gdk-pixbuf.h>
  25 #include <gdk/gdk.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GTK_TYPE_ICON_INFO              (gtk_icon_info_get_type ())
  30
  31 #define GTK_TYPE_ICON_THEME             (gtk_icon_theme_get_type ())
  32 #define GTK_ICON_THEME(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ICON_THEME, GtkIconTheme))
  33 #define GTK_ICON_THEME_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ICON_THEME, GtkIconThemeClass))
  34 #define GTK_IS_ICON_THEME(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ICON_THEME))
  35 #define GTK_IS_ICON_THEME_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ICON_THEME))
  36 #define GTK_ICON_THEME_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ICON_THEME, GtkIconThemeClass))
  37
  38 typedef struct _GtkIconInfo         GtkIconInfo;
  39 typedef struct _GtkIconTheme        GtkIconTheme;
  40 typedef struct _GtkIconThemeClass   GtkIconThemeClass;
  41 typedef struct _GtkIconThemePrivate GtkIconThemePrivate;
  42
  43 struct _GtkIconTheme
  44 {
  45   /*< private >*/
  46   GObject parent_instance;
  47
  48   GtkIconThemePrivate *priv;
  49 };
  50
  51 struct _GtkIconThemeClass
  52 {
  53   GObjectClass parent_class;
  54
  55   void (* changed)  (GtkIconTheme *icon_theme);
  56 };
  57
  58 /**
  59  * GtkIconLookupFlags:
  60  * @GTK_ICON_LOOKUP_NO_SVG: Never return SVG icons, even if gdk-pixbuf
  61  *   supports them. Cannot be used together with %GTK_ICON_LOOKUP_FORCE_SVG.
  62  * @GTK_ICON_LOOKUP_FORCE_SVG: Return SVG icons, even if gdk-pixbuf
  63  *   doesn't support them.
  64  *   Cannot be used together with %GTK_ICON_LOOKUP_NO_SVG.
  65  * @GTK_ICON_LOOKUP_USE_BUILTIN: When passed to
  66  *   gtk_icon_theme_lookup_icon() includes builtin icons
  67  *   as well as files. For a builtin icon, gtk_icon_info_get_filename()
  68  *   returns %NULL and you need to call gtk_icon_info_get_builtin_pixbuf().
  69  * @GTK_ICON_LOOKUP_GENERIC_FALLBACK: Try to shorten icon name at '-'
  70  *   characters before looking at inherited themes. For more general
  71  *   fallback, see gtk_icon_theme_choose_icon(). Since 2.12.
  72  *
  73  * Used to specify options for gtk_icon_theme_lookup_icon()
  74  **/
  75 typedef enum
  76 {
  77   GTK_ICON_LOOKUP_NO_SVG = 1 << 0,
  78   GTK_ICON_LOOKUP_FORCE_SVG = 1 << 1,
  79   GTK_ICON_LOOKUP_USE_BUILTIN = 1 << 2,
  80   GTK_ICON_LOOKUP_GENERIC_FALLBACK = 1 << 3
  81 } GtkIconLookupFlags;
  82
  83 #define GTK_ICON_THEME_ERROR gtk_icon_theme_error_quark ()
  84
  85 /**
  86  * GtkIconThemeError:
  87  * @GTK_ICON_THEME_NOT_FOUND: The icon specified does not exist in the theme
  88  * @GTK_ICON_THEME_FAILED: An unspecified error occurred.
  89  *
  90  * Error codes for GtkIconTheme operations.
  91  **/
  92 typedef enum {
  93   GTK_ICON_THEME_NOT_FOUND,
  94   GTK_ICON_THEME_FAILED
  95 } GtkIconThemeError;
  96
  97 GQuark gtk_icon_theme_error_quark (void);
  98
  99 #ifdef G_OS_WIN32
 100 /* Reserve old name for DLL ABI backward compatibility */
 101 #define gtk_icon_theme_set_search_path gtk_icon_theme_set_search_path_utf8
 102 #define gtk_icon_theme_get_search_path gtk_icon_theme_get_search_path_utf8
 103 #define gtk_icon_theme_append_search_path gtk_icon_theme_append_search_path_utf8
 104 #define gtk_icon_theme_prepend_search_path gtk_icon_theme_prepend_search_path_utf8
 105 #define gtk_icon_info_get_filename gtk_icon_info_get_filename_utf8
 106 #endif
 107
 108 GType         gtk_icon_theme_get_type              (void) G_GNUC_CONST;
 109
 110 GtkIconTheme *gtk_icon_theme_new                   (void);
 111 GtkIconTheme *gtk_icon_theme_get_default           (void);
 112 GtkIconTheme *gtk_icon_theme_get_for_screen        (GdkScreen                   *screen);
 113 void          gtk_icon_theme_set_screen            (GtkIconTheme                *icon_theme,
 114                                                     GdkScreen                   *screen);
 115
 116 void          gtk_icon_theme_set_search_path       (GtkIconTheme                *icon_theme,
 117                                                     const gchar                 *path[],
 118                                                     gint                         n_elements);
 119 void          gtk_icon_theme_get_search_path       (GtkIconTheme                *icon_theme,
 120                                                     gchar                      **path[],
 121                                                     gint                        *n_elements);
 122 void          gtk_icon_theme_append_search_path    (GtkIconTheme                *icon_theme,
 123                                                     const gchar                 *path);
 124 void          gtk_icon_theme_prepend_search_path   (GtkIconTheme                *icon_theme,
 125                                                     const gchar                 *path);
 126
 127 void          gtk_icon_theme_set_custom_theme      (GtkIconTheme                *icon_theme,
 128                                                     const gchar                 *theme_name);
 129
 130 gboolean      gtk_icon_theme_has_icon              (GtkIconTheme                *icon_theme,
 131                                                     const gchar                 *icon_name);
 132 gint         *gtk_icon_theme_get_icon_sizes        (GtkIconTheme                *icon_theme,
 133                                                     const gchar                 *icon_name);
 134 GtkIconInfo * gtk_icon_theme_lookup_icon           (GtkIconTheme                *icon_theme,
 135                                                     const gchar                 *icon_name,
 136                                                     gint                         size,
 137                                                     GtkIconLookupFlags           flags);
 138 GtkIconInfo * gtk_icon_theme_choose_icon           (GtkIconTheme                *icon_theme,
 139                                                     const gchar                 *icon_names[],
 140                                                     gint                         size,
 141                                                     GtkIconLookupFlags           flags);
 142 GdkPixbuf *   gtk_icon_theme_load_icon             (GtkIconTheme                *icon_theme,
 143                                                     const gchar                 *icon_name,
 144                                                     gint                         size,
 145                                                     GtkIconLookupFlags           flags,
 146                                                     GError                     **error);
 147
 148 GList *       gtk_icon_theme_list_icons            (GtkIconTheme                *icon_theme,
 149                                                     const gchar                 *context);
 150 GList *       gtk_icon_theme_list_contexts         (GtkIconTheme                *icon_theme);
 151 char *        gtk_icon_theme_get_example_icon_name (GtkIconTheme                *icon_theme);
 152
 153 gboolean      gtk_icon_theme_rescan_if_needed      (GtkIconTheme                *icon_theme);
 154
 155 void       gtk_icon_theme_add_builtin_icon  (const gchar *icon_name,
 156                                              gint         size,
 157                                              GdkPixbuf   *pixbuf);
 158
 159 GType         gtk_icon_info_get_type (void) G_GNUC_CONST;
 160 GtkIconInfo  *gtk_icon_info_copy     (GtkIconInfo *icon_info);
 161 void          gtk_icon_info_free     (GtkIconInfo *icon_info);
 162
 163 gint                  gtk_icon_info_get_base_size      (GtkIconInfo *icon_info);
 164 G_CONST_RETURN gchar *gtk_icon_info_get_filename       (GtkIconInfo *icon_info);
 165 GdkPixbuf    *        gtk_icon_info_get_builtin_pixbuf (GtkIconInfo *icon_info);
 166 GdkPixbuf    *        gtk_icon_info_load_icon          (GtkIconInfo *icon_info,
 167                                                         GError     **error);
 168
 169 void                  gtk_icon_info_set_raw_coordinates (GtkIconInfo *icon_info,
 170                                                          gboolean     raw_coordinates);
 171
 172 gboolean              gtk_icon_info_get_embedded_rect (GtkIconInfo   *icon_info,
 173                                                        GdkRectangle  *rectangle);
 174 gboolean              gtk_icon_info_get_attach_points (GtkIconInfo   *icon_info,
 175                                                        GdkPoint     **points,
 176                                                        gint          *n_points);
 177 G_CONST_RETURN gchar *gtk_icon_info_get_display_name  (GtkIconInfo   *icon_info);
 178
 179 /* Non-public methods */
 180 void _gtk_icon_theme_check_reload                     (GdkDisplay *display);
 181 void _gtk_icon_theme_ensure_builtin_cache             (void);
 182
 183 G_END_DECLS
 184
 185 #endif /* __GTK_ICON_THEME_H__ */