GimpZoomPreview: GIMP Library Reference Manual

## GimpZoomPreview GimpZoomPreview — A drawable preview with zooming capabilities. |

## Functions

GtkWidget * | gimp_zoom_preview_new ()
GtkWidget * | gimp_zoom_preview_new_from_drawable_id ()
GtkWidget * | gimp_zoom_preview_new_with_model_from_drawable_id ()
GtkWidget * | gimp_zoom_preview_new_with_model ()
guchar * | gimp_zoom_preview_get_source ()
GimpDrawable * | gimp_zoom_preview_get_drawable ()
gint32 | gimp_zoom_preview_get_drawable_id ()
gdouble | gimp_zoom_preview_get_factor ()
GimpZoomModel * | gimp_zoom_preview_get_model ()

## Properties

gpointer | drawable | Read / Write / Construct Only
int | drawable-id | Read / Write / Construct Only
GimpZoomModel * | model | Read / Write / Construct Only

## Types and Values

| GimpZoomPreview

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkObject
                ╰── GtkWidget
                    ╰── GtkContainer
                        ╰── GtkBox
                            ╰── GimpPreview
                                ╰── GimpScrolledPreview
                                    ╰── GimpZoomPreview

## Implemented Interfaces

GimpZoomPreview implements AtkImplementorIface, GtkBuildable and GtkOrientable.

## Description

A drawable preview with zooming capabilities.

## Functions

### gimp_zoom_preview_new ()

    GtkWidget *
    gimp_zoom_preview_new (GimpDrawable *drawable);

`gimp_zoom_preview_new` has been deprecated since version 2.10 and should not be used in newly-written code.

Use `gimp_zoom_preview_new_from_drawable_id()` instead.

Creates a new GimpZoomPreview widget for `drawable` .

#### Parameters

drawable | a GimpDrawable |

#### Returns

a new GimpZoomPreview.

Since: 2.4

### gimp_zoom_preview_new_from_drawable_id ()

    GtkWidget *
    gimp_zoom_preview_new_from_drawable_id
                                   (gint32 drawable_ID);

Creates a new GimpZoomPreview widget for `drawable_ID` .

#### Parameters

drawable_ID | a drawable ID |

#### Returns

a new GimpZoomPreview.

Since: 2.10

### gimp_zoom_preview_new_with_model_from_drawable_id ()

    GtkWidget *
    gimp_zoom_preview_new_with_model_from_drawable_id
                                   (gint32 drawable_ID,
                                    GimpZoomModel *model);

Creates a new GimpZoomPreview widget for `drawable_ID` using the given `model` .

This variant of `gimp_zoom_preview_new_from_drawable_id()` allows you to create a preview using an existing zoom model. This may be useful if for example you want to have two zoom previews that keep their zoom factor in sync.

#### Parameters

drawable_ID | a drawable ID |
model | a GimpZoomModel |

#### Returns

a new GimpZoomPreview.

Since: 2.10

### gimp_zoom_preview_new_with_model ()

    GtkWidget *
    gimp_zoom_preview_new_with_model (GimpDrawable *drawable,
                                      GimpZoomModel *model);

`gimp_zoom_preview_new_with_model` has been deprecated since version 2.10 and should not be used in newly-written code.

Use `gimp_zoom_preview_new_with_model_from_drawable_id()` instead.

Creates a new GimpZoomPreview widget for `drawable` using the given `model` .

This variant of `gimp_zoom_preview_new()` allows you to create a preview using an existing zoom model. This may be useful if for example you want to have two zoom previews that keep their zoom factor in sync.

#### Parameters

drawable | a GimpDrawable |
model | a GimpZoomModel |

#### Returns

a new GimpZoomPreview.

Since: 2.4

### gimp_zoom_preview_get_source ()

    guchar *
    gimp_zoom_preview_get_source (GimpZoomPreview *preview,
                                  gint *width,
                                  gint *height,
                                  gint *bpp);

Returns the scaled image data of the part of the drawable the GimpZoomPreview is currently showing, as a newly allocated array of guchar. This function also allow to get the current width, height and bpp of the GimpZoomPreview.

#### Parameters

preview | a GimpZoomPreview widget |
width | a pointer to an int where the current width of the zoom widget will be put. |
height | a pointer to an int where the current width of the zoom widget will be put. |
bpp | return location for the number of bytes per pixel |

#### Returns

newly allocated data that should be released using `g_free()` when it is not any longer needed

Since: 2.4

### gimp_zoom_preview_get_drawable ()

    GimpDrawable *
    gimp_zoom_preview_get_drawable (GimpZoomPreview *preview);

`gimp_zoom_preview_get_drawable` has been deprecated since version 2.10 and should not be used in newly-written code.

Use `gimp_zoom_preview_get_drawable_id()` instead.

Returns the GimpDrawable the GimpZoomPreview is attached to.

#### Parameters

preview | a GimpZoomPreview widget |

#### Returns

the GimpDrawable that was passed to `gimp_zoom_preview_new()`.

Since: 2.4

### gimp_zoom_preview_get_drawable_id ()

    gint32
    gimp_zoom_preview_get_drawable_id (GimpZoomPreview *preview);

Returns the drawable_ID the GimpZoomPreview is attached to.

#### Parameters

preview | a GimpZoomPreview widget |

#### Returns

the drawable_ID that was passed to `gimp_zoom_preview_new_from_drawable_id()`.

Since: 2.10

### gimp_zoom_preview_get_factor ()

    gdouble
    gimp_zoom_preview_get_factor (GimpZoomPreview *preview);

Returns the zoom factor the preview is currently using.

#### Parameters

preview | a GimpZoomPreview widget |

#### Returns

the current zoom factor

Since: 2.4

### gimp_zoom_preview_get_model ()

    GimpZoomModel *
    gimp_zoom_preview_get_model (GimpZoomPreview *preview);

Returns the GimpZoomModel the preview is using.

#### Parameters

preview | a GimpZoomPreview widget |

#### Returns

a pointer to the GimpZoomModel owned by the `preview`

Since: 2.4

## Types and Values

### GimpZoomPreview

    typedef struct _GimpZoomPreview GimpZoomPreview;

## Property Details

### The `“drawable”` property

      “drawable”                 gpointer

The drawable the GimpZoomPreview is attached to.

`GimpZoomPreview:drawable` is deprecated and should not be used in newly-written code.

use the drawable-id property instead.

Owner: GimpZoomPreview

Flags: Read / Write / Construct Only

Since: 2.4

### The `“drawable-id”` property

      “drawable-id”              int

The drawable the GimpZoomPreview is attached to.

Owner: GimpZoomPreview

Flags: Read / Write / Construct Only

Allowed values: >= -1

Default value: -1

Since: 2.10

### The `“model”` property

      “model”                    GimpZoomModel *

The GimpZoomModel used by this GimpZoomPreview.

Owner: GimpZoomPreview

Flags: Read / Write / Construct Only

Since: 2.4