1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Evince Document Library Reference Manual: ev-document-factory</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Evince Document Library Reference Manual">
<link rel="up" href="document-helpers.html" title="Part III. Helper Functions">
<link rel="prev" href="libevdocument-ev-file-helpers.html" title="ev-file-helpers">
<link rel="next" href="libevdocument-ev-backends-manager.html" title="ev-backends-manager">
<meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libevdocument-ev-document-factory.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="document-helpers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libevdocument-ev-file-helpers.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libevdocument-ev-backends-manager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libevdocument-ev-document-factory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libevdocument-ev-document-factory.top_of_page"></a>ev-document-factory</span></h2>
<p>ev-document-factory</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libevdocument-ev-document-factory.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="EvDocument.html" title="EvDocument"><span class="returnvalue">EvDocument</span></a> *
</td>
<td class="function_name">
<a class="link" href="libevdocument-ev-document-factory.html#ev-document-factory-get-document" title="ev_document_factory_get_document ()">ev_document_factory_get_document</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="EvDocument.html" title="EvDocument"><span class="returnvalue">EvDocument</span></a> *
</td>
<td class="function_name">
<a class="link" href="libevdocument-ev-document-factory.html#ev-document-factory-get-document-for-gfile" title="ev_document_factory_get_document_for_gfile ()">ev_document_factory_get_document_for_gfile</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="EvDocument.html" title="EvDocument"><span class="returnvalue">EvDocument</span></a> *
</td>
<td class="function_name">
<a class="link" href="libevdocument-ev-document-factory.html#ev-document-factory-get-document-for-stream" title="ev_document_factory_get_document_for_stream ()">ev_document_factory_get_document_for_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libevdocument-ev-document-factory.html#ev-document-factory-add-filters" title="ev_document_factory_add_filters ()">ev_document_factory_add_filters</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libevdocument-ev-document-factory.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libevdocument-ev-document-factory.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ev-document-factory-get-document"></a><h3>ev_document_factory_get_document ()</h3>
<pre class="programlisting"><a class="link" href="EvDocument.html" title="EvDocument"><span class="returnvalue">EvDocument</span></a> *
ev_document_factory_get_document (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Creates a <a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> for the document at <em class="parameter"><code>uri</code></em>
; or, if no backend handling
the document's type is found, or an error occurred on opening the document,
returns <code class="literal">NULL</code> and fills in <em class="parameter"><code>error</code></em>
.
If the document is encrypted, it is returned but also <em class="parameter"><code>error</code></em>
is set to
<a class="link" href="EvDocument.html#EV-DOCUMENT-ERROR-ENCRYPTED:CAPS"><code class="literal">EV_DOCUMENT_ERROR_ENCRYPTED</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.6.5.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>an URI</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> location to store an error, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.6.5.2.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a>, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ev-document-factory-get-document-for-gfile"></a><h3>ev_document_factory_get_document_for_gfile ()</h3>
<pre class="programlisting"><a class="link" href="EvDocument.html" title="EvDocument"><span class="returnvalue">EvDocument</span></a> *
ev_document_factory_get_document_for_gfile
(<em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
<em class="parameter"><code><a class="link" href="EvDocument.html#EvDocumentLoadFlags" title="enum EvDocumentLoadFlags"><span class="type">EvDocumentLoadFlags</span></a> flags</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="ev-document-factory-get-document-for-stream"></a><h3>ev_document_factory_get_document_for_stream ()</h3>
<pre class="programlisting"><a class="link" href="EvDocument.html" title="EvDocument"><span class="returnvalue">EvDocument</span></a> *
ev_document_factory_get_document_for_stream
(<em class="parameter"><code><span class="type">GInputStream</span> *stream</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>,
<em class="parameter"><code><a class="link" href="EvDocument.html#EvDocumentLoadFlags" title="enum EvDocumentLoadFlags"><span class="type">EvDocumentLoadFlags</span></a> flags</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="ev-document-factory-add-filters"></a><h3>ev_document_factory_add_filters ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ev_document_factory_add_filters (<em class="parameter"><code><span class="type">GtkWidget</span> *chooser</code></em>,
<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>);</pre>
<p>Adds some file filters to <em class="parameter"><code>chooser</code></em>
.</p>
<p>Always add a "All documents" format.</p>
<p>If <em class="parameter"><code>document</code></em>
is not <code class="literal">NULL</code>, adds a <span class="type">GtkFileFilter</span> for <em class="parameter"><code>document</code></em>
's MIME type.</p>
<p>If <em class="parameter"><code>document</code></em>
is <code class="literal">NULL</code>, adds a <span class="type">GtkFileFilter</span> for each document type that evince
can handle.</p>
<div class="refsect3">
<a name="id-1.4.6.5.5.8"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>chooser</p></td>
<td class="parameter_description"><p>a <span class="type">GtkFileChooser</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>document</p></td>
<td class="parameter_description"><p>a <a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libevdocument-ev-document-factory.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21.1</div>
</body>
</html>
|
