struct FoFo

struct FoFo;

struct FoFoClass

struct FoFoClass;

FO_FO_ERROR

#define     FO_FO_ERROR

fo_fo_error_quark ()

GQuark      fo_fo_error_quark               (void);

enum FoFoError

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_LAST
} FoFoError;

struct FoFoAreaNew2Context

struct FoFoAreaNew2Context {

  FoDoc   *fo_doc;
  FoArea  *parent_area;
  FoArea **new_area;
  guint    debug_level;
};

struct FoFoAreaIterator

struct FoFoAreaIterator;

fo_fo_new ()

FoFo*       fo_fo_new                       (void);

Creates a new FoFo initialized to default value.

fo_fo_debug_dump_properties ()

void        fo_fo_debug_dump_properties     (FoFo *fo,
                                             gint depth);

Log debug messages for most of the instance variables and some of the class variables of fo.

fo_fo_set_context ()

void        fo_fo_set_context               (FoFo *fo_fo,
                                             FoContext *new_context);

Sets the context of fo_fo to new_context

fo_fo_get_context ()

FoContext*  fo_fo_get_context               (FoFo *fo_fo);

Gets the "context" of fo_fo

fo_fo_update_from_context ()

void        fo_fo_update_from_context       (FoFo *fo_fo,
                                             FoContext *context);

Calls the FoFo-specific _update_from_context() function to update the FoFo's property values from the larger set of property values maintained in the FoContext.

fo_fo_get_flow ()

FoFo*       fo_fo_get_flow                  (FoFo *fo_fo);

Gets the flow of fo_fo

fo_fo_get_tree ()

FoFo*       fo_fo_get_tree                  (FoFo *fo_fo);

Gets the tree of fo_fo

fo_fo_get_generate_reference_area ()

gboolean    fo_fo_get_generate_reference_area
                                            (FoFo *fo_fo);

Gets whether or not the FO generates reference areas.

fo_fo_get_allow_mixed_content ()

gboolean    fo_fo_get_allow_mixed_content   (FoFo *fo_fo);

Gets whether or not the FO allows mixed content (i.e. text nodes).

fo_fo_validate_content ()

gboolean    fo_fo_validate_content          (FoFo *fo,
                                             GError **error);

Calls the FoFo-specific _validate_content() function to validate the FoFo's content model and returns the value returned by that function.

fo_fo_resolve_property_attributes ()

gboolean    fo_fo_resolve_property_attributes
                                            (FoNode *fo_node,
                                             gpointer data);

fo_fo_children_properties_resolve ()

void        fo_fo_children_properties_resolve
                                            (FoFo *this_fo,
                                             FoArea *this_fo_parent_area,
                                             FoArea **new_area,
                                             GHashTable *prop_eval_hash,
                                             FoDoc *fo_doc,
                                             gint debug_level,
                                             GError **error);

fo_fo_validate ()

void        fo_fo_validate                  (FoFo *fo,
                                             FoContext *current_context,
                                             FoContext *parent_context,
                                             GError **error);

Validate and/or munge the properties of fo.

fo_fo_clone ()

FoFo*       fo_fo_clone                     (FoFo *original);

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

fo_fo_area_new ()

void        fo_fo_area_new                  (FoFo *fo,
                                             FoDoc *fo_doc,
                                             FoArea *parent_area,
                                             FoArea **new_area,
                                             guint debug_level);

fo_fo_area_new2 ()

void        fo_fo_area_new2                 (FoFo *fo,
                                             FoFoAreaNew2Context *context,
                                             GError **error);

fo_fo_trim_whitespace_children ()

void        fo_fo_trim_whitespace_children  (FoFo *fo);

Remove any "whitespace" children of fo. I.e., unlink and unref any children that are FoText that contain only whitespace or are FoWrapperWhitespace nodes.

Leaves fo with no "whitespace" children.

fo_fo_validate_content_empty ()

gboolean    fo_fo_validate_content_empty    (FoFo *fo,
                                             GError **error);

fo_fo_validate_content_block_plus ()

gboolean    fo_fo_validate_content_block_plus
                                            (FoFo *fo,
                                             GError **error);

fo_fo_validate_pcdata_or_inline ()

void        fo_fo_validate_pcdata_or_inline (FoNode *fo_node,
                                             gboolean *is_not_pcdata_inline);

fo_fo_validate_block_or_whitespace ()

void        fo_fo_validate_block_or_whitespace
                                            (FoNode *fo_node,
                                             gboolean *is_not_block_or_whitespace);

fo_fo_validate_pcdata_inline_block_neutral ()

void        fo_fo_validate_pcdata_inline_block_neutral
                                            (FoNode *fo_node,
                                             gboolean *is_not_pcdata_inline_block_neutral);

fo_fo_get_area_iterator ()

FoFoAreaIterator* fo_fo_get_area_iterator   (FoFo *fo);

fo_fo_area_iterator_get_area ()

FoArea*     fo_fo_area_iterator_get_area    (const FoFoAreaIterator *iterator);

fo_fo_area_iterator_next ()

gboolean    fo_fo_area_iterator_next        (FoFoAreaIterator *iterator);