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

   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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  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/.
  25  */
  26
  27 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_ICON_FACTORY_H__
  32 #define __GTK_ICON_FACTORY_H__
  33
  34 #include <gdk/gdk.h>
  35 #include <gtk/gtkrc.h>
  36
  37 G_BEGIN_DECLS
  38
  39
  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 ())
  48
  49 typedef struct _GtkIconFactoryPrivate       GtkIconFactoryPrivate;
  50 typedef struct _GtkIconFactoryClass         GtkIconFactoryClass;
  51
  52 struct _GtkIconFactory
  53 {
  54   GObject parent_instance;
  55
  56   /* <private> */
  57   GtkIconFactoryPrivate *priv;
  58 };
  59
  60 struct _GtkIconFactoryClass
  61 {
  62   GObjectClass parent_class;
  63
  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);
  69 };
  70
  71 #ifdef G_OS_WIN32
  72 /* Reserve old names for DLL ABI backward compatibility */
  73 #define gtk_icon_source_set_filename gtk_icon_source_set_filename_utf8
  74 #define gtk_icon_source_get_filename gtk_icon_source_get_filename_utf8
  75 #endif
  76
  77 GType           gtk_icon_factory_get_type (void) G_GNUC_CONST;
  78 GtkIconFactory* gtk_icon_factory_new      (void);
  79 void            gtk_icon_factory_add      (GtkIconFactory *factory,
  80                                            const gchar    *stock_id,
  81                                            GtkIconSet     *icon_set);
  82 GtkIconSet*     gtk_icon_factory_lookup   (GtkIconFactory *factory,
  83                                            const gchar    *stock_id);
  84
  85 /* Manage the default icon factory stack */
  86
  87 void        gtk_icon_factory_add_default     (GtkIconFactory  *factory);
  88 void        gtk_icon_factory_remove_default  (GtkIconFactory  *factory);
  89 GtkIconSet* gtk_icon_factory_lookup_default  (const gchar     *stock_id);
  90
  91 /* Get preferred real size from registered semantic size.  Note that
  92  * themes SHOULD use this size, but they aren't required to; for size
  93  * requests and such, you should get the actual pixbuf from the icon
  94  * set and see what size was rendered.
  95  *
  96  * This function is intended for people who are scaling icons,
  97  * rather than for people who are displaying already-scaled icons.
  98  * That is, if you are displaying an icon, you should get the
  99  * size from the rendered pixbuf, not from here.
 100  */
 101
 102 #ifndef GDK_MULTIHEAD_SAFE
 103 gboolean gtk_icon_size_lookup              (GtkIconSize  size,
 104                                             gint        *width,
 105                                             gint        *height);
 106 #endif /* GDK_MULTIHEAD_SAFE */
 107 gboolean gtk_icon_size_lookup_for_settings (GtkSettings *settings,
 108                                             GtkIconSize  size,
 109                                             gint        *width,
 110                                             gint        *height);
 111
 112 GtkIconSize           gtk_icon_size_register       (const gchar *name,
 113                                                     gint         width,
 114                                                     gint         height);
 115 void                  gtk_icon_size_register_alias (const gchar *alias,
 116                                                     GtkIconSize  target);
 117 GtkIconSize           gtk_icon_size_from_name      (const gchar *name);
 118 G_CONST_RETURN gchar* gtk_icon_size_get_name       (GtkIconSize  size);
 119
 120 /* Icon sets */
 121
 122 GType       gtk_icon_set_get_type        (void) G_GNUC_CONST;
 123 GtkIconSet* gtk_icon_set_new             (void);
 124 GtkIconSet* gtk_icon_set_new_from_pixbuf (GdkPixbuf       *pixbuf);
 125
 126 GtkIconSet* gtk_icon_set_ref             (GtkIconSet      *icon_set);
 127 void        gtk_icon_set_unref           (GtkIconSet      *icon_set);
 128 GtkIconSet* gtk_icon_set_copy            (GtkIconSet      *icon_set);
 129
 130 /* Get one of the icon variants in the set, creating the variant if
 131  * necessary.
 132  */
 133 GdkPixbuf*  gtk_icon_set_render_icon     (GtkIconSet      *icon_set,
 134                                           GtkStyle        *style,
 135                                           GtkTextDirection direction,
 136                                           GtkStateType     state,
 137                                           GtkIconSize      size,
 138                                           GtkWidget       *widget,
 139                                           const char      *detail);
 140
 141
 142 void           gtk_icon_set_add_source   (GtkIconSet          *icon_set,
 143                                           const GtkIconSource *source);
 144
 145 void           gtk_icon_set_get_sizes    (GtkIconSet          *icon_set,
 146                                           GtkIconSize        **sizes,
 147                                           gint                *n_sizes);
 148
 149 GType          gtk_icon_source_get_type                 (void) G_GNUC_CONST;
 150 GtkIconSource* gtk_icon_source_new                      (void);
 151 GtkIconSource* gtk_icon_source_copy                     (const GtkIconSource *source);
 152 void           gtk_icon_source_free                     (GtkIconSource       *source);
 153
 154 void           gtk_icon_source_set_filename             (GtkIconSource       *source,
 155                                                          const gchar         *filename);
 156 void           gtk_icon_source_set_icon_name            (GtkIconSource       *source,
 157                                                          const gchar         *icon_name);
 158 void           gtk_icon_source_set_pixbuf               (GtkIconSource       *source,
 159                                                          GdkPixbuf           *pixbuf);
 160
 161 G_CONST_RETURN gchar* gtk_icon_source_get_filename  (const GtkIconSource *source);
 162 G_CONST_RETURN gchar* gtk_icon_source_get_icon_name (const GtkIconSource *source);
 163 GdkPixbuf*            gtk_icon_source_get_pixbuf    (const GtkIconSource *source);
 164
 165 void             gtk_icon_source_set_direction_wildcarded (GtkIconSource       *source,
 166                                                            gboolean             setting);
 167 void             gtk_icon_source_set_state_wildcarded     (GtkIconSource       *source,
 168                                                            gboolean             setting);
 169 void             gtk_icon_source_set_size_wildcarded      (GtkIconSource       *source,
 170                                                            gboolean             setting);
 171 gboolean         gtk_icon_source_get_size_wildcarded      (const GtkIconSource *source);
 172 gboolean         gtk_icon_source_get_state_wildcarded     (const GtkIconSource *source);
 173 gboolean         gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source);
 174 void             gtk_icon_source_set_direction            (GtkIconSource       *source,
 175                                                            GtkTextDirection     direction);
 176 void             gtk_icon_source_set_state                (GtkIconSource       *source,
 177                                                            GtkStateType         state);
 178 void             gtk_icon_source_set_size                 (GtkIconSource       *source,
 179                                                            GtkIconSize          size);
 180 GtkTextDirection gtk_icon_source_get_direction            (const GtkIconSource *source);
 181 GtkStateType     gtk_icon_source_get_state                (const GtkIconSource *source);
 182 GtkIconSize      gtk_icon_source_get_size                 (const GtkIconSource *source);
 183
 184
 185 /* ignore this */
 186 void _gtk_icon_set_invalidate_caches (void);
 187 GList* _gtk_icon_factory_list_ids (void);
 188 void _gtk_icon_factory_ensure_default_icons (void);
 189
 190 G_END_DECLS
 191
 192 #endif /* __GTK_ICON_FACTORY_H__ */