![]() | ![]() | ![]() | xmlroff Reference Manual | ![]() |
---|
fo-doc —
struct FoDoc; struct FoDocClass; #define FO_DOC_ERRORGQuark fo_doc_error_quark (void); enum FoDocError; enum FoDocLineCap; enum FoDocLineJoin; FoDoc* fo_doc_new (void); FoDoc* fo_doc_new_from_type (constgchar *type); void fo_doc_open_file (FoDoc *fo_doc, constgchar *filename,GError **error); FoLayout* fo_doc_get_new_layout (FoDoc *fo_doc); constgchar * fo_doc_get_language (FoDoc *fo_doc); void fo_doc_set_language (FoDoc *fo_doc, constgchar *language);FoEnumAreaDirection fo_doc_get_base_dir (FoDoc *fo_doc); void fo_doc_set_base_dir (FoDoc *fo_doc,FoEnumAreaDirection base_dir); void fo_doc_begin_page (FoDoc *fo_doc,gfloat width,gfloat height); void fo_doc_end_page (FoDoc *fo_doc); FoDatatype* fo_doc_get_fill_color (FoDoc *fo_doc); void fo_doc_set_fill_color (FoDoc *fo_doc, FoDatatype *color); FoDatatype* fo_doc_get_stroke_color (FoDoc *fo_doc); void fo_doc_set_stroke_color (FoDoc *fo_doc, FoDatatype *color); FoDocLineCap fo_doc_get_line_cap (FoDoc *fo_doc); void fo_doc_set_line_cap (FoDoc *fo_doc, FoDocLineCap line_cap); FoDocLineJoin fo_doc_get_line_join (FoDoc *fo_doc); void fo_doc_set_line_join (FoDoc *fo_doc, FoDocLineJoin line_join);gfloat fo_doc_get_line_width (FoDoc *fo_doc); void fo_doc_set_line_width (FoDoc *fo_doc,gfloat line_width); void fo_doc_set_dash (FoDoc *fo_doc,gfloat b,gfloat w); void fo_doc_translate (FoDoc *fo_doc,gfloat x,gfloat y); void fo_doc_clip (FoDoc *fo_doc); void fo_doc_save (FoDoc *fo_doc); void fo_doc_restore (FoDoc *fo_doc); void fo_doc_line_to (FoDoc *fo_doc,gfloat x,gfloat y); void fo_doc_move_to (FoDoc *fo_doc,gfloat x,gfloat y); void fo_doc_line_stroked (FoDoc *fo_doc,gfloat x0,gfloat y0,gfloat x1,gfloat y1); void fo_doc_rect_stroked (FoDoc *fo_doc,gfloat x,gfloat y,gfloat width,gfloat height); void fo_doc_rect_filled (FoDoc *fo_doc,gfloat x,gfloat y,gfloat width,gfloat height); void fo_doc_fill (FoDoc *fo_doc); void fo_doc_stroke (FoDoc *fo_doc); void fo_doc_fill_stroke (FoDoc *fo_doc); void fo_doc_place_image (FoDoc *fo_doc,gint image,gfloat x,gfloat y,gfloat scale);gint fo_doc_open_image_file (FoDoc *fo_doc, const char *imagetype, const char *filename, const char *stringparam,gint intparam); void fo_doc_close_image (FoDoc *fo_doc,gint image); FoFontDesc* fo_doc_get_font_desc (FoDoc *fo_doc); void fo_doc_render_layout_lines (FoDoc *fo_doc, FoArea *area_layout,gfloat x,gfloat y); void fo_doc_render_layout (FoDoc *fo_doc, FoArea *area_layout,gfloat x,gfloat y);
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_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;
void fo_doc_open_file (FoDoc *fo_doc, constgchar *filename,GError **error);
fo_doc : | |
filename : | |
error : |
FoLayout* fo_doc_get_new_layout (FoDoc *fo_doc);
Get a new FoLayout for use with fo_doc.
constgchar * fo_doc_get_language (FoDoc *fo_doc);
Get the language in fo_doc.
fo_doc : | FoDoc |
Returns : | Language of file parsed to make fo_doc. |
void fo_doc_set_language (FoDoc *fo_doc, constgchar *language);
Set the language in fo_doc.
fo_doc : | FoDoc. |
language : | Language. |
FoEnumAreaDirection fo_doc_get_base_dir (FoDoc *fo_doc);
Get the
fo_doc : | FoDoc. |
Returns : | |
void fo_doc_set_base_dir (FoDoc *fo_doc,FoEnumAreaDirection base_dir);
Set the
fo_doc : | FoDoc. |
base_dir : | |
void fo_doc_begin_page (FoDoc *fo_doc,gfloat width,gfloat height);
Add a new page to fo_doc.
This must always be paired with a matching fo_doc_end_page call.
fo_doc : | FoDoc. |
width : | Width of the new page. |
height : | Height of the new page. |
void fo_doc_end_page (FoDoc *fo_doc);
Finish the current page of fo_doc.
fo_doc : | FoDoc. |
FoDatatype* fo_doc_get_fill_color (FoDoc *fo_doc);
Get the current fill color of fo_doc.
fo_doc : | FoDoc. |
Returns : | FoDatatype for the current fill color. |
void fo_doc_set_fill_color (FoDoc *fo_doc, FoDatatype *color);
Set the fill color of fo_doc to color.
fo_doc : | FoDoc. |
color : | FoDatatype for new fill color. |
FoDatatype* fo_doc_get_stroke_color (FoDoc *fo_doc);
Get the current stroke color of fo_doc.
fo_doc : | FoDoc. |
Returns : | FoDatatype for the current stroke color. |
void fo_doc_set_stroke_color (FoDoc *fo_doc, FoDatatype *color);
Set the stroke color of fo_doc to color.
fo_doc : | FoDoc. |
color : | FoDatatype for new stroke color. |
FoDocLineCap fo_doc_get_line_cap (FoDoc *fo_doc);
Get the current "linecap" parameter value of fo_doc.
fo_doc : | FoDoc. |
Returns : | Current "linecap" parameter value. |
void fo_doc_set_line_cap (FoDoc *fo_doc, FoDocLineCap line_cap);
Set the "linecap" parameter value of fo_doc.
fo_doc : | FoDoc. |
line_cap : | New "linecap" parameter value. |
FoDocLineJoin fo_doc_get_line_join (FoDoc *fo_doc);
Get the current "linejoin" parameter value of fo_doc.
fo_doc : | FoDoc. |
Returns : | Current "linejoin" parameter value. |
void fo_doc_set_line_join (FoDoc *fo_doc, FoDocLineJoin line_join);
Set the "linejoin" parameter value of fo_doc.
fo_doc : | FoDoc. |
line_join : | New "linejoin" parameter value. |
gfloat fo_doc_get_line_width (FoDoc *fo_doc);
Get the current line width of fo_doc.
fo_doc : | FoDoc. |
Returns : | Current line width. |
void fo_doc_set_line_width (FoDoc *fo_doc,gfloat line_width);
Set the line width of fo_doc.
fo_doc : | FoDoc. |
line_width : | New line width value. |
void fo_doc_set_dash (FoDoc *fo_doc,gfloat b,gfloat w);
Set the current dash pattern of fo_doc.
The dash pattern is the ratio of b to w.
Set b and w to 0 to produce a solid line.
The dash pattern is set to solid (b = w = 0) at the beginning of each page.
fo_doc : | FoDoc. |
b : | Number of black units. |
w : | Number of white units. |
void fo_doc_translate (FoDoc *fo_doc,gfloat x,gfloat y);
Translate the origin of the coordinate system of fo_doc.
x and y are measured in the old coordinate system.
fo_doc : | FoDoc. |
x : | X-coordinate of the new origin of the coordinate system. |
y : | Y-coordinate of the new origin of the coordinate system. |
void fo_doc_clip (FoDoc *fo_doc);
Use the current path of fo_doc as its clipping path.
fo_doc : | FoDoc. |
void fo_doc_save (FoDoc *fo_doc);
Save the current graphics state of fo_doc.
fo_doc : | FoDoc. |
void fo_doc_restore (FoDoc *fo_doc);
Restore the most recently saved graphics state of fo_doc.
fo_doc : | FoDoc. |
void fo_doc_line_to (FoDoc *fo_doc,gfloat x,gfloat y);
Draw a line from the current point to another point.
fo_doc : | FoDoc. |
x : | X-coordinate of the new current point. |
y : | Y-coordinate of the new current point. |
void fo_doc_move_to (FoDoc *fo_doc,gfloat x,gfloat y);
Set the current point of fo_doc to (x, y).
fo_doc : | FoDoc. |
x : | X-coordinate of the new current point. |
y : | Y-coordinate of the new current point. |
void fo_doc_line_stroked (FoDoc *fo_doc,gfloat x0,gfloat y0,gfloat x1,gfloat y1);
Draw a line from (x0,y0) to (x1,y1).
fo_doc : | FoDoc. |
x0 : | X-coordinate of the start of the line. |
y0 : | Y-coordinate of the start of the line. |
x1 : | X-coordinate of the end of the line. |
y1 : | Y-coordinate of the end of the line. |
void fo_doc_rect_stroked (FoDoc *fo_doc,gfloat x,gfloat y,gfloat width,gfloat height);
Draw an outline rectangle.
fo_doc : | FoDoc. |
x : | X-coordinate of the lower-left corner of the rectangle. |
y : | Y-coordinate of the lower-left corner of the rectangle. |
width : | Width of the rectangle. |
height : | Height of the rectangle. |
void fo_doc_rect_filled (FoDoc *fo_doc,gfloat x,gfloat y,gfloat width,gfloat height);
Draw a filled rectangle.
fo_doc : | FoDoc. |
x : | X-coordinate of the lower-left corner of the rectangle. |
y : | Y-coordinate of the lower-left corner of the rectangle. |
width : | Width of the rectangle. |
height : | Height of the rectangle. |
void fo_doc_fill (FoDoc *fo_doc);
Fill the interior of the path of fo_doc with the current fill color.
fo_doc : | FoDoc. |
void fo_doc_stroke (FoDoc *fo_doc);
Stroke the path of fo_doc and clear the path.
fo_doc : | FoDoc. |
void fo_doc_fill_stroke (FoDoc *fo_doc);
Fill and stroke the path of fo_doc with the current fill and stroke colors.
fo_doc : | FoDoc. |
void fo_doc_place_image (FoDoc *fo_doc,gint image,gfloat x,gfloat y,gfloat scale);
fo_doc : | |
image : | |
x : | |
y : | |
scale : |
gint fo_doc_open_image_file (FoDoc *fo_doc, const char *imagetype, const char *filename, const char *stringparam,gint intparam);
fo_doc : | |
imagetype : | |
filename : | |
stringparam : | |
intparam : | |
Returns : |
FoFontDesc* fo_doc_get_font_desc (FoDoc *fo_doc);
Get the
fo_doc : | FoDoc. |
Returns : | |
void fo_doc_render_layout_lines (FoDoc *fo_doc, FoArea *area_layout,gfloat x,gfloat y);
fo_doc : | |
area_layout : | |
x : | |
y : |
<< FoLibfoContext | FoXslFormatter >> |