## FoAreaPage

FoAreaPage —

## Synopsis

                FoAreaPage;
                FoAreaPageClass;
    #define     FO_AREA_PAGE_ERROR
    GQuark      fo_area_page_error_quark        (void);
    enum        FoAreaPageError;
    FoArea*     fo_area_page_new                (void);
    void        fo_area_page_set_page_number    (FoArea *fo_area_page,
                                                 gint new_page_number);
    gint        fo_area_page_get_page_number    (FoArea *fo_area_page);
    void        fo_area_page_set_page_width     (FoArea *fo_area_page,
                                                 gfloat new_page_width);
    gfloat      fo_area_page_get_page_width     (FoArea *fo_area_page);
    void        fo_area_page_set_page_height    (FoArea *fo_area_page,
                                                 gfloat new_page_height);
    gfloat      fo_area_page_get_page_height    (FoArea *fo_area_page);
    void        fo_area_page_set_margin_top     (FoArea *fo_area_page,
                                                 gfloat new_margin_top);
    gfloat      fo_area_page_get_margin_top     (FoArea *fo_area_page);
    void        fo_area_page_set_margin_bottom  (FoArea *fo_area_page,
                                                 gfloat new_margin_bottom);
    gfloat      fo_area_page_get_margin_bottom  (FoArea *fo_area_page);
    void        fo_area_page_set_margin_left    (FoArea *fo_area_page,
                                                 gfloat new_margin_left);
    gfloat      fo_area_page_get_margin_left    (FoArea *fo_area_page);
    void        fo_area_page_set_margin_right   (FoArea *fo_area_page,
                                                 gfloat new_margin_right);
    gfloat      fo_area_page_get_margin_right   (FoArea *fo_area_page);

## Object Hierarchy

      GObject
       +----FoObject
             +----FoNode
                   +----FoArea
                         +----FoAreaArea
                               +----FoAreaReference
                                     +----FoAreaViewportReference
                                           +----FoAreaPage

## Properties

      "margin-bottom"        gfloat                : Read / Write
      "margin-left"          gfloat                : Read / Write
      "margin-right"         gfloat                : Read / Write
      "margin-top"           gfloat                : Read / Write
      "page-height"          gfloat                : Read / Write
      "page-number"          gint                  : Read / Write
      "page-width"           gfloat                : Read / Write

## Description

## Details

### FoAreaPage

    typedef struct _FoAreaPage FoAreaPage;

### FoAreaPageClass

    typedef struct _FoAreaPageClass FoAreaPageClass;

### FO_AREA_PAGE_ERROR

    #define FO_AREA_PAGE_ERROR (fo_area_page_error_quark ())

### fo_area_page_error_quark ()

    GQuark      fo_area_page_error_quark        (void);

Gets the GQuark identifying FoAreaPage errors.

Returns : | GQuark identifying FoAreaPage errors.

### enum FoAreaPageError

    typedef enum
    {
      FO_AREA_PAGE_ERROR_FAILED,            /* Generic error code */
      FO_AREA_PAGE_ERROR_WARNING,	        /* Non-fatal error */
      FO_AREA_PAGE_ERROR_OVERFLOW	        /* An area is too large for the region */
    } FoAreaPageError;

### fo_area_page_new ()

    FoArea*     fo_area_page_new                (void);

Creates a new FoAreaPage initialized to default value.

Returns : | the new FoAreaPage

### fo_area_page_set_page_number ()

    void        fo_area_page_set_page_number    (FoArea *fo_area_page,
                                                 gint new_page_number);

Sets the page_number property of `area_page` to `new_page_number`

`fo_area_page` : | The `FoAreaPage` object
`new_page_number` : | The new "page-number" property value

### fo_area_page_get_page_number ()

    gint        fo_area_page_get_page_number    (FoArea *fo_area_page);

Gets the page_number property of `area_page`

`fo_area_page` : | The `FoAreaPage` object
Returns : | The "page-number" property value

### fo_area_page_set_page_width ()

    void        fo_area_page_set_page_width     (FoArea *fo_area_page,
                                                 gfloat new_page_width);

Sets the page_width property of `area_page` to `new_page_width`

`fo_area_page` : | The `FoAreaPage` object
`new_page_width` : | The new "page-width" property value

### fo_area_page_get_page_width ()

    gfloat      fo_area_page_get_page_width     (FoArea *fo_area_page);

Gets the page_width property of `area_page`

`fo_area_page` : | The `FoAreaPage` object
Returns : | The "page-width" property value

### fo_area_page_set_page_height ()

    void        fo_area_page_set_page_height    (FoArea *fo_area_page,
                                                 gfloat new_page_height);

Sets the "page_height" property of `area_page` to `new_page_height`

`fo_area_page` : | The `FoAreaPage` object
`new_page_height` : | The new "page-height" property value

### fo_area_page_get_page_height ()

    gfloat      fo_area_page_get_page_height    (FoArea *fo_area_page);

Gets the page_height property of `area_page`

`fo_area_page` : | The `FoAreaPage` object
Returns : | The "page-height" property value

### fo_area_page_set_margin_top ()

    void        fo_area_page_set_margin_top     (FoArea *fo_area_page,
                                                 gfloat new_margin_top);

Sets the margin_top property of `area_page` to `new_margin_top`

`fo_area_page` : | The `FoAreaPage` object
`new_margin_top` : | The new "margin-top" property value

### fo_area_page_get_margin_top ()

    gfloat      fo_area_page_get_margin_top     (FoArea *fo_area_page);

Gets the margin_top property of `area_page`

`fo_area_page` : | The `FoAreaPage` object
Returns : | The "margin-top" property value

### fo_area_page_set_margin_bottom ()

    void        fo_area_page_set_margin_bottom  (FoArea *fo_area_page,
                                                 gfloat new_margin_bottom);

Sets the margin_bottom property of `area_page` to `new_margin_bottom`

`fo_area_page` : | The `FoAreaPage` object
`new_margin_bottom` : | The new "margin-bottom" property value

### fo_area_page_get_margin_bottom ()

    gfloat      fo_area_page_get_margin_bottom  (FoArea *fo_area_page);

Gets the margin_bottom property of `area_page`

`fo_area_page` : | The `FoAreaPage` object
Returns : | The "margin-bottom" property value

### fo_area_page_set_margin_left ()

    void        fo_area_page_set_margin_left    (FoArea *fo_area_page,
                                                 gfloat new_margin_left);

Sets the margin_left property of `area_page` to `new_margin_left`

`fo_area_page` : | The `FoAreaPage` object
`new_margin_left` : | The new "margin-left" property value

### fo_area_page_get_margin_left ()

    gfloat      fo_area_page_get_margin_left    (FoArea *fo_area_page);

Gets the margin_left property of `area_page`

`fo_area_page` : | The `FoAreaPage` object
Returns : | The "margin-left" property value

### fo_area_page_set_margin_right ()

    void        fo_area_page_set_margin_right   (FoArea *fo_area_page,
                                                 gfloat new_margin_right);

Sets the margin_right property of `area_page` to `new_margin_right`

`fo_area_page` : | The `FoAreaPage` object
`new_margin_right` : | The new "margin-right" property value

### fo_area_page_get_margin_right ()

    gfloat      fo_area_page_get_margin_right   (FoArea *fo_area_page);

Gets the margin_right property of `area_page`

`fo_area_page` : | The `FoAreaPage` object
Returns : | The "margin-right" property value

## Property Details

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

      "margin-bottom"        gfloat                : Read / Write

Margin bottom property.

Default value: 0

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

      "margin-left"          gfloat                : Read / Write

Margin left property.

Default value: 0

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

      "margin-right"         gfloat                : Read / Write

Margin right property.

Default value: 0

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

      "margin-top"           gfloat                : Read / Write

Margin top property.

Default value: 0

### The "`page-height`" property

      "page-height"          gfloat                : Read / Write

Page height property.

Default value: 0

### The "`page-number`" property

      "page-number"          gint                  : Read / Write

Page number property.

Allowed values: >= 0

Default value: 0

### The "`page-width`" property

      "page-width"           gfloat                : Read / Write

Page width property.

Default value: 0