Mercurial > repos > rliterman > csp2
comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/gtk-doc/html/cairo/cairo-PDF-Surfaces.html @ 68:5028fdace37b
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author | jpayne |
---|---|
date | Tue, 18 Mar 2025 16:23:26 -0400 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
67:0e9998148a16 | 68:5028fdace37b |
---|---|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> | |
2 <html> | |
3 <head> | |
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
5 <title>PDF Surfaces: Cairo: A Vector Graphics Library</title> | |
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> | |
7 <link rel="home" href="index.html" title="Cairo: A Vector Graphics Library"> | |
8 <link rel="up" href="cairo-surfaces.html" title="Surfaces"> | |
9 <link rel="prev" href="cairo-Image-Surfaces.html" title="Image Surfaces"> | |
10 <link rel="next" href="cairo-PNG-Support.html" title="PNG Support"> | |
11 <meta name="generator" content="GTK-Doc V1.27 (XML mode)"> | |
12 <link rel="stylesheet" href="style.css" type="text/css"> | |
13 </head> | |
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> | |
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> | |
16 <td width="100%" align="left" class="shortcuts"> | |
17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> | |
18 <a href="#cairo-PDF-Surfaces.description" class="shortcut">Description</a></span> | |
19 </td> | |
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> | |
21 <td><a accesskey="u" href="cairo-surfaces.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> | |
22 <td><a accesskey="p" href="cairo-Image-Surfaces.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> | |
23 <td><a accesskey="n" href="cairo-PNG-Support.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> | |
24 </tr></table> | |
25 <div class="refentry"> | |
26 <a name="cairo-PDF-Surfaces"></a><div class="titlepage"></div> | |
27 <div class="refnamediv"><table width="100%"><tr> | |
28 <td valign="top"> | |
29 <h2><span class="refentrytitle"><a name="cairo-PDF-Surfaces.top_of_page"></a>PDF Surfaces</span></h2> | |
30 <p>PDF Surfaces — Rendering PDF documents</p> | |
31 </td> | |
32 <td class="gallery_image" valign="top" align="right"></td> | |
33 </tr></table></div> | |
34 <div class="refsect1"> | |
35 <a name="cairo-PDF-Surfaces.functions"></a><h2>Functions</h2> | |
36 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
37 <colgroup> | |
38 <col width="150px" class="functions_return"> | |
39 <col class="functions_name"> | |
40 </colgroup> | |
41 <tbody> | |
42 <tr> | |
43 <td class="function_type"> | |
44 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> * | |
45 </td> | |
46 <td class="function_name"> | |
47 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-create" title="cairo_pdf_surface_create ()">cairo_pdf_surface_create</a> <span class="c_punctuation">()</span> | |
48 </td> | |
49 </tr> | |
50 <tr> | |
51 <td class="function_type"> | |
52 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> * | |
53 </td> | |
54 <td class="function_name"> | |
55 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-create-for-stream" title="cairo_pdf_surface_create_for_stream ()">cairo_pdf_surface_create_for_stream</a> <span class="c_punctuation">()</span> | |
56 </td> | |
57 </tr> | |
58 <tr> | |
59 <td class="function_type"> | |
60 <span class="returnvalue">void</span> | |
61 </td> | |
62 <td class="function_name"> | |
63 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-restrict-to-version" title="cairo_pdf_surface_restrict_to_version ()">cairo_pdf_surface_restrict_to_version</a> <span class="c_punctuation">()</span> | |
64 </td> | |
65 </tr> | |
66 <tr> | |
67 <td class="function_type"> | |
68 <span class="returnvalue">void</span> | |
69 </td> | |
70 <td class="function_name"> | |
71 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-get-versions" title="cairo_pdf_get_versions ()">cairo_pdf_get_versions</a> <span class="c_punctuation">()</span> | |
72 </td> | |
73 </tr> | |
74 <tr> | |
75 <td class="function_type">const <span class="returnvalue">char</span> * | |
76 </td> | |
77 <td class="function_name"> | |
78 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-version-to-string" title="cairo_pdf_version_to_string ()">cairo_pdf_version_to_string</a> <span class="c_punctuation">()</span> | |
79 </td> | |
80 </tr> | |
81 <tr> | |
82 <td class="function_type"> | |
83 <span class="returnvalue">void</span> | |
84 </td> | |
85 <td class="function_name"> | |
86 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-set-size" title="cairo_pdf_surface_set_size ()">cairo_pdf_surface_set_size</a> <span class="c_punctuation">()</span> | |
87 </td> | |
88 </tr> | |
89 <tr> | |
90 <td class="function_type"> | |
91 <span class="returnvalue">int</span> | |
92 </td> | |
93 <td class="function_name"> | |
94 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-add-outline" title="cairo_pdf_surface_add_outline ()">cairo_pdf_surface_add_outline</a> <span class="c_punctuation">()</span> | |
95 </td> | |
96 </tr> | |
97 <tr> | |
98 <td class="function_type"> | |
99 <span class="returnvalue">void</span> | |
100 </td> | |
101 <td class="function_name"> | |
102 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-set-metadata" title="cairo_pdf_surface_set_metadata ()">cairo_pdf_surface_set_metadata</a> <span class="c_punctuation">()</span> | |
103 </td> | |
104 </tr> | |
105 <tr> | |
106 <td class="function_type"> | |
107 <span class="returnvalue">void</span> | |
108 </td> | |
109 <td class="function_name"> | |
110 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-set-page-label" title="cairo_pdf_surface_set_page_label ()">cairo_pdf_surface_set_page_label</a> <span class="c_punctuation">()</span> | |
111 </td> | |
112 </tr> | |
113 <tr> | |
114 <td class="function_type"> | |
115 <span class="returnvalue">void</span> | |
116 </td> | |
117 <td class="function_name"> | |
118 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-set-thumbnail-size" title="cairo_pdf_surface_set_thumbnail_size ()">cairo_pdf_surface_set_thumbnail_size</a> <span class="c_punctuation">()</span> | |
119 </td> | |
120 </tr> | |
121 </tbody> | |
122 </table></div> | |
123 </div> | |
124 <div class="refsect1"> | |
125 <a name="cairo-PDF-Surfaces.other"></a><h2>Types and Values</h2> | |
126 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
127 <colgroup> | |
128 <col width="150px" class="name"> | |
129 <col class="description"> | |
130 </colgroup> | |
131 <tbody> | |
132 <tr> | |
133 <td class="define_keyword">#define</td> | |
134 <td class="function_name"><a class="link" href="cairo-PDF-Surfaces.html#CAIRO-HAS-PDF-SURFACE:CAPS" title="CAIRO_HAS_PDF_SURFACE">CAIRO_HAS_PDF_SURFACE</a></td> | |
135 </tr> | |
136 <tr> | |
137 <td class="define_keyword">#define</td> | |
138 <td class="function_name"><a class="link" href="cairo-PDF-Surfaces.html#CAIRO-PDF-OUTLINE-ROOT:CAPS" title="CAIRO_PDF_OUTLINE_ROOT">CAIRO_PDF_OUTLINE_ROOT</a></td> | |
139 </tr> | |
140 <tr> | |
141 <td class="datatype_keyword">enum</td> | |
142 <td class="function_name"><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-outline-flags-t" title="enum cairo_pdf_outline_flags_t">cairo_pdf_outline_flags_t</a></td> | |
143 </tr> | |
144 <tr> | |
145 <td class="datatype_keyword">enum</td> | |
146 <td class="function_name"><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-metadata-t" title="enum cairo_pdf_metadata_t">cairo_pdf_metadata_t</a></td> | |
147 </tr> | |
148 <tr> | |
149 <td class="datatype_keyword">enum</td> | |
150 <td class="function_name"><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-version-t" title="enum cairo_pdf_version_t">cairo_pdf_version_t</a></td> | |
151 </tr> | |
152 </tbody> | |
153 </table></div> | |
154 </div> | |
155 <div class="refsect1"> | |
156 <a name="cairo-PDF-Surfaces.description"></a><h2>Description</h2> | |
157 <p>The PDF surface is used to render cairo graphics to Adobe | |
158 PDF files and is a multi-page vector surface backend.</p> | |
159 <p>The following mime types are supported: <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JPEG:CAPS" title="CAIRO_MIME_TYPE_JPEG"><code class="literal">CAIRO_MIME_TYPE_JPEG</code></a>, | |
160 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JP2:CAPS" title="CAIRO_MIME_TYPE_JP2"><code class="literal">CAIRO_MIME_TYPE_JP2</code></a>, <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-UNIQUE-ID:CAPS" title="CAIRO_MIME_TYPE_UNIQUE_ID"><code class="literal">CAIRO_MIME_TYPE_UNIQUE_ID</code></a>, | |
161 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2:CAPS" title="CAIRO_MIME_TYPE_JBIG2"><code class="literal">CAIRO_MIME_TYPE_JBIG2</code></a>, <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2-GLOBAL:CAPS" title="CAIRO_MIME_TYPE_JBIG2_GLOBAL"><code class="literal">CAIRO_MIME_TYPE_JBIG2_GLOBAL</code></a>, | |
162 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2-GLOBAL-ID:CAPS" title="CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID"><code class="literal">CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID</code></a>, | |
163 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-CCITT-FAX:CAPS" title="CAIRO_MIME_TYPE_CCITT_FAX"><code class="literal">CAIRO_MIME_TYPE_CCITT_FAX</code></a>, <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-CCITT-FAX-PARAMS:CAPS" title="CAIRO_MIME_TYPE_CCITT_FAX_PARAMS"><code class="literal">CAIRO_MIME_TYPE_CCITT_FAX_PARAMS</code></a>.</p> | |
164 <div class="refsect2"> | |
165 <a name="id-1.5.5.5.4"></a><h3>JBIG2 Images</h3> | |
166 <p>JBIG2 data in PDF must be in the embedded format as described in | |
167 ISO/IEC 11544. Image specific JBIG2 data must be in | |
168 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2:CAPS" title="CAIRO_MIME_TYPE_JBIG2"><code class="literal">CAIRO_MIME_TYPE_JBIG2</code></a>. Any global segments in the JBIG2 data | |
169 (segments with page association field set to 0) must be in | |
170 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2-GLOBAL:CAPS" title="CAIRO_MIME_TYPE_JBIG2_GLOBAL"><code class="literal">CAIRO_MIME_TYPE_JBIG2_GLOBAL</code></a>. The global data may be shared by | |
171 multiple images. All images sharing the same global data must set | |
172 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2-GLOBAL-ID:CAPS" title="CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID"><code class="literal">CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID</code></a> to a unique identifier. At least | |
173 one of the images must provide the global data using | |
174 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2-GLOBAL:CAPS" title="CAIRO_MIME_TYPE_JBIG2_GLOBAL"><code class="literal">CAIRO_MIME_TYPE_JBIG2_GLOBAL</code></a>. The global data will only be | |
175 embedded once and shared by all JBIG2 images with the same | |
176 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2-GLOBAL-ID:CAPS" title="CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID"><code class="literal">CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID</code></a>.</p> | |
177 </div> | |
178 <hr> | |
179 <div class="refsect2"> | |
180 <a name="ccitt"></a><h3>CCITT Fax Images</h3> | |
181 <p>The <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-CCITT-FAX:CAPS" title="CAIRO_MIME_TYPE_CCITT_FAX"><code class="literal">CAIRO_MIME_TYPE_CCITT_FAX</code></a> mime data requires a number of decoding | |
182 parameters These parameters are specified using <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-CCITT-FAX-PARAMS:CAPS" title="CAIRO_MIME_TYPE_CCITT_FAX_PARAMS"><code class="literal">CAIRO_MIME_TYPE_CCITT_FAX_PARAMS</code></a>.</p> | |
183 <p><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-CCITT-FAX-PARAMS:CAPS" title="CAIRO_MIME_TYPE_CCITT_FAX_PARAMS"><code class="literal">CAIRO_MIME_TYPE_CCITT_FAX_PARAMS</code></a> mime data must contain a string of the form | |
184 "param1=value1 param2=value2 ...".</p> | |
185 <p><em class="parameter"><code>Columns</code></em> | |
186 : [required] An integer specifying the width of the image in pixels.</p> | |
187 <p><em class="parameter"><code>Rows</code></em> | |
188 : [required] An integer specifying the height of the image in scan lines.</p> | |
189 <p><em class="parameter"><code>K</code></em> | |
190 : [optional] An integer identifying the encoding scheme used. < 0 | |
191 is 2 dimensional Group 4, = 0 is Group3 1 dimensional, > 0 is mixed 1 | |
192 and 2 dimensional encoding. Default is 0.</p> | |
193 <p><em class="parameter"><code>EndOfLine</code></em> | |
194 : [optional] If true end-of-line bit patterns are present. Default is false.</p> | |
195 <p><em class="parameter"><code>EncodedByteAlign</code></em> | |
196 : [optional] If true the end of line is padded | |
197 with 0 bits so the next line begins on a byte boundary. Default is false.</p> | |
198 <p><em class="parameter"><code>EndOfBlock</code></em> | |
199 : [optional] If true the data contains an end-of-block pattern. Default is true.</p> | |
200 <p><em class="parameter"><code>BlackIs1</code></em> | |
201 : [optional] If true 1 bits are black pixels. Default is false.</p> | |
202 <p><em class="parameter"><code>DamagedRowsBeforeError</code></em> | |
203 : [optional] An integer specifying the | |
204 number of damages rows tolerated before an error occurs. Default is 0.</p> | |
205 <p>Boolean values may be "true" or "false", or 1 or 0.</p> | |
206 <p>These parameters are the same as the CCITTFaxDecode parameters in the | |
207 <a class="ulink" href="https://www.adobe.com/products/postscript/pdfs/PLRM.pdf" target="_top">PostScript Language Reference</a> | |
208 and <a class="ulink" href="https://www.adobe.com/content/dam/Adobe/en/devnet/pdf/pdfs/PDF32000_2008.pdf" target="_top">Portable Document Format (PDF)</a>. | |
209 Refer to these documents for further details.</p> | |
210 <p>An example <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-CCITT-FAX-PARAMS:CAPS" title="CAIRO_MIME_TYPE_CCITT_FAX_PARAMS"><code class="literal">CAIRO_MIME_TYPE_CCITT_FAX_PARAMS</code></a> string is:</p> | |
211 <pre class="programlisting"> | |
212 "Columns=10230 Rows=40000 K=1 EndOfLine=true EncodedByteAlign=1 BlackIs1=false" | |
213 </pre> | |
214 </div> | |
215 </div> | |
216 <div class="refsect1"> | |
217 <a name="cairo-PDF-Surfaces.functions_details"></a><h2>Functions</h2> | |
218 <div class="refsect2"> | |
219 <a name="cairo-pdf-surface-create"></a><h3>cairo_pdf_surface_create ()</h3> | |
220 <pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> * | |
221 cairo_pdf_surface_create (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, | |
222 <em class="parameter"><code><span class="type">double</span> width_in_points</code></em>, | |
223 <em class="parameter"><code><span class="type">double</span> height_in_points</code></em>);</pre> | |
224 <p>Creates a PDF surface of the specified size in points to be written | |
225 to <em class="parameter"><code>filename</code></em> | |
226 .</p> | |
227 <div class="refsect3"> | |
228 <a name="cairo-pdf-surface-create.parameters"></a><h4>Parameters</h4> | |
229 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
230 <colgroup> | |
231 <col width="150px" class="parameters_name"> | |
232 <col class="parameters_description"> | |
233 <col width="200px" class="parameters_annotations"> | |
234 </colgroup> | |
235 <tbody> | |
236 <tr> | |
237 <td class="parameter_name"><p>filename</p></td> | |
238 <td class="parameter_description"><p>a filename for the PDF output (must be writable), <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> may be | |
239 used to specify no output. This will generate a PDF surface that | |
240 may be queried and used as a source, without generating a | |
241 temporary file.</p></td> | |
242 <td class="parameter_annotations"> </td> | |
243 </tr> | |
244 <tr> | |
245 <td class="parameter_name"><p>width_in_points</p></td> | |
246 <td class="parameter_description"><p>width of the surface, in points (1 point == 1/72.0 inch)</p></td> | |
247 <td class="parameter_annotations"> </td> | |
248 </tr> | |
249 <tr> | |
250 <td class="parameter_name"><p>height_in_points</p></td> | |
251 <td class="parameter_description"><p>height of the surface, in points (1 point == 1/72.0 inch)</p></td> | |
252 <td class="parameter_annotations"> </td> | |
253 </tr> | |
254 </tbody> | |
255 </table></div> | |
256 </div> | |
257 <div class="refsect3"> | |
258 <a name="cairo-pdf-surface-create.returns"></a><h4>Returns</h4> | |
259 <p> a pointer to the newly created surface. The caller | |
260 owns the surface and should call <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy" title="cairo_surface_destroy ()"><code class="function">cairo_surface_destroy()</code></a> when done | |
261 with it.</p> | |
262 <p>This function always returns a valid pointer, but it will return a | |
263 pointer to a "nil" surface if an error such as out of memory | |
264 occurs. You can use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-status" title="cairo_surface_status ()"><code class="function">cairo_surface_status()</code></a> to check for this.</p> | |
265 </div> | |
266 <p class="since">Since: 1.2</p> | |
267 </div> | |
268 <hr> | |
269 <div class="refsect2"> | |
270 <a name="cairo-pdf-surface-create-for-stream"></a><h3>cairo_pdf_surface_create_for_stream ()</h3> | |
271 <pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> * | |
272 cairo_pdf_surface_create_for_stream (<em class="parameter"><code><a class="link" href="cairo-PNG-Support.html#cairo-write-func-t" title="cairo_write_func_t ()"><span class="type">cairo_write_func_t</span></a> write_func</code></em>, | |
273 <em class="parameter"><code><span class="type">void</span> *closure</code></em>, | |
274 <em class="parameter"><code><span class="type">double</span> width_in_points</code></em>, | |
275 <em class="parameter"><code><span class="type">double</span> height_in_points</code></em>);</pre> | |
276 <p>Creates a PDF surface of the specified size in points to be written | |
277 incrementally to the stream represented by <em class="parameter"><code>write_func</code></em> | |
278 and <em class="parameter"><code>closure</code></em> | |
279 .</p> | |
280 <div class="refsect3"> | |
281 <a name="cairo-pdf-surface-create-for-stream.parameters"></a><h4>Parameters</h4> | |
282 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
283 <colgroup> | |
284 <col width="150px" class="parameters_name"> | |
285 <col class="parameters_description"> | |
286 <col width="200px" class="parameters_annotations"> | |
287 </colgroup> | |
288 <tbody> | |
289 <tr> | |
290 <td class="parameter_name"><p>write_func</p></td> | |
291 <td class="parameter_description"><p>a <a class="link" href="cairo-PNG-Support.html#cairo-write-func-t" title="cairo_write_func_t ()"><span class="type">cairo_write_func_t</span></a> to accept the output data, may be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> | |
292 to indicate a no-op <em class="parameter"><code>write_func</code></em> | |
293 . With a no-op <em class="parameter"><code>write_func</code></em> | |
294 , | |
295 the surface may be queried or used as a source without | |
296 generating any temporary files.</p></td> | |
297 <td class="parameter_annotations"> </td> | |
298 </tr> | |
299 <tr> | |
300 <td class="parameter_name"><p>closure</p></td> | |
301 <td class="parameter_description"><p>the closure argument for <em class="parameter"><code>write_func</code></em> | |
302 </p></td> | |
303 <td class="parameter_annotations"> </td> | |
304 </tr> | |
305 <tr> | |
306 <td class="parameter_name"><p>width_in_points</p></td> | |
307 <td class="parameter_description"><p>width of the surface, in points (1 point == 1/72.0 inch)</p></td> | |
308 <td class="parameter_annotations"> </td> | |
309 </tr> | |
310 <tr> | |
311 <td class="parameter_name"><p>height_in_points</p></td> | |
312 <td class="parameter_description"><p>height of the surface, in points (1 point == 1/72.0 inch)</p></td> | |
313 <td class="parameter_annotations"> </td> | |
314 </tr> | |
315 </tbody> | |
316 </table></div> | |
317 </div> | |
318 <div class="refsect3"> | |
319 <a name="cairo-pdf-surface-create-for-stream.returns"></a><h4>Returns</h4> | |
320 <p> a pointer to the newly created surface. The caller | |
321 owns the surface and should call <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy" title="cairo_surface_destroy ()"><code class="function">cairo_surface_destroy()</code></a> when done | |
322 with it.</p> | |
323 <p>This function always returns a valid pointer, but it will return a | |
324 pointer to a "nil" surface if an error such as out of memory | |
325 occurs. You can use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-status" title="cairo_surface_status ()"><code class="function">cairo_surface_status()</code></a> to check for this.</p> | |
326 </div> | |
327 <p class="since">Since: 1.2</p> | |
328 </div> | |
329 <hr> | |
330 <div class="refsect2"> | |
331 <a name="cairo-pdf-surface-restrict-to-version"></a><h3>cairo_pdf_surface_restrict_to_version ()</h3> | |
332 <pre class="programlisting"><span class="returnvalue">void</span> | |
333 cairo_pdf_surface_restrict_to_version (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>, | |
334 <em class="parameter"><code><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-version-t" title="enum cairo_pdf_version_t"><span class="type">cairo_pdf_version_t</span></a> version</code></em>);</pre> | |
335 <p>Restricts the generated PDF file to <em class="parameter"><code>version</code></em> | |
336 . See <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-get-versions" title="cairo_pdf_get_versions ()"><code class="function">cairo_pdf_get_versions()</code></a> | |
337 for a list of available version values that can be used here.</p> | |
338 <p>This function should only be called before any drawing operations | |
339 have been performed on the given surface. The simplest way to do | |
340 this is to call this function immediately after creating the | |
341 surface.</p> | |
342 <div class="refsect3"> | |
343 <a name="cairo-pdf-surface-restrict-to-version.parameters"></a><h4>Parameters</h4> | |
344 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
345 <colgroup> | |
346 <col width="150px" class="parameters_name"> | |
347 <col class="parameters_description"> | |
348 <col width="200px" class="parameters_annotations"> | |
349 </colgroup> | |
350 <tbody> | |
351 <tr> | |
352 <td class="parameter_name"><p>surface</p></td> | |
353 <td class="parameter_description"><p>a PDF <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td> | |
354 <td class="parameter_annotations"> </td> | |
355 </tr> | |
356 <tr> | |
357 <td class="parameter_name"><p>version</p></td> | |
358 <td class="parameter_description"><p>PDF version</p></td> | |
359 <td class="parameter_annotations"> </td> | |
360 </tr> | |
361 </tbody> | |
362 </table></div> | |
363 </div> | |
364 <p class="since">Since: 1.10</p> | |
365 </div> | |
366 <hr> | |
367 <div class="refsect2"> | |
368 <a name="cairo-pdf-get-versions"></a><h3>cairo_pdf_get_versions ()</h3> | |
369 <pre class="programlisting"><span class="returnvalue">void</span> | |
370 cairo_pdf_get_versions (<em class="parameter"><code><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-version-t" title="enum cairo_pdf_version_t"><span class="type">cairo_pdf_version_t</span></a> const **versions</code></em>, | |
371 <em class="parameter"><code><span class="type">int</span> *num_versions</code></em>);</pre> | |
372 <p>Used to retrieve the list of supported versions. See | |
373 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-restrict-to-version" title="cairo_pdf_surface_restrict_to_version ()"><code class="function">cairo_pdf_surface_restrict_to_version()</code></a>.</p> | |
374 <div class="refsect3"> | |
375 <a name="cairo-pdf-get-versions.parameters"></a><h4>Parameters</h4> | |
376 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
377 <colgroup> | |
378 <col width="150px" class="parameters_name"> | |
379 <col class="parameters_description"> | |
380 <col width="200px" class="parameters_annotations"> | |
381 </colgroup> | |
382 <tbody> | |
383 <tr> | |
384 <td class="parameter_name"><p>versions</p></td> | |
385 <td class="parameter_description"><p>supported version list</p></td> | |
386 <td class="parameter_annotations"> </td> | |
387 </tr> | |
388 <tr> | |
389 <td class="parameter_name"><p>num_versions</p></td> | |
390 <td class="parameter_description"><p>list length</p></td> | |
391 <td class="parameter_annotations"> </td> | |
392 </tr> | |
393 </tbody> | |
394 </table></div> | |
395 </div> | |
396 <p class="since">Since: 1.10</p> | |
397 </div> | |
398 <hr> | |
399 <div class="refsect2"> | |
400 <a name="cairo-pdf-version-to-string"></a><h3>cairo_pdf_version_to_string ()</h3> | |
401 <pre class="programlisting">const <span class="returnvalue">char</span> * | |
402 cairo_pdf_version_to_string (<em class="parameter"><code><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-version-t" title="enum cairo_pdf_version_t"><span class="type">cairo_pdf_version_t</span></a> version</code></em>);</pre> | |
403 <p>Get the string representation of the given <em class="parameter"><code>version</code></em> | |
404 id. This function | |
405 will return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>version</code></em> | |
406 isn't valid. See <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-get-versions" title="cairo_pdf_get_versions ()"><code class="function">cairo_pdf_get_versions()</code></a> | |
407 for a way to get the list of valid version ids.</p> | |
408 <div class="refsect3"> | |
409 <a name="cairo-pdf-version-to-string.parameters"></a><h4>Parameters</h4> | |
410 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
411 <colgroup> | |
412 <col width="150px" class="parameters_name"> | |
413 <col class="parameters_description"> | |
414 <col width="200px" class="parameters_annotations"> | |
415 </colgroup> | |
416 <tbody><tr> | |
417 <td class="parameter_name"><p>version</p></td> | |
418 <td class="parameter_description"><p>a version id</p></td> | |
419 <td class="parameter_annotations"> </td> | |
420 </tr></tbody> | |
421 </table></div> | |
422 </div> | |
423 <div class="refsect3"> | |
424 <a name="cairo-pdf-version-to-string.returns"></a><h4>Returns</h4> | |
425 <p> the string associated to given version.</p> | |
426 </div> | |
427 <p class="since">Since: 1.10</p> | |
428 </div> | |
429 <hr> | |
430 <div class="refsect2"> | |
431 <a name="cairo-pdf-surface-set-size"></a><h3>cairo_pdf_surface_set_size ()</h3> | |
432 <pre class="programlisting"><span class="returnvalue">void</span> | |
433 cairo_pdf_surface_set_size (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>, | |
434 <em class="parameter"><code><span class="type">double</span> width_in_points</code></em>, | |
435 <em class="parameter"><code><span class="type">double</span> height_in_points</code></em>);</pre> | |
436 <p>Changes the size of a PDF surface for the current (and | |
437 subsequent) pages.</p> | |
438 <p>This function should only be called before any drawing operations | |
439 have been performed on the current page. The simplest way to do | |
440 this is to call this function immediately after creating the | |
441 surface or immediately after completing a page with either | |
442 <a class="link" href="cairo-cairo-t.html#cairo-show-page" title="cairo_show_page ()"><code class="function">cairo_show_page()</code></a> or <a class="link" href="cairo-cairo-t.html#cairo-copy-page" title="cairo_copy_page ()"><code class="function">cairo_copy_page()</code></a>.</p> | |
443 <div class="refsect3"> | |
444 <a name="cairo-pdf-surface-set-size.parameters"></a><h4>Parameters</h4> | |
445 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
446 <colgroup> | |
447 <col width="150px" class="parameters_name"> | |
448 <col class="parameters_description"> | |
449 <col width="200px" class="parameters_annotations"> | |
450 </colgroup> | |
451 <tbody> | |
452 <tr> | |
453 <td class="parameter_name"><p>surface</p></td> | |
454 <td class="parameter_description"><p>a PDF <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td> | |
455 <td class="parameter_annotations"> </td> | |
456 </tr> | |
457 <tr> | |
458 <td class="parameter_name"><p>width_in_points</p></td> | |
459 <td class="parameter_description"><p>new surface width, in points (1 point == 1/72.0 inch)</p></td> | |
460 <td class="parameter_annotations"> </td> | |
461 </tr> | |
462 <tr> | |
463 <td class="parameter_name"><p>height_in_points</p></td> | |
464 <td class="parameter_description"><p>new surface height, in points (1 point == 1/72.0 inch)</p></td> | |
465 <td class="parameter_annotations"> </td> | |
466 </tr> | |
467 </tbody> | |
468 </table></div> | |
469 </div> | |
470 <p class="since">Since: 1.2</p> | |
471 </div> | |
472 <hr> | |
473 <div class="refsect2"> | |
474 <a name="cairo-pdf-surface-add-outline"></a><h3>cairo_pdf_surface_add_outline ()</h3> | |
475 <pre class="programlisting"><span class="returnvalue">int</span> | |
476 cairo_pdf_surface_add_outline (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>, | |
477 <em class="parameter"><code><span class="type">int</span> parent_id</code></em>, | |
478 <em class="parameter"><code>const <span class="type">char</span> *utf8</code></em>, | |
479 <em class="parameter"><code>const <span class="type">char</span> *link_attribs</code></em>, | |
480 <em class="parameter"><code><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-outline-flags-t" title="enum cairo_pdf_outline_flags_t"><span class="type">cairo_pdf_outline_flags_t</span></a> flags</code></em>);</pre> | |
481 <p>Add an item to the document outline hierarchy with the name <em class="parameter"><code>utf8</code></em> | |
482 | |
483 that links to the location specified by <em class="parameter"><code>link_attribs</code></em> | |
484 . Link | |
485 attributes have the same keys and values as the <a class="link" href="cairo-Tags-and-Links.html#link" title="Link Tags">Link Tag</a>, | |
486 excluding the "rect" attribute. The item will be a child of the | |
487 item with id <em class="parameter"><code>parent_id</code></em> | |
488 . Use <a class="link" href="cairo-PDF-Surfaces.html#CAIRO-PDF-OUTLINE-ROOT:CAPS" title="CAIRO_PDF_OUTLINE_ROOT"><code class="literal">CAIRO_PDF_OUTLINE_ROOT</code></a> as the parent | |
489 id of top level items.</p> | |
490 <div class="refsect3"> | |
491 <a name="cairo-pdf-surface-add-outline.parameters"></a><h4>Parameters</h4> | |
492 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
493 <colgroup> | |
494 <col width="150px" class="parameters_name"> | |
495 <col class="parameters_description"> | |
496 <col width="200px" class="parameters_annotations"> | |
497 </colgroup> | |
498 <tbody> | |
499 <tr> | |
500 <td class="parameter_name"><p>surface</p></td> | |
501 <td class="parameter_description"><p>a PDF <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td> | |
502 <td class="parameter_annotations"> </td> | |
503 </tr> | |
504 <tr> | |
505 <td class="parameter_name"><p>parent_id</p></td> | |
506 <td class="parameter_description"><p>the id of the parent item or <a class="link" href="cairo-PDF-Surfaces.html#CAIRO-PDF-OUTLINE-ROOT:CAPS" title="CAIRO_PDF_OUTLINE_ROOT"><code class="literal">CAIRO_PDF_OUTLINE_ROOT</code></a> if this is a top level item.</p></td> | |
507 <td class="parameter_annotations"> </td> | |
508 </tr> | |
509 <tr> | |
510 <td class="parameter_name"><p>utf8</p></td> | |
511 <td class="parameter_description"><p>the name of the outline</p></td> | |
512 <td class="parameter_annotations"> </td> | |
513 </tr> | |
514 <tr> | |
515 <td class="parameter_name"><p>link_attribs</p></td> | |
516 <td class="parameter_description"><p>the link attributes specifying where this outline links to</p></td> | |
517 <td class="parameter_annotations"> </td> | |
518 </tr> | |
519 <tr> | |
520 <td class="parameter_name"><p>flags</p></td> | |
521 <td class="parameter_description"><p>outline item flags</p></td> | |
522 <td class="parameter_annotations"> </td> | |
523 </tr> | |
524 </tbody> | |
525 </table></div> | |
526 </div> | |
527 <div class="refsect3"> | |
528 <a name="cairo-pdf-surface-add-outline.returns"></a><h4>Returns</h4> | |
529 <p> the id for the added item.</p> | |
530 </div> | |
531 <p class="since">Since: 1.16</p> | |
532 </div> | |
533 <hr> | |
534 <div class="refsect2"> | |
535 <a name="cairo-pdf-surface-set-metadata"></a><h3>cairo_pdf_surface_set_metadata ()</h3> | |
536 <pre class="programlisting"><span class="returnvalue">void</span> | |
537 cairo_pdf_surface_set_metadata (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>, | |
538 <em class="parameter"><code><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-metadata-t" title="enum cairo_pdf_metadata_t"><span class="type">cairo_pdf_metadata_t</span></a> metadata</code></em>, | |
539 <em class="parameter"><code>const <span class="type">char</span> *utf8</code></em>);</pre> | |
540 <p>Set document metadata. The <a class="link" href="cairo-PDF-Surfaces.html#CAIRO-PDF-METADATA-CREATE-DATE:CAPS"><code class="literal">CAIRO_PDF_METADATA_CREATE_DATE</code></a> and | |
541 <a class="link" href="cairo-PDF-Surfaces.html#CAIRO-PDF-METADATA-MOD-DATE:CAPS"><code class="literal">CAIRO_PDF_METADATA_MOD_DATE</code></a> values must be in ISO-8601 format: | |
542 YYYY-MM-DDThh:mm:ss. An optional timezone of the form "[+/-]hh:mm" | |
543 or "Z" for UTC time can be appended. All other metadata values can be any UTF-8 | |
544 string.</p> | |
545 <p>For example:</p> | |
546 <div class="informalexample"> | |
547 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> | |
548 <tbody> | |
549 <tr> | |
550 <td class="listing_lines" align="right"><pre>1 | |
551 2</pre></td> | |
552 <td class="listing_code"><pre class="programlisting"><span class="function"><a href="cairo-PDF-Surfaces.html#cairo-pdf-surface-set-metadata">cairo_pdf_surface_set_metadata</a></span> <span class="gtkdoc opt">(</span>surface<span class="gtkdoc opt">,</span> CAIRO_PDF_METADATA_TITLE<span class="gtkdoc opt">,</span> <span class="string">"My Document"</span><span class="gtkdoc opt">);</span> | |
553 <span class="function"><a href="cairo-PDF-Surfaces.html#cairo-pdf-surface-set-metadata">cairo_pdf_surface_set_metadata</a></span> <span class="gtkdoc opt">(</span>surface<span class="gtkdoc opt">,</span> CAIRO_PDF_METADATA_CREATE_DATE<span class="gtkdoc opt">,</span> <span class="string">"2015-12-31T23:59+02:00"</span><span class="gtkdoc opt">);</span></pre></td> | |
554 </tr> | |
555 </tbody> | |
556 </table> | |
557 </div> | |
558 | |
559 <div class="refsect3"> | |
560 <a name="cairo-pdf-surface-set-metadata.parameters"></a><h4>Parameters</h4> | |
561 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
562 <colgroup> | |
563 <col width="150px" class="parameters_name"> | |
564 <col class="parameters_description"> | |
565 <col width="200px" class="parameters_annotations"> | |
566 </colgroup> | |
567 <tbody> | |
568 <tr> | |
569 <td class="parameter_name"><p>surface</p></td> | |
570 <td class="parameter_description"><p>a PDF <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td> | |
571 <td class="parameter_annotations"> </td> | |
572 </tr> | |
573 <tr> | |
574 <td class="parameter_name"><p>metadata</p></td> | |
575 <td class="parameter_description"><p>The metadata item to set.</p></td> | |
576 <td class="parameter_annotations"> </td> | |
577 </tr> | |
578 <tr> | |
579 <td class="parameter_name"><p>utf8</p></td> | |
580 <td class="parameter_description"><p>metadata value</p></td> | |
581 <td class="parameter_annotations"> </td> | |
582 </tr> | |
583 </tbody> | |
584 </table></div> | |
585 </div> | |
586 <p class="since">Since: 1.16</p> | |
587 </div> | |
588 <hr> | |
589 <div class="refsect2"> | |
590 <a name="cairo-pdf-surface-set-page-label"></a><h3>cairo_pdf_surface_set_page_label ()</h3> | |
591 <pre class="programlisting"><span class="returnvalue">void</span> | |
592 cairo_pdf_surface_set_page_label (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>, | |
593 <em class="parameter"><code>const <span class="type">char</span> *utf8</code></em>);</pre> | |
594 <p>Set page label for the current page.</p> | |
595 <div class="refsect3"> | |
596 <a name="cairo-pdf-surface-set-page-label.parameters"></a><h4>Parameters</h4> | |
597 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
598 <colgroup> | |
599 <col width="150px" class="parameters_name"> | |
600 <col class="parameters_description"> | |
601 <col width="200px" class="parameters_annotations"> | |
602 </colgroup> | |
603 <tbody> | |
604 <tr> | |
605 <td class="parameter_name"><p>surface</p></td> | |
606 <td class="parameter_description"><p>a PDF <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td> | |
607 <td class="parameter_annotations"> </td> | |
608 </tr> | |
609 <tr> | |
610 <td class="parameter_name"><p>utf8</p></td> | |
611 <td class="parameter_description"><p>The page label.</p></td> | |
612 <td class="parameter_annotations"> </td> | |
613 </tr> | |
614 </tbody> | |
615 </table></div> | |
616 </div> | |
617 <p class="since">Since: 1.16</p> | |
618 </div> | |
619 <hr> | |
620 <div class="refsect2"> | |
621 <a name="cairo-pdf-surface-set-thumbnail-size"></a><h3>cairo_pdf_surface_set_thumbnail_size ()</h3> | |
622 <pre class="programlisting"><span class="returnvalue">void</span> | |
623 cairo_pdf_surface_set_thumbnail_size (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>, | |
624 <em class="parameter"><code><span class="type">int</span> width</code></em>, | |
625 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre> | |
626 <p>Set the thumbnail image size for the current and all subsequent | |
627 pages. Setting a width or height of 0 disables thumbnails for the | |
628 current and subsequent pages.</p> | |
629 <div class="refsect3"> | |
630 <a name="cairo-pdf-surface-set-thumbnail-size.parameters"></a><h4>Parameters</h4> | |
631 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
632 <colgroup> | |
633 <col width="150px" class="parameters_name"> | |
634 <col class="parameters_description"> | |
635 <col width="200px" class="parameters_annotations"> | |
636 </colgroup> | |
637 <tbody> | |
638 <tr> | |
639 <td class="parameter_name"><p>surface</p></td> | |
640 <td class="parameter_description"><p>a PDF <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td> | |
641 <td class="parameter_annotations"> </td> | |
642 </tr> | |
643 <tr> | |
644 <td class="parameter_name"><p>width</p></td> | |
645 <td class="parameter_description"><p>Thumbnail width.</p></td> | |
646 <td class="parameter_annotations"> </td> | |
647 </tr> | |
648 <tr> | |
649 <td class="parameter_name"><p>height</p></td> | |
650 <td class="parameter_description"><p>Thumbnail height</p></td> | |
651 <td class="parameter_annotations"> </td> | |
652 </tr> | |
653 </tbody> | |
654 </table></div> | |
655 </div> | |
656 <p class="since">Since: 1.16</p> | |
657 </div> | |
658 </div> | |
659 <div class="refsect1"> | |
660 <a name="cairo-PDF-Surfaces.other_details"></a><h2>Types and Values</h2> | |
661 <div class="refsect2"> | |
662 <a name="CAIRO-HAS-PDF-SURFACE:CAPS"></a><h3>CAIRO_HAS_PDF_SURFACE</h3> | |
663 <pre class="programlisting">#define CAIRO_HAS_PDF_SURFACE 1 | |
664 </pre> | |
665 <p>Defined if the PDF surface backend is available. | |
666 This macro can be used to conditionally compile backend-specific code.</p> | |
667 <p class="since">Since: 1.2</p> | |
668 </div> | |
669 <hr> | |
670 <div class="refsect2"> | |
671 <a name="CAIRO-PDF-OUTLINE-ROOT:CAPS"></a><h3>CAIRO_PDF_OUTLINE_ROOT</h3> | |
672 <pre class="programlisting">#define CAIRO_PDF_OUTLINE_ROOT 0 | |
673 </pre> | |
674 <p>The root outline item in <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-add-outline" title="cairo_pdf_surface_add_outline ()"><code class="function">cairo_pdf_surface_add_outline()</code></a>.</p> | |
675 <p class="since">Since: 1.16</p> | |
676 </div> | |
677 <hr> | |
678 <div class="refsect2"> | |
679 <a name="cairo-pdf-outline-flags-t"></a><h3>enum cairo_pdf_outline_flags_t</h3> | |
680 <p><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-outline-flags-t" title="enum cairo_pdf_outline_flags_t"><span class="type">cairo_pdf_outline_flags_t</span></a> is used by the | |
681 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-add-outline" title="cairo_pdf_surface_add_outline ()"><code class="function">cairo_pdf_surface_add_outline()</code></a> function specify the attributes of | |
682 an outline item. These flags may be bitwise-or'd to produce any | |
683 combination of flags.</p> | |
684 <div class="refsect3"> | |
685 <a name="cairo-pdf-outline-flags-t.members"></a><h4>Members</h4> | |
686 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
687 <colgroup> | |
688 <col width="300px" class="enum_members_name"> | |
689 <col class="enum_members_description"> | |
690 <col width="200px" class="enum_members_annotations"> | |
691 </colgroup> | |
692 <tbody> | |
693 <tr> | |
694 <td class="enum_member_name"><p><a name="CAIRO-PDF-OUTLINE-FLAG-OPEN:CAPS"></a>CAIRO_PDF_OUTLINE_FLAG_OPEN</p></td> | |
695 <td class="enum_member_description"> | |
696 <p>The outline item defaults to open in the PDF viewer (Since 1.16)</p> | |
697 </td> | |
698 <td class="enum_member_annotations"> </td> | |
699 </tr> | |
700 <tr> | |
701 <td class="enum_member_name"><p><a name="CAIRO-PDF-OUTLINE-FLAG-BOLD:CAPS"></a>CAIRO_PDF_OUTLINE_FLAG_BOLD</p></td> | |
702 <td class="enum_member_description"> | |
703 <p>The outline item is displayed by the viewer in bold text (Since 1.16)</p> | |
704 </td> | |
705 <td class="enum_member_annotations"> </td> | |
706 </tr> | |
707 <tr> | |
708 <td class="enum_member_name"><p><a name="CAIRO-PDF-OUTLINE-FLAG-ITALIC:CAPS"></a>CAIRO_PDF_OUTLINE_FLAG_ITALIC</p></td> | |
709 <td class="enum_member_description"> | |
710 <p>The outline item is displayed by the viewer in italic text (Since 1.16)</p> | |
711 </td> | |
712 <td class="enum_member_annotations"> </td> | |
713 </tr> | |
714 </tbody> | |
715 </table></div> | |
716 </div> | |
717 <p class="since">Since: 1.16</p> | |
718 </div> | |
719 <hr> | |
720 <div class="refsect2"> | |
721 <a name="cairo-pdf-metadata-t"></a><h3>enum cairo_pdf_metadata_t</h3> | |
722 <p><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-metadata-t" title="enum cairo_pdf_metadata_t"><span class="type">cairo_pdf_metadata_t</span></a> is used by the | |
723 <a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-surface-set-metadata" title="cairo_pdf_surface_set_metadata ()"><code class="function">cairo_pdf_surface_set_metadata()</code></a> function specify the metadata to set.</p> | |
724 <div class="refsect3"> | |
725 <a name="cairo-pdf-metadata-t.members"></a><h4>Members</h4> | |
726 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
727 <colgroup> | |
728 <col width="300px" class="enum_members_name"> | |
729 <col class="enum_members_description"> | |
730 <col width="200px" class="enum_members_annotations"> | |
731 </colgroup> | |
732 <tbody> | |
733 <tr> | |
734 <td class="enum_member_name"><p><a name="CAIRO-PDF-METADATA-TITLE:CAPS"></a>CAIRO_PDF_METADATA_TITLE</p></td> | |
735 <td class="enum_member_description"> | |
736 <p>The document title (Since 1.16)</p> | |
737 </td> | |
738 <td class="enum_member_annotations"> </td> | |
739 </tr> | |
740 <tr> | |
741 <td class="enum_member_name"><p><a name="CAIRO-PDF-METADATA-AUTHOR:CAPS"></a>CAIRO_PDF_METADATA_AUTHOR</p></td> | |
742 <td class="enum_member_description"> | |
743 <p>The document author (Since 1.16)</p> | |
744 </td> | |
745 <td class="enum_member_annotations"> </td> | |
746 </tr> | |
747 <tr> | |
748 <td class="enum_member_name"><p><a name="CAIRO-PDF-METADATA-SUBJECT:CAPS"></a>CAIRO_PDF_METADATA_SUBJECT</p></td> | |
749 <td class="enum_member_description"> | |
750 <p>The document subject (Since 1.16)</p> | |
751 </td> | |
752 <td class="enum_member_annotations"> </td> | |
753 </tr> | |
754 <tr> | |
755 <td class="enum_member_name"><p><a name="CAIRO-PDF-METADATA-KEYWORDS:CAPS"></a>CAIRO_PDF_METADATA_KEYWORDS</p></td> | |
756 <td class="enum_member_description"> | |
757 <p>The document keywords (Since 1.16)</p> | |
758 </td> | |
759 <td class="enum_member_annotations"> </td> | |
760 </tr> | |
761 <tr> | |
762 <td class="enum_member_name"><p><a name="CAIRO-PDF-METADATA-CREATOR:CAPS"></a>CAIRO_PDF_METADATA_CREATOR</p></td> | |
763 <td class="enum_member_description"> | |
764 <p>The document creator (Since 1.16)</p> | |
765 </td> | |
766 <td class="enum_member_annotations"> </td> | |
767 </tr> | |
768 <tr> | |
769 <td class="enum_member_name"><p><a name="CAIRO-PDF-METADATA-CREATE-DATE:CAPS"></a>CAIRO_PDF_METADATA_CREATE_DATE</p></td> | |
770 <td class="enum_member_description"> | |
771 <p>The document creation date (Since 1.16)</p> | |
772 </td> | |
773 <td class="enum_member_annotations"> </td> | |
774 </tr> | |
775 <tr> | |
776 <td class="enum_member_name"><p><a name="CAIRO-PDF-METADATA-MOD-DATE:CAPS"></a>CAIRO_PDF_METADATA_MOD_DATE</p></td> | |
777 <td class="enum_member_description"> | |
778 <p>The document modification date (Since 1.16)</p> | |
779 </td> | |
780 <td class="enum_member_annotations"> </td> | |
781 </tr> | |
782 </tbody> | |
783 </table></div> | |
784 </div> | |
785 <p class="since">Since: 1.16</p> | |
786 </div> | |
787 <hr> | |
788 <div class="refsect2"> | |
789 <a name="cairo-pdf-version-t"></a><h3>enum cairo_pdf_version_t</h3> | |
790 <p><a class="link" href="cairo-PDF-Surfaces.html#cairo-pdf-version-t" title="enum cairo_pdf_version_t"><span class="type">cairo_pdf_version_t</span></a> is used to describe the version number of the PDF | |
791 specification that a generated PDF file will conform to.</p> | |
792 <div class="refsect3"> | |
793 <a name="cairo-pdf-version-t.members"></a><h4>Members</h4> | |
794 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
795 <colgroup> | |
796 <col width="300px" class="enum_members_name"> | |
797 <col class="enum_members_description"> | |
798 <col width="200px" class="enum_members_annotations"> | |
799 </colgroup> | |
800 <tbody> | |
801 <tr> | |
802 <td class="enum_member_name"><p><a name="CAIRO-PDF-VERSION-1-4:CAPS"></a>CAIRO_PDF_VERSION_1_4</p></td> | |
803 <td class="enum_member_description"> | |
804 <p>The version 1.4 of the PDF specification. (Since 1.10)</p> | |
805 </td> | |
806 <td class="enum_member_annotations"> </td> | |
807 </tr> | |
808 <tr> | |
809 <td class="enum_member_name"><p><a name="CAIRO-PDF-VERSION-1-5:CAPS"></a>CAIRO_PDF_VERSION_1_5</p></td> | |
810 <td class="enum_member_description"> | |
811 <p>The version 1.5 of the PDF specification. (Since 1.10)</p> | |
812 </td> | |
813 <td class="enum_member_annotations"> </td> | |
814 </tr> | |
815 </tbody> | |
816 </table></div> | |
817 </div> | |
818 <p class="since">Since: 1.10</p> | |
819 </div> | |
820 </div> | |
821 <div class="refsect1"> | |
822 <a name="cairo-PDF-Surfaces.see-also"></a><h2>See Also</h2> | |
823 <p><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p> | |
824 </div> | |
825 </div> | |
826 <div class="footer"> | |
827 <hr>Generated by GTK-Doc V1.27</div> | |
828 </body> | |
829 </html> |