GooCanvasImageModel: GooCanvas Reference Manual

## GooCanvasImageModel GooCanvasImageModel — a model for image items. |

## Functions

GooCanvasItemModel * | goo_canvas_image_model_new ()

## Properties

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

## Types and Values

struct | GooCanvasImageModel

## Object Hierarchy

        GObject
        ╰── GooCanvasItemModelSimple
            ╰── GooCanvasImageModel

## Implemented Interfaces

GooCanvasImageModel implements GooCanvasItemModel.

## Description

GooCanvasImageModel represent a model for image items.

It is usually necessary to set the "scale-to-fit" property to `TRUE` to scale the image to fit the given rectangle. When using units other than `GTK_UNIT_PIXEL` it is also necessary to set the "width" and "height" properties to set the desired size.

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

It also implements the GooCanvasItemModel interface, so you can use the GooCanvasItemModel functions such as `goo_canvas_item_model_raise()` and `goo_canvas_item_model_rotate()`.

To create a GooCanvasImageModel use `goo_canvas_image_model_new()`.

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

To respond to events such as mouse clicks on the image you must connect to the signal handlers of the corresponding GooCanvasImage objects. (See `goo_canvas_get_item()` and “item-created”.)

## Functions

### goo_canvas_image_model_new ()

    GooCanvasItemModel *
    goo_canvas_image_model_new (GooCanvasItemModel *parent,
                                GdkPixbuf *pixbuf,
                                gdouble x,
                                gdouble y,
                                ...);

Creates a new image model.

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
    GooCanvasItemModel *image = goo_canvas_image_model_new (mygroup, pixbuf, 100.0, 100.0,
                                                            NULL);

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

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

#### Parameters

parent | the parent model, 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 model.

[transfer full]

## Types and Values

### struct GooCanvasImageModel

    struct GooCanvasImageModel;

The GooCanvasImageModel struct contains private data only.

## Property Details

### The `“alpha”` property

      “alpha”                    gdouble

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

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

### The `“height”` property

      “height”                   gdouble

The height of the image.

Flags: Read / Write

Allowed values: >= 0

Default value: 0

### The `“pattern”` property

      “pattern”                  GooCairoPattern *

The cairo pattern to paint.

Flags: Read / Write

### The `“pixbuf”` property

      “pixbuf”                   GdkPixbuf *

The GdkPixbuf to display.

Flags: Write

### The `“scale-to-fit”` property

      “scale-to-fit”             gboolean

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

Flags: Read / Write

Default value: FALSE

### The `“width”` property

      “width”                    gdouble

The width of the image.

Flags: Read / Write

Allowed values: >= 0

Default value: 0

### The `“x”` property

      “x”                        gdouble

The x coordinate of the image.

Flags: Read / Write

Default value: 0

### The `“y”` property

      “y”                        gdouble

The y coordinate of the image.

Flags: Read / Write

Default value: 0