struct FoArea

struct FoArea;

Instance of the base class for area objects.

struct FoAreaClass

struct FoAreaClass;

Class structure for the base class for area objects.

fo_area_new ()

FoArea*     fo_area_new                     (void);

Creates a new FoArea initialized to default value.

fo_area_get_page ()

FoArea*     fo_area_get_page                (FoArea *fo_area);

Gets the page property of area

fo_area_get_reference ()

FoArea*     fo_area_get_reference           (FoArea *fo_area);

Gets the reference property of area

fo_area_get_page_sequence ()

FoArea*     fo_area_get_page_sequence       (FoArea *fo_area);

Gets the page_sequence property of area

fo_area_get_is_first ()

gboolean    fo_area_get_is_first            (FoArea *fo_area);

Gets the is_first property of area

fo_area_get_is_last ()

gboolean    fo_area_get_is_last             (FoArea *fo_area);

Gets the is_last property of area

fo_area_get_next_x ()

gfloat      fo_area_get_next_x              (FoArea *fo_area);

Gets the next_x property of area

fo_area_set_next_x ()

void        fo_area_set_next_x              (FoArea *fo_area,
                                             gfloat new_next_x);

Sets the next-x property of area to new_next_x

fo_area_get_next_y ()

gfloat      fo_area_get_next_y              (FoArea *fo_area);

Gets the "next_y" property of area

fo_area_set_next_y ()

void        fo_area_set_next_y              (FoArea *fo_area,
                                             gfloat new_next_y);

Sets the next-y property of area to new_next_y

fo_area_get_available_width ()

gfloat      fo_area_get_available_width     (FoArea *fo_area);

Gets the "available-width" property of area

fo_area_set_available_width ()

void        fo_area_set_available_width     (FoArea *fo_area,
                                             gfloat new_available_width);

Sets the "available-width" property of area to new_available_width

fo_area_get_available_height ()

gfloat      fo_area_get_available_height    (FoArea *fo_area);

Gets the available-height property of area

fo_area_set_available_height ()

void        fo_area_set_available_height    (FoArea *fo_area,
                                             gfloat new_available_height);

Sets the available-height property of area to new_available_height

fo_area_get_child_available_ipdim ()

gfloat      fo_area_get_child_available_ipdim
                                            (FoArea *fo_area);

Gets the "child-available-ipdim" property of area

fo_area_set_child_available_ipdim ()

void        fo_area_set_child_available_ipdim
                                            (FoArea *fo_area,
                                             gfloat new_child_available_ipdim);

Sets the "child-available-ipdim" property of area to new_child_available_ipdim

fo_area_get_child_available_bpdim ()

gfloat      fo_area_get_child_available_bpdim
                                            (FoArea *fo_area);

Gets the "child-available-bpdim" property of area

fo_area_set_child_available_bpdim ()

void        fo_area_set_child_available_bpdim
                                            (FoArea *fo_area,
                                             gfloat new_child_available_bpdim);

Sets the "child-available-bpdim" property of area to new_child_available_bpdim

fo_area_get_generated_by ()

FoFo*       fo_area_get_generated_by        (FoArea *fo_area);

Gets the generated-by property of area

fo_area_set_generated_by ()

void        fo_area_set_generated_by        (FoArea *fo_area,
                                             FoFo *new_fo);

Sets the generated-by property of area to new_fo

fo_area_add_child ()

FoArea*     fo_area_add_child               (FoArea *parent,
                                             FoArea *child);

Add child to parent by calling the _add_child() function for parent.

fo_area_real_add_child ()

FoArea*     fo_area_real_add_child          (FoArea *parent,
                                             FoArea *child);

Add child as a child of parent in the area tree and set child's page_sequence, page, and reference instance variables as appropriate for both parent and child.

Does NOT modify any other properties -- including geometric properties -- of either child or parent.

fo_area_size_request ()

FoArea*     fo_area_size_request            (FoArea *child);

Checks that the parent area of child has sufficient space for child. If not enough space, requests that the parent has sufficient space allocated for it, then adjusts child and its siblings as necessary to fit into the resized parent area.

You should call #fo_area_size_request() immediately after adding an area to the area tree or making a change to the area's height.

The child area's requested height is taken from the area's height property value. Its requested width is taken from its width property value.

The height allocated to the area is set in the area's available_height property value. Its width allocation is set in its available_width property value.

Immediately after calling this function, the child area should set its height and width according to the available_height and available_width property values. How the child area resolves any difference between the available height and width and the height and width that it needs is up to the child area to work out.

The child area's x and y property values may also have been adjusted, but a child area doesn't set its own x and y property values anyway.

The area that is returned may be a different area object than the child area that is passed as the argument to this function. For example, the parent area may not have been large enough to contain the child area at its requested height, and the child area, the parent area, and all ancestor areas up to an FoAreaPage may have been split (possibly more than once) and the overflow placed on one or more new pages.

fo_area_debug_dump_properties ()

void        fo_area_debug_dump_properties   (FoArea *area,
                                             gint depth);

Dump the properties of area.

fo_area_border_padding_space_resolve ()

void        fo_area_border_padding_space_resolve
                                            (FoArea *parent_area,
                                             FoArea *child_area);

fo_area_break_resolve ()

FoArea*     fo_area_break_resolve           (FoArea *parent_area,
                                             FoArea *new_area);

fo_area_set_height_from_children ()

void        fo_area_set_height_from_children
                                            (FoArea *parent_area);

fo_area_clone ()

FoArea*     fo_area_clone                   (FoArea *original);

Make a clone of original and insert the clone after original in the area tree. Set instance properties of the clone to match original.

fo_area_update_after_clone ()

void        fo_area_update_after_clone      (FoArea *clone,
                                             FoArea *original);

Update the instance variables of clone to match those of original.

fo_area_split_before_height ()

FoArea*     fo_area_split_before_height     (FoArea *area,
                                             gfloat height);

Split area at or before height.

fo_area_split_before_height_check ()

gboolean    fo_area_split_before_height_check
                                            (FoArea *area,
                                             gfloat height);

Check whether area can split at or before height.

fo_area_resolve_text_align ()

void        fo_area_resolve_text_align      (FoArea *area);

FoAreaTraverseFunc ()

gboolean    (*FoAreaTraverseFunc)           (FoArea *area,
                                             gpointer data);

FoAreaForeachFunc ()

void        (*FoAreaForeachFunc)            (FoArea *area,
                                             gpointer data);

FO_AREA_IS_ROOT()

#define FO_AREA_IS_ROOT(area)    (FO_NODE_IS_ROOT(((FoNode*) (area))))

FO_AREA_IS_LEAF()

#define FO_AREA_IS_LEAF(area)    (FO_NODE_IS_LEAF(((FoNode*) (area))))

fo_area_insert ()

FoArea*     fo_area_insert                  (FoArea *parent,
                                             gint position,
                                             FoArea *area);

fo_area_insert_before ()

FoArea*     fo_area_insert_before           (FoArea *parent,
                                             FoArea *sibling,
                                             FoArea *area);

fo_area_insert_after ()

FoArea*     fo_area_insert_after            (FoArea *parent,
                                             FoArea *sibling,
                                             FoArea *area);

fo_area_prepend ()

FoArea*     fo_area_prepend                 (FoArea *parent,
                                             FoArea *area);

Inserts a FoArea as the first child of the given parent and updates the inserted FoArea.

fo_area_n_areas ()

guint       fo_area_n_areas                 (FoArea *root,
                                             GTraverseFlags flags);

Gets the number of nodes in a tree.

fo_area_get_root ()

FoArea*     fo_area_get_root                (FoArea *area);

fo_area_is_ancestor ()

gboolean    fo_area_is_ancestor             (FoArea *area,
                                             FoArea *descendant);

fo_area_depth ()

guint       fo_area_depth                   (FoArea *area);

Gets the depth of a FoArea.

If area is NULL the depth is 0. The root node has a depth of 1. For the children of the root node the depth is 2. And so on.

fo_area_append ()

FoArea*     fo_area_append                  (FoArea *parent,
                                             FoArea *area);

Inserts a FoArea as the last child of the given parent and updates the inserted FoArea.

fo_area_traverse ()

void        fo_area_traverse                (FoArea *root,
                                             GTraverseType order,
                                             GTraverseFlags flags,
                                             gint max_depth,
                                             FoAreaTraverseFunc func,
                                             gpointer data);

fo_area_max_height ()

guint       fo_area_max_height              (FoArea *root);

Gets the maximum height of all branches beneath a FoArea. This is the maximum distance from the FoArea to all leaf nodes.

If root is NULL, 0 is returned. If root has no children, 1 is returned. If root has children, 2 is returned. And so on.

fo_area_children_foreach ()

void        fo_area_children_foreach        (FoArea *area,
                                             GTraverseFlags flags,
                                             FoAreaForeachFunc func,
                                             gpointer data);

Calls a function for each of the children of a FoArea. Note that it doesn't descend beneath the child nodes.

fo_area_reverse_children ()

void        fo_area_reverse_children        (FoArea *area);

Reverses the order of the children of a FoArea. (It doesn't change the order of the grandchildren.)

fo_area_n_children ()

guint       fo_area_n_children              (FoArea *area);

Gets the number of children of a FoArea.

fo_area_nth_child ()

FoArea*     fo_area_nth_child               (FoArea *area,
                                             guint n);

Gets a child of a FoArea, using the given index. The first child is at index 0. If the index is too big, NULL is returned.

fo_area_last_child ()

FoArea*     fo_area_last_child              (FoArea *area);

Gets the last child of a FoArea.

fo_area_child_position ()

guint       fo_area_child_position          (FoArea *area,
                                             FoArea *child);

Gets the position of a FoArea with respect to its siblings. child must be a child of area. The first child is numbered 0, the second 1, and so on.

fo_area_first_sibling ()

FoArea*     fo_area_first_sibling           (FoArea *area);

Gets the first sibling of a FoArea. This could possibly be the node itself.

fo_area_last_sibling ()

FoArea*     fo_area_last_sibling            (FoArea *area);

Gets the last sibling of a FoArea. This could possibly be the node itself.

fo_area_prev_sibling ()

FoArea*     fo_area_prev_sibling            (FoArea *area);

Gets the previous sibling of a FoArea.

fo_area_next_sibling ()

FoArea*     fo_area_next_sibling            (FoArea *area);

Gets the next sibling of a FoArea.

fo_area_first_child ()

FoArea*     fo_area_first_child             (FoArea *area);

Gets the first child of a FoArea.

fo_area_parent ()

FoArea*     fo_area_parent                  (FoArea *area);

Gets the parent of a FoArea.

fo_area_unlink ()

void        fo_area_unlink                  (FoArea *area);

Unlinks an FoArea from an FoArea tree, resulting in two separate trees.

fo_area_unlink_with_next_siblings ()

void        fo_area_unlink_with_next_siblings
                                            (FoArea *area);

Unlinks area and its following siblings.

fo_area_insert_with_next_siblings ()

FoArea*     fo_area_insert_with_next_siblings
                                            (FoArea *parent,
                                             gint position,
                                             FoArea *area);

Implements fo_node_insert_with_next_siblings for FoArea.

fo_area_accumulate_height ()

void        fo_area_accumulate_height       (FoArea *area,
                                             gpointer data);

fo_area_size_adjust ()

void        fo_area_size_adjust             (FoArea *area,
                                             gpointer data);

Place area within its parent and adjust the parent's next-x and next-y properties accordingly.

fo_area_set_or_split ()

void        fo_area_set_or_split            (FoArea *area,
                                             gpointer data);