]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkimage.h
fix local prototype of _gtk_file_chooser_label_for_file() (takes a GFile,
[~andy/gtk] / gtk / gtkimage.h
index 0c5da6db62622cd177da0cd210d8301d5f004042..c4dacfeefac69bf38aee85f032aea28304b68e68 100644 (file)
  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  * file for a list of people on the GTK+ Team.  See the ChangeLog
  * files for a list of changes.  These files are distributed with
- * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  */
 
+#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
 #ifndef __GTK_IMAGE_H__
 #define __GTK_IMAGE_H__
 
 
 #include <gdk/gdk.h>
+#include <gio/gio.h>
 #include <gtk/gtkmisc.h>
 
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
 
 #define GTK_TYPE_IMAGE                  (gtk_image_get_type ())
-#define GTK_IMAGE(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_IMAGE, GtkImage))
-#define GTK_IMAGE_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_IMAGE, GtkImageClass))
-#define GTK_IS_IMAGE(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_IMAGE))
-#define GTK_IS_IMAGE_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_IMAGE))
-#define GTK_IMAGE_GET_CLASS(obj)        (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_IMAGE, GtkImageClass))
+#define GTK_IMAGE(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_IMAGE, GtkImage))
+#define GTK_IMAGE_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_IMAGE, GtkImageClass))
+#define GTK_IS_IMAGE(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_IMAGE))
+#define GTK_IS_IMAGE_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_IMAGE))
+#define GTK_IMAGE_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_IMAGE, GtkImageClass))
 
 
 typedef struct _GtkImage       GtkImage;
@@ -52,17 +55,18 @@ typedef struct _GtkImageImageData   GtkImageImageData;
 typedef struct _GtkImagePixbufData  GtkImagePixbufData;
 typedef struct _GtkImageStockData   GtkImageStockData;
 typedef struct _GtkImageIconSetData GtkImageIconSetData;
+typedef struct _GtkImageAnimationData GtkImageAnimationData;
+typedef struct _GtkImageIconNameData  GtkImageIconNameData;
+typedef struct _GtkImageGIconData     GtkImageGIconData;
 
 struct _GtkImagePixmapData
 {
   GdkPixmap *pixmap;
-  GdkBitmap *mask;
 };
 
 struct _GtkImageImageData
 {
   GdkImage *image;
-  GdkBitmap *mask;
 };
 
 struct _GtkImagePixbufData
@@ -73,13 +77,32 @@ struct _GtkImagePixbufData
 struct _GtkImageStockData
 {
   gchar *stock_id;
-  gchar *size;
 };
 
 struct _GtkImageIconSetData
 {
   GtkIconSet *icon_set;
-  gchar      *size;
+};
+
+struct _GtkImageAnimationData
+{
+  GdkPixbufAnimation *anim;
+  GdkPixbufAnimationIter *iter;
+  guint frame_timeout;
+};
+
+struct _GtkImageIconNameData
+{
+  gchar *icon_name;
+  GdkPixbuf *pixbuf;
+  guint theme_change_id;
+};
+
+struct _GtkImageGIconData
+{
+  GIcon *icon;
+  GdkPixbuf *pixbuf;
+  guint theme_change_id;
 };
 
 typedef enum
@@ -89,7 +112,10 @@ typedef enum
   GTK_IMAGE_IMAGE,
   GTK_IMAGE_PIXBUF,
   GTK_IMAGE_STOCK,
-  GTK_IMAGE_ICON_SET
+  GTK_IMAGE_ICON_SET,
+  GTK_IMAGE_ANIMATION,
+  GTK_IMAGE_ICON_NAME,
+  GTK_IMAGE_GICON
 } GtkImageType;
 
 struct _GtkImage
@@ -105,43 +131,81 @@ struct _GtkImage
     GtkImagePixbufData pixbuf;
     GtkImageStockData stock;
     GtkImageIconSetData icon_set;
+    GtkImageAnimationData anim;
+    GtkImageIconNameData name;
+    GtkImageGIconData gicon;
   } data;
+
+  /* Only used with GTK_IMAGE_PIXMAP, GTK_IMAGE_IMAGE */
+  GdkBitmap *mask;
+
+  /* Only used with GTK_IMAGE_STOCK, GTK_IMAGE_ICON_SET, GTK_IMAGE_ICON_NAME */
+  GtkIconSize icon_size;
 };
 
 struct _GtkImageClass
 {
   GtkMiscClass parent_class;
+
+  /* Padding for future expansion */
+  void (*_gtk_reserved1) (void);
+  void (*_gtk_reserved2) (void);
+  void (*_gtk_reserved3) (void);
+  void (*_gtk_reserved4) (void);
 };
 
-GtkType    gtk_image_get_type (void) G_GNUC_CONST;
-
-GtkWidget* gtk_image_new_from_pixmap   (GdkPixmap       *pixmap,
-                                        GdkBitmap       *mask);
-GtkWidget* gtk_image_new_from_image    (GdkImage        *image,
-                                        GdkBitmap       *mask);
-GtkWidget* gtk_image_new_from_file     (const gchar     *filename);
-GtkWidget* gtk_image_new_from_pixbuf   (GdkPixbuf       *pixbuf);
-GtkWidget* gtk_image_new_from_stock    (const gchar     *stock_id,
-                                        const gchar     *size);
-GtkWidget* gtk_image_new_from_icon_set (GtkIconSet      *icon_set,
-                                        const gchar     *size);
-
-void gtk_image_set_from_pixmap   (GtkImage        *image,
-                                  GdkPixmap       *pixmap,
-                                  GdkBitmap       *mask);
-void gtk_image_set_from_image    (GtkImage        *image,
-                                  GdkImage        *gdk_image,
-                                  GdkBitmap       *mask);
-void gtk_image_set_from_file     (GtkImage        *image,
-                                  const gchar     *filename);
-void gtk_image_set_from_pixbuf   (GtkImage        *image,
-                                  GdkPixbuf       *pixbuf);
-void gtk_image_set_from_stock    (GtkImage        *image,
-                                  const gchar     *stock_id,
-                                  const gchar     *size);
-void gtk_image_set_from_icon_set (GtkImage        *image,
-                                  GtkIconSet      *icon_set,
-                                  const gchar     *size);
+#ifdef G_OS_WIN32
+/* Reserve old names for DLL ABI backward compatibility */
+#define gtk_image_new_from_file gtk_image_new_from_file_utf8
+#define gtk_image_set_from_file gtk_image_set_from_file_utf8
+#endif
+
+GType      gtk_image_get_type (void) G_GNUC_CONST;
+
+GtkWidget* gtk_image_new                (void);
+GtkWidget* gtk_image_new_from_pixmap    (GdkPixmap       *pixmap,
+                                         GdkBitmap       *mask);
+GtkWidget* gtk_image_new_from_image     (GdkImage        *image,
+                                         GdkBitmap       *mask);
+GtkWidget* gtk_image_new_from_file      (const gchar     *filename);
+GtkWidget* gtk_image_new_from_pixbuf    (GdkPixbuf       *pixbuf);
+GtkWidget* gtk_image_new_from_stock     (const gchar     *stock_id,
+                                         GtkIconSize      size);
+GtkWidget* gtk_image_new_from_icon_set  (GtkIconSet      *icon_set,
+                                         GtkIconSize      size);
+GtkWidget* gtk_image_new_from_animation (GdkPixbufAnimation *animation);
+GtkWidget* gtk_image_new_from_icon_name (const gchar     *icon_name,
+                                        GtkIconSize      size);
+GtkWidget* gtk_image_new_from_gicon     (GIcon           *icon,
+                                        GtkIconSize      size);
+
+void gtk_image_clear              (GtkImage        *image);
+void gtk_image_set_from_pixmap    (GtkImage        *image,
+                                   GdkPixmap       *pixmap,
+                                   GdkBitmap       *mask);
+void gtk_image_set_from_image     (GtkImage        *image,
+                                   GdkImage        *gdk_image,
+                                   GdkBitmap       *mask);
+void gtk_image_set_from_file      (GtkImage        *image,
+                                   const gchar     *filename);
+void gtk_image_set_from_pixbuf    (GtkImage        *image,
+                                   GdkPixbuf       *pixbuf);
+void gtk_image_set_from_stock     (GtkImage        *image,
+                                   const gchar     *stock_id,
+                                   GtkIconSize      size);
+void gtk_image_set_from_icon_set  (GtkImage        *image,
+                                   GtkIconSet      *icon_set,
+                                   GtkIconSize      size);
+void gtk_image_set_from_animation (GtkImage           *image,
+                                   GdkPixbufAnimation *animation);
+void gtk_image_set_from_icon_name (GtkImage        *image,
+                                  const gchar     *icon_name,
+                                  GtkIconSize      size);
+void gtk_image_set_from_gicon     (GtkImage        *image,
+                                  GIcon           *icon,
+                                  GtkIconSize      size);
+void gtk_image_set_pixel_size     (GtkImage        *image,
+                                  gint             pixel_size);
 
 GtkImageType gtk_image_get_storage_type (GtkImage   *image);
 
@@ -154,17 +218,22 @@ void       gtk_image_get_image    (GtkImage         *image,
 GdkPixbuf* gtk_image_get_pixbuf   (GtkImage         *image);
 void       gtk_image_get_stock    (GtkImage         *image,
                                    gchar           **stock_id,
-                                   gchar           **size);
+                                   GtkIconSize      *size);
 void       gtk_image_get_icon_set (GtkImage         *image,
                                    GtkIconSet      **icon_set,
-                                   gchar           **size);
-
+                                   GtkIconSize      *size);
+GdkPixbufAnimation* gtk_image_get_animation (GtkImage *image);
+void       gtk_image_get_icon_name (GtkImage              *image,
+                                   G_CONST_RETURN gchar **icon_name,
+                                   GtkIconSize           *size);
+void       gtk_image_get_gicon     (GtkImage              *image,
+                                   GIcon                **gicon,
+                                   GtkIconSize           *size);
+gint       gtk_image_get_pixel_size (GtkImage             *image);
 
 #ifndef GTK_DISABLE_DEPRECATED
 /* These three are deprecated */
 
-GtkWidget* gtk_image_new      (GdkImage   *val,
-                              GdkBitmap  *mask);
 void       gtk_image_set      (GtkImage   *image,
                               GdkImage   *val,
                               GdkBitmap  *mask);
@@ -173,9 +242,6 @@ void       gtk_image_get      (GtkImage   *image,
                               GdkBitmap **mask);
 #endif /* GTK_DISABLE_DEPRECATED */
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
-
+G_END_DECLS
 
 #endif /* __GTK_IMAGE_H__ */