File: fo-area.xml

package info (click to toggle)
xmlroff 0.6.2-1.1
links: PTS, VCS
area: main
in suites: wheezy
size: 36,456 kB
sloc: ansic: 178,247; xml: 109,155; sh: 8,973; makefile: 1,331; perl: 30
file content (1278 lines) | stat: -rw-r--r-- 85,785 bytes
parent folder | download | duplicates (4)
<refentry id="FoArea">
<refmeta>
<refentrytitle role="top_of_page" id="FoArea.top_of_page">FoArea</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>FoArea</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="FoArea.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="FoArea-struct">FoArea</link>;
                    <link linkend="FoAreaClass">FoAreaClass</link>;
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-new">fo_area_new</link>                         (void);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-get-page">fo_area_get_page</link>                    (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-get-reference">fo_area_get_reference</link>               (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-get-page-sequence">fo_area_get_page_sequence</link>           (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-area-get-is-first">fo_area_get_is_first</link>                (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-area-get-is-last">fo_area_get_is_last</link>                 (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="gfloat">gfloat</link>              <link linkend="fo-area-get-next-x">fo_area_get_next_x</link>                  (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="void">void</link>                <link linkend="fo-area-set-next-x">fo_area_set_next_x</link>                  (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_next_x);
<link linkend="gfloat">gfloat</link>              <link linkend="fo-area-get-next-y">fo_area_get_next_y</link>                  (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="void">void</link>                <link linkend="fo-area-set-next-y">fo_area_set_next_y</link>                  (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_next_y);
<link linkend="gfloat">gfloat</link>              <link linkend="fo-area-get-available-width">fo_area_get_available_width</link>         (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="void">void</link>                <link linkend="fo-area-set-available-width">fo_area_set_available_width</link>         (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_available_width);
<link linkend="gfloat">gfloat</link>              <link linkend="fo-area-get-available-height">fo_area_get_available_height</link>        (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="void">void</link>                <link linkend="fo-area-set-available-height">fo_area_set_available_height</link>        (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_available_height);
<link linkend="gfloat">gfloat</link>              <link linkend="fo-area-get-child-available-ipdim">fo_area_get_child_available_ipdim</link>   (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="void">void</link>                <link linkend="fo-area-set-child-available-ipdim">fo_area_set_child_available_ipdim</link>   (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_child_available_ipdim);
<link linkend="gfloat">gfloat</link>              <link linkend="fo-area-get-child-available-bpdim">fo_area_get_child_available_bpdim</link>   (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="void">void</link>                <link linkend="fo-area-set-child-available-bpdim">fo_area_set_child_available_bpdim</link>   (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_child_available_bpdim);
<link linkend="FoFo">FoFo</link>*               <link linkend="fo-area-get-generated-by">fo_area_get_generated_by</link>            (<link linkend="FoArea">FoArea</link> *fo_area);
<link linkend="void">void</link>                <link linkend="fo-area-set-generated-by">fo_area_set_generated_by</link>            (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="FoFo">FoFo</link> *new_fo);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-add-child">fo_area_add_child</link>                   (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="FoArea">FoArea</link> *child);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-size-request">fo_area_size_request</link>                (<link linkend="FoArea">FoArea</link> *child);
<link linkend="void">void</link>                <link linkend="fo-area-debug-dump-properties">fo_area_debug_dump_properties</link>       (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="gint">gint</link> depth);
<link linkend="void">void</link>                <link linkend="fo-area-border-padding-space-resolve">fo_area_border_padding_space_resolve</link>
                                                        (<link linkend="FoArea">FoArea</link> *parent_area,
                                                         <link linkend="FoArea">FoArea</link> *child_area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-break-resolve">fo_area_break_resolve</link>               (<link linkend="FoArea">FoArea</link> *parent_area,
                                                         <link linkend="FoArea">FoArea</link> *new_area);
<link linkend="void">void</link>                <link linkend="fo-area-set-height-from-children">fo_area_set_height_from_children</link>    (<link linkend="FoArea">FoArea</link> *parent_area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-clone">fo_area_clone</link>                       (<link linkend="FoArea">FoArea</link> *original);
<link linkend="void">void</link>                <link linkend="fo-area-update-after-clone">fo_area_update_after_clone</link>          (<link linkend="FoArea">FoArea</link> *clone,
                                                         <link linkend="FoArea">FoArea</link> *original);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-split-before-height">fo_area_split_before_height</link>         (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="gfloat">gfloat</link> height);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-area-split-before-height-check">fo_area_split_before_height_check</link>   (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="gfloat">gfloat</link> height);
<link linkend="void">void</link>                <link linkend="fo-area-resolve-text-align">fo_area_resolve_text_align</link>          (<link linkend="FoArea">FoArea</link> *area);
<link linkend="gboolean">gboolean</link>            (<link linkend="FoAreaTraverseFunc">*FoAreaTraverseFunc</link>)               (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link>                (<link linkend="FoAreaForeachFunc">*FoAreaForeachFunc</link>)                (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="gpointer">gpointer</link> data);
#define             <link linkend="FO-AREA-IS-ROOT:CAPS">FO_AREA_IS_ROOT</link>                     (area)
#define             <link linkend="FO-AREA-IS-LEAF:CAPS">FO_AREA_IS_LEAF</link>                     (area)
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-insert">fo_area_insert</link>                      (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="gint">gint</link> position,
                                                         <link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-insert-before">fo_area_insert_before</link>               (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="FoArea">FoArea</link> *sibling,
                                                         <link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-insert-after">fo_area_insert_after</link>                (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="FoArea">FoArea</link> *sibling,
                                                         <link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-prepend">fo_area_prepend</link>                     (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="FoArea">FoArea</link> *area);
<link linkend="guint">guint</link>               <link linkend="fo-area-n-areas">fo_area_n_areas</link>                     (<link linkend="FoArea">FoArea</link> *root,
                                                         <link linkend="GTraverseFlags">GTraverseFlags</link> flags);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-get-root">fo_area_get_root</link>                    (<link linkend="FoArea">FoArea</link> *area);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-area-is-ancestor">fo_area_is_ancestor</link>                 (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="FoArea">FoArea</link> *descendant);
<link linkend="guint">guint</link>               <link linkend="fo-area-depth">fo_area_depth</link>                       (<link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-append">fo_area_append</link>                      (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="FoArea">FoArea</link> *area);
<link linkend="void">void</link>                <link linkend="fo-area-traverse">fo_area_traverse</link>                    (<link linkend="FoArea">FoArea</link> *root,
                                                         <link linkend="GTraverseType">GTraverseType</link> order,
                                                         <link linkend="GTraverseFlags">GTraverseFlags</link> flags,
                                                         <link linkend="gint">gint</link> max_depth,
                                                         <link linkend="FoAreaTraverseFunc">FoAreaTraverseFunc</link> func,
                                                         <link linkend="gpointer">gpointer</link> data);
<link linkend="guint">guint</link>               <link linkend="fo-area-max-height">fo_area_max_height</link>                  (<link linkend="FoArea">FoArea</link> *root);
<link linkend="void">void</link>                <link linkend="fo-area-children-foreach">fo_area_children_foreach</link>            (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="GTraverseFlags">GTraverseFlags</link> flags,
                                                         <link linkend="FoAreaForeachFunc">FoAreaForeachFunc</link> func,
                                                         <link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link>                <link linkend="fo-area-reverse-children">fo_area_reverse_children</link>            (<link linkend="FoArea">FoArea</link> *area);
<link linkend="guint">guint</link>               <link linkend="fo-area-n-children">fo_area_n_children</link>                  (<link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-nth-child">fo_area_nth_child</link>                   (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="guint">guint</link> n);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-last-child">fo_area_last_child</link>                  (<link linkend="FoArea">FoArea</link> *area);
<link linkend="guint">guint</link>               <link linkend="fo-area-child-position">fo_area_child_position</link>              (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="FoArea">FoArea</link> *child);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-first-sibling">fo_area_first_sibling</link>               (<link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-last-sibling">fo_area_last_sibling</link>                (<link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-prev-sibling">fo_area_prev_sibling</link>                (<link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-next-sibling">fo_area_next_sibling</link>                (<link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-first-child">fo_area_first_child</link>                 (<link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-parent">fo_area_parent</link>                      (<link linkend="FoArea">FoArea</link> *area);
<link linkend="void">void</link>                <link linkend="fo-area-unlink">fo_area_unlink</link>                      (<link linkend="FoArea">FoArea</link> *area);
<link linkend="void">void</link>                <link linkend="fo-area-unlink-with-next-siblings">fo_area_unlink_with_next_siblings</link>   (<link linkend="FoArea">FoArea</link> *area);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-area-insert-with-next-siblings">fo_area_insert_with_next_siblings</link>   (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="gint">gint</link> position,
                                                         <link linkend="FoArea">FoArea</link> *area);
</synopsis>
</refsynopsisdiv>

<refsect1 id="FoArea.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="FoObject">FoObject</link>
         +----<link linkend="FoNode">FoNode</link>
               +----FoArea
                     +----<link linkend="FoAreaArea">FoAreaArea</link>
                     +----<link linkend="FoAreaTree">FoAreaTree</link>
</synopsis>

</refsect1>





<refsect1 id="FoArea.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="FoArea--available-height">available-height</link>&quot;         <link linkend="gfloat">gfloat</link>                : Read / Write
  &quot;<link linkend="FoArea--available-width">available-width</link>&quot;          <link linkend="gfloat">gfloat</link>                : Read / Write
  &quot;<link linkend="FoArea--child-available-bpdim">child-available-bpdim</link>&quot;    <link linkend="gfloat">gfloat</link>                : Read / Write
  &quot;<link linkend="FoArea--child-available-ipdim">child-available-ipdim</link>&quot;    <link linkend="gfloat">gfloat</link>                : Read / Write
  &quot;<link linkend="FoArea--generated-by">generated-by</link>&quot;             <link linkend="FoFo">FoFo</link>*                 : Read / Write
  &quot;<link linkend="FoArea--is-first">is-first</link>&quot;                 <link linkend="gboolean">gboolean</link>              : Read
  &quot;<link linkend="FoArea--is-last">is-last</link>&quot;                  <link linkend="gboolean">gboolean</link>              : Read
  &quot;<link linkend="FoArea--next-x">next-x</link>&quot;                   <link linkend="gfloat">gfloat</link>                : Read / Write
  &quot;<link linkend="FoArea--next-y">next-y</link>&quot;                   <link linkend="gfloat">gfloat</link>                : Read / Write
  &quot;<link linkend="FoArea--page">page</link>&quot;                     <link linkend="FoArea">FoArea</link>*               : Read
  &quot;<link linkend="FoArea--page-sequence">page-sequence</link>&quot;            <link linkend="FoFo">FoFo</link>*                 : Read / Write
</synopsis>
</refsect1>



<refsect1 id="FoArea.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="FoArea.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoArea-struct" role="struct">
<title>FoArea</title>
<indexterm zone="FoArea-struct"><primary>FoArea</primary></indexterm><programlisting>typedef struct _FoArea FoArea;</programlisting>
<para>
Instance of the base class for area objects.</para>
<para>

</para></refsect2>
<refsect2 id="FoAreaClass" role="struct">
<title>FoAreaClass</title>
<indexterm zone="FoAreaClass"><primary>FoAreaClass</primary></indexterm><programlisting>typedef struct _FoAreaClass FoAreaClass;</programlisting>
<para>
Class structure for the base class for area objects.</para>
<para>

</para></refsect2>
<refsect2 id="fo-area-new" role="function">
<title>fo_area_new ()</title>
<indexterm zone="fo-area-new"><primary>fo_area_new</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_new                         (void);</programlisting>
<para>
Creates a new <link linkend="FoArea"><type>FoArea</type></link> initialized to default value.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new <link linkend="FoArea"><type>FoArea</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-page" role="function">
<title>fo_area_get_page ()</title>
<indexterm zone="fo-area-get-page"><primary>fo_area_get_page</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_get_page                    (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the <link linkend="page"><type>page</type></link> property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "page" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-reference" role="function">
<title>fo_area_get_reference ()</title>
<indexterm zone="fo-area-get-reference"><primary>fo_area_get_reference</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_get_reference               (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the <link linkend="reference"><type>reference</type></link> property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "reference" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-page-sequence" role="function">
<title>fo_area_get_page_sequence ()</title>
<indexterm zone="fo-area-get-page-sequence"><primary>fo_area_get_page_sequence</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_get_page_sequence           (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the <link linkend="page-sequence"><type>page_sequence</type></link> property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "page-sequence" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-is-first" role="function">
<title>fo_area_get_is_first ()</title>
<indexterm zone="fo-area-get-is-first"><primary>fo_area_get_is_first</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_area_get_is_first                (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the <link linkend="is-first"><type>is_first</type></link> property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "is-first" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-is-last" role="function">
<title>fo_area_get_is_last ()</title>
<indexterm zone="fo-area-get-is-last"><primary>fo_area_get_is_last</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_area_get_is_last                 (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the <link linkend="is-last"><type>is_last</type></link> property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "is-last" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-next-x" role="function">
<title>fo_area_get_next_x ()</title>
<indexterm zone="fo-area-get-next-x"><primary>fo_area_get_next_x</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link>              fo_area_get_next_x                  (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the <link linkend="next-x"><type>next_x</type></link> property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "next_x" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-set-next-x" role="function">
<title>fo_area_set_next_x ()</title>
<indexterm zone="fo-area-set-next-x"><primary>fo_area_set_next_x</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_set_next_x                  (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_next_x);</programlisting>
<para>
Sets the <link linkend="next-x"><type>next-x</type></link> property of <parameter>area</parameter> to <parameter>new_next_x</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_next_x</parameter>&nbsp;:</term>
<listitem><simpara> The new "next_x" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-next-y" role="function">
<title>fo_area_get_next_y ()</title>
<indexterm zone="fo-area-get-next-y"><primary>fo_area_get_next_y</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link>              fo_area_get_next_y                  (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the "next_y" property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "next-y" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-set-next-y" role="function">
<title>fo_area_set_next_y ()</title>
<indexterm zone="fo-area-set-next-y"><primary>fo_area_set_next_y</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_set_next_y                  (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_next_y);</programlisting>
<para>
Sets the <link linkend="next-y"><type>next-y</type></link> property of <parameter>area</parameter> to <parameter>new_next_y</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_next_y</parameter>&nbsp;:</term>
<listitem><simpara> The new "next-y" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-available-width" role="function">
<title>fo_area_get_available_width ()</title>
<indexterm zone="fo-area-get-available-width"><primary>fo_area_get_available_width</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link>              fo_area_get_available_width         (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the "available-width" property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "available-width" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-set-available-width" role="function">
<title>fo_area_set_available_width ()</title>
<indexterm zone="fo-area-set-available-width"><primary>fo_area_set_available_width</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_set_available_width         (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_available_width);</programlisting>
<para>
Sets the "available-width" property of <parameter>area</parameter> to <parameter>new_available_width</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_available_width</parameter>&nbsp;:</term>
<listitem><simpara> The new "available-width" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-available-height" role="function">
<title>fo_area_get_available_height ()</title>
<indexterm zone="fo-area-get-available-height"><primary>fo_area_get_available_height</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link>              fo_area_get_available_height        (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the <link linkend="available-height"><type>available-height</type></link> property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "available_height" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-set-available-height" role="function">
<title>fo_area_set_available_height ()</title>
<indexterm zone="fo-area-set-available-height"><primary>fo_area_set_available_height</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_set_available_height        (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_available_height);</programlisting>
<para>
Sets the <link linkend="available-height"><type>available-height</type></link> property of <parameter>area</parameter> to <parameter>new_available_height</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_available_height</parameter>&nbsp;:</term>
<listitem><simpara> The new "available-height" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-child-available-ipdim" role="function">
<title>fo_area_get_child_available_ipdim ()</title>
<indexterm zone="fo-area-get-child-available-ipdim"><primary>fo_area_get_child_available_ipdim</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link>              fo_area_get_child_available_ipdim   (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the "child-available-ipdim" property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "child-available-ipdim" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-set-child-available-ipdim" role="function">
<title>fo_area_set_child_available_ipdim ()</title>
<indexterm zone="fo-area-set-child-available-ipdim"><primary>fo_area_set_child_available_ipdim</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_set_child_available_ipdim   (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_child_available_ipdim);</programlisting>
<para>
Sets the "child-available-ipdim" property of <parameter>area</parameter> to
<parameter>new_child_available_ipdim</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_child_available_ipdim</parameter>&nbsp;:</term>
<listitem><simpara> The new "child-available-ipdim" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-child-available-bpdim" role="function">
<title>fo_area_get_child_available_bpdim ()</title>
<indexterm zone="fo-area-get-child-available-bpdim"><primary>fo_area_get_child_available_bpdim</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link>              fo_area_get_child_available_bpdim   (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the "child-available-bpdim" property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "child-available-bpdim" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-set-child-available-bpdim" role="function">
<title>fo_area_set_child_available_bpdim ()</title>
<indexterm zone="fo-area-set-child-available-bpdim"><primary>fo_area_set_child_available_bpdim</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_set_child_available_bpdim   (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="gfloat">gfloat</link> new_child_available_bpdim);</programlisting>
<para>
Sets the "child-available-bpdim" property of <parameter>area</parameter> to
<parameter>new_child_available_bpdim</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_child_available_bpdim</parameter>&nbsp;:</term>
<listitem><simpara> The new "child-available-bpdim" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-generated-by" role="function">
<title>fo_area_get_generated_by ()</title>
<indexterm zone="fo-area-get-generated-by"><primary>fo_area_get_generated_by</primary></indexterm><programlisting><link linkend="FoFo">FoFo</link>*               fo_area_get_generated_by            (<link linkend="FoArea">FoArea</link> *fo_area);</programlisting>
<para>
Gets the <link linkend="generated-by"><type>generated-by</type></link> property of <parameter>area</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The "generated-by" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-set-generated-by" role="function">
<title>fo_area_set_generated_by ()</title>
<indexterm zone="fo-area-set-generated-by"><primary>fo_area_set_generated_by</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_set_generated_by            (<link linkend="FoArea">FoArea</link> *fo_area,
                                                         <link linkend="FoFo">FoFo</link> *new_fo);</programlisting>
<para>
Sets the <link linkend="generated-by"><type>generated-by</type></link> property of <parameter>area</parameter> to <parameter>new_fo</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_area</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoArea</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_fo</parameter>&nbsp;:</term>
<listitem><simpara> The new "generated-by" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-add-child" role="function">
<title>fo_area_add_child ()</title>
<indexterm zone="fo-area-add-child"><primary>fo_area_add_child</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_add_child                   (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="FoArea">FoArea</link> *child);</programlisting>
<para>
Add <parameter>child</parameter> to <parameter>parent</parameter> by calling the <link linkend="add-child"><function>_add_child()</function></link> function for
<parameter>parent</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara> Parent area node
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child</parameter>&nbsp;:</term>
<listitem><simpara>  Child area node
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <parameter>child</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-size-request" role="function">
<title>fo_area_size_request ()</title>
<indexterm zone="fo-area-size-request"><primary>fo_area_size_request</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_size_request                (<link linkend="FoArea">FoArea</link> *child);</programlisting>
<para>
Checks that the parent area of <parameter>child</parameter> has sufficient space for
<parameter>child</parameter>.  If not enough space, requests that the parent has
sufficient space allocated for it, then adjusts <parameter>child</parameter> and its
siblings as necessary to fit into the resized parent area.
</para>
<para>
You should call #<link linkend="fo-area-size-request"><function>fo_area_size_request()</function></link> immediately after adding
an area to the area tree or making a change to the area's height.
</para>
<para>
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.
</para>
<para>
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.
</para>
<para>
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.
</para>
<para>
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.
</para>
<para>
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.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>child</parameter>&nbsp;:</term>
<listitem><simpara> Child area
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Pointer to the last area generated from <parameter>child</parameter> after
any reallocation and resizing
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-debug-dump-properties" role="function">
<title>fo_area_debug_dump_properties ()</title>
<indexterm zone="fo-area-debug-dump-properties"><primary>fo_area_debug_dump_properties</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_debug_dump_properties       (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="gint">gint</link> depth);</programlisting>
<para>
Dump the properties of <parameter>area</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="FoArea"><type>FoArea</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter>&nbsp;:</term>
<listitem><simpara> Indent level to add to the output
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-border-padding-space-resolve" role="function">
<title>fo_area_border_padding_space_resolve ()</title>
<indexterm zone="fo-area-border-padding-space-resolve"><primary>fo_area_border_padding_space_resolve</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_border_padding_space_resolve
                                                        (<link linkend="FoArea">FoArea</link> *parent_area,
                                                         <link linkend="FoArea">FoArea</link> *child_area);</programlisting>
<para>
Resolves the border, padding, and space properties of <parameter>child_area</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent_area</parameter>&nbsp;:</term>
<listitem><simpara> Parent area of <parameter>child_area</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child_area</parameter>&nbsp;:</term>
<listitem><simpara>  <link linkend="FoArea"><type>FoArea</type></link> for which to resolve properties.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-break-resolve" role="function">
<title>fo_area_break_resolve ()</title>
<indexterm zone="fo-area-break-resolve"><primary>fo_area_break_resolve</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_break_resolve               (<link linkend="FoArea">FoArea</link> *parent_area,
                                                         <link linkend="FoArea">FoArea</link> *new_area);</programlisting>
<para>
Resolves the break properties of <parameter>new_area</parameter>, which may result in
<parameter>new_area</parameter> being split into multiple areas.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent_area</parameter>&nbsp;:</term>
<listitem><simpara> Parent area of <parameter>new_area</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_area</parameter>&nbsp;:</term>
<listitem><simpara>    <link linkend="FoArea"><type>FoArea</type></link> for which to resolve breaks.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Last area resulting from resolving breaks.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-set-height-from-children" role="function">
<title>fo_area_set_height_from_children ()</title>
<indexterm zone="fo-area-set-height-from-children"><primary>fo_area_set_height_from_children</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_set_height_from_children    (<link linkend="FoArea">FoArea</link> *parent_area);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent_area</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-clone" role="function">
<title>fo_area_clone ()</title>
<indexterm zone="fo-area-clone"><primary>fo_area_clone</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_clone                       (<link linkend="FoArea">FoArea</link> *original);</programlisting>
<para>
Make a clone of <parameter>original</parameter> and insert the clone after <parameter>original</parameter> in
the area tree.  Set instance properties of the clone to match
<parameter>original</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>original</parameter>&nbsp;:</term>
<listitem><simpara> Area object to be cloned.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Clone of <parameter>original</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-update-after-clone" role="function">
<title>fo_area_update_after_clone ()</title>
<indexterm zone="fo-area-update-after-clone"><primary>fo_area_update_after_clone</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_update_after_clone          (<link linkend="FoArea">FoArea</link> *clone,
                                                         <link linkend="FoArea">FoArea</link> *original);</programlisting>
<para>
Update the instance variables of <parameter>clone</parameter> to match those of <parameter>original</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>clone</parameter>&nbsp;:</term>
<listitem><simpara>    New object cloned from <parameter>original</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>original</parameter>&nbsp;:</term>
<listitem><simpara> Original area object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-split-before-height" role="function">
<title>fo_area_split_before_height ()</title>
<indexterm zone="fo-area-split-before-height"><primary>fo_area_split_before_height</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_split_before_height         (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="gfloat">gfloat</link> height);</programlisting>
<para>
Split <parameter>area</parameter> at or before <parameter>height</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara>   <link linkend="FoArea"><type>FoArea</type></link> to be split
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> Maximum block-progression-dimension of <parameter>area</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The part of <parameter>area</parameter> spit from <parameter>area</parameter>, or NULL if unsplit.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-split-before-height-check" role="function">
<title>fo_area_split_before_height_check ()</title>
<indexterm zone="fo-area-split-before-height-check"><primary>fo_area_split_before_height_check</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_area_split_before_height_check   (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="gfloat">gfloat</link> height);</programlisting>
<para>
Check whether <parameter>area</parameter> can split at or before <parameter>height</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara>   <link linkend="FoArea"><type>FoArea</type></link> to be split
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> Maximum block-progression-dimension of <parameter>area</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if can split, otherwise FALSE.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-resolve-text-align" role="function">
<title>fo_area_resolve_text_align ()</title>
<indexterm zone="fo-area-resolve-text-align"><primary>fo_area_resolve_text_align</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_resolve_text_align          (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Resolves the text alignment value for <parameter>area</parameter> and its descendants.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoArea"><type>FoArea</type></link> for which to resolve text alignment.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoAreaTraverseFunc" role="function">
<title>FoAreaTraverseFunc ()</title>
<indexterm zone="FoAreaTraverseFunc"><primary>FoAreaTraverseFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            (*FoAreaTraverseFunc)               (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoAreaForeachFunc" role="function">
<title>FoAreaForeachFunc ()</title>
<indexterm zone="FoAreaForeachFunc"><primary>FoAreaForeachFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*FoAreaForeachFunc)                (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FO-AREA-IS-ROOT:CAPS" role="macro">
<title>FO_AREA_IS_ROOT()</title>
<indexterm zone="FO-AREA-IS-ROOT:CAPS"><primary>FO_AREA_IS_ROOT</primary></indexterm><programlisting>#define FO_AREA_IS_ROOT(area)    (FO_NODE_IS_ROOT(((FoNode*) (area))))
</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FO-AREA-IS-LEAF:CAPS" role="macro">
<title>FO_AREA_IS_LEAF()</title>
<indexterm zone="FO-AREA-IS-LEAF:CAPS"><primary>FO_AREA_IS_LEAF</primary></indexterm><programlisting>#define FO_AREA_IS_LEAF(area)    (FO_NODE_IS_LEAF(((FoNode*) (area))))
</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-insert" role="function">
<title>fo_area_insert ()</title>
<indexterm zone="fo-area-insert"><primary>fo_area_insert</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_insert                      (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="gint">gint</link> position,
                                                         <link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>position</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-insert-before" role="function">
<title>fo_area_insert_before ()</title>
<indexterm zone="fo-area-insert-before"><primary>fo_area_insert_before</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_insert_before               (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="FoArea">FoArea</link> *sibling,
                                                         <link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sibling</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-insert-after" role="function">
<title>fo_area_insert_after ()</title>
<indexterm zone="fo-area-insert-after"><primary>fo_area_insert_after</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_insert_after                (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="FoArea">FoArea</link> *sibling,
                                                         <link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sibling</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-prepend" role="function">
<title>fo_area_prepend ()</title>
<indexterm zone="fo-area-prepend"><primary>fo_area_prepend</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_prepend                     (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Inserts a <link linkend="FoArea"><type>FoArea</type></link> as the first child of the given parent and
updates the inserted <link linkend="FoArea"><type>FoArea</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="FoArea"><type>FoArea</type></link> to place the new <link linkend="FoArea"><type>FoArea</type></link> under.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="FoArea"><type>FoArea</type></link> to insert.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the inserted <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-n-areas" role="function">
<title>fo_area_n_areas ()</title>
<indexterm zone="fo-area-n-areas"><primary>fo_area_n_areas</primary></indexterm><programlisting><link linkend="guint">guint</link>               fo_area_n_areas                     (<link linkend="FoArea">FoArea</link> *root,
                                                         <link linkend="GTraverseFlags">GTraverseFlags</link> flags);</programlisting>
<para>
Gets the number of nodes in a tree.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>root</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara> which types of children are to be counted, one of
        <link linkend="G-TRAVERSE-ALL:CAPS"><literal>G_TRAVERSE_ALL</literal></link>, <link linkend="G-TRAVERSE-LEAFS:CAPS"><literal>G_TRAVERSE_LEAFS</literal></link> and
        <link linkend="G-TRAVERSE-NON-LEAFS:CAPS"><literal>G_TRAVERSE_NON_LEAFS</literal></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the number of nodes in the tree.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-get-root" role="function">
<title>fo_area_get_root ()</title>
<indexterm zone="fo-area-get-root"><primary>fo_area_get_root</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_get_root                    (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-is-ancestor" role="function">
<title>fo_area_is_ancestor ()</title>
<indexterm zone="fo-area-is-ancestor"><primary>fo_area_is_ancestor</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_area_is_ancestor                 (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="FoArea">FoArea</link> *descendant);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>descendant</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-depth" role="function">
<title>fo_area_depth ()</title>
<indexterm zone="fo-area-depth"><primary>fo_area_depth</primary></indexterm><programlisting><link linkend="guint">guint</link>               fo_area_depth                       (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Gets the depth of a <link linkend="FoArea"><type>FoArea</type></link>.
</para>
<para>
If <parameter>area</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link> 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.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the depth of the <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-append" role="function">
<title>fo_area_append ()</title>
<indexterm zone="fo-area-append"><primary>fo_area_append</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_append                      (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Inserts a <link linkend="FoArea"><type>FoArea</type></link> as the last child of the given parent and updates
the inserted <link linkend="FoArea"><type>FoArea</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="FoArea"><type>FoArea</type></link> to place the new <link linkend="FoArea"><type>FoArea</type></link> under.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="FoArea"><type>FoArea</type></link> to insert.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the inserted <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-traverse" role="function">
<title>fo_area_traverse ()</title>
<indexterm zone="fo-area-traverse"><primary>fo_area_traverse</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_traverse                    (<link linkend="FoArea">FoArea</link> *root,
                                                         <link linkend="GTraverseType">GTraverseType</link> order,
                                                         <link linkend="GTraverseFlags">GTraverseFlags</link> flags,
                                                         <link linkend="gint">gint</link> max_depth,
                                                         <link linkend="FoAreaTraverseFunc">FoAreaTraverseFunc</link> func,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>root</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>order</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max_depth</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-max-height" role="function">
<title>fo_area_max_height ()</title>
<indexterm zone="fo-area-max-height"><primary>fo_area_max_height</primary></indexterm><programlisting><link linkend="guint">guint</link>               fo_area_max_height                  (<link linkend="FoArea">FoArea</link> *root);</programlisting>
<para>
Gets the maximum height of all branches beneath a <link linkend="FoArea"><type>FoArea</type></link>. This is
the maximum distance from the <link linkend="FoArea"><type>FoArea</type></link> to all leaf nodes.
</para>
<para>
If <parameter>root</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, 0 is returned. If <parameter>root</parameter> has no children, 1 is
returned. If <parameter>root</parameter> has children, 2 is returned. And so on.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>root</parameter>&nbsp;:</term>
<listitem><simpara> Root node of a <link linkend="FoArea"><type>FoArea</type></link> tree.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the maximum height of the tree beneath <parameter>root</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-children-foreach" role="function">
<title>fo_area_children_foreach ()</title>
<indexterm zone="fo-area-children-foreach"><primary>fo_area_children_foreach</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_children_foreach            (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="GTraverseFlags">GTraverseFlags</link> flags,
                                                         <link linkend="FoAreaForeachFunc">FoAreaForeachFunc</link> func,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Calls a function for each of the children of a <link linkend="FoArea"><type>FoArea</type></link>. Note that
it doesn't descend beneath the child nodes.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara> which types of children are to be visited, one of
        <link linkend="G-TRAVERSE-ALL:CAPS"><literal>G_TRAVERSE_ALL</literal></link>, <link linkend="G-TRAVERSE-LEAFS:CAPS"><literal>G_TRAVERSE_LEAFS</literal></link> and
        <link linkend="G-TRAVERSE-NON-LEAFS:CAPS"><literal>G_TRAVERSE_NON_LEAFS</literal></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
<listitem><simpara> the function to call for each visited node.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara> user data to pass to the function.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-reverse-children" role="function">
<title>fo_area_reverse_children ()</title>
<indexterm zone="fo-area-reverse-children"><primary>fo_area_reverse_children</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_reverse_children            (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Reverses the order of the children of a <link linkend="FoArea"><type>FoArea</type></link>. (It doesn't change
the order of the grandchildren.)</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-n-children" role="function">
<title>fo_area_n_children ()</title>
<indexterm zone="fo-area-n-children"><primary>fo_area_n_children</primary></indexterm><programlisting><link linkend="guint">guint</link>               fo_area_n_children                  (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Gets the number of children of a <link linkend="FoArea"><type>FoArea</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the number of children of <parameter>area</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-nth-child" role="function">
<title>fo_area_nth_child ()</title>
<indexterm zone="fo-area-nth-child"><primary>fo_area_nth_child</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_nth_child                   (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="guint">guint</link> n);</programlisting>
<para>
Gets a child of a <link linkend="FoArea"><type>FoArea</type></link>, using the given index. The first child
is at index 0. If the index is too big, <link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n</parameter>&nbsp;:</term>
<listitem><simpara> the index of the desired child.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the child of <parameter>area</parameter> at index <parameter>n</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-last-child" role="function">
<title>fo_area_last_child ()</title>
<indexterm zone="fo-area-last-child"><primary>fo_area_last_child</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_last_child                  (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Gets the last child of a <link linkend="FoArea"><type>FoArea</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link> (nust not be <link linkend="NULL:CAPS"><literal>NULL</literal></link>).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the last child of <parameter>area</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>area</parameter> has no
children.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-child-position" role="function">
<title>fo_area_child_position ()</title>
<indexterm zone="fo-area-child-position"><primary>fo_area_child_position</primary></indexterm><programlisting><link linkend="guint">guint</link>               fo_area_child_position              (<link linkend="FoArea">FoArea</link> *area,
                                                         <link linkend="FoArea">FoArea</link> *child);</programlisting>
<para>
Gets the position of a <link linkend="FoArea"><type>FoArea</type></link> with respect to its siblings. <parameter>child</parameter>
must be a child of <parameter>area</parameter>. The first child is numbered 0, the second
1, and so on.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child</parameter>&nbsp;:</term>
<listitem><simpara> a child of <parameter>area</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the position of <parameter>child</parameter> with respect to its siblings.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-first-sibling" role="function">
<title>fo_area_first_sibling ()</title>
<indexterm zone="fo-area-first-sibling"><primary>fo_area_first_sibling</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_first_sibling               (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Gets the first sibling of a <link linkend="FoArea"><type>FoArea</type></link>. This could possibly be the
node itself.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the first sibling of <parameter>area</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-last-sibling" role="function">
<title>fo_area_last_sibling ()</title>
<indexterm zone="fo-area-last-sibling"><primary>fo_area_last_sibling</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_last_sibling                (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Gets the last sibling of a <link linkend="FoArea"><type>FoArea</type></link>. This could possibly be the node
itself.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the last sibling of <parameter>area</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-prev-sibling" role="function">
<title>fo_area_prev_sibling ()</title>
<indexterm zone="fo-area-prev-sibling"><primary>fo_area_prev_sibling</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_prev_sibling                (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Gets the previous sibling of a <link linkend="FoArea"><type>FoArea</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the previous sibling of <parameter>area</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>area</parameter> is
<link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-next-sibling" role="function">
<title>fo_area_next_sibling ()</title>
<indexterm zone="fo-area-next-sibling"><primary>fo_area_next_sibling</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_next_sibling                (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Gets the next sibling of a <link linkend="FoArea"><type>FoArea</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the next sibling of <parameter>area</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>area</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-first-child" role="function">
<title>fo_area_first_child ()</title>
<indexterm zone="fo-area-first-child"><primary>fo_area_first_child</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_first_child                 (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Gets the first child of a <link linkend="FoArea"><type>FoArea</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the first child of <parameter>area</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>area</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link> or
has no children.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-parent" role="function">
<title>fo_area_parent ()</title>
<indexterm zone="fo-area-parent"><primary>fo_area_parent</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_parent                      (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Gets the parent of a <link linkend="FoArea"><type>FoArea</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the parent of <parameter>area</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>area</parameter> is the root of
the tree.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-unlink" role="function">
<title>fo_area_unlink ()</title>
<indexterm zone="fo-area-unlink"><primary>fo_area_unlink</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_unlink                      (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Unlinks an <link linkend="FoArea"><type>FoArea</type></link> from an <link linkend="FoArea"><type>FoArea</type></link> tree, resulting in two separate
trees.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="FoArea"><type>FoArea</type></link> to unlink, which becomes the root of a new tree.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-unlink-with-next-siblings" role="function">
<title>fo_area_unlink_with_next_siblings ()</title>
<indexterm zone="fo-area-unlink-with-next-siblings"><primary>fo_area_unlink_with_next_siblings</primary></indexterm><programlisting><link linkend="void">void</link>                fo_area_unlink_with_next_siblings   (<link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Unlinks <parameter>area</parameter> and its following siblings.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara> First <link linkend="FoArea"><type>FoArea</type></link> to unlink.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-insert-with-next-siblings" role="function">
<title>fo_area_insert_with_next_siblings ()</title>
<indexterm zone="fo-area-insert-with-next-siblings"><primary>fo_area_insert_with_next_siblings</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_area_insert_with_next_siblings   (<link linkend="FoArea">FoArea</link> *parent,
                                                         <link linkend="gint">gint</link> position,
                                                         <link linkend="FoArea">FoArea</link> *area);</programlisting>
<para>
Implements fo_node_insert_with_next_siblings for <link linkend="FoArea"><type>FoArea</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara>   <link linkend="FoArea"><type>FoArea</type></link> to be parent of <parameter>area</parameter> and its siblings.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>position</parameter>&nbsp;:</term>
<listitem><simpara> Offset at which to insert <parameter>area</parameter> and its siblings.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
<listitem><simpara>     <link linkend="FoArea"><type>FoArea</type></link>, possibly with following siblings.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <parameter>parent</parameter> with <parameter>area</parameter> and siblings inserted.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="FoArea.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoArea--available-height"><title>The <literal>&quot;available-height&quot;</literal> property</title>
<indexterm zone="FoArea--available-height"><primary>FoArea:available-height</primary></indexterm><programlisting>  &quot;available-height&quot;         <link linkend="gfloat">gfloat</link>                : Read / Write</programlisting>
<para>Height available to child areas.</para><para>Default value: 0</para>
</refsect2>
<refsect2 id="FoArea--available-width"><title>The <literal>&quot;available-width&quot;</literal> property</title>
<indexterm zone="FoArea--available-width"><primary>FoArea:available-width</primary></indexterm><programlisting>  &quot;available-width&quot;          <link linkend="gfloat">gfloat</link>                : Read / Write</programlisting>
<para>Width available to child areas.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="FoArea--child-available-bpdim"><title>The <literal>&quot;child-available-bpdim&quot;</literal> property</title>
<indexterm zone="FoArea--child-available-bpdim"><primary>FoArea:child-available-bpdim</primary></indexterm><programlisting>  &quot;child-available-bpdim&quot;    <link linkend="gfloat">gfloat</link>                : Read / Write</programlisting>
<para>Block-progression-dimension available to child areas.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="FoArea--child-available-ipdim"><title>The <literal>&quot;child-available-ipdim&quot;</literal> property</title>
<indexterm zone="FoArea--child-available-ipdim"><primary>FoArea:child-available-ipdim</primary></indexterm><programlisting>  &quot;child-available-ipdim&quot;    <link linkend="gfloat">gfloat</link>                : Read / Write</programlisting>
<para>Inline-progression-dimension available to child areas.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="FoArea--generated-by"><title>The <literal>&quot;generated-by&quot;</literal> property</title>
<indexterm zone="FoArea--generated-by"><primary>FoArea:generated-by</primary></indexterm><programlisting>  &quot;generated-by&quot;             <link linkend="FoFo">FoFo</link>*                 : Read / Write</programlisting>
<para>Formatting object that generated this area.</para></refsect2>
<refsect2 id="FoArea--is-first"><title>The <literal>&quot;is-first&quot;</literal> property</title>
<indexterm zone="FoArea--is-first"><primary>FoArea:is-first</primary></indexterm><programlisting>  &quot;is-first&quot;                 <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>Is this the first area produced by the formatting object?.</para><para>Default value: TRUE</para>
</refsect2>
<refsect2 id="FoArea--is-last"><title>The <literal>&quot;is-last&quot;</literal> property</title>
<indexterm zone="FoArea--is-last"><primary>FoArea:is-last</primary></indexterm><programlisting>  &quot;is-last&quot;                  <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>Is this the last area produced by the formatting object?.</para><para>Default value: TRUE</para>
</refsect2>
<refsect2 id="FoArea--next-x"><title>The <literal>&quot;next-x&quot;</literal> property</title>
<indexterm zone="FoArea--next-x"><primary>FoArea:next-x</primary></indexterm><programlisting>  &quot;next-x&quot;                   <link linkend="gfloat">gfloat</link>                : Read / Write</programlisting>
<para>x-coordinate of next child area.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="FoArea--next-y"><title>The <literal>&quot;next-y&quot;</literal> property</title>
<indexterm zone="FoArea--next-y"><primary>FoArea:next-y</primary></indexterm><programlisting>  &quot;next-y&quot;                   <link linkend="gfloat">gfloat</link>                : Read / Write</programlisting>
<para>y-coordinate of next child area.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="FoArea--page"><title>The <literal>&quot;page&quot;</literal> property</title>
<indexterm zone="FoArea--page"><primary>FoArea:page</primary></indexterm><programlisting>  &quot;page&quot;                     <link linkend="FoArea">FoArea</link>*               : Read</programlisting>
<para>Ancestor FoAreaPage node in the area tree.</para></refsect2>
<refsect2 id="FoArea--page-sequence"><title>The <literal>&quot;page-sequence&quot;</literal> property</title>
<indexterm zone="FoArea--page-sequence"><primary>FoArea:page-sequence</primary></indexterm><programlisting>  &quot;page-sequence&quot;            <link linkend="FoFo">FoFo</link>*                 : Read / Write</programlisting>
<para>Ancestor fo:page_sequence node in the formatting object tree.</para></refsect2>

</refsect1>




</refentry>