← Back to branch summary

~ubuntu-branches/ubuntu/vivid/emscripten/vivid

« back to all changes in this revision

Viewing changes to tests/poppler/glib/reference/html/poppler-poppler.html

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2013-05-02 13:11:51 UTC
  • Revision ID: package-import@ubuntu.com-20130502131151-q8dvteqr1ef2x7xz
Tags: upstream-1.4.1~20130504~adb56cb
Import upstream version 1.4.1~20130504~adb56cb

Show diffs side-by-side

added added

removed removed

Lines of Context:
tests/poppler/glib/reference/html/poppler-poppler.html
 
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>poppler</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Poppler Reference Manual">
 
8
<link rel="up" href="ch01.html" title="Poppler">
 
9
<link rel="prev" href="ch01.html" title="Poppler">
 
10
<link rel="next" href="PopplerDocument.html" title="PopplerDocument">
 
11
<meta name="generator" content="GTK-Doc V1.17 (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="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Poppler Reference Manual</th>
 
21
<td><a accesskey="n" href="PopplerDocument.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#poppler-poppler.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#poppler-poppler.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
 
29
<div class="refentry">
 
30
<a name="poppler-poppler"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle"><a name="poppler-poppler.top_of_page"></a>poppler</span></h2>
 
34
<p>poppler</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<a name="poppler-poppler.synopsis"></a><h2>Synopsis</h2>
 
40
<pre class="synopsis">
 
41
#include &lt;poppler.h&gt;
 
42
 
 
43
#define             <a class="link" href="poppler-poppler.html#POPPLER-ERROR:CAPS" title="POPPLER_ERROR">POPPLER_ERROR</a>
 
44
enum                <a class="link" href="poppler-poppler.html#PopplerError" title="enum PopplerError">PopplerError</a>;
 
45
enum                <a class="link" href="poppler-poppler.html#PopplerOrientation" title="enum PopplerOrientation">PopplerOrientation</a>;
 
46
enum                <a class="link" href="poppler-poppler.html#PopplerBackend" title="enum PopplerBackend">PopplerBackend</a>;
 
47
                    <a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor">PopplerColor</a>;
 
48
enum                <a class="link" href="poppler-poppler.html#PopplerPrintFlags" title="enum PopplerPrintFlags">PopplerPrintFlags</a>;
 
49
<a class="link" href="poppler-poppler.html#PopplerBackend" title="enum PopplerBackend"><span class="returnvalue">PopplerBackend</span></a>      <a class="link" href="poppler-poppler.html#poppler-get-backend" title="poppler_get_backend ()">poppler_get_backend</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
 
50
const <span class="returnvalue">char</span> *        <a class="link" href="poppler-poppler.html#poppler-get-version" title="poppler_get_version ()">poppler_get_version</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
 
51
<span class="returnvalue">gboolean</span>            <a class="link" href="poppler-poppler.html#poppler-date-parse" title="poppler_date_parse ()">poppler_date_parse</a>                  (<em class="parameter"><code>const <span class="type">gchar</span> *date</code></em>,
 
52
                                                         <em class="parameter"><code><span class="type">time_t</span> *timet</code></em>);
 
53
<a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="returnvalue">PopplerColor</span></a> *      <a class="link" href="poppler-poppler.html#poppler-color-new" title="poppler_color_new ()">poppler_color_new</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
 
54
<a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="returnvalue">PopplerColor</span></a> *      <a class="link" href="poppler-poppler.html#poppler-color-copy" title="poppler_color_copy ()">poppler_color_copy</a>                  (<em class="parameter"><code><a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="type">PopplerColor</span></a> *color</code></em>);
 
55
<span class="returnvalue">void</span>                <a class="link" href="poppler-poppler.html#poppler-color-free" title="poppler_color_free ()">poppler_color_free</a>                  (<em class="parameter"><code><a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="type">PopplerColor</span></a> *color</code></em>);
 
56
</pre>
 
57
</div>
 
58
<div class="refsect1">
 
59
<a name="poppler-poppler.description"></a><h2>Description</h2>
 
60
</div>
 
61
<div class="refsect1">
 
62
<a name="poppler-poppler.details"></a><h2>Details</h2>
 
63
<div class="refsect2">
 
64
<a name="POPPLER-ERROR:CAPS"></a><h3>POPPLER_ERROR</h3>
 
65
<pre class="programlisting">#define POPPLER_ERROR poppler_error_quark ()
 
66
</pre>
 
67
</div>
 
68
<hr>
 
69
<div class="refsect2">
 
70
<a name="PopplerError"></a><h3>enum PopplerError</h3>
 
71
<pre class="programlisting">typedef enum
 
72
{
 
73
  POPPLER_ERROR_INVALID,
 
74
  POPPLER_ERROR_ENCRYPTED,
 
75
  POPPLER_ERROR_OPEN_FILE,
 
76
  POPPLER_ERROR_BAD_CATALOG,
 
77
  POPPLER_ERROR_DAMAGED
 
78
} PopplerError;
 
79
</pre>
 
80
<p>
 
81
Error codes returned by <a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a>
 
82
</p>
 
83
<div class="variablelist"><table border="0">
 
84
<col align="left" valign="top">
 
85
<tbody>
 
86
<tr>
 
87
<td><p><a name="POPPLER-ERROR-INVALID:CAPS"></a><span class="term"><code class="literal">POPPLER_ERROR_INVALID</code></span></p></td>
 
88
<td>Generic error when a document opration fails
 
89
</td>
 
90
</tr>
 
91
<tr>
 
92
<td><p><a name="POPPLER-ERROR-ENCRYPTED:CAPS"></a><span class="term"><code class="literal">POPPLER_ERROR_ENCRYPTED</code></span></p></td>
 
93
<td>Document is encrypted
 
94
</td>
 
95
</tr>
 
96
<tr>
 
97
<td><p><a name="POPPLER-ERROR-OPEN-FILE:CAPS"></a><span class="term"><code class="literal">POPPLER_ERROR_OPEN_FILE</code></span></p></td>
 
98
<td>File could not be opened for writing when saving document
 
99
</td>
 
100
</tr>
 
101
<tr>
 
102
<td><p><a name="POPPLER-ERROR-BAD-CATALOG:CAPS"></a><span class="term"><code class="literal">POPPLER_ERROR_BAD_CATALOG</code></span></p></td>
 
103
<td>Failed to read the document catalog
 
104
</td>
 
105
</tr>
 
106
<tr>
 
107
<td><p><a name="POPPLER-ERROR-DAMAGED:CAPS"></a><span class="term"><code class="literal">POPPLER_ERROR_DAMAGED</code></span></p></td>
 
108
<td>Document is damaged
 
109
</td>
 
110
</tr>
 
111
</tbody>
 
112
</table></div>
 
113
</div>
 
114
<hr>
 
115
<div class="refsect2">
 
116
<a name="PopplerOrientation"></a><h3>enum PopplerOrientation</h3>
 
117
<pre class="programlisting">typedef enum
 
118
{
 
119
  POPPLER_ORIENTATION_PORTRAIT,
 
120
  POPPLER_ORIENTATION_LANDSCAPE,
 
121
  POPPLER_ORIENTATION_UPSIDEDOWN,
 
122
  POPPLER_ORIENTATION_SEASCAPE
 
123
} PopplerOrientation;
 
124
</pre>
 
125
</div>
 
126
<hr>
 
127
<div class="refsect2">
 
128
<a name="PopplerBackend"></a><h3>enum PopplerBackend</h3>
 
129
<pre class="programlisting">typedef enum
 
130
{
 
131
  POPPLER_BACKEND_UNKNOWN,
 
132
  POPPLER_BACKEND_SPLASH,
 
133
  POPPLER_BACKEND_CAIRO
 
134
} PopplerBackend;
 
135
</pre>
 
136
</div>
 
137
<hr>
 
138
<div class="refsect2">
 
139
<a name="PopplerColor"></a><h3>PopplerColor</h3>
 
140
<pre class="programlisting">typedef struct {
 
141
  guint16 red;
 
142
  guint16 green;
 
143
  guint16 blue;
 
144
} PopplerColor;
 
145
</pre>
 
146
<p>
 
147
A <a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="type">PopplerColor</span></a> describes a RGB color. Color components
 
148
are values between 0 and 65535
 
149
</p>
 
150
<div class="variablelist"><table border="0">
 
151
<col align="left" valign="top">
 
152
<tbody>
 
153
<tr>
 
154
<td><p><span class="term"><span class="type">guint16</span> <em class="structfield"><code><a name="PopplerColor.red"></a>red</code></em>;</span></p></td>
 
155
<td>the red componment of color</td>
 
156
</tr>
 
157
<tr>
 
158
<td><p><span class="term"><span class="type">guint16</span> <em class="structfield"><code><a name="PopplerColor.green"></a>green</code></em>;</span></p></td>
 
159
<td>the green component of color</td>
 
160
</tr>
 
161
<tr>
 
162
<td><p><span class="term"><span class="type">guint16</span> <em class="structfield"><code><a name="PopplerColor.blue"></a>blue</code></em>;</span></p></td>
 
163
<td>the blue component of color</td>
 
164
</tr>
 
165
</tbody>
 
166
</table></div>
 
167
</div>
 
168
<hr>
 
169
<div class="refsect2">
 
170
<a name="PopplerPrintFlags"></a><h3>enum PopplerPrintFlags</h3>
 
171
<pre class="programlisting">typedef enum /*&lt; flags &gt;*/
 
172
{
 
173
  POPPLER_PRINT_DOCUMENT          = 0,
 
174
  POPPLER_PRINT_MARKUP_ANNOTS     = 1 &lt;&lt; 0,
 
175
  POPPLER_PRINT_STAMP_ANNOTS_ONLY = 1 &lt;&lt; 1,
 
176
  POPPLER_PRINT_ALL               = POPPLER_PRINT_MARKUP_ANNOTS
 
177
} PopplerPrintFlags;
 
178
</pre>
 
179
<p>
 
180
Printing flags
 
181
</p>
 
182
<div class="variablelist"><table border="0">
 
183
<col align="left" valign="top">
 
184
<tbody>
 
185
<tr>
 
186
<td><p><a name="POPPLER-PRINT-DOCUMENT:CAPS"></a><span class="term"><code class="literal">POPPLER_PRINT_DOCUMENT</code></span></p></td>
 
187
<td>print main document contents
 
188
</td>
 
189
</tr>
 
190
<tr>
 
191
<td><p><a name="POPPLER-PRINT-MARKUP-ANNOTS:CAPS"></a><span class="term"><code class="literal">POPPLER_PRINT_MARKUP_ANNOTS</code></span></p></td>
 
192
<td>print document and markup annotations
 
193
</td>
 
194
</tr>
 
195
<tr>
 
196
<td><p><a name="POPPLER-PRINT-STAMP-ANNOTS-ONLY:CAPS"></a><span class="term"><code class="literal">POPPLER_PRINT_STAMP_ANNOTS_ONLY</code></span></p></td>
 
197
<td>print doucment and only stamp annotations
 
198
</td>
 
199
</tr>
 
200
<tr>
 
201
<td><p><a name="POPPLER-PRINT-ALL:CAPS"></a><span class="term"><code class="literal">POPPLER_PRINT_ALL</code></span></p></td>
 
202
<td>print main document contents and all markup annotations
 
203
</td>
 
204
</tr>
 
205
</tbody>
 
206
</table></div>
 
207
<p class="since">Since 0.16</p>
 
208
</div>
 
209
<hr>
 
210
<div class="refsect2">
 
211
<a name="poppler-get-backend"></a><h3>poppler_get_backend ()</h3>
 
212
<pre class="programlisting"><a class="link" href="poppler-poppler.html#PopplerBackend" title="enum PopplerBackend"><span class="returnvalue">PopplerBackend</span></a>      poppler_get_backend                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
213
<p>
 
214
Returns the backend compiled into the poppler library.
 
215
</p>
 
216
<div class="variablelist"><table border="0">
 
217
<col align="left" valign="top">
 
218
<tbody><tr>
 
219
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
220
<td>The backend used by poppler</td>
 
221
</tr></tbody>
 
222
</table></div>
 
223
</div>
 
224
<hr>
 
225
<div class="refsect2">
 
226
<a name="poppler-get-version"></a><h3>poppler_get_version ()</h3>
 
227
<pre class="programlisting">const <span class="returnvalue">char</span> *        poppler_get_version                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
228
<p>
 
229
Returns the version of poppler in use.  This result is not to be freed.
 
230
</p>
 
231
<div class="variablelist"><table border="0">
 
232
<col align="left" valign="top">
 
233
<tbody><tr>
 
234
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
235
<td>the version of poppler.</td>
 
236
</tr></tbody>
 
237
</table></div>
 
238
</div>
 
239
<hr>
 
240
<div class="refsect2">
 
241
<a name="poppler-date-parse"></a><h3>poppler_date_parse ()</h3>
 
242
<pre class="programlisting"><span class="returnvalue">gboolean</span>            poppler_date_parse                  (<em class="parameter"><code>const <span class="type">gchar</span> *date</code></em>,
 
243
                                                         <em class="parameter"><code><span class="type">time_t</span> *timet</code></em>);</pre>
 
244
<p>
 
245
Parses a PDF format date string and converts it to a <span class="type">time_t</span>. Returns <span class="type">FALSE</span>
 
246
if the parsing fails or the input string is not a valid PDF format date string
 
247
</p>
 
248
<div class="variablelist"><table border="0">
 
249
<col align="left" valign="top">
 
250
<tbody>
 
251
<tr>
 
252
<td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
 
253
<td>string to parse</td>
 
254
</tr>
 
255
<tr>
 
256
<td><p><span class="term"><em class="parameter"><code>timet</code></em> :</span></p></td>
 
257
<td>an uninitialized <span class="type">time_t</span>
 
258
</td>
 
259
</tr>
 
260
<tr>
 
261
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
262
<td>
 
263
<span class="type">TRUE</span>, if <em class="parameter"><code>timet</code></em> was set</td>
 
264
</tr>
 
265
</tbody>
 
266
</table></div>
 
267
<p class="since">Since 0.12</p>
 
268
</div>
 
269
<hr>
 
270
<div class="refsect2">
 
271
<a name="poppler-color-new"></a><h3>poppler_color_new ()</h3>
 
272
<pre class="programlisting"><a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="returnvalue">PopplerColor</span></a> *      poppler_color_new                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
273
<p>
 
274
Creates a new <a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="type">PopplerColor</span></a>
 
275
</p>
 
276
<div class="variablelist"><table border="0">
 
277
<col align="left" valign="top">
 
278
<tbody><tr>
 
279
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
280
<td>a new <a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="type">PopplerColor</span></a>, use <a class="link" href="poppler-poppler.html#poppler-color-free" title="poppler_color_free ()"><code class="function">poppler_color_free()</code></a> to free it</td>
 
281
</tr></tbody>
 
282
</table></div>
 
283
</div>
 
284
<hr>
 
285
<div class="refsect2">
 
286
<a name="poppler-color-copy"></a><h3>poppler_color_copy ()</h3>
 
287
<pre class="programlisting"><a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="returnvalue">PopplerColor</span></a> *      poppler_color_copy                  (<em class="parameter"><code><a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="type">PopplerColor</span></a> *color</code></em>);</pre>
 
288
<p>
 
289
Creates a copy of <em class="parameter"><code>color</code></em>
 
290
</p>
 
291
<div class="variablelist"><table border="0">
 
292
<col align="left" valign="top">
 
293
<tbody>
 
294
<tr>
 
295
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 
296
<td>a <a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="type">PopplerColor</span></a> to copy</td>
 
297
</tr>
 
298
<tr>
 
299
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
300
<td>a new allocated copy of <em class="parameter"><code>color</code></em>
 
301
</td>
 
302
</tr>
 
303
</tbody>
 
304
</table></div>
 
305
</div>
 
306
<hr>
 
307
<div class="refsect2">
 
308
<a name="poppler-color-free"></a><h3>poppler_color_free ()</h3>
 
309
<pre class="programlisting"><span class="returnvalue">void</span>                poppler_color_free                  (<em class="parameter"><code><a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="type">PopplerColor</span></a> *color</code></em>);</pre>
 
310
<p>
 
311
Frees the given <a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="type">PopplerColor</span></a>
 
312
</p>
 
313
<div class="variablelist"><table border="0">
 
314
<col align="left" valign="top">
 
315
<tbody><tr>
 
316
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 
317
<td>a <a class="link" href="poppler-poppler.html#PopplerColor" title="PopplerColor"><span class="type">PopplerColor</span></a>
 
318
</td>
 
319
</tr></tbody>
 
320
</table></div>
 
321
</div>
 
322
</div>
 
323
</div>
 
324
<div class="footer">
 
325
<hr>
 
326
          Generated by GTK-Doc V1.17</div>
 
327
</body>
 
328
</html>
 
 
b'\\ No newline at end of file'