## FoAreaLayout

FoAreaLayout

## Synopsis

                        FoAreaLayout;
                        FoAreaLayoutClass;
    FoArea*             fo_area_layout_new                  (void);
    FoArea*             fo_area_layout_new_with_layout      (FoLayout *layout);
    void                fo_area_layout_set_layout           (FoArea *fo_area_layout,
                                                             FoLayout *new_layout);
    FoLayout*           fo_area_layout_get_layout           (FoArea *fo_area_layout);
    void                fo_area_layout_set_line_first       (FoArea *fo_area_layout,
                                                             guint new_line_first);
    guint               fo_area_layout_get_line_first       (FoArea *fo_area_layout);
    void                fo_area_layout_set_line_last        (FoArea *fo_area_layout,
                                                             guint new_line_last);
    guint               fo_area_layout_get_line_last        (FoArea *fo_area_layout);
    gdouble             fo_area_layout_get_line_height      (FoArea *fo_area_layout,
                                                             gint line_number);

## Object Hierarchy

      GObject
       +----FoObject
             +----FoNode
                   +----FoArea
                         +----FoAreaArea
                               +----FoAreaLayout

## Properties

      "layout"                   gpointer              : Read / Write

## Description

## Details

### FoAreaLayout

    typedef struct _FoAreaLayout FoAreaLayout;

### FoAreaLayoutClass

    typedef struct _FoAreaLayoutClass FoAreaLayoutClass;

### fo_area_layout_new ()

    FoArea*             fo_area_layout_new                  (void);

Creates a new FoAreaLayout initialized to default value.

Returns : | the new FoAreaLayout

### fo_area_layout_new_with_layout ()

    FoArea*             fo_area_layout_new_with_layout      (FoLayout *layout);

Creates a new FoAreaLayout initialized with `layout`.

`layout` : | FoLayout used by the new FoAreaLayout
Returns : | the new FoAreaLayout

### fo_area_layout_set_layout ()

    void                fo_area_layout_set_layout           (FoArea *fo_area_layout,
                                                             FoLayout *new_layout);

Sets the layout property of `area_area` to `new_layout`

`fo_area_layout` : | The FoAreaLayout object
`new_layout` : | The new "layout" property value

### fo_area_layout_get_layout ()

    FoLayout*           fo_area_layout_get_layout           (FoArea *fo_area_layout);

Gets the layout property of `area_layout`

`fo_area_layout` : | The FoAreaLayout object
Returns : | The "layout" property value

### fo_area_layout_set_line_first ()

    void                fo_area_layout_set_line_first       (FoArea *fo_area_layout,
                                                             guint new_line_first);

Sets the line-first property of `area_area` to `new_line_first`

`fo_area_layout` : | The FoAreaLayout object
`new_line_first` : | The new "line_first" property value

### fo_area_layout_get_line_first ()

    guint               fo_area_layout_get_line_first       (FoArea *fo_area_layout);

Gets the line-first property of `area_layout`

`fo_area_layout` : | The FoAreaLayout object
Returns : | The "line_first" property value

### fo_area_layout_set_line_last ()

    void                fo_area_layout_set_line_last        (FoArea *fo_area_layout,
                                                             guint new_line_last);

Sets the line-last property of `fo_area_layout` to `new_line_last`.

`fo_area_layout` : | The FoAreaLayout object.
`new_line_last` : | The new "line_last" property value.

### fo_area_layout_get_line_last ()

    guint               fo_area_layout_get_line_last        (FoArea *fo_area_layout);

Gets the line-last property of `fo_area_layout`.

`fo_area_layout` : | The FoAreaLayout object.
Returns : | The "line_last" property value.

### fo_area_layout_get_line_height ()

    gdouble             fo_area_layout_get_line_height      (FoArea *fo_area_layout,
                                                             gint line_number);

Get the height of line `line_number`.

`fo_area_layout` : | FoArea.
`line_number` : | Number of the line for which to get the height.
Returns : | The line height in points.

## Property Details

### The `"layout"` property

      "layout"                   gpointer              : Read / Write

FoLayout layout of formatted text of block.