libdee-doc 1.0.10-3.1 / usr / share / gtk-doc / html / dee-1.0 / DeeFileResourceManager.html

This file is indexed.

/usr/share/gtk-doc/html/dee-1.0/DeeFileResourceManager.html is in libdee-doc 1.0.10-3.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Dee Reference Manual: DeeFileResourceManager</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Dee Reference Manual">
<link rel="up" href="ch04.html" title="Resources and Serialization">
<link rel="prev" href="ch04.html" title="Resources and Serialization">
<link rel="next" href="dee-1.0-DeeResourceManager.html" title="DeeResourceManager">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#DeeFileResourceManager.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#DeeFileResourceManager.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 
                  <a href="#DeeFileResourceManager.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 
                  <a href="#DeeFileResourceManager.properties" class="shortcut">Properties</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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch04.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="dee-1.0-DeeResourceManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="DeeFileResourceManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="DeeFileResourceManager.top_of_page"></a>DeeFileResourceManager</span></h2>
<p>DeeFileResourceManager — A resource manager backed by memory mapped files</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="DeeFileResourceManager.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="DeeFileResourceManager.html#dee-file-resource-manager-add-search-path" title="dee_file_resource_manager_add_search_path ()">dee_file_resource_manager_add_search_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="DeeFileResourceManager.html#dee-file-resource-manager-get-primary-path" title="dee_file_resource_manager_get_primary_path ()">dee_file_resource_manager_get_primary_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">DeeResourceManager</span> *
</td>
<td class="function_name">
<a class="link" href="DeeFileResourceManager.html#dee-file-resource-manager-new" title="dee_file_resource_manager_new ()">dee_file_resource_manager_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeFileResourceManager.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="DeeFileResourceManager.html#DeeFileResourceManager--primary-path" title="The “primary-path” property">primary-path</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeFileResourceManager.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="DeeFileResourceManager.html#DeeFileResourceManager-struct" title="struct DeeFileResourceManager">DeeFileResourceManager</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="DeeFileResourceManager.html#DeeFileResourceManagerClass" title="struct DeeFileResourceManagerClass">DeeFileResourceManagerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeFileResourceManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> DeeFileResourceManager
</pre>
</div>
<div class="refsect1">
<a name="DeeFileResourceManager.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
DeeFileResourceManager implements
 DeeResourceManager.</p>
</div>
<div class="refsect1">
<a name="DeeFileResourceManager.description"></a><h2>Description</h2>
<p>This is an implementation of the <span class="type">DeeResourceManager</span> interface.
It uses atomic operations to write resources to files and memory maps
the resource files when you load them.</p>
<p>Unless you have very specific circumstances you should normally not
create resource managers yourself, but get the default one for your
platform by calling <a class="link" href="dee-1.0-DeeResourceManager.html#dee-resource-manager-get-default" title="dee_resource_manager_get_default ()"><code class="function">dee_resource_manager_get_default()</code></a>.</p>
</div>
<div class="refsect1">
<a name="DeeFileResourceManager.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dee-file-resource-manager-add-search-path"></a><h3>dee_file_resource_manager_add_search_path ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_file_resource_manager_add_search_path
                               (<em class="parameter"><code><span class="type">DeeResourceManager</span> *self</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
<p>Add a path to the set of paths searched for resources. The manager will
first search the primary path as specified in the constructor and then
search paths in the order they where added.</p>
<div class="refsect3">
<a name="id-1.5.2.9.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>self</p></td>
<td class="parameter_description"><p> The resource manager to add a search
path to. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> DeeFileResourceManager]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>The path to add to the set of searched paths</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-file-resource-manager-get-primary-path"></a><h3>dee_file_resource_manager_get_primary_path ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
dee_file_resource_manager_get_primary_path
                               (<em class="parameter"><code><span class="type">DeeResourceManager</span> *self</code></em>);</pre>
<p>Helper method to access the :primary-path property.</p>
<div class="refsect3">
<a name="id-1.5.2.9.3.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>self</p></td>
<td class="parameter_description"><p> The resource manager to inspect. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> DeeFileResourceManager]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.9.3.6"></a><h4>Returns</h4>
<p> The value of the :primary-path property</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-file-resource-manager-new"></a><h3>dee_file_resource_manager_new ()</h3>
<pre class="programlisting"><span class="returnvalue">DeeResourceManager</span> *
dee_file_resource_manager_new (<em class="parameter"><code>const <span class="type">gchar</span> *primary_path</code></em>);</pre>
<p>Create a new <a class="link" href="DeeFileResourceManager.html" title="DeeFileResourceManager"><span class="type">DeeFileResourceManager</span></a> with its primary store- and load
path set to <em class="parameter"><code>primary_path</code></em>
.</p>
<p>You can manually add fallback search paths by calling
<a class="link" href="DeeFileResourceManager.html#dee-file-resource-manager-add-search-path" title="dee_file_resource_manager_add_search_path ()"><code class="function">dee_file_resource_manager_add_search_path()</code></a>.</p>
<p>You normally don't need to create you own resource managers. Instead
you should call <a class="link" href="dee-1.0-DeeResourceManager.html#dee-resource-manager-get-default" title="dee_resource_manager_get_default ()"><code class="function">dee_resource_manager_get_default()</code></a>.</p>
<div class="refsect3">
<a name="id-1.5.2.9.4.7"></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>primary_path</p></td>
<td class="parameter_description"><p>The primary path used to store and load resources.
If you pass <code class="literal">NULL</code> the manager will use a default path.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.9.4.8"></a><h4>Returns</h4>
<p> A newly allocated <a class="link" href="DeeFileResourceManager.html" title="DeeFileResourceManager"><span class="type">DeeFileResourceManager</span></a>.
Free with <code class="function">g_object_unref()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> DeeFileResourceManager]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="DeeFileResourceManager.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DeeFileResourceManager-struct"></a><h3>struct DeeFileResourceManager</h3>
<pre class="programlisting">struct DeeFileResourceManager;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeFileResourceManagerClass"></a><h3>struct DeeFileResourceManagerClass</h3>
<pre class="programlisting">struct DeeFileResourceManagerClass {
  GObjectClass  parent_class;
};
</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="DeeFileResourceManager.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="DeeFileResourceManager--primary-path"></a><h3>The <code class="literal">“primary-path”</code> property</h3>
<pre class="programlisting">  “primary-path”             <span class="type">gchar</span> *</pre>
<p>Property holding the primary path used to store and load resources</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.