/usr/share/gtk-doc/html/libgxps/GXPSDocument.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GXPSDocument</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="GXPSFile.html" title="GXPSFile">
<link rel="next" href="GXPSPage.html" title="GXPSPage">
<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="GXPSFile.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="GXPSPage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GXPSDocument.synopsis" class="shortcut">Top</a>
|
<a href="#GXPSDocument.description" class="shortcut">Description</a>
|
<a href="#GXPSDocument.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GXPSDocument.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GXPSDocument.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GXPSDocument"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GXPSDocument.top_of_page"></a>GXPSDocument</span></h2>
<p>GXPSDocument — XPS Documents</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GXPSDocument.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgxps/gxps.h>
struct <a class="link" href="GXPSDocument.html#GXPSDocument-struct" title="struct GXPSDocument">GXPSDocument</a>;
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="GXPSDocument.html#gxps-document-get-n-pages" title="gxps_document_get_n_pages ()">gxps_document_get_n_pages</a> (<em class="parameter"><code><a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> *doc</code></em>);
<a class="link" href="GXPSPage.html" title="GXPSPage"><span class="returnvalue">GXPSPage</span></a> * <a class="link" href="GXPSDocument.html#gxps-document-get-page" title="gxps_document_get_page ()">gxps_document_get_page</a> (<em class="parameter"><code><a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> *doc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_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="GXPSDocument.html#gxps-document-get-page-size" title="gxps_document_get_page_size ()">gxps_document_get_page_size</a> (<em class="parameter"><code><a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> *doc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_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#gint"><span class="returnvalue">gint</span></a> <a class="link" href="GXPSDocument.html#gxps-document-get-page-for-anchor" title="gxps_document_get_page_for_anchor ()">gxps_document_get_page_for_anchor</a> (<em class="parameter"><code><a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> *doc</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>);
<a class="link" href="GXPSDocumentStructure.html" title="GXPSDocumentStructure"><span class="returnvalue">GXPSDocumentStructure</span></a> * <a class="link" href="GXPSDocument.html#gxps-document-get-structure" title="gxps_document_get_structure ()">gxps_document_get_structure</a> (<em class="parameter"><code><a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> *doc</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GXPSDocument.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>
+----GXPSDocument
</pre>
</div>
<div class="refsect1">
<a name="GXPSDocument.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GXPSDocument implements
<a href="/usr/share/gtk-doc/html/gio/GInitable.html">GInitable</a>.</p>
</div>
<div class="refsect1">
<a name="GXPSDocument.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GXPSDocument.html#GXPSDocument--archive" title='The "archive" property'>archive</a>" <span class="type">GXPSArchive</span>* : Write / Construct Only
"<a class="link" href="GXPSDocument.html#GXPSDocument--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="GXPSDocument.description"></a><h2>Description</h2>
<p>
<a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> represents a document in a <a class="link" href="GXPSFile.html" title="GXPSFile"><span class="type">GXPSFile</span></a>. <a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a>
objects can not be created directly, they are retrieved from a
<a class="link" href="GXPSFile.html" title="GXPSFile"><span class="type">GXPSFile</span></a> with <a class="link" href="GXPSFile.html#gxps-file-get-document" title="gxps_file_get_document ()"><code class="function">gxps_file_get_document()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="GXPSDocument.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GXPSDocument-struct"></a><h3>struct GXPSDocument</h3>
<pre class="programlisting">struct GXPSDocument;</pre>
<p>
The <span class="structname">GXPSDocument</span> struct contains
only private fields and should not be directly accessed.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gxps-document-get-n-pages"></a><h3>gxps_document_get_n_pages ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gxps_document_get_n_pages (<em class="parameter"><code><a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> *doc</code></em>);</pre>
<p>
Gets the number of pages in <em class="parameter"><code>doc</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
<td>a <a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of pages.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-document-get-page"></a><h3>gxps_document_get_page ()</h3>
<pre class="programlisting"><a class="link" href="GXPSPage.html" title="GXPSPage"><span class="returnvalue">GXPSPage</span></a> * gxps_document_get_page (<em class="parameter"><code><a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> *doc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_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>
Creates a new <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> representing the page at
index <em class="parameter"><code>n_doc</code></em> in <em class="parameter"><code>doc</code></em> document.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
<td>a <a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_page</code></em> :</span></p></td>
<td>the index of the page to get</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 new <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.
Free the returned object with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<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-document-get-page-size"></a><h3>gxps_document_get_page_size ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gxps_document_get_page_size (<em class="parameter"><code><a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> *doc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_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 typical size of the page at index <em class="parameter"><code>n_page</code></em> in <em class="parameter"><code>doc</code></em> document.
This function is useful to get the advisory size of pages in a document
without creating <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a> objects. This page size might be different than
the actual page size so page dimension might need to be updated once the
page is loaded. Advisory page sizes are not always available in <em class="parameter"><code>doc</code></em>,
in which case this function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
To get the authoritative size of a page you should use <a class="link" href="GXPSPage.html#gxps-page-get-size" title="gxps_page_get_size ()"><code class="function">gxps_page_get_size()</code></a>
instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
<td>a <a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_page</code></em> :</span></p></td>
<td>the index of a page in <em class="parameter"><code>doc</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>return location for the width of <em class="parameter"><code>n_page</code></em>. <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 height of <em class="parameter"><code>n_page</code></em>. <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"><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 page size information is available in <em class="parameter"><code>doc</code></em>,
<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-document-get-page-for-anchor"></a><h3>gxps_document_get_page_for_anchor ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gxps_document_get_page_for_anchor (<em class="parameter"><code><a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> *doc</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>);</pre>
<p>
Gets the index of the page in <em class="parameter"><code>doc</code></em> where the given
anchor is.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
<td>a <a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</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</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the page index of the given anchor.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-document-get-structure"></a><h3>gxps_document_get_structure ()</h3>
<pre class="programlisting"><a class="link" href="GXPSDocumentStructure.html" title="GXPSDocumentStructure"><span class="returnvalue">GXPSDocumentStructure</span></a> * gxps_document_get_structure (<em class="parameter"><code><a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a> *doc</code></em>);</pre>
<p>
Creates a new <a class="link" href="GXPSDocumentStructure.html" title="GXPSDocumentStructure"><span class="type">GXPSDocumentStructure</span></a> representing the document
structure of <em class="parameter"><code>doc</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
<td>a a <a class="link" href="GXPSDocument.html" title="GXPSDocument"><span class="type">GXPSDocument</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GXPSDocumentStructure.html" title="GXPSDocumentStructure"><span class="type">GXPSDocumentStructure</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if document doesn't have a structure.
Free the returned object with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GXPSDocument.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GXPSDocument--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="GXPSDocument--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 Document Source File.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GXPSDocument.see-also"></a><h2>See Also</h2>
<a class="link" href="GXPSFile.html" title="GXPSFile"><span class="type">GXPSFile</span></a>, <a class="link" href="GXPSPage.html" title="GXPSPage"><span class="type">GXPSPage</span></a>, <a class="link" href="GXPSDocumentStructure.html" title="GXPSDocumentStructure"><span class="type">GXPSDocumentStructure</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|