![]() |
![]() |
![]() |
xmlroff Reference Manual | ![]() |
---|---|---|---|---|
FoDoc; FoDocClass; #define FO_DOC_ERROR GQuark fo_doc_error_quark (void); enum FoDocError; enum FoDocLineCap; enum FoDocLineJoin; FoDoc* fo_doc_new (void); FoDoc* fo_doc_new_from_type (const gchar *type); FoFlagsFormat fo_doc_formats_from_name (const gchar *name); void fo_doc_open_file (FoDoc *fo_doc, const gchar *filename, FoLibfoContext *libfo_context, GError **error); FoLayout* fo_doc_get_new_layout (FoDoc *fo_doc); const gchar* fo_doc_get_language (FoDoc *fo_doc); void fo_doc_set_language (FoDoc *fo_doc, const gchar *language); FoEnumAreaDirection fo_doc_get_base_dir (FoDoc *fo_doc); void fo_doc_set_base_dir (FoDoc *fo_doc, FoEnumAreaDirection base_dir);
FoDoc provides the primitives for writing text, lines, rectangles, etc., to the output.
It is generalised so that libfo can support multiple backend implementations (and add and remove backend implementations) without having to restructure the rest of libfo.
GQuark fo_doc_error_quark (void);
Get the error quark for FoDoc.
If the quark does not yet exist, create it.
Returns : |
Quark associated with FoDoc errors. |
typedef enum { FO_DOC_ERROR_FAILED, FO_DOC_ERROR_OPEN_FAILED, /* Cannot open output document */ FO_DOC_ERROR_UNSUPPORTED_FORMAT, /* Unsupported document format */ FO_DOC_ERROR_LAST } FoDocError;
typedef enum { FO_DOC_LINE_CAP_INVALID, FO_DOC_LINE_CAP_BUTT, FO_DOC_LINE_CAP_ROUND, FO_DOC_LINE_CAP_SQUARE, FO_DOC_LINE_CAP_LIMIT } FoDocLineCap;
typedef enum { FO_DOC_LINE_JOIN_INVALID, FO_DOC_LINE_JOIN_MITER, FO_DOC_LINE_JOIN_ROUND, FO_DOC_LINE_JOIN_BEVEL, FO_DOC_LINE_JOIN_LIMIT } FoDocLineJoin;
FoFlagsFormat fo_doc_formats_from_name (const gchar *name);
Gets the output formats supported by name
class.
name
should not be NULL.
If name
does not implement any formats, returns
FO_FLAG_FORMAT_UNKNOWN.
|
Registered FoObject type name, e.g., "FoDocCairo" |
Returns : |
FoFlagsFormat with zero or more bits set for the supported formats. |
void fo_doc_open_file (FoDoc *fo_doc, const gchar *filename, FoLibfoContext *libfo_context, GError **error);
No reference to libfo_context
is kept.
|
FoDoc for which to open an output file. |
|
Name of output file. |
|
FoLibfoContext containing extra info. |
|
Information about any error that occurred. |
FoLayout* fo_doc_get_new_layout (FoDoc *fo_doc);
Get a new FoLayout for use with fo_doc
.
const gchar* fo_doc_get_language (FoDoc *fo_doc);
Get the language in fo_doc
.
|
FoDoc |
Returns : |
Language of file parsed to make fo_doc .
|
void fo_doc_set_language (FoDoc *fo_doc, const gchar *language);
Set the language in fo_doc
.
|
FoDoc. |
|
Language. |
FoEnumAreaDirection fo_doc_get_base_dir (FoDoc *fo_doc);
Get the FoEnumAreaDirection used as input to fo_doc
.
|
FoDoc. |
Returns : |
FoEnumAreaDirection used as input to fo_doc .
|
void fo_doc_set_base_dir (FoDoc *fo_doc, FoEnumAreaDirection base_dir);
Set the FoEnumAreaDirection in fo_doc
.
|
FoDoc. |
|
FoEnumAreaDirection value for new base direction. |