GooCanvas Reference Manual: GooCanvasImage

## GooCanvasImage GooCanvasImage — an image item. |

## Synopsis

    struct              GooCanvasImage;
    GooCanvasItem *     goo_canvas_image_new                (GooCanvasItem *parent,
                                                             GdkPixbuf *pixbuf,
                                                             gdouble x,
                                                             gdouble y,
                                                             ...);

## Object Hierarchy

      GObject
       +----GooCanvasItemSimple
             +----GooCanvasImage

## Implemented Interfaces

GooCanvasImage implements GooCanvasItem.

## Properties

      "alpha"                    gdouble               : Read / Write
      "height"                   gdouble               : Read / Write
      "pattern"                  GooCairoPattern*      : Read / Write
      "pixbuf"                   GdkPixbuf*            : Write
      "scale-to-fit"             gboolean              : Read / Write
      "width"                    gdouble               : Read / Write
      "x"                        gdouble               : Read / Write
      "y"                        gdouble               : Read / Write

## Description

GooCanvasImage represents an image item.

### Note

It is usually necessary to set the "scale-to-fit" property to `TRUE` to scale the image to fit the given rectangle.

It is a subclass of GooCanvasItemSimple and so inherits all of the style properties such as "operator" and "pointer-events".

It also implements the GooCanvasItem interface, so you can use the GooCanvasItem functions such as `goo_canvas_item_raise()` and `goo_canvas_item_rotate()`.

To create a GooCanvasImage use `goo_canvas_image_new()`.

To get or set the properties of an existing GooCanvasImage, use `g_object_get()` and `g_object_set()`.

## Details

### struct GooCanvasImage

    struct GooCanvasImage;

The GooCanvasImage struct contains private data only.

### goo_canvas_image_new ()

    GooCanvasItem *     goo_canvas_image_new                (GooCanvasItem *parent,
                                                             GdkPixbuf *pixbuf,
                                                             gdouble x,
                                                             gdouble y,
                                                             ...);

Creates a new image item.

`parent` : | the parent item, or `NULL`. If a parent is specified, it will assume ownership of the item, and the item will automatically be freed when it is removed from the parent. Otherwise call `g_object_unref()` to free it. [skip]
`pixbuf` : | the GdkPixbuf containing the image data, or `NULL`. [allow-none]
`x` : | the x coordinate of the image.
`y` : | the y coordinate of the image.
`...` : | optional pairs of property names and values, and a terminating `NULL`.
Returns : | a new image item. [transfer full]

Here's an example showing how to create an image at (100.0, 100.0), using the given pixbuf at its natural width and height:

    1
    2
    GooCanvasItem *image = goo_canvas_image_new (mygroup, pixbuf, 100.0, 100.0,
                                                 NULL);

This example creates an image scaled to a size of 200x200:

    1
    2
    3
    4
    5
    GooCanvasItem *image = goo_canvas_image_new (mygroup, pixbuf, 100.0, 100.0,
                                                 "width", 200.0,
                                                 "height", 200.0,
                                                 "scale-to-fit", TRUE,
                                                 NULL);

## Property Details

### The `"alpha"` property

      "alpha"                    gdouble               : Read / Write

The opacity of the image, 0.0 is fully transparent, and 1.0 is opaque.

Allowed values: [0,1]

Default value: 1

### The `"height"` property

      "height"                   gdouble               : Read / Write

The height of the image.

Allowed values: >= 0

Default value: 0

### The `"pattern"` property

      "pattern"                  GooCairoPattern*      : Read / Write

The cairo pattern to paint.

### The `"pixbuf"` property

      "pixbuf"                   GdkPixbuf*            : Write

The GdkPixbuf to display.

### The `"scale-to-fit"` property

      "scale-to-fit"             gboolean              : Read / Write

If the image is scaled to fit the width and height settings.

Default value: FALSE

### The `"width"` property

      "width"                    gdouble               : Read / Write

The width of the image.

Allowed values: >= 0

Default value: 0

### The `"x"` property

      "x"                        gdouble               : Read / Write

The x coordinate of the image.

Default value: 0

### The `"y"` property

      "y"                        gdouble               : Read / Write

The y coordinate of the image.

Default value: 0