/usr/share/gtk-doc/html/libgxps/libgxps-GXPS-Links.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GXPS Links</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="GXPSPage.html" title="GXPSPage">
<link rel="next" href="GXPSDocumentStructure.html" title="GXPSDocumentStructure">
<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="GXPSPage.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="GXPSDocumentStructure.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgxps-GXPS-Links.synopsis" class="shortcut">Top</a>
|
<a href="#libgxps-GXPS-Links.description" class="shortcut">Description</a>
|
<a href="#libgxps-GXPS-Links.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgxps-GXPS-Links"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgxps-GXPS-Links.top_of_page"></a>GXPS Links</span></h2>
<p>GXPS Links — XPS Links</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgxps-GXPS-Links.synopsis"></a><h2>Synopsis</h2>
<a name="GXPSLinkTarget"></a><a name="GXPSLink"></a><pre class="synopsis">
#include <libgxps/gxps.h>
<a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget-struct" title="GXPSLinkTarget">GXPSLinkTarget</a>;
<a class="link" href="libgxps-GXPS-Links.html#GXPSLink-struct" title="GXPSLink">GXPSLink</a>;
<a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="returnvalue">GXPSLinkTarget</span></a> * <a class="link" href="libgxps-GXPS-Links.html#gxps-link-target-copy" title="gxps_link_target_copy ()">gxps_link_target_copy</a> (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> *target</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgxps-GXPS-Links.html#gxps-link-target-free" title="gxps_link_target_free ()">gxps_link_target_free</a> (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> *target</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="libgxps-GXPS-Links.html#gxps-link-target-is-internal" title="gxps_link_target_is_internal ()">gxps_link_target_is_internal</a> (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> *target</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgxps-GXPS-Links.html#gxps-link-target-get-anchor" title="gxps_link_target_get_anchor ()">gxps_link_target_get_anchor</a> (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> *target</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgxps-GXPS-Links.html#gxps-link-target-get-uri" title="gxps_link_target_get_uri ()">gxps_link_target_get_uri</a> (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> *target</code></em>);
<a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="returnvalue">GXPSLink</span></a> * <a class="link" href="libgxps-GXPS-Links.html#gxps-link-copy" title="gxps_link_copy ()">gxps_link_copy</a> (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> *link</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgxps-GXPS-Links.html#gxps-link-free" title="gxps_link_free ()">gxps_link_free</a> (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> *link</code></em>);
<a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="returnvalue">GXPSLinkTarget</span></a> * <a class="link" href="libgxps-GXPS-Links.html#gxps-link-get-target" title="gxps_link_get_target ()">gxps_link_get_target</a> (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> *link</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgxps-GXPS-Links.html#gxps-link-get-area" title="gxps_link_get_area ()">gxps_link_get_area</a> (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> *link</code></em>,
<em class="parameter"><code><span class="type">cairo_rectangle_t</span> *area</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgxps-GXPS-Links.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GBoxed
+----GXPSLinkTarget
</pre>
<pre class="synopsis">
GBoxed
+----GXPSLink
</pre>
</div>
<div class="refsect1">
<a name="libgxps-GXPS-Links.description"></a><h2>Description</h2>
<p>
<a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> is a hyperlink source that can point to a location in
any of the documents of the XPS file or to an external document.
Internal <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>s have an URI relative to the XPS file,
and a named destination represented by an anchor. External
<a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>s have an absolute URI pointing to a location
in another XPS File and might optionally have an anchor.
To get the destination pointed by a in internal <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> you can use
<a class="link" href="GXPSFile.html#gxps-file-get-document-for-link-target" title="gxps_file_get_document_for_link_target ()"><code class="function">gxps_file_get_document_for_link_target()</code></a> to get the document within the file,
<a class="link" href="GXPSDocument.html#gxps-document-get-page-for-anchor" title="gxps_document_get_page_for_anchor ()"><code class="function">gxps_document_get_page_for_anchor()</code></a> to get the page within the document, and
<a class="link" href="GXPSPage.html#gxps-page-get-anchor-destination" title="gxps_page_get_anchor_destination ()"><code class="function">gxps_page_get_anchor_destination()</code></a> to get the page area.
</p>
<p>
<a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> maps a location in a page to a <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>. To get the list of
link for a page you can use <a class="link" href="GXPSPage.html#gxps-page-get-links" title="gxps_page_get_links ()"><code class="function">gxps_page_get_links()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="libgxps-GXPS-Links.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GXPSLinkTarget-struct"></a><h3>GXPSLinkTarget</h3>
<pre class="programlisting">typedef struct _GXPSLinkTarget GXPSLinkTarget;</pre>
<p>
GXPSLinkTarget represents a hyperlink source.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GXPSLink-struct"></a><h3>GXPSLink</h3>
<pre class="programlisting">typedef struct _GXPSLink GXPSLink;</pre>
<p>
GXPSLink maps a location in a page to a <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gxps-link-target-copy"></a><h3>gxps_link_target_copy ()</h3>
<pre class="programlisting"><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="returnvalue">GXPSLinkTarget</span></a> * gxps_link_target_copy (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> *target</code></em>);</pre>
<p>
Creates a copy of a <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>a <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a copy of <em class="parameter"><code>target</code></em>.
Free the returned object with <a class="link" href="libgxps-GXPS-Links.html#gxps-link-target-free" title="gxps_link_target_free ()"><code class="function">gxps_link_target_free()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-link-target-free"></a><h3>gxps_link_target_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gxps_link_target_free (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> *target</code></em>);</pre>
<p>
Frees a <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>a <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-link-target-is-internal"></a><h3>gxps_link_target_is_internal ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gxps_link_target_is_internal (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> *target</code></em>);</pre>
<p>
Gets whether <em class="parameter"><code>target</code></em> destination is internal or not.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>a <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>
</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 <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> points to an internal location,
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it points to a external one.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-link-target-get-anchor"></a><h3>gxps_link_target_get_anchor ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gxps_link_target_get_anchor (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> *target</code></em>);</pre>
<p>
Gets the anchor name <em class="parameter"><code>target</code></em> links to. If <em class="parameter"><code>target</code></em> is
an internal <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> this function always returns
and anchor, if it is external it might return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the
<em class="parameter"><code>target</code></em> does not have an anchor.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>a <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the name of the anchor of <em class="parameter"><code>target</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-link-target-get-uri"></a><h3>gxps_link_target_get_uri ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gxps_link_target_get_uri (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> *target</code></em>);</pre>
<p>
Gets the URI <em class="parameter"><code>target</code></em> links to.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>a <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the URI of <em class="parameter"><code>target</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-link-copy"></a><h3>gxps_link_copy ()</h3>
<pre class="programlisting"><a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="returnvalue">GXPSLink</span></a> * gxps_link_copy (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> *link</code></em>);</pre>
<p>
Creates a copy of a <a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>link</code></em> :</span></p></td>
<td>a <a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a copy of <em class="parameter"><code>link</code></em>.
Free the returned object with <a class="link" href="libgxps-GXPS-Links.html#gxps-link-free" title="gxps_link_free ()"><code class="function">gxps_link_free()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-link-free"></a><h3>gxps_link_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gxps_link_free (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> *link</code></em>);</pre>
<p>
Frees a <a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>link</code></em> :</span></p></td>
<td>a <a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-link-get-target"></a><h3>gxps_link_get_target ()</h3>
<pre class="programlisting"><a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="returnvalue">GXPSLinkTarget</span></a> * gxps_link_get_target (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> *link</code></em>);</pre>
<p>
Gets the <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> mapped by <em class="parameter"><code>link</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>link</code></em> :</span></p></td>
<td>a <a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a> of <em class="parameter"><code>link</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gxps-link-get-area"></a><h3>gxps_link_get_area ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gxps_link_get_area (<em class="parameter"><code><a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a> *link</code></em>,
<em class="parameter"><code><span class="type">cairo_rectangle_t</span> *area</code></em>);</pre>
<p>
Gets the rectangle of a page where the <a class="link" href="libgxps-GXPS-Links.html#GXPSLinkTarget"><span class="type">GXPSLinkTarget</span></a>
mapped by <em class="parameter"><code>link</code></em> is.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>link</code></em> :</span></p></td>
<td>a <a class="link" href="libgxps-GXPS-Links.html#GXPSLink"><span class="type">GXPSLink</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
<td>return location for page area. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libgxps-GXPS-Links.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>
|