![]() | ![]() | ![]() | xmlroff Reference Manual | ![]() |
---|
FoArea —
struct FoArea; struct FoAreaClass; FoArea* fo_area_new (void); FoArea* fo_area_get_page (FoArea *fo_area); FoArea* fo_area_get_reference (FoArea *fo_area); FoArea* fo_area_get_page_sequence (FoArea *fo_area);gboolean fo_area_get_is_first (FoArea *fo_area);gboolean fo_area_get_is_last (FoArea *fo_area);gfloat fo_area_get_next_x (FoArea *fo_area); void fo_area_set_next_x (FoArea *fo_area,gfloat new_next_x);gfloat fo_area_get_next_y (FoArea *fo_area); void fo_area_set_next_y (FoArea *fo_area,gfloat new_next_y);gfloat fo_area_get_available_width (FoArea *fo_area); void fo_area_set_available_width (FoArea *fo_area,gfloat new_available_width);gfloat fo_area_get_available_height (FoArea *fo_area); void fo_area_set_available_height (FoArea *fo_area,gfloat new_available_height);gfloat fo_area_get_child_available_ipdim (FoArea *fo_area); void fo_area_set_child_available_ipdim (FoArea *fo_area,gfloat new_child_available_ipdim);gfloat fo_area_get_child_available_bpdim (FoArea *fo_area); void fo_area_set_child_available_bpdim (FoArea *fo_area,gfloat new_child_available_bpdim); FoFo* fo_area_get_generated_by (FoArea *fo_area); void fo_area_set_generated_by (FoArea *fo_area, FoFo *new_fo); FoArea* fo_area_add_child (FoArea *parent, FoArea *child); FoArea* fo_area_real_add_child (FoArea *parent, FoArea *child); FoArea* fo_area_size_request (FoArea *child); void fo_area_debug_dump_properties (FoArea *area,gint depth); void fo_area_border_padding_space_resolve (FoArea *parent_area, FoArea *child_area); FoArea* fo_area_break_resolve (FoArea *parent_area, FoArea *new_area); void fo_area_set_height_from_children (FoArea *parent_area); FoArea* fo_area_clone (FoArea *original); void fo_area_update_after_clone (FoArea *clone, FoArea *original); FoArea* fo_area_split_before_height (FoArea *area,gfloat height);gboolean fo_area_split_before_height_check (FoArea *area,gfloat height); void fo_area_resolve_text_align (FoArea *area);gboolean (*FoAreaTraverseFunc) (FoArea *area,gpointer data); void (*FoAreaForeachFunc) (FoArea *area,gpointer data); #define FO_AREA_IS_ROOT (area) #define FO_AREA_IS_LEAF (area) FoArea* fo_area_insert (FoArea *parent,gint position, FoArea *area); FoArea* fo_area_insert_before (FoArea *parent, FoArea *sibling, FoArea *area); FoArea* fo_area_insert_after (FoArea *parent, FoArea *sibling, FoArea *area); FoArea* fo_area_prepend (FoArea *parent, FoArea *area);guint fo_area_n_areas (FoArea *root,GTraverseFlags flags); FoArea* fo_area_get_root (FoArea *area);gboolean fo_area_is_ancestor (FoArea *area, FoArea *descendant);guint fo_area_depth (FoArea *area); FoArea* fo_area_append (FoArea *parent, FoArea *area); void fo_area_traverse (FoArea *root,GTraverseType order,GTraverseFlags flags,gint max_depth, FoAreaTraverseFunc func,gpointer data);guint fo_area_max_height (FoArea *root); void fo_area_children_foreach (FoArea *area,GTraverseFlags flags, FoAreaForeachFunc func,gpointer data); void fo_area_reverse_children (FoArea *area);guint fo_area_n_children (FoArea *area); FoArea* fo_area_nth_child (FoArea *area,guint n); FoArea* fo_area_last_child (FoArea *area);guint fo_area_child_position (FoArea *area, FoArea *child); FoArea* fo_area_first_sibling (FoArea *area); FoArea* fo_area_last_sibling (FoArea *area); FoArea* fo_area_prev_sibling (FoArea *area); FoArea* fo_area_next_sibling (FoArea *area); FoArea* fo_area_first_child (FoArea *area); FoArea* fo_area_parent (FoArea *area); void fo_area_unlink (FoArea *area); void fo_area_unlink_with_next_siblings (FoArea *area); FoArea* fo_area_insert_with_next_siblings (FoArea *parent,gint position, FoArea *area); void fo_area_accumulate_height (FoArea *area,gpointer data); void fo_area_size_adjust (FoArea *area,gpointer data); void fo_area_set_or_split (FoArea *area,gpointer data);
"available-height"gfloat : Read / Write "available-width"gfloat : Read / Write "child-available-bpdim"gfloat : Read / Write "child-available-ipdim"gfloat : Read / Write "generated-by" FoFo : Read / Write "is-first"gboolean : Read "is-last"gboolean : Read "next-x"gfloat : Read / Write "next-y"gfloat : Read / Write "page" FoArea : Read "page-sequence" FoFo : Read / Write
FoArea* fo_area_new (void);
Creates a new FoArea initialized to default value.
Returns : | the new FoArea |
FoArea* fo_area_get_page (FoArea *fo_area);
Gets the
fo_area : | The FoArea object |
Returns : | The "page" property value |
FoArea* fo_area_get_reference (FoArea *fo_area);
Gets the
fo_area : | The FoArea object |
Returns : | The "reference" property value |
FoArea* fo_area_get_page_sequence (FoArea *fo_area);
Gets the page_sequence property of area
fo_area : | The FoArea object |
Returns : | The "page-sequence" property value |
gboolean fo_area_get_is_first (FoArea *fo_area);
Gets the
fo_area : | The FoArea object |
Returns : | The "is-first" property value |
gboolean fo_area_get_is_last (FoArea *fo_area);
Gets the
fo_area : | The FoArea object |
Returns : | The "is-last" property value |
gfloat fo_area_get_next_x (FoArea *fo_area);
Gets the
fo_area : | The FoArea object |
Returns : | The "next_x" property value |
void fo_area_set_next_x (FoArea *fo_area,gfloat new_next_x);
Sets the
fo_area : | The FoArea object |
new_next_x : | The new "next_x" property value |
gfloat fo_area_get_next_y (FoArea *fo_area);
Gets the "next_y" property of area
fo_area : | The FoArea object |
Returns : | The "next-y" property value |
void fo_area_set_next_y (FoArea *fo_area,gfloat new_next_y);
Sets the
fo_area : | The FoArea object |
new_next_y : | The new "next-y" property value |
gfloat fo_area_get_available_width (FoArea *fo_area);
Gets the "available-width" property of area
fo_area : | The FoArea object |
Returns : | The "available-width" property value |
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 : | The FoArea object |
new_available_width : | The new "available-width" property value |
gfloat fo_area_get_available_height (FoArea *fo_area);
Gets the
fo_area : | The FoArea object |
Returns : | The "available_height" property value |
void fo_area_set_available_height (FoArea *fo_area,gfloat new_available_height);
Sets the
fo_area : | The FoArea object |
new_available_height : | The new "available-height" property value |
gfloat fo_area_get_child_available_ipdim (FoArea *fo_area);
Gets the "child-available-ipdim" property of area
fo_area : | The FoArea object |
Returns : | The "child-available-ipdim" property value |
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 : | The FoArea object |
new_child_available_ipdim : | The new "child-available-ipdim" property value |
gfloat fo_area_get_child_available_bpdim (FoArea *fo_area);
Gets the "child-available-bpdim" property of area
fo_area : | The FoArea object |
Returns : | The "child-available-bpdim" property value |
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 : | The FoArea object |
new_child_available_bpdim : | The new "child-available-bpdim" property value |
FoFo* fo_area_get_generated_by (FoArea *fo_area);
Gets the
fo_area : | The FoArea object |
Returns : | The "generated-by" property value |
void fo_area_set_generated_by (FoArea *fo_area, FoFo *new_fo);
Sets the
fo_area : | The FoArea object |
new_fo : | The new "generated-by" property value |
FoArea* fo_area_add_child (FoArea *parent, FoArea *child);
Add child to parent by calling the
parent : | Parent area node |
child : | Child area node |
Returns : | 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.
parent : | Parent area node |
child : | Child area node |
Returns : | child |
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.
child : | Child area |
Returns : | Pointer to the last area generated from child after any reallocation and resizing |
void fo_area_debug_dump_properties (FoArea *area,gint depth);
Dump the properties of area.
area : | The FoArea object |
depth : | Indent level to add to the output |
void fo_area_border_padding_space_resolve (FoArea *parent_area, FoArea *child_area);
parent_area : | |
child_area : |
FoArea* fo_area_break_resolve (FoArea *parent_area, FoArea *new_area);
parent_area : | |
new_area : | |
Returns : |
void fo_area_set_height_from_children (FoArea *parent_area);
parent_area : |
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.
original : | Area object to be cloned. |
Returns : | Clone of original. |
void fo_area_update_after_clone (FoArea *clone, FoArea *original);
Update the instance variables of clone to match those of original.
clone : | New object cloned from original. |
original : | Original area object. |
FoArea* fo_area_split_before_height (FoArea *area,gfloat height);
Split area at or before height.
area : | FoArea to be split |
height : | Maximum block-progression-dimension of area |
Returns : | The part of area spit from area, or NULL if unsplit. |
gboolean fo_area_split_before_height_check (FoArea *area,gfloat height);
Check whether area can split at or before height.
area : | FoArea to be split |
height : | Maximum block-progression-dimension of area |
Returns : | TRUE if can split, otherwise FALSE. |
gboolean (*FoAreaTraverseFunc) (FoArea *area,gpointer data);
area : | |
data : | |
Returns : |
FoArea* fo_area_insert (FoArea *parent,gint position, FoArea *area);
parent : | |
position : | |
area : | |
Returns : |
FoArea* fo_area_insert_before (FoArea *parent, FoArea *sibling, FoArea *area);
parent : | |
sibling : | |
area : | |
Returns : |
FoArea* fo_area_insert_after (FoArea *parent, FoArea *sibling, FoArea *area);
parent : | |
sibling : | |
area : | |
Returns : |
guint fo_area_n_areas (FoArea *root,GTraverseFlags flags);
root : | |
flags : | |
Returns : |
gboolean fo_area_is_ancestor (FoArea *area, FoArea *descendant);
area : | |
descendant : | |
Returns : |
void fo_area_traverse (FoArea *root,GTraverseType order,GTraverseFlags flags,gint max_depth, FoAreaTraverseFunc func,gpointer data);
root : | |
order : | |
flags : | |
max_depth : | |
func : | |
data : |
void fo_area_children_foreach (FoArea *area,GTraverseFlags flags, FoAreaForeachFunc func,gpointer data);
area : | |
flags : | |
func : | |
data : |
guint fo_area_child_position (FoArea *area, FoArea *child);
area : | |
child : | |
Returns : |
void fo_area_unlink_with_next_siblings (FoArea *area);
Unlinks area and its following siblings.
area : | First FoArea to unlink. |
FoArea* fo_area_insert_with_next_siblings (FoArea *parent,gint position, FoArea *area);
Implements fo_node_insert_with_next_siblings for FoArea.
void fo_area_accumulate_height (FoArea *area,gpointer data);
area : | |
data : |
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.
area : | FoArea node to be placed within parent |
data : | Not used |
"available-height" ( |
|
"available-width" ( |
|
"child-available-bpdim" ( |
|
"child-available-ipdim" ( |
|
"generated-by" (FoFo : Read / Write) |
|
"is-first" ( |
|
"is-last" ( |
|
"next-x" ( |
|
"next-y" ( |
|
"page" (FoArea : Read) |
|
"page-sequence" (FoFo : Read / Write) |
|
<< Area Objects | FoAreaArea >> |