[Contents] [Back] [Prev] [Up] [Next] [Forward]

# Package Gtk.Image

The Gtk_Image widget displays a graphical image. The image is typically created using Gdk.Image.Gdk_New.

The pixels in a Gtk_Image may be manipulated by the application after creation, as Gtk_Image store the pixel data on the client side. If you wish to store the pixel data on the server side (thus not allowing manipulation of the data after creation) you should use Gtk_Pixmap.

- Gtk.Image Widget Hierarchy
- Gtk.Image Types
- Gtk.Image Subprograms

## Widget Hierarchy

    GObject                       (see section Package Glib.Object)
    Gtk_Object                    (see section Package Gtk.Object)
       \___ Gtk_Widget            (see section Package Gtk.Widget)
          \___ Gtk_Misc           (see section Package Gtk.Misc)
             \___ Gtk_Image       (see section Package Gtk.Image)

## Types

    type Gtk_Image_Type is
        (Image_Empty,
         Image_Pixmap,
         Image_Image,
         Image_Pixbuf,
         Image_Stock,
         Image_Icon_Set,
         Image_Animation);

## Subprograms

    procedure Gtk_New
      (Image              : out    Gtk_Image;
       Val                :        Gdk.Image.Gdk_Image;
       Mask               :        Gdk.Bitmap.Gdk_Bitmap);

    procedure Gtk_New
      (Image              : out    Gtk_Image;
       Pixmap             :        Gdk.Pixmap.Gdk_Pixmap;
       Mask               :        Gdk.Bitmap.Gdk_Bitmap);

    procedure Gtk_New
      (Image              : out    Gtk_Image;
       Filename           :        String);

    procedure Gtk_New
      (Image              : out    Gtk_Image;
       Pixbuf             :        Gdk.Pixbuf.Gdk_Pixbuf);

    procedure Gtk_New
      (Image              : out    Gtk_Image;
       Stock_Id           :        String;
       Size               :        Gtk.Enums.Gtk_Icon_Size);

    procedure Gtk_New
      (Image              : out    Gtk_Image;
       Icon_Set           :        Gtk.Icon_Factory.Gtk_Icon_Set;
       Size               :        Gtk.Enums.Gtk_Icon_Size);

    procedure Gtk_New
      (Image              : out    Gtk_Image;
       Animation          :        Gdk.Pixbuf.Gdk_Pixbuf_Animation);

| Create a GtkImage displaying the given animation.

    function Get_Type              return Glib.GType;

| Return the internal value associated with a Gtk_Image.

    procedure Set
      (Image              : access Gtk_Image_Record;
       Pixmap             :        Gdk.Pixmap.Gdk_Pixmap;
       Mask               :        Gdk.Bitmap.Gdk_Bitmap);

| Set the value of a Gtk_Image. Mask indicates which parts of the image should be transparent.

    procedure Set
      (Image              : access Gtk_Image_Record;
       Val                :        Gdk.Image.Gdk_Image;
       Mask               :        Gdk.Bitmap.Gdk_Bitmap);

| Set the value of a Gtk_Image. Mask indicates which parts of the image should be transparent.

    procedure Set
      (Image              : access Gtk_Image_Record;
       File               :        String);

    procedure Set
      (Image              : access Gtk_Image_Record;
       Pixbuf             :        Gdk.Pixbuf.Gdk_Pixbuf);

    procedure Set
      (Image              : access Gtk_Image_Record;
       Stock_Id           :        String;
       Size               :        Gtk.Enums.Gtk_Icon_Size);

    procedure Set
      (Image              : access Gtk_Image_Record;
       Icon_Set           :        Gtk.Icon_Factory.Gtk_Icon_Set;
       Size               :        Gtk.Enums.Gtk_Icon_Size);

    procedure Set
      (Image              : access Gtk_Image_Record;
       Animation          :        Gdk.Pixbuf.Gdk_Pixbuf_Animation);

| Cause the Image to display the given Animation.

    function Get_Storage_Type
      (Image              : access Gtk_Image_Record)
       return Gtk_Image_Type;

    procedure Get
      (Image              : access Gtk_Image_Record;
       Pixmap             : out    Gdk.Pixmap.Gdk_Pixmap;
       Mask               : out    Gdk.Bitmap.Gdk_Bitmap);

| Get the values of a Gtk_Image. Mask indicates which parts of the image should be transparent.

    procedure Get
      (Image              : access Gtk_Image_Record;
       Val                : out    Gdk.Image.Gdk_Image;
       Mask               : out    Gdk.Bitmap.Gdk_Bitmap);

| Get the values of a Gtk_Image. Mask indicates which parts of the image should be transparent.

    function Get
      (Image              : access Gtk_Image_Record)
       return Gdk.Pixbuf.Gdk_Pixbuf;

    function Get
      (Image              : access Gtk_Image_Record;
       Size               : access Gtk.Enums.Gtk_Icon_Size)
       return String;

    procedure Get
      (Image              : access Gtk_Image_Record;
       Icon_Set           : out    Gtk.Icon_Factory.Gtk_Icon_Set;
       Size               : out    Gtk.Enums.Gtk_Icon_Size);

    function Get
      (Image              : access Gtk_Image_Record)
       return Gdk.Pixbuf.Gdk_Pixbuf_Animation;

| Get the Pixbuf Animation being displayed by the given Image. The reference counter for the returned animation is not incremented. This must be done separately if needed.

[Contents] [Back] [Prev] [Up] [Next] [Forward]