Github User Fetcher 1.0.0
C Application with Server and GUI
Loading...
Searching...
No Matches
cairo-pdf.h File Reference
#include "cairo.h"

Go to the source code of this file.

Macros

#define CAIRO_PDF_OUTLINE_ROOT   0
 

Typedefs

typedef CAIRO_BEGIN_DECLS enum _cairo_pdf_version cairo_pdf_version_t
 
typedef enum _cairo_pdf_outline_flags cairo_pdf_outline_flags_t
 
typedef enum _cairo_pdf_metadata cairo_pdf_metadata_t
 

Enumerations

enum  _cairo_pdf_version { CAIRO_PDF_VERSION_1_4 , CAIRO_PDF_VERSION_1_5 , CAIRO_PDF_VERSION_1_6 , CAIRO_PDF_VERSION_1_7 }
 
enum  _cairo_pdf_outline_flags { CAIRO_PDF_OUTLINE_FLAG_OPEN = 0x1 , CAIRO_PDF_OUTLINE_FLAG_BOLD = 0x2 , CAIRO_PDF_OUTLINE_FLAG_ITALIC = 0x4 }
 
enum  _cairo_pdf_metadata {
  CAIRO_PDF_METADATA_TITLE , CAIRO_PDF_METADATA_AUTHOR , CAIRO_PDF_METADATA_SUBJECT , CAIRO_PDF_METADATA_KEYWORDS ,
  CAIRO_PDF_METADATA_CREATOR , CAIRO_PDF_METADATA_CREATE_DATE , CAIRO_PDF_METADATA_MOD_DATE
}
 

Functions

cairo_public cairo_surface_tcairo_pdf_surface_create (const char *filename, double width_in_points, double height_in_points)
 
cairo_public cairo_surface_tcairo_pdf_surface_create_for_stream (cairo_write_func_t write_func, void *closure, double width_in_points, double height_in_points)
 
cairo_public void cairo_pdf_surface_restrict_to_version (cairo_surface_t *surface, cairo_pdf_version_t version)
 
cairo_public void cairo_pdf_get_versions (cairo_pdf_version_t const **versions, int *num_versions)
 
cairo_public const char * cairo_pdf_version_to_string (cairo_pdf_version_t version)
 
cairo_public void cairo_pdf_surface_set_size (cairo_surface_t *surface, double width_in_points, double height_in_points)
 
cairo_public 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)
 
cairo_public void cairo_pdf_surface_set_metadata (cairo_surface_t *surface, cairo_pdf_metadata_t metadata, const char *utf8)
 
cairo_public void cairo_pdf_surface_set_custom_metadata (cairo_surface_t *surface, const char *name, const char *value)
 
cairo_public void cairo_pdf_surface_set_page_label (cairo_surface_t *surface, const char *utf8)
 
cairo_public void cairo_pdf_surface_set_thumbnail_size (cairo_surface_t *surface, int width, int height)
 

Macro Definition Documentation

◆ CAIRO_PDF_OUTLINE_ROOT

#define CAIRO_PDF_OUTLINE_ROOT   0

Definition at line 111 of file cairo-pdf.h.

Typedef Documentation

◆ cairo_pdf_metadata_t

cairo_pdf_metadata_t: @CAIRO_PDF_METADATA_TITLE: The document title (Since 1.16) @CAIRO_PDF_METADATA_AUTHOR: The document author (Since 1.16) @CAIRO_PDF_METADATA_SUBJECT: The document subject (Since 1.16) @CAIRO_PDF_METADATA_KEYWORDS: The document keywords (Since 1.16) @CAIRO_PDF_METADATA_CREATOR: The document creator (Since 1.16) @CAIRO_PDF_METADATA_CREATE_DATE: The document creation date (Since 1.16) @CAIRO_PDF_METADATA_MOD_DATE: The document modification date (Since 1.16)

cairo_pdf_metadata_t is used by the cairo_pdf_surface_set_metadata() function specify the metadata to set.

Since: 1.16

◆ cairo_pdf_outline_flags_t

cairo_pdf_outline_flags_t: @CAIRO_PDF_OUTLINE_FLAG_OPEN: The outline item defaults to open in the PDF viewer (Since 1.16) @CAIRO_PDF_OUTLINE_FLAG_BOLD: The outline item is displayed by the viewer in bold text (Since 1.16) @CAIRO_PDF_OUTLINE_FLAG_ITALIC: The outline item is displayed by the viewer in italic text (Since 1.16)

cairo_pdf_outline_flags_t is used by the cairo_pdf_surface_add_outline() function specify the attributes of an outline item. These flags may be bitwise-or'd to produce any combination of flags.

Since: 1.16

◆ cairo_pdf_version_t

cairo_pdf_version_t: @CAIRO_PDF_VERSION_1_4: The version 1.4 of the PDF specification. (Since 1.10) @CAIRO_PDF_VERSION_1_5: The version 1.5 of the PDF specification. (Since 1.10) @CAIRO_PDF_VERSION_1_6: The version 1.6 of the PDF specification. (Since 1.18) @CAIRO_PDF_VERSION_1_7: The version 1.7 of the PDF specification. (Since 1.18)

cairo_pdf_version_t is used to describe the version number of the PDF specification that a generated PDF file will conform to.

Since: 1.10

Enumeration Type Documentation

◆ _cairo_pdf_metadata

cairo_pdf_metadata_t: @CAIRO_PDF_METADATA_TITLE: The document title (Since 1.16) @CAIRO_PDF_METADATA_AUTHOR: The document author (Since 1.16) @CAIRO_PDF_METADATA_SUBJECT: The document subject (Since 1.16) @CAIRO_PDF_METADATA_KEYWORDS: The document keywords (Since 1.16) @CAIRO_PDF_METADATA_CREATOR: The document creator (Since 1.16) @CAIRO_PDF_METADATA_CREATE_DATE: The document creation date (Since 1.16) @CAIRO_PDF_METADATA_MOD_DATE: The document modification date (Since 1.16)

cairo_pdf_metadata_t is used by the cairo_pdf_surface_set_metadata() function specify the metadata to set.

Since: 1.16

Enumerator
CAIRO_PDF_METADATA_TITLE 
CAIRO_PDF_METADATA_AUTHOR 
CAIRO_PDF_METADATA_SUBJECT 
CAIRO_PDF_METADATA_KEYWORDS 
CAIRO_PDF_METADATA_CREATOR 
CAIRO_PDF_METADATA_CREATE_DATE 
CAIRO_PDF_METADATA_MOD_DATE 

Definition at line 135 of file cairo-pdf.h.

135 {
enum _cairo_pdf_metadata cairo_pdf_metadata_t
@ CAIRO_PDF_METADATA_SUBJECT
Definition cairo-pdf.h:138
@ CAIRO_PDF_METADATA_CREATOR
Definition cairo-pdf.h:140
@ CAIRO_PDF_METADATA_AUTHOR
Definition cairo-pdf.h:137
@ CAIRO_PDF_METADATA_KEYWORDS
Definition cairo-pdf.h:139
@ CAIRO_PDF_METADATA_TITLE
Definition cairo-pdf.h:136
@ CAIRO_PDF_METADATA_CREATE_DATE
Definition cairo-pdf.h:141
@ CAIRO_PDF_METADATA_MOD_DATE
Definition cairo-pdf.h:142

◆ _cairo_pdf_outline_flags

cairo_pdf_outline_flags_t: @CAIRO_PDF_OUTLINE_FLAG_OPEN: The outline item defaults to open in the PDF viewer (Since 1.16) @CAIRO_PDF_OUTLINE_FLAG_BOLD: The outline item is displayed by the viewer in bold text (Since 1.16) @CAIRO_PDF_OUTLINE_FLAG_ITALIC: The outline item is displayed by the viewer in italic text (Since 1.16)

cairo_pdf_outline_flags_t is used by the cairo_pdf_surface_add_outline() function specify the attributes of an outline item. These flags may be bitwise-or'd to produce any combination of flags.

Since: 1.16

Enumerator
CAIRO_PDF_OUTLINE_FLAG_OPEN 
CAIRO_PDF_OUTLINE_FLAG_BOLD 
CAIRO_PDF_OUTLINE_FLAG_ITALIC 

Definition at line 105 of file cairo-pdf.h.

105 {
enum _cairo_pdf_outline_flags cairo_pdf_outline_flags_t
@ CAIRO_PDF_OUTLINE_FLAG_ITALIC
Definition cairo-pdf.h:108
@ CAIRO_PDF_OUTLINE_FLAG_BOLD
Definition cairo-pdf.h:107
@ CAIRO_PDF_OUTLINE_FLAG_OPEN
Definition cairo-pdf.h:106

◆ _cairo_pdf_version

cairo_pdf_version_t: @CAIRO_PDF_VERSION_1_4: The version 1.4 of the PDF specification. (Since 1.10) @CAIRO_PDF_VERSION_1_5: The version 1.5 of the PDF specification. (Since 1.10) @CAIRO_PDF_VERSION_1_6: The version 1.6 of the PDF specification. (Since 1.18) @CAIRO_PDF_VERSION_1_7: The version 1.7 of the PDF specification. (Since 1.18)

cairo_pdf_version_t is used to describe the version number of the PDF specification that a generated PDF file will conform to.

Since: 1.10

Enumerator
CAIRO_PDF_VERSION_1_4 
CAIRO_PDF_VERSION_1_5 
CAIRO_PDF_VERSION_1_6 
CAIRO_PDF_VERSION_1_7 

Definition at line 58 of file cairo-pdf.h.

58 {
@ CAIRO_PDF_VERSION_1_7
Definition cairo-pdf.h:62
@ CAIRO_PDF_VERSION_1_5
Definition cairo-pdf.h:60
@ CAIRO_PDF_VERSION_1_4
Definition cairo-pdf.h:59
@ CAIRO_PDF_VERSION_1_6
Definition cairo-pdf.h:61
CAIRO_BEGIN_DECLS enum _cairo_pdf_version cairo_pdf_version_t

Function Documentation

◆ cairo_pdf_get_versions()

cairo_public void cairo_pdf_get_versions ( cairo_pdf_version_t const ** versions,
int * num_versions )

◆ cairo_pdf_surface_add_outline()

cairo_public 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 )

◆ cairo_pdf_surface_create()

cairo_public cairo_surface_t * cairo_pdf_surface_create ( const char * filename,
double width_in_points,
double height_in_points )

◆ cairo_pdf_surface_create_for_stream()

cairo_public cairo_surface_t * cairo_pdf_surface_create_for_stream ( cairo_write_func_t write_func,
void * closure,
double width_in_points,
double height_in_points )

◆ cairo_pdf_surface_restrict_to_version()

cairo_public void cairo_pdf_surface_restrict_to_version ( cairo_surface_t * surface,
cairo_pdf_version_t version )

◆ cairo_pdf_surface_set_custom_metadata()

cairo_public void cairo_pdf_surface_set_custom_metadata ( cairo_surface_t * surface,
const char * name,
const char * value )

◆ cairo_pdf_surface_set_metadata()

cairo_public void cairo_pdf_surface_set_metadata ( cairo_surface_t * surface,
cairo_pdf_metadata_t metadata,
const char * utf8 )

◆ cairo_pdf_surface_set_page_label()

cairo_public void cairo_pdf_surface_set_page_label ( cairo_surface_t * surface,
const char * utf8 )

◆ cairo_pdf_surface_set_size()

cairo_public void cairo_pdf_surface_set_size ( cairo_surface_t * surface,
double width_in_points,
double height_in_points )

◆ cairo_pdf_surface_set_thumbnail_size()

cairo_public void cairo_pdf_surface_set_thumbnail_size ( cairo_surface_t * surface,
int width,
int height )

◆ cairo_pdf_version_to_string()

cairo_public const char * cairo_pdf_version_to_string ( cairo_pdf_version_t version)