File: fo-fo.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 (715 lines) | stat: -rw-r--r-- 48,045 bytes
parent folder | download | duplicates (4)
<refentry id="FoFo">
<refmeta>
<refentrytitle role="top_of_page" id="FoFo.top_of_page">FoFo</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>

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

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

<synopsis>
                    <link linkend="FoFo-struct">FoFo</link>;
                    <link linkend="FoFoClass">FoFoClass</link>;
#define             <link linkend="FO-FO-ERROR:CAPS">FO_FO_ERROR</link>
<link linkend="GQuark">GQuark</link>              <link linkend="fo-fo-error-quark">fo_fo_error_quark</link>                   (void);
enum                <link linkend="FoFoError">FoFoError</link>;
                    <link linkend="FoFoAreaNew2Context">FoFoAreaNew2Context</link>;
                    <link linkend="FoFoAreaIterator">FoFoAreaIterator</link>;
<link linkend="FoFo">FoFo</link>*               <link linkend="fo-fo-new">fo_fo_new</link>                           (void);
<link linkend="void">void</link>                <link linkend="fo-fo-debug-dump-properties">fo_fo_debug_dump_properties</link>         (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="gint">gint</link> depth);
<link linkend="void">void</link>                <link linkend="fo-fo-set-context">fo_fo_set_context</link>                   (<link linkend="FoFo">FoFo</link> *fo_fo,
                                                         <link linkend="FoContext">FoContext</link> *new_context);
<link linkend="FoContext">FoContext</link>*          <link linkend="fo-fo-get-context">fo_fo_get_context</link>                   (<link linkend="FoFo">FoFo</link> *fo_fo);
<link linkend="void">void</link>                <link linkend="fo-fo-update-from-context">fo_fo_update_from_context</link>           (<link linkend="FoFo">FoFo</link> *fo_fo,
                                                         <link linkend="FoContext">FoContext</link> *context);
<link linkend="FoFo">FoFo</link>*               <link linkend="fo-fo-get-flow">fo_fo_get_flow</link>                      (<link linkend="FoFo">FoFo</link> *fo_fo);
<link linkend="FoFo">FoFo</link>*               <link linkend="fo-fo-get-tree">fo_fo_get_tree</link>                      (<link linkend="FoFo">FoFo</link> *fo_fo);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-fo-get-generate-reference-area">fo_fo_get_generate_reference_area</link>   (<link linkend="FoFo">FoFo</link> *fo_fo);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-fo-get-allow-mixed-content">fo_fo_get_allow_mixed_content</link>       (<link linkend="FoFo">FoFo</link> *fo_fo);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-fo-validate-content">fo_fo_validate_content</link>              (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-fo-resolve-property-attributes">fo_fo_resolve_property_attributes</link>   (<link linkend="FoNode">FoNode</link> *fo_node,
                                                         <link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link>                <link linkend="fo-fo-children-properties-resolve">fo_fo_children_properties_resolve</link>   (<link linkend="FoFo">FoFo</link> *this_fo,
                                                         <link linkend="FoArea">FoArea</link> *this_fo_parent_area,
                                                         <link linkend="FoArea">FoArea</link> **new_area,
                                                         <link linkend="GHashTable">GHashTable</link> *prop_eval_hash,
                                                         <link linkend="FoDoc">FoDoc</link> *fo_doc,
                                                         <link linkend="gboolean">gboolean</link> continue_after_error,
                                                         <link linkend="FoDebugFlag">FoDebugFlag</link> debug_level,
                                                         <link linkend="FoWarningFlag">FoWarningFlag</link> warning_mode,
                                                         <link linkend="GError">GError</link> **error);
<link linkend="void">void</link>                <link linkend="fo-fo-validate">fo_fo_validate</link>                      (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="FoContext">FoContext</link> *current_context,
                                                         <link linkend="FoContext">FoContext</link> *parent_context,
                                                         <link linkend="GError">GError</link> **error);
<link linkend="FoFo">FoFo</link>*               <link linkend="fo-fo-clone">fo_fo_clone</link>                         (<link linkend="FoFo">FoFo</link> *original);
<link linkend="void">void</link>                <link linkend="fo-fo-area-new">fo_fo_area_new</link>                      (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="FoDoc">FoDoc</link> *fo_doc,
                                                         <link linkend="FoArea">FoArea</link> *parent_area,
                                                         <link linkend="FoArea">FoArea</link> **new_area,
                                                         <link linkend="guint">guint</link> debug_level);
<link linkend="void">void</link>                <link linkend="fo-fo-area-new2">fo_fo_area_new2</link>                     (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="FoFoAreaNew2Context">FoFoAreaNew2Context</link> *context,
                                                         <link linkend="GError">GError</link> **error);
<link linkend="void">void</link>                <link linkend="fo-fo-trim-whitespace-children">fo_fo_trim_whitespace_children</link>      (<link linkend="FoFo">FoFo</link> *fo);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-fo-validate-content-empty">fo_fo_validate_content_empty</link>        (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-fo-validate-content-block-plus">fo_fo_validate_content_block_plus</link>   (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="GError">GError</link> **error);
<link linkend="void">void</link>                <link linkend="fo-fo-validate-pcdata-or-inline">fo_fo_validate_pcdata_or_inline</link>     (<link linkend="FoNode">FoNode</link> *fo_node,
                                                         <link linkend="gboolean">gboolean</link> *is_not_pcdata_inline);
<link linkend="void">void</link>                <link linkend="fo-fo-validate-block-or-whitespace">fo_fo_validate_block_or_whitespace</link>  (<link linkend="FoNode">FoNode</link> *fo_node,
                                                         <link linkend="gboolean">gboolean</link> *is_not_block_or_whitespace);
<link linkend="void">void</link>                <link linkend="fo-fo-validate-pcdata-inline-block-neutral">fo_fo_validate_pcdata_inline_block_neutral</link>
                                                        (<link linkend="FoNode">FoNode</link> *fo_node,
                                                         <link linkend="gpointer">gpointer</link> data);
<link linkend="FoFoAreaIterator">FoFoAreaIterator</link>*   <link linkend="fo-fo-get-area-iterator">fo_fo_get_area_iterator</link>             (<link linkend="FoFo">FoFo</link> *fo);
<link linkend="FoArea">FoArea</link>*             <link linkend="fo-fo-area-iterator-get-area">fo_fo_area_iterator_get_area</link>        (const <link linkend="FoFoAreaIterator">FoFoAreaIterator</link> *iterator);
<link linkend="gboolean">gboolean</link>            <link linkend="fo-fo-area-iterator-next">fo_fo_area_iterator_next</link>            (<link linkend="FoFoAreaIterator">FoFoAreaIterator</link> *iterator);
</synopsis>
</refsynopsisdiv>

<refsect1 id="FoFo.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>
               +----FoFo
                     +----<link linkend="FoMarkerParent">FoMarkerParent</link>
                     +----<link linkend="FoCharacter">FoCharacter</link>
                     +----<link linkend="FoColorProfile">FoColorProfile</link>
                     +----<link linkend="FoConditionalPageMasterReference">FoConditionalPageMasterReference</link>
                     +----<link linkend="FoDeclarations">FoDeclarations</link>
                     +----<link linkend="FoExternalGraphic">FoExternalGraphic</link>
                     +----<link linkend="FoFloat">FoFloat</link>
                     +----<link linkend="FoFlow">FoFlow</link>
                     +----<link linkend="FoFootnoteBody">FoFootnoteBody</link>
                     +----<link linkend="FoFootnote">FoFootnote</link>
                     +----<link linkend="FoInitialPropertySet">FoInitialPropertySet</link>
                     +----<link linkend="FoInstreamForeignObject">FoInstreamForeignObject</link>
                     +----<link linkend="FoLayoutMasterSet">FoLayoutMasterSet</link>
                     +----<link linkend="FoLeader">FoLeader</link>
                     +----<link linkend="FoMarker">FoMarker</link>
                     +----<link linkend="FoMultiCase">FoMultiCase</link>
                     +----<link linkend="FoMultiProperties">FoMultiProperties</link>
                     +----<link linkend="FoMultiPropertySet">FoMultiPropertySet</link>
                     +----<link linkend="FoMultiSwitch">FoMultiSwitch</link>
                     +----<link linkend="FoMultiToggle">FoMultiToggle</link>
                     +----<link linkend="FoPageNumberCitation">FoPageNumberCitation</link>
                     +----<link linkend="FoPageNumber">FoPageNumber</link>
                     +----<link linkend="FoPageSequence">FoPageSequence</link>
                     +----<link linkend="FoPageSequenceMaster">FoPageSequenceMaster</link>
                     +----<link linkend="FoRegionAfter">FoRegionAfter</link>
                     +----<link linkend="FoRegionBefore">FoRegionBefore</link>
                     +----<link linkend="FoRegionBody">FoRegionBody</link>
                     +----<link linkend="FoRegionEnd">FoRegionEnd</link>
                     +----<link linkend="FoRegionStart">FoRegionStart</link>
                     +----<link linkend="FoRepeatablePageMasterAlternatives">FoRepeatablePageMasterAlternatives</link>
                     +----<link linkend="FoRepeatablePageMasterReference">FoRepeatablePageMasterReference</link>
                     +----<link linkend="FoRetrieveMarker">FoRetrieveMarker</link>
                     +----<link linkend="FoRoot">FoRoot</link>
                     +----<link linkend="FoSimplePageMaster">FoSimplePageMaster</link>
                     +----<link linkend="FoSinglePageMasterReference">FoSinglePageMasterReference</link>
                     +----<link linkend="FoStaticContent">FoStaticContent</link>
                     +----<link linkend="FoTableColumn">FoTableColumn</link>
                     +----<link linkend="FoTableRow">FoTableRow</link>
                     +----<link linkend="FoText">FoText</link>
                     +----<link linkend="FoTitle">FoTitle</link>
                     +----<link linkend="FoTree">FoTree</link>
</synopsis>

</refsect1>


<refsect1 id="FoFo.derived-interfaces" role="derived_interfaces">
<title role="derived_interfaces.title">Known Derived Interfaces</title>
<para>
FoFo is required by
 <link linkend="FoInlineFoIface">FoInlineFoIface</link>,  <link linkend="FoTableBorderFoIface">FoTableBorderFoIface</link> and  <link linkend="FoBlockFoIface">FoBlockFoIface</link>.</para>

</refsect1>



<refsect1 id="FoFo.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="FoFo--allow-mixed-content">allow-mixed-content</link>&quot;      <link linkend="gboolean">gboolean</link>              : Read
  &quot;<link linkend="FoFo--context">context</link>&quot;                  <link linkend="FoContext">FoContext</link>*            : Read
  &quot;<link linkend="FoFo--flow">flow</link>&quot;                     <link linkend="FoFo">FoFo</link>*                 : Read
  &quot;<link linkend="FoFo--generate-reference-area">generate-reference-area</link>&quot;  <link linkend="gboolean">gboolean</link>              : Read
  &quot;<link linkend="FoFo--tree">tree</link>&quot;                     <link linkend="FoFo">FoFo</link>*                 : Read
</synopsis>
</refsect1>



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

</para>
</refsect1>

<refsect1 id="FoFo.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoFo-struct" role="struct">
<title>FoFo</title>
<indexterm zone="FoFo-struct"><primary>FoFo</primary></indexterm><programlisting>typedef struct _FoFo FoFo;</programlisting>
<para>

</para></refsect2>
<refsect2 id="FoFoClass" role="struct">
<title>FoFoClass</title>
<indexterm zone="FoFoClass"><primary>FoFoClass</primary></indexterm><programlisting>typedef struct _FoFoClass FoFoClass;</programlisting>
<para>

</para></refsect2>
<refsect2 id="FO-FO-ERROR:CAPS" role="macro">
<title>FO_FO_ERROR</title>
<indexterm zone="FO-FO-ERROR:CAPS"><primary>FO_FO_ERROR</primary></indexterm><programlisting>#define FO_FO_ERROR (fo_fo_error_quark ())
</programlisting>
<para>

</para></refsect2>
<refsect2 id="fo-fo-error-quark" role="function">
<title>fo_fo_error_quark ()</title>
<indexterm zone="fo-fo-error-quark"><primary>fo_fo_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>              fo_fo_error_quark                   (void);</programlisting>
<para>
Gets the <link linkend="GQuark"><type>GQuark</type></link> identifying <link linkend="FoFo"><type>FoFo</type></link> errors.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="GQuark"><type>GQuark</type></link> identifying <link linkend="FoFo"><type>FoFo</type></link> errors.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoFoError" role="enum">
<title>enum FoFoError</title>
<indexterm zone="FoFoError"><primary>FoFoError</primary></indexterm><programlisting>typedef enum
{
  FO_FO_ERROR_FAILED,            /* Generic error code */
  FO_FO_ERROR_WARNING,	         /* Non-fatal error */
  FO_FO_ERROR_EMPTY,             /* FO should not be empty */
  FO_FO_ERROR_NOT_EMPTY,         /* FO should be empty */
  FO_FO_ERROR_NOT_BLOCK,         /* FO should contain (%block;)+ */
  FO_FO_ERROR_INVALID_CHILD,     /* FO not allowed as child of parent FO */
  FO_FO_ERROR_INVALID_CONTENT,   /* FO content does not match content model */
  FO_FO_ERROR_ENUMERATION_TOKEN, /* Unrecognised enumeration token */
  FO_FO_ERROR_DATATYPE,          /* Invalid datatype value for property */
  FO_FO_ERROR_DATATYPE_REPLACE,  /* Invalid datatype value for property replaced */
  FO_FO_ERROR_DATATYPE_NULL,     /* Invalid datatype value for property: NULL */
  FO_FO_ERROR_UNSUPPORTED_PROPERTY,	/* Unsupported property */
  FO_FO_ERROR_NO_IMAGE,		 /* No image */
  FO_FO_ERROR_LAST
} FoFoError;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="FoFoAreaNew2Context" role="struct">
<title>FoFoAreaNew2Context</title>
<indexterm zone="FoFoAreaNew2Context"><primary>FoFoAreaNew2Context</primary></indexterm><programlisting>typedef struct {
  FoDoc        *fo_doc;
  FoArea       *parent_area;
  FoArea      **new_area;
  gboolean      continue_after_error;
  FoDebugFlag   debug_level;
  FoWarningFlag warning_mode;
} FoFoAreaNew2Context;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="FoFoAreaIterator" role="struct">
<title>FoFoAreaIterator</title>
<indexterm zone="FoFoAreaIterator"><primary>FoFoAreaIterator</primary></indexterm><programlisting>typedef struct _FoFoAreaIterator FoFoAreaIterator;</programlisting>
<para>

</para></refsect2>
<refsect2 id="fo-fo-new" role="function">
<title>fo_fo_new ()</title>
<indexterm zone="fo-fo-new"><primary>fo_fo_new</primary></indexterm><programlisting><link linkend="FoFo">FoFo</link>*               fo_fo_new                           (void);</programlisting>
<para>
Creates a new <link linkend="FoFo"><type>FoFo</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="FoFo"><type>FoFo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-debug-dump-properties" role="function">
<title>fo_fo_debug_dump_properties ()</title>
<indexterm zone="fo-fo-debug-dump-properties"><primary>fo_fo_debug_dump_properties</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_debug_dump_properties         (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="gint">gint</link> depth);</programlisting>
<para>
Log debug messages for most of the instance variables and some of
the class variables of <parameter>fo</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo</parameter>&nbsp;:</term>
<listitem><simpara>    <link linkend="FoFo"><type>FoFo</type></link> whose properties to dump
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter>&nbsp;:</term>
<listitem><simpara> Indication of relative depth to be applied to the output.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-set-context" role="function">
<title>fo_fo_set_context ()</title>
<indexterm zone="fo-fo-set-context"><primary>fo_fo_set_context</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_set_context                   (<link linkend="FoFo">FoFo</link> *fo_fo,
                                                         <link linkend="FoContext">FoContext</link> *new_context);</programlisting>
<para>
Sets the <link linkend="context"><type>context</type></link> of <parameter>fo_fo</parameter> to <parameter>new_context</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_fo</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="FoFo"><type>FoFo</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_context</parameter>&nbsp;:</term>
<listitem><simpara> The new context
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-get-context" role="function">
<title>fo_fo_get_context ()</title>
<indexterm zone="fo-fo-get-context"><primary>fo_fo_get_context</primary></indexterm><programlisting><link linkend="FoContext">FoContext</link>*          fo_fo_get_context                   (<link linkend="FoFo">FoFo</link> *fo_fo);</programlisting>
<para>
Gets the "context" of <parameter>fo_fo</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_fo</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="FoFo"><type>FoFo</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The context
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-update-from-context" role="function">
<title>fo_fo_update_from_context ()</title>
<indexterm zone="fo-fo-update-from-context"><primary>fo_fo_update_from_context</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_update_from_context           (<link linkend="FoFo">FoFo</link> *fo_fo,
                                                         <link linkend="FoContext">FoContext</link> *context);</programlisting>
<para>
Calls the FoFo-specific <link linkend="update-from-context"><function>_update_from_context()</function></link> function to update
the FoFo's property values from the larger set of property values
maintained in the <link linkend="FoContext"><type>FoContext</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_fo</parameter>&nbsp;:</term>
<listitem><simpara>   <link linkend="FoFo"><type>FoFo</type></link> to be updated
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoContext"><type>FoContext</type></link> from which to update the <link linkend="FoFo"><type>FoFo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-get-flow" role="function">
<title>fo_fo_get_flow ()</title>
<indexterm zone="fo-fo-get-flow"><primary>fo_fo_get_flow</primary></indexterm><programlisting><link linkend="FoFo">FoFo</link>*               fo_fo_get_flow                      (<link linkend="FoFo">FoFo</link> *fo_fo);</programlisting>
<para>
Gets the <link linkend="flow"><type>flow</type></link> of <parameter>fo_fo</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_fo</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoFo</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The flow
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-get-tree" role="function">
<title>fo_fo_get_tree ()</title>
<indexterm zone="fo-fo-get-tree"><primary>fo_fo_get_tree</primary></indexterm><programlisting><link linkend="FoFo">FoFo</link>*               fo_fo_get_tree                      (<link linkend="FoFo">FoFo</link> *fo_fo);</programlisting>
<para>
Gets the tree of <parameter>fo_fo</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_fo</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoFo</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The tree
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-get-generate-reference-area" role="function">
<title>fo_fo_get_generate_reference_area ()</title>
<indexterm zone="fo-fo-get-generate-reference-area"><primary>fo_fo_get_generate_reference_area</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_fo_get_generate_reference_area   (<link linkend="FoFo">FoFo</link> *fo_fo);</programlisting>
<para>
Gets whether or not the FO generates reference areas.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_fo</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoFo</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The generate-reference-area class property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-get-allow-mixed-content" role="function">
<title>fo_fo_get_allow_mixed_content ()</title>
<indexterm zone="fo-fo-get-allow-mixed-content"><primary>fo_fo_get_allow_mixed_content</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_fo_get_allow_mixed_content       (<link linkend="FoFo">FoFo</link> *fo_fo);</programlisting>
<para>
Gets whether or not the FO allows mixed content (i.e. text nodes).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_fo</parameter>&nbsp;:</term>
<listitem><simpara> The <parameter>FoFo</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The allow_mixed_content class property value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-validate-content" role="function">
<title>fo_fo_validate_content ()</title>
<indexterm zone="fo-fo-validate-content"><primary>fo_fo_validate_content</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_fo_validate_content              (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="GError">GError</link> **error);</programlisting>
<para>
Calls the FoFo-specific <link linkend="validate-content"><function>_validate_content()</function></link> function to validate
the FoFo's content model and returns the value returned by that
function.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo</parameter>&nbsp;:</term>
<listitem><simpara>    FoFo whose content is to be validated
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> GError
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> FALSE if no content model error, otherwise TRUE
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-resolve-property-attributes" role="function">
<title>fo_fo_resolve_property_attributes ()</title>
<indexterm zone="fo-fo-resolve-property-attributes"><primary>fo_fo_resolve_property_attributes</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_fo_resolve_property_attributes   (<link linkend="FoNode">FoNode</link> *fo_node,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Resolves the values of the properties of <parameter>fo_node</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_node</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoNode"><type>FoNode</type></link> for which to resolve property attributes.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara>    Context in which to resolve the properties.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if an error occurred, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-children-properties-resolve" role="function">
<title>fo_fo_children_properties_resolve ()</title>
<indexterm zone="fo-fo-children-properties-resolve"><primary>fo_fo_children_properties_resolve</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_children_properties_resolve   (<link linkend="FoFo">FoFo</link> *this_fo,
                                                         <link linkend="FoArea">FoArea</link> *this_fo_parent_area,
                                                         <link linkend="FoArea">FoArea</link> **new_area,
                                                         <link linkend="GHashTable">GHashTable</link> *prop_eval_hash,
                                                         <link linkend="FoDoc">FoDoc</link> *fo_doc,
                                                         <link linkend="gboolean">gboolean</link> continue_after_error,
                                                         <link linkend="FoDebugFlag">FoDebugFlag</link> debug_level,
                                                         <link linkend="FoWarningFlag">FoWarningFlag</link> warning_mode,
                                                         <link linkend="GError">GError</link> **error);</programlisting>
<para>
Resolves the properties of the children of <parameter>this_fo</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>this_fo</parameter>&nbsp;:</term>
<listitem><simpara>              <link linkend="FoFo"><type>FoFo</type></link> for which to resolve properties.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>this_fo_parent_area</parameter>&nbsp;:</term>
<listitem><simpara>  Parent <link linkend="FoArea"><type>FoArea</type></link> to which to add new areas.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_area</parameter>&nbsp;:</term>
<listitem><simpara>             New area, if any.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prop_eval_hash</parameter>&nbsp;:</term>
<listitem><simpara>       Map of property names to property eval functions.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fo_doc</parameter>&nbsp;:</term>
<listitem><simpara>               Output <link linkend="FoDoc"><type>FoDoc</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>continue_after_error</parameter>&nbsp;:</term>
<listitem><simpara> Whether to continue after any formatting errors.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>debug_level</parameter>&nbsp;:</term>
<listitem><simpara>          Debug level.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>warning_mode</parameter>&nbsp;:</term>
<listitem><simpara>         Warning mode.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara>                Indication of any error that occurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-validate" role="function">
<title>fo_fo_validate ()</title>
<indexterm zone="fo-fo-validate"><primary>fo_fo_validate</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_validate                      (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="FoContext">FoContext</link> *current_context,
                                                         <link linkend="FoContext">FoContext</link> *parent_context,
                                                         <link linkend="GError">GError</link> **error);</programlisting>
<para>
Validate and/or munge the properties of <parameter>fo</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo</parameter>&nbsp;:</term>
<listitem><simpara>              <link linkend="FoFo"><type>FoFo</type></link> to validate.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>current_context</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoContext"><type>FoContext</type></link> of <parameter>fo</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent_context</parameter>&nbsp;:</term>
<listitem><simpara>  <link linkend="FoContext"><type>FoContext</type></link> of parent of <parameter>fo</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara>           <link linkend="GError"><type>GError</type></link> indicating any error that occurs
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-clone" role="function">
<title>fo_fo_clone ()</title>
<indexterm zone="fo-fo-clone"><primary>fo_fo_clone</primary></indexterm><programlisting><link linkend="FoFo">FoFo</link>*               fo_fo_clone                         (<link linkend="FoFo">FoFo</link> *original);</programlisting>
<para>
Make a clone of <parameter>original</parameter> and insert the clone after <parameter>original</parameter> in
the fo 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> Fo 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-fo-area-new" role="function" condition="deprecated:Use #fo_fo_area_new2 in new code.">
<title>fo_fo_area_new ()</title>
<indexterm zone="fo-fo-area-new" role="deprecated"><primary>fo_fo_area_new</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_area_new                      (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="FoDoc">FoDoc</link> *fo_doc,
                                                         <link linkend="FoArea">FoArea</link> *parent_area,
                                                         <link linkend="FoArea">FoArea</link> **new_area,
                                                         <link linkend="guint">guint</link> debug_level);</programlisting>
<warning><para><literal>fo_fo_area_new</literal> is deprecated and should not be used in newly-written code. Use <link linkend="fo-fo-area-new2"><type>fo_fo_area_new2</type></link> in new code.</para></warning>
<para>
Creates a new <link linkend="FoArea"><type>FoArea</type></link> for <parameter>fo</parameter> and adds it as the last child of
<parameter>parent_area</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo</parameter>&nbsp;:</term>
<listitem><simpara>          <link linkend="FoFo"><type>FoFo</type></link> for which to create a new area.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fo_doc</parameter>&nbsp;:</term>
<listitem><simpara>      Output <link linkend="FoDoc"><type>FoDoc</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent_area</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoArea"><type>FoArea</type></link> to which to add new area.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_area</parameter>&nbsp;:</term>
<listitem><simpara>    New area.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>debug_level</parameter>&nbsp;:</term>
<listitem><simpara> Debug level.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-area-new2" role="function">
<title>fo_fo_area_new2 ()</title>
<indexterm zone="fo-fo-area-new2"><primary>fo_fo_area_new2</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_area_new2                     (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="FoFoAreaNew2Context">FoFoAreaNew2Context</link> *context,
                                                         <link linkend="GError">GError</link> **error);</programlisting>
<para>
Creates a new <link linkend="FoArea"><type>FoArea</type></link> corresponding to <parameter>fo</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo</parameter>&nbsp;:</term>
<listitem><simpara>      <link linkend="FoFo"><type>FoFo</type></link> for which to create area.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
<listitem><simpara> Context in which to create area.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara>   Indication of any error that occurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-trim-whitespace-children" role="function">
<title>fo_fo_trim_whitespace_children ()</title>
<indexterm zone="fo-fo-trim-whitespace-children"><primary>fo_fo_trim_whitespace_children</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_trim_whitespace_children      (<link linkend="FoFo">FoFo</link> *fo);</programlisting>
<para>
Remove any "whitespace" children of <parameter>fo</parameter>. I.e., unlink and unref any
children that are FoText that contain only whitespace or are
FoWrapperWhitespace nodes.
</para>
<para>
Leaves <parameter>fo</parameter> with no "whitespace" children.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoFo"><type>FoFo</type></link> to trim
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-validate-content-empty" role="function">
<title>fo_fo_validate_content_empty ()</title>
<indexterm zone="fo-fo-validate-content-empty"><primary>fo_fo_validate_content_empty</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_fo_validate_content_empty        (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="GError">GError</link> **error);</programlisting>
<para>
Validates that <parameter>fo</parameter> does not contain any child <link linkend="FoFo"><type>FoFo</type></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo</parameter>&nbsp;:</term>
<listitem><simpara>    <link linkend="FoFo"><type>FoFo</type></link> to validate.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GError"><type>GError</type></link> indicating any error.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if <parameter>fo</parameter> is empty.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-validate-content-block-plus" role="function">
<title>fo_fo_validate_content_block_plus ()</title>
<indexterm zone="fo-fo-validate-content-block-plus"><primary>fo_fo_validate_content_block_plus</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_fo_validate_content_block_plus   (<link linkend="FoFo">FoFo</link> *fo,
                                                         <link linkend="GError">GError</link> **error);</programlisting>
<para>
Validates the <parameter>fo</parameter> contains one or more <link linkend="FoBlockFo"><type>FoBlockFo</type></link> formatting objects.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo</parameter>&nbsp;:</term>
<listitem><simpara>    <link linkend="FoFo"><type>FoFo</type></link> to validate.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GError"><type>GError</type></link> indicating any error.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if content matches.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-validate-pcdata-or-inline" role="function">
<title>fo_fo_validate_pcdata_or_inline ()</title>
<indexterm zone="fo-fo-validate-pcdata-or-inline"><primary>fo_fo_validate_pcdata_or_inline</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_validate_pcdata_or_inline     (<link linkend="FoNode">FoNode</link> *fo_node,
                                                         <link linkend="gboolean">gboolean</link> *is_not_pcdata_inline);</programlisting>
<para>

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


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-validate-block-or-whitespace" role="function">
<title>fo_fo_validate_block_or_whitespace ()</title>
<indexterm zone="fo-fo-validate-block-or-whitespace"><primary>fo_fo_validate_block_or_whitespace</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_validate_block_or_whitespace  (<link linkend="FoNode">FoNode</link> *fo_node,
                                                         <link linkend="gboolean">gboolean</link> *is_not_block_or_whitespace);</programlisting>
<para>

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


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-validate-pcdata-inline-block-neutral" role="function">
<title>fo_fo_validate_pcdata_inline_block_neutral ()</title>
<indexterm zone="fo-fo-validate-pcdata-inline-block-neutral"><primary>fo_fo_validate_pcdata_inline_block_neutral</primary></indexterm><programlisting><link linkend="void">void</link>                fo_fo_validate_pcdata_inline_block_neutral
                                                        (<link linkend="FoNode">FoNode</link> *fo_node,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Validates that the content of <parameter>fo_node</parameter> is only #<link linkend="PCDATA:CAPS"><type>PCDATA</type></link> or <link linkend="FoInline"><type>FoInline</type></link> or
<link linkend="FoNeutral"><type>FoNeutral</type></link> formatting objects.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo_node</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoFo"><type>FoFo</type></link> to validate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara>    Pointer to <link linkend="gboolean"><type>gboolean</type></link> storing result
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-get-area-iterator" role="function">
<title>fo_fo_get_area_iterator ()</title>
<indexterm zone="fo-fo-get-area-iterator"><primary>fo_fo_get_area_iterator</primary></indexterm><programlisting><link linkend="FoFoAreaIterator">FoFoAreaIterator</link>*   fo_fo_get_area_iterator             (<link linkend="FoFo">FoFo</link> *fo);</programlisting>
<para>
Gets a <link linkend="FoFoAreaIterator"><type>FoFoAreaIterator</type></link> for iterating over the areas generated by <parameter>fo</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fo</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoFo"><type>FoFo</type></link> for which to get iterator.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="FoFoAreaIterator"><type>FoFoAreaIterator</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-area-iterator-get-area" role="function">
<title>fo_fo_area_iterator_get_area ()</title>
<indexterm zone="fo-fo-area-iterator-get-area"><primary>fo_fo_area_iterator_get_area</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>*             fo_fo_area_iterator_get_area        (const <link linkend="FoFoAreaIterator">FoFoAreaIterator</link> *iterator);</programlisting>
<para>
Gets the current <link linkend="FoArea"><type>FoArea</type></link> pointed to by <parameter>iterator</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>iterator</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoFoAreaIterator"><type>FoFoAreaIterator</type></link> for which to get current area.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The current <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-fo-area-iterator-next" role="function">
<title>fo_fo_area_iterator_next ()</title>
<indexterm zone="fo-fo-area-iterator-next"><primary>fo_fo_area_iterator_next</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            fo_fo_area_iterator_next            (<link linkend="FoFoAreaIterator">FoFoAreaIterator</link> *iterator);</programlisting>
<para>
Makes <parameter>iterator</parameter> point to the next <link linkend="FoArea"><type>FoArea</type></link> in its list.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>iterator</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoFoAreaIterator"><type>FoFoAreaIterator</type></link> to modify
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if there is a next <link linkend="FoArea"><type>FoArea</type></link>, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="FoFo.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoFo--allow-mixed-content"><title>The <literal>&quot;allow-mixed-content&quot;</literal> property</title>
<indexterm zone="FoFo--allow-mixed-content"><primary>FoFo:allow-mixed-content</primary></indexterm><programlisting>  &quot;allow-mixed-content&quot;      <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>Whether or not the formatting object allows mixed content.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="FoFo--context"><title>The <literal>&quot;context&quot;</literal> property</title>
<indexterm zone="FoFo--context"><primary>FoFo:context</primary></indexterm><programlisting>  &quot;context&quot;                  <link linkend="FoContext">FoContext</link>*            : Read</programlisting>
<para>Set of current formatting object properties.</para></refsect2>
<refsect2 id="FoFo--flow"><title>The <literal>&quot;flow&quot;</literal> property</title>
<indexterm zone="FoFo--flow"><primary>FoFo:flow</primary></indexterm><programlisting>  &quot;flow&quot;                     <link linkend="FoFo">FoFo</link>*                 : Read</programlisting>
<para>Ancestor fo:flow node in the formatting object tree.</para></refsect2>
<refsect2 id="FoFo--generate-reference-area"><title>The <literal>&quot;generate-reference-area&quot;</literal> property</title>
<indexterm zone="FoFo--generate-reference-area"><primary>FoFo:generate-reference-area</primary></indexterm><programlisting>  &quot;generate-reference-area&quot;  <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>Whether or not the formatting object generates a reference area.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="FoFo--tree"><title>The <literal>&quot;tree&quot;</literal> property</title>
<indexterm zone="FoFo--tree"><primary>FoFo:tree</primary></indexterm><programlisting>  &quot;tree&quot;                     <link linkend="FoFo">FoFo</link>*                 : Read</programlisting>
<para>Top of the formatting object tree.</para></refsect2>

</refsect1>




</refentry>