/usr/share/gtk-doc/html/template-glib/TmplTemplateLocator.html is in libtemplate-glib-doc 3.28.0-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TmplTemplateLocator: Template-GLib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Template-GLib Reference Manual">
<link rel="up" href="ch01.html" title="Template-GLib API Reference">
<link rel="prev" href="TmplTemplate.html" title="TmplTemplate">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.27 (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="#TmplTemplateLocator.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#TmplTemplateLocator.object-hierarchy" class="shortcut">Object Hierarchy</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="TmplTemplate.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="TmplTemplateLocator"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="TmplTemplateLocator.top_of_page"></a>TmplTemplateLocator</span></h2>
<p>TmplTemplateLocator</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="TmplTemplateLocator.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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="TmplTemplateLocator.html" title="TmplTemplateLocator"><span class="returnvalue">TmplTemplateLocator</span></a> *
</td>
<td class="function_name">
<a class="link" href="TmplTemplateLocator.html#tmpl-template-locator-new" title="tmpl_template_locator_new ()">tmpl_template_locator_new</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="TmplTemplateLocator.html#tmpl-template-locator-append-search-path" title="tmpl_template_locator_append_search_path ()">tmpl_template_locator_append_search_path</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="TmplTemplateLocator.html#tmpl-template-locator-prepend-search-path" title="tmpl_template_locator_prepend_search_path ()">tmpl_template_locator_prepend_search_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GInputStream</span> *
</td>
<td class="function_name">
<a class="link" href="TmplTemplateLocator.html#tmpl-template-locator-locate" title="tmpl_template_locator_locate ()">tmpl_template_locator_locate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="TmplTemplateLocator.html#tmpl-template-locator-get-search-path" title="tmpl_template_locator_get_search_path ()">tmpl_template_locator_get_search_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="TmplTemplateLocator.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="TmplTemplateLocator.html#TMPL-TYPE-TEMPLATE-LOCATOR:CAPS" title="TMPL_TYPE_TEMPLATE_LOCATOR">TMPL_TYPE_TEMPLATE_LOCATOR</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="TmplTemplateLocator.html#TmplTemplateLocatorClass" title="struct TmplTemplateLocatorClass">TmplTemplateLocatorClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="TmplTemplateLocator.html#TmplTemplateLocator-struct" title="TmplTemplateLocator">TmplTemplateLocator</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="TmplTemplateLocator.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> TmplTemplateLocator
</pre>
</div>
<div class="refsect1">
<a name="TmplTemplateLocator.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="TmplTemplateLocator.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="tmpl-template-locator-new"></a><h3>tmpl_template_locator_new ()</h3>
<pre class="programlisting"><a class="link" href="TmplTemplateLocator.html" title="TmplTemplateLocator"><span class="returnvalue">TmplTemplateLocator</span></a> *
tmpl_template_locator_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="tmpl-template-locator-append-search-path"></a><h3>tmpl_template_locator_append_search_path ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tmpl_template_locator_append_search_path
(<em class="parameter"><code><a class="link" href="TmplTemplateLocator.html" title="TmplTemplateLocator"><span class="type">TmplTemplateLocator</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="tmpl-template-locator-prepend-search-path"></a><h3>tmpl_template_locator_prepend_search_path ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tmpl_template_locator_prepend_search_path
(<em class="parameter"><code><a class="link" href="TmplTemplateLocator.html" title="TmplTemplateLocator"><span class="type">TmplTemplateLocator</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="tmpl-template-locator-locate"></a><h3>tmpl_template_locator_locate ()</h3>
<pre class="programlisting"><span class="returnvalue">GInputStream</span> *
tmpl_template_locator_locate (<em class="parameter"><code><a class="link" href="TmplTemplateLocator.html" title="TmplTemplateLocator"><span class="type">TmplTemplateLocator</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This will resolve the relative path using the search paths found within
the template loader.</p>
<div class="refsect3">
<a name="tmpl-template-locator-locate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="TmplTemplateLocator.html" title="TmplTemplateLocator"><span class="type">TmplTemplateLocator</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a relative path to the file</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tmpl-template-locator-locate.returns"></a><h4>Returns</h4>
<p>A <span class="type">GInputStream</span> or <code class="literal">NULL</code> and <em class="parameter"><code>error</code></em>
is set. </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="tmpl-template-locator-get-search-path"></a><h3>tmpl_template_locator_get_search_path ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> **
tmpl_template_locator_get_search_path (<em class="parameter"><code><a class="link" href="TmplTemplateLocator.html" title="TmplTemplateLocator"><span class="type">TmplTemplateLocator</span></a> *self</code></em>);</pre>
<p>Gets the current search path used by the template locator.</p>
<div class="refsect3">
<a name="tmpl-template-locator-get-search-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="TmplTemplateLocator.html" title="TmplTemplateLocator"><span class="type">TmplTemplateLocator</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tmpl-template-locator-get-search-path.returns"></a><h4>Returns</h4>
<p>A <code class="literal">NULL</code>-terminated array of strings. </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>
</div>
<div class="refsect1">
<a name="TmplTemplateLocator.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="TMPL-TYPE-TEMPLATE-LOCATOR:CAPS"></a><h3>TMPL_TYPE_TEMPLATE_LOCATOR</h3>
<pre class="programlisting">#define TMPL_TYPE_TEMPLATE_LOCATOR (tmpl_template_locator_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="TmplTemplateLocatorClass"></a><h3>struct TmplTemplateLocatorClass</h3>
<pre class="programlisting">struct TmplTemplateLocatorClass {
GObjectClass parent_instance;
GInputStream *(*locate) (TmplTemplateLocator *self,
const gchar *path,
GError **error);
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="TmplTemplateLocator-struct"></a><h3>TmplTemplateLocator</h3>
<pre class="programlisting">typedef struct _TmplTemplateLocator TmplTemplateLocator;</pre>
<p>The <span class="type">TmplTemplateLoader</span> class is used to specify how templates
should be loaded. This can be used directly by your code that
will compile the data streams into <a class="link" href="TmplTemplate.html" title="TmplTemplate"><span class="type">TmplTemplate</span></a> instances, or
by a <a class="link" href="TmplTemplate.html" title="TmplTemplate"><span class="type">TmplTemplate</span></a> that is resolving includes from the
<code class="literal">{{include "path.tmpl"}}</code> directive.</p>
<p>See <a class="link" href="TmplTemplate.html#TmplTemplate--locator" title="The “locator” property"><span class="type">“locator”</span></a> for more information.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|