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

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   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_IMAGE_H__
  32 #define __GTK_IMAGE_H__
  33
  34
  35 #include <gio/gio.h>
  36 #include <gtk/gtkmisc.h>
  37
  38
  39 G_BEGIN_DECLS
  40
  41 #define GTK_TYPE_IMAGE                  (gtk_image_get_type ())
  42 #define GTK_IMAGE(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_IMAGE, GtkImage))
  43 #define GTK_IMAGE_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_IMAGE, GtkImageClass))
  44 #define GTK_IS_IMAGE(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_IMAGE))
  45 #define GTK_IS_IMAGE_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_IMAGE))
  46 #define GTK_IMAGE_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_IMAGE, GtkImageClass))
  47
  48
  49 typedef struct _GtkImage       GtkImage;
  50 typedef struct _GtkImageClass  GtkImageClass;
  51
  52 typedef struct _GtkImagePixmapData  GtkImagePixmapData;
  53 typedef struct _GtkImageImageData   GtkImageImageData;
  54 typedef struct _GtkImagePixbufData  GtkImagePixbufData;
  55 typedef struct _GtkImageStockData   GtkImageStockData;
  56 typedef struct _GtkImageIconSetData GtkImageIconSetData;
  57 typedef struct _GtkImageAnimationData GtkImageAnimationData;
  58 typedef struct _GtkImageIconNameData  GtkImageIconNameData;
  59 typedef struct _GtkImageGIconData     GtkImageGIconData;
  60
  61 struct _GtkImagePixmapData
  62 {
  63   GdkPixmap *pixmap;
  64 };
  65
  66 struct _GtkImageImageData
  67 {
  68   GdkImage *image;
  69 };
  70
  71 struct _GtkImagePixbufData
  72 {
  73   GdkPixbuf *pixbuf;
  74 };
  75
  76 struct _GtkImageStockData
  77 {
  78   gchar *stock_id;
  79 };
  80
  81 struct _GtkImageIconSetData
  82 {
  83   GtkIconSet *icon_set;
  84 };
  85
  86 struct _GtkImageAnimationData
  87 {
  88   GdkPixbufAnimation *anim;
  89   GdkPixbufAnimationIter *iter;
  90   guint frame_timeout;
  91 };
  92
  93 struct _GtkImageIconNameData
  94 {
  95   gchar *icon_name;
  96   GdkPixbuf *pixbuf;
  97   guint theme_change_id;
  98 };
  99
 100 struct _GtkImageGIconData
 101 {
 102   GIcon *icon;
 103   GdkPixbuf *pixbuf;
 104   guint theme_change_id;
 105 };
 106
 107 /**
 108  * GtkImageType:
 109  * @GTK_IMAGE_EMPTY: there is no image displayed by the widget
 110  * @GTK_IMAGE_PIXMAP: the widget contains a #GdkPixmap
 111  * @GTK_IMAGE_IMAGE: the widget contains a #GdkImage
 112  * @GTK_IMAGE_PIXBUF: the widget contains a #GdkPixbuf
 113  * @GTK_IMAGE_STOCK: the widget contains a stock icon name (see
 114  *  <xref linkend="gtk3-Stock-Items"/>)
 115  * @GTK_IMAGE_ICON_SET: the widget contains a #GtkIconSet
 116  * @GTK_IMAGE_ANIMATION: the widget contains a #GdkPixbufAnimation
 117  * @GTK_IMAGE_ICON_NAME: the widget contains a named icon.
 118  *  This image type was added in GTK+ 2.6
 119  * @GTK_IMAGE_GICON: the widget contains a #GIcon.
 120  *  This image type was added in GTK+ 2.14
 121  *
 122  * Describes the image data representation used by a #GtkImage. If you
 123  * want to get the image from the widget, you can only get the
 124  * currently-stored representation. e.g.  if the
 125  * gtk_image_get_storage_type() returns #GTK_IMAGE_PIXBUF, then you can
 126  * call gtk_image_get_pixbuf() but not gtk_image_get_stock().  For empty
 127  * images, you can request any storage type (call any of the "get"
 128  * functions), but they will all return %NULL values.
 129  */
 130 typedef enum
 131 {
 132   GTK_IMAGE_EMPTY,
 133   GTK_IMAGE_PIXMAP,
 134   GTK_IMAGE_IMAGE,
 135   GTK_IMAGE_PIXBUF,
 136   GTK_IMAGE_STOCK,
 137   GTK_IMAGE_ICON_SET,
 138   GTK_IMAGE_ANIMATION,
 139   GTK_IMAGE_ICON_NAME,
 140   GTK_IMAGE_GICON
 141 } GtkImageType;
 142
 143 /**
 144  * GtkImage:
 145  *
 146  * This struct contain private data only and should be accessed by the functions
 147  * below.
 148  */
 149 struct _GtkImage
 150 {
 151   GtkMisc misc;
 152
 153   GtkImageType GSEAL (storage_type);
 154
 155   union
 156   {
 157     GtkImagePixmapData pixmap;
 158     GtkImageImageData image;
 159     GtkImagePixbufData pixbuf;
 160     GtkImageStockData stock;
 161     GtkImageIconSetData icon_set;
 162     GtkImageAnimationData anim;
 163     GtkImageIconNameData name;
 164     GtkImageGIconData gicon;
 165   } GSEAL (data);
 166
 167   /* Only used with GTK_IMAGE_PIXMAP, GTK_IMAGE_IMAGE */
 168   GdkBitmap *GSEAL (mask);
 169
 170   /* Only used with GTK_IMAGE_STOCK, GTK_IMAGE_ICON_SET, GTK_IMAGE_ICON_NAME */
 171   GtkIconSize GSEAL (icon_size);
 172 };
 173
 174 struct _GtkImageClass
 175 {
 176   GtkMiscClass parent_class;
 177
 178   /* Padding for future expansion */
 179   void (*_gtk_reserved1) (void);
 180   void (*_gtk_reserved2) (void);
 181   void (*_gtk_reserved3) (void);
 182   void (*_gtk_reserved4) (void);
 183 };
 184
 185 #ifdef G_OS_WIN32
 186 /* Reserve old names for DLL ABI backward compatibility */
 187 #define gtk_image_new_from_file gtk_image_new_from_file_utf8
 188 #define gtk_image_set_from_file gtk_image_set_from_file_utf8
 189 #endif
 190
 191 GType      gtk_image_get_type (void) G_GNUC_CONST;
 192
 193 GtkWidget* gtk_image_new                (void);
 194 GtkWidget* gtk_image_new_from_pixmap    (GdkPixmap       *pixmap,
 195                                          GdkBitmap       *mask);
 196 GtkWidget* gtk_image_new_from_image     (GdkImage        *image,
 197                                          GdkBitmap       *mask);
 198 GtkWidget* gtk_image_new_from_file      (const gchar     *filename);
 199 GtkWidget* gtk_image_new_from_pixbuf    (GdkPixbuf       *pixbuf);
 200 GtkWidget* gtk_image_new_from_stock     (const gchar     *stock_id,
 201                                          GtkIconSize      size);
 202 GtkWidget* gtk_image_new_from_icon_set  (GtkIconSet      *icon_set,
 203                                          GtkIconSize      size);
 204 GtkWidget* gtk_image_new_from_animation (GdkPixbufAnimation *animation);
 205 GtkWidget* gtk_image_new_from_icon_name (const gchar     *icon_name,
 206                                          GtkIconSize      size);
 207 GtkWidget* gtk_image_new_from_gicon     (GIcon           *icon,
 208                                          GtkIconSize      size);
 209
 210 void gtk_image_clear              (GtkImage        *image);
 211 void gtk_image_set_from_pixmap    (GtkImage        *image,
 212                                    GdkPixmap       *pixmap,
 213                                    GdkBitmap       *mask);
 214 void gtk_image_set_from_image     (GtkImage        *image,
 215                                    GdkImage        *gdk_image,
 216                                    GdkBitmap       *mask);
 217 void gtk_image_set_from_file      (GtkImage        *image,
 218                                    const gchar     *filename);
 219 void gtk_image_set_from_pixbuf    (GtkImage        *image,
 220                                    GdkPixbuf       *pixbuf);
 221 void gtk_image_set_from_stock     (GtkImage        *image,
 222                                    const gchar     *stock_id,
 223                                    GtkIconSize      size);
 224 void gtk_image_set_from_icon_set  (GtkImage        *image,
 225                                    GtkIconSet      *icon_set,
 226                                    GtkIconSize      size);
 227 void gtk_image_set_from_animation (GtkImage           *image,
 228                                    GdkPixbufAnimation *animation);
 229 void gtk_image_set_from_icon_name (GtkImage        *image,
 230                                    const gchar     *icon_name,
 231                                    GtkIconSize      size);
 232 void gtk_image_set_from_gicon     (GtkImage        *image,
 233                                    GIcon           *icon,
 234                                    GtkIconSize      size);
 235 void gtk_image_set_pixel_size     (GtkImage        *image,
 236                                    gint             pixel_size);
 237
 238 GtkImageType gtk_image_get_storage_type (GtkImage   *image);
 239
 240 void       gtk_image_get_pixmap   (GtkImage         *image,
 241                                    GdkPixmap       **pixmap,
 242                                    GdkBitmap       **mask);
 243 void       gtk_image_get_image    (GtkImage         *image,
 244                                    GdkImage        **gdk_image,
 245                                    GdkBitmap       **mask);
 246 GdkPixbuf* gtk_image_get_pixbuf   (GtkImage         *image);
 247 void       gtk_image_get_stock    (GtkImage         *image,
 248                                    gchar           **stock_id,
 249                                    GtkIconSize      *size);
 250 void       gtk_image_get_icon_set (GtkImage         *image,
 251                                    GtkIconSet      **icon_set,
 252                                    GtkIconSize      *size);
 253 GdkPixbufAnimation* gtk_image_get_animation (GtkImage *image);
 254 void       gtk_image_get_icon_name (GtkImage              *image,
 255                                     G_CONST_RETURN gchar **icon_name,
 256                                     GtkIconSize           *size);
 257 void       gtk_image_get_gicon     (GtkImage              *image,
 258                                     GIcon                **gicon,
 259                                     GtkIconSize           *size);
 260 gint       gtk_image_get_pixel_size (GtkImage             *image);
 261
 262 G_END_DECLS
 263
 264 #endif /* __GTK_IMAGE_H__ */