This file is indexed.

/usr/share/gtk-doc/html/libgxps/GXPSPage.html is in libgxps-doc 0.2.2-2ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GXPSPage</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GXPS Reference Manual">
<link rel="up" href="ch01.html" title="GXPS">
<link rel="prev" href="GXPSDocument.html" title="GXPSDocument">
<link rel="next" href="libgxps-GXPS-Links.html" title="GXPS Links">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GXPSDocument.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GXPS Reference Manual</th>
<td><a accesskey="n" href="libgxps-GXPS-Links.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GXPSPage.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GXPSPage.description" class="shortcut">Description</a>
                   | 
                  <a href="#GXPSPage.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GXPSPage.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#GXPSPage.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GXPSPage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GXPSPage.top_of_page"></a>GXPSPage</span></h2>
<p>GXPSPage — Page of XPS document</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GXPSPage.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgxps/gxps.h&gt;

struct              <a class="link" href="GXPSPage.html#GXPSPage-struct" title="struct GXPSPage">GXPSPage</a>;
#define             <a class="link" href="GXPSPage.html#GXPS-PAGE-ERROR:CAPS" title="GXPS_PAGE_ERROR">GXPS_PAGE_ERROR</a>
enum                <a class="link" href="GXPSPage.html#GXPSPageError" title="enum GXPSPageError">GXPSPageError</a>;
<span class="returnvalue">void</span>                <a class="link" href="GXPSPage.html#gxps-page-get-size" title="gxps_page_get_size ()">gxps_page_get_size</a>                  (<em class="parameter"><code><a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> *page</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *width</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *height</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GXPSPage.html#gxps-page-render" title="gxps_page_render ()">gxps_page_render</a>                    (<em class="parameter"><code><a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> *page</code></em>,
                                                         <em class="parameter"><code><span class="type">cairo_t</span> *cr</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GXPSPage.html#gxps-page-get-links" title="gxps_page_get_links ()">gxps_page_get_links</a>                 (<em class="parameter"><code><a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> *page</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GXPSPage.html#gxps-page-get-anchor-destination" title="gxps_page_get_anchor_destination ()">gxps_page_get_anchor_destination</a>    (<em class="parameter"><code><a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> *page</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *anchor</code></em>,
                                                         <em class="parameter"><code><span class="type">cairo_rectangle_t</span> *area</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GXPSPage.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----GXPSPage
</pre>
</div>
<div class="refsect1">
<a name="GXPSPage.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GXPSPage implements
 <a href="/usr/share/gtk-doc/html/gio/GInitable.html">GInitable</a>.</p>
</div>
<div class="refsect1">
<a name="GXPSPage.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GXPSPage.html#GXPSPage--archive" title='The "archive" property'>archive</a>"                  <span class="type">GXPSArchive</span>*          : Write / Construct Only
  "<a class="link" href="GXPSPage.html#GXPSPage--source" title='The "source" property'>source</a>"                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="GXPSPage.description"></a><h2>Description</h2>
<p>
<a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> represents a page in a XPS document. <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a>s
can be rendered into a cairo context with <a class="link" href="GXPSPage.html#gxps-page-render" title="gxps_page_render ()"><code class="function">gxps_page_render()</code></a>.
<a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> objects can not be created directly, they are retrieved
from a <a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> with <a class="link" href="GXPSDocument.html#gxps-document-get-page" title="gxps_document_get_page ()"><code class="function">gxps_document_get_page()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="GXPSPage.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GXPSPage-struct"></a><h3>struct GXPSPage</h3>
<pre class="programlisting">struct GXPSPage;</pre>
<p>
The <span class="structname">GXPSPage</span> struct contains
only private fields and should not be directly accessed.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GXPS-PAGE-ERROR:CAPS"></a><h3>GXPS_PAGE_ERROR</h3>
<pre class="programlisting">#define GXPS_PAGE_ERROR          (gxps_page_error_quark ())
</pre>
<p>
Error domain for <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a>. Errors in this domain will be from
<a class="link" href="GXPSPage.html#GXPSPageError" title="enum GXPSPageError"><span class="type">GXPSPageError</span></a> enumeration.
See <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for more information on error domains.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GXPSPageError"></a><h3>enum GXPSPageError</h3>
<pre class="programlisting">typedef enum {
	GXPS_PAGE_ERROR_INVALID,
	GXPS_PAGE_ERROR_RENDER,
	GXPS_PAGE_ERROR_INVALID_ANCHOR
} GXPSPageError;
</pre>
<p>
Error codes returned by <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> functions
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GXPS-PAGE-ERROR-INVALID:CAPS"></a><span class="term"><code class="literal">GXPS_PAGE_ERROR_INVALID</code></span></p></td>
<td>The page is invalid.
</td>
</tr>
<tr>
<td><p><a name="GXPS-PAGE-ERROR-RENDER:CAPS"></a><span class="term"><code class="literal">GXPS_PAGE_ERROR_RENDER</code></span></p></td>
<td>Error rendering the page.
</td>
</tr>
<tr>
<td><p><a name="GXPS-PAGE-ERROR-INVALID-ANCHOR:CAPS"></a><span class="term"><code class="literal">GXPS_PAGE_ERROR_INVALID_ANCHOR</code></span></p></td>
<td>Anchor is invalid for the page.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-page-get-size"></a><h3>gxps_page_get_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gxps_page_get_size                  (<em class="parameter"><code><a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> *page</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *width</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *height</code></em>);</pre>
<p>
Gets the size of the page.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td>a <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>return location for the page width. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>return location for the page height. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-page-render"></a><h3>gxps_page_render ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gxps_page_render                    (<em class="parameter"><code><a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> *page</code></em>,
                                                         <em class="parameter"><code><span class="type">cairo_t</span> *cr</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Render the page to the given cairo context. In case of
error, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em> is filled with
information about error.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td>a <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cr</code></em> :</span></p></td>
<td>a cairo context to render to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for error reporting, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if page was successfully rendered,
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-page-get-links"></a><h3>gxps_page_get_links ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             gxps_page_get_links                 (<em class="parameter"><code><a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> *page</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Gets a list of <a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> items that map from a location
in <em class="parameter"><code>page</code></em> to a <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>. Items in the list should
be freed with <a class="link" href="libgxps-GXPS-Links.html#gxps-link-free" title="gxps_link_free ()"><code class="function">gxps_link_free()</code></a> and the list itself with
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a> when done.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td>a <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for error reporting, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a>
of <a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> items. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GXPS.Link][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-page-get-anchor-destination"></a><h3>gxps_page_get_anchor_destination ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gxps_page_get_anchor_destination    (<em class="parameter"><code><a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> *page</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *anchor</code></em>,
                                                         <em class="parameter"><code><span class="type">cairo_rectangle_t</span> *area</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Gets the rectangle of <em class="parameter"><code>page</code></em> corresponding to the destination
of the given anchor. If <em class="parameter"><code>anchor</code></em> is not found in <em class="parameter"><code>page</code></em>, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
will be returned and <em class="parameter"><code>error</code></em> will contain <a class="link" href="GXPSPage.html#GXPS-PAGE-ERROR-INVALID-ANCHOR:CAPS"><code class="literal">GXPS_PAGE_ERROR_INVALID_ANCHOR</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td>a <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>anchor</code></em> :</span></p></td>
<td>the name of an anchor in <em class="parameter"><code>page</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
<td>return location for page area of <em class="parameter"><code>anchor</code></em>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for error reporting, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the destination for the anchor was found in page
and <em class="parameter"><code>area</code></em> contains the rectangle, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GXPSPage.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GXPSPage--archive"></a><h3>The <code class="literal">"archive"</code> property</h3>
<pre class="programlisting">  "archive"                  <span class="type">GXPSArchive</span>*          : Write / Construct Only</pre>
<p>The document archive.</p>
</div>
<hr>
<div class="refsect2">
<a name="GXPSPage--source"></a><h3>The <code class="literal">"source"</code> property</h3>
<pre class="programlisting">  "source"                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write / Construct Only</pre>
<p>The Page Source File.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GXPSPage.see-also"></a><h2>See Also</h2>
<a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a>, <a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a>, <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>