cairo_pdf_surface_add_outline

Add an item to the document outline hierarchy with the name utf8 that links to the location specified by link_attribs. Link attributes have the same keys and values as the [Link Tag][link], excluding the "rect" attribute. The item will be a child of the item with id parent_id. Use %CAIRO_PDF_OUTLINE_ROOT as the parent id of top level items.

cairo_pdf_surface_add_outline(surface, parent_id, utf8, link_attribs, flags)

Arguments

surface	[cairo_surface_t *] a PDF #cairo_surface_t
parent_id	[int] the id of the parent item or %CAIRO_PDF_OUTLINE_ROOT if this is a top level item.
utf8	[char *] the name of the outline
link_attribs	[char *] the link attributes specifying where this outline links to
flags	[int] outline item flags

Value

[int]

Details

Return value: the id for the added item.

Since: 1.16

C function prototype: int cairo_pdf_surface_add_outline (cairo_surface_t *surface, int parent_id, const char *utf8, const char *link_attribs, cairo_pdf_outline_flags_t flags)

See also

Other cairo-pdf-surface: cairo_pdf_surface_create(), cairo_pdf_surface_restrict_to_version(), cairo_pdf_surface_set_metadata(), cairo_pdf_surface_set_page_label(), cairo_pdf_surface_set_size(), cairo_pdf_surface_set_thumbnail_size(), cairo_pdf_version_to_string()