## FoXslFormatter

FoXslFormatter

## Synopsis

    #define             FO_XSL_FORMATTER_ERROR
    GQuark              fo_xsl_formatter_error_quark        (void);
    enum                FoXslFormatterError;
                        FoXslFormatter;
                        FoXslFormatterClass;
    FoXslFormatter*     fo_xsl_formatter_new                (void);
    gboolean            fo_xsl_formatter_format             (FoXslFormatter *fo_xsl_formatter,
                                                             FoLibfoContext *libfo_context,
                                                             GError **error);
    gboolean            fo_xsl_formatter_draw               (FoXslFormatter *fo_xsl_formatter,
                                                             FoLibfoContext *libfo_context,
                                                             GError **error);
    void                fo_xsl_formatter_set_result_tree    (FoXslFormatter *fo_xsl_formatter,
                                                             FoXmlDoc *result_tree);
    void                fo_xsl_formatter_set_fo_doc         (FoXslFormatter *fo_xsl_formatter,
                                                             FoDoc *fo_doc);
    GObject*            fo_xsl_formatter_get_fo_tree        (FoXslFormatter *fo_xsl_formatter);
    GObject*            fo_xsl_formatter_get_area_tree      (FoXslFormatter *fo_xsl_formatter);

## Description

## Details

### FO_XSL_FORMATTER_ERROR

    #define FO_XSL_FORMATTER_ERROR fo_xsl_formatter_error_quark ()

### fo_xsl_formatter_error_quark ()

    GQuark              fo_xsl_formatter_error_quark        (void);

Get the error quark for FoXslFormatter.

If the quark does not yet exist, create it.

Returns : | GQuark associated with FoXslFormatter errors.

### enum FoXslFormatterError

    typedef enum
    {
      FO_XSL_FORMATTER_ERROR_FAILED,
      FO_XSL_FORMATTER_ERROR_FORMAT_FAILED,
      FO_XSL_FORMATTER_ERROR_PARSE_FAILED,
      FO_XSL_FORMATTER_ERROR_NO_RESULT_TREE,
      FO_XSL_FORMATTER_ERROR_RESULT_TREE_NOT_FO,
      FO_XSL_FORMATTER_ERROR_NO_AREA_TREE,
      FO_XSL_FORMATTER_ERROR_NO_FO_DOC,
      FO_XSL_FORMATTER_ERROR_NOT_FO_DOC,
      FO_XSL_FORMATTER_ERROR_UNKNOWN_FO	/* Unknown FO element type */
    } FoXslFormatterError;

### FoXslFormatter

    typedef struct _FoXslFormatter FoXslFormatter;

### FoXslFormatterClass

    typedef struct _FoXslFormatterClass FoXslFormatterClass;

### fo_xsl_formatter_new ()

    FoXslFormatter*     fo_xsl_formatter_new                (void);

Creates a new FoXslFormatter initialized to default value.

Returns : | The new FoXslFormatter.

### fo_xsl_formatter_format ()

    gboolean            fo_xsl_formatter_format             (FoXslFormatter *fo_xsl_formatter,
                                                             FoLibfoContext *libfo_context,
                                                             GError **error);

Formats `fo_xsl_formatter`.

Outputs debug info according to debug mode set in `libfo_context`.

`fo_xsl_formatter` : | FoXslFormatter.
`libfo_context` : | FoLibfoContext.
`error` : | GError.
Returns : | Success indication.

### fo_xsl_formatter_draw ()

    gboolean            fo_xsl_formatter_draw               (FoXslFormatter *fo_xsl_formatter,
                                                             FoLibfoContext *libfo_context,
                                                             GError **error);

Formats `fo_xsl_formatter`.

`fo_xsl_formatter` : | FoXslFormatter.
`libfo_context` : | FoLibfoContext.
`error` : | GError.
Returns : | Success indication.

### fo_xsl_formatter_set_result_tree ()

    void                fo_xsl_formatter_set_result_tree    (FoXslFormatter *fo_xsl_formatter,
                                                             FoXmlDoc *result_tree);

Set the result tree in `fo_xsl_formatter`. Voids the current FO and area trees.

`fo_xsl_formatter` : | FoXslFormatter
`result_tree` : | Result of previous parse or transformation.

### fo_xsl_formatter_set_fo_doc ()

    void                fo_xsl_formatter_set_fo_doc         (FoXslFormatter *fo_xsl_formatter,
                                                             FoDoc *fo_doc);

Set the FoDoc in `fo_xsl_formatter`. Voids the current FO and area trees.

`fo_xsl_formatter` : | FoXslFormatter
`fo_doc` : | FoDoc for use as output of formatter.

### fo_xsl_formatter_get_fo_tree ()

    GObject*            fo_xsl_formatter_get_fo_tree        (FoXslFormatter *fo_xsl_formatter);

Get the FoFo tree created by `fo_xsl_formatter`.

`fo_xsl_formatter` : | FoXslFormatter
Returns : | FoFo tree created by `fo_xsl_formatter`.

### fo_xsl_formatter_get_area_tree ()

    GObject*            fo_xsl_formatter_get_area_tree      (FoXslFormatter *fo_xsl_formatter);

Get the FoArea tree created by `fo_xsl_formatter`.

`fo_xsl_formatter` : | FoXslFormatter
Returns : | FoArea tree created by `fo_xsl_formatter`.