## EogPrintPreview

EogPrintPreview

## Synopsis

                        EogPrintPreview;
    GtkWidget *         eog_print_preview_new               (void);
    GtkWidget *         eog_print_preview_new_with_pixbuf   (GdkPixbuf *pixbuf);
    void                eog_print_preview_set_page_margins  (EogPrintPreview *preview,
                                                             gfloat l_margin,
                                                             gfloat r_margin,
                                                             gfloat t_margin,
                                                             gfloat b_margin);
    void                eog_print_preview_set_from_page_setup
                                                            (EogPrintPreview *preview,
                                                             GtkPageSetup *setup);
    void                eog_print_preview_get_image_position
                                                            (EogPrintPreview *preview,
                                                             gdouble *x,
                                                             gdouble *y);
    void                eog_print_preview_set_image_position
                                                            (EogPrintPreview *preview,
                                                             gdouble x,
                                                             gdouble y);
    void                eog_print_preview_set_scale         (EogPrintPreview *preview,
                                                             gfloat scale);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBin
                                     +----GtkFrame
                                           +----GtkAspectFrame
                                                 +----EogPrintPreview

## Implemented Interfaces

EogPrintPreview implements AtkImplementorIface and GtkBuildable.

## Properties

      "image"                    GObject*              : Read / Write
      "image-scale"              gfloat                : Read / Write
      "image-x-align"            gfloat                : Read / Write
      "image-y-align"            gfloat                : Read / Write
      "page-bottom-margin"       gfloat                : Read / Write
      "page-left-margin"         gfloat                : Read / Write
      "page-right-margin"        gfloat                : Read / Write
      "page-top-margin"          gfloat                : Read / Write
      "paper-height"             gfloat                : Read / Write
      "paper-width"              gfloat                : Read / Write

## Signals

      "image-moved"                                    : Run First

## Description

## Details

### EogPrintPreview

    typedef struct _EogPrintPreview EogPrintPreview;

### eog_print_preview_new ()

    GtkWidget *         eog_print_preview_new               (void);

Creates a new EogPrintPreview widget, setting it to the default values, and leaving the page empty. You still need to set the "image" property to make it useful.

Returns : | A new and empty EogPrintPreview widget.

### eog_print_preview_new_with_pixbuf ()

    GtkWidget *         eog_print_preview_new_with_pixbuf   (GdkPixbuf *pixbuf);

Creates a new EogPrintPreview widget, and sets the GdkPixbuf to preview on it.

`pixbuf` : | a GdkPixbuf
Returns : | A new EogPrintPreview widget.

### eog_print_preview_set_page_margins ()

    void                eog_print_preview_set_page_margins  (EogPrintPreview *preview,
                                                             gfloat l_margin,
                                                             gfloat r_margin,
                                                             gfloat t_margin,
                                                             gfloat b_margin);

Manually set the margins, in inches.

`preview` : | a EogPrintPreview
`l_margin` : | Left margin.
`r_margin` : | Right margin.
`t_margin` : | Top margin.
`b_margin` : | Bottom margin.

### eog_print_preview_set_from_page_setup ()

    void                eog_print_preview_set_from_page_setup
                                                            (EogPrintPreview *preview,
                                                             GtkPageSetup *setup);

Sets up the page properties from a GtkPageSetup. Useful when using the widget with the GtkPrint API.

`preview` : | a EogPrintPreview
`setup` : | a GtkPageSetup to set the properties from

### eog_print_preview_get_image_position ()

    void                eog_print_preview_get_image_position
                                                            (EogPrintPreview *preview,
                                                             gdouble *x,
                                                             gdouble *y);

Gets current image position in inches, relative to the margins. A (0, 0) position is the intersection between the left and top margins.

`preview` : | a EogPrintPreview
`x` : | a pointer to a gdouble, or `NULL` to ignore it
`y` : | a pointer to a gdouble, or `NULL` to ignore it

### eog_print_preview_set_image_position ()

    void                eog_print_preview_set_image_position
                                                            (EogPrintPreview *preview,
                                                             gdouble x,
                                                             gdouble y);

Sets the image position. You can pass -1 to one of the coordinates if you only want to set the other.

`preview` : | a EogPrintPreview
`x` : | The X coordinate, in inches, or -1 to ignore it.
`y` : | The Y coordinate, in inches, or -1 to ignore it.

### eog_print_preview_set_scale ()

    void                eog_print_preview_set_scale         (EogPrintPreview *preview,
                                                             gfloat scale);

Sets the scale for the image.

`preview` : | a EogPrintPreview
`scale` : | a scale value, between 0 and 1.

## Property Details

### The `"image"` property

      "image"                    GObject*              : Read / Write

The "image" property defines the image that is previewed in the widget.

### The `"image-scale"` property

      "image-scale"              gfloat                : Read / Write

The "image-scale" property defines the scaling of the image that the user wants for the printing.

Allowed values: [0,1]

Default value: 1

### The `"image-x-align"` property

      "image-x-align"            gfloat                : Read / Write

The "image-x-align" property defines the horizontal alignment of the image in the widget.

Allowed values: [0,1]

Default value: 0.5

### The `"image-y-align"` property

      "image-y-align"            gfloat                : Read / Write

The "image-y-align" property defines the horizontal alignment of the image in the widget.

Allowed values: [0,1]

Default value: 0.5

### The `"page-bottom-margin"` property

      "page-bottom-margin"       gfloat                : Read / Write

The size of the page's bottom margin, in inches.

Allowed values: [0,200]

Default value: 0.56

### The `"page-left-margin"` property

      "page-left-margin"         gfloat                : Read / Write

The size of the page's left margin, in inches.

Allowed values: [0,100]

Default value: 0.25

### The `"page-right-margin"` property

      "page-right-margin"        gfloat                : Read / Write

The size of the page's right margin, in inches.

Allowed values: [0,200]

Default value: 0.25

### The `"page-top-margin"` property

      "page-top-margin"          gfloat                : Read / Write

The size of the page's top margin, in inches.

Allowed values: [0,100]

Default value: 0.25

### The `"paper-height"` property

      "paper-height"             gfloat                : Read / Write

The height of the previewed paper, in inches.

Allowed values: [0,200]

Default value: 11

### The `"paper-width"` property

      "paper-width"              gfloat                : Read / Write

The width of the previewed paper, in inches.

Allowed values: [0,100]

Default value: 8.5

## Signal Details

### The `"image-moved"` signal

    void                user_function                      (EogPrintPreview *preview,
                                                            gpointer         user_data)      : Run First

The "image-moved" signal is emitted when the position of the image is changed.

`preview` : | the object which received the signal
`user_data` : | user data set when the signal handler was connected.