/usr/share/gtk-doc/html/libfm/FmFile.html is in libfm-doc 1.2.5-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 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 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FmFile: Libfm Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Libfm Reference Manual">
<link rel="up" href="libfm-core.html" title="Libfm Core Reference.">
<link rel="prev" href="FmDummyMonitor.html" title="FmDummyMonitor">
<link rel="next" href="libfm-FmFileInfo.html" title="FmFileInfo">
<meta name="generator" content="GTK-Doc V1.25 (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="#FmFile.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#FmFile.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#FmFile.prerequisites" class="shortcut">Prerequisites</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="libfm-core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="FmDummyMonitor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libfm-FmFileInfo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="FmFile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="FmFile.top_of_page"></a>FmFile</span></h2>
<p>FmFile — Extensions for GFile interface.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="FmFile.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="FmFile.html#fm-file-add-vfs" title="fm_file_add_vfs ()">fm_file_add_vfs</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> *
</td>
<td class="function_name">
<a class="link" href="FmFile.html#fm-file-new-for-commandline-arg" title="fm_file_new_for_commandline_arg ()">fm_file_new_for_commandline_arg</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> *
</td>
<td class="function_name">
<a class="link" href="FmFile.html#fm-file-new-for-uri" title="fm_file_new_for_uri ()">fm_file_new_for_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="FmFile.html#fm-file-wants-incremental" title="fm_file_wants_incremental ()">fm_file_wants_incremental</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmFile.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="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="FmFile.html#FmFile-struct" title="FmFile">FmFile</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="FmFile.html#FmFileInitTable" title="struct FmFileInitTable">FmFileInitTable</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="FmFile.html#FmFileInterface" title="struct FmFileInterface">FmFileInterface</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="FmFile.html#FM-MODULE-vfs-VERSION" title="FM_MODULE_vfs_VERSION">FM_MODULE_vfs_VERSION</a></td>
</tr>
<tr>
<td class="variable_type">extern FmFileInitTable </td>
<td class="function_name"><a class="link" href="FmFile.html#fm-module-init-vfs" title="fm_module_init_vfs">fm_module_init_vfs</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmFile.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> FmFile
</pre>
</div>
<div class="refsect1">
<a name="FmFile.prerequisites"></a><h2>Prerequisites</h2>
<p>
FmFile requires
<a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct">GFile</a> and <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="FmFile.description"></a><h2>Description</h2>
<p><em class="parameter"><code>include</code></em>
: libfm/fm.h</p>
<p>The <a class="link" href="FmFile.html" title="FmFile"><span class="type">FmFile</span></a> represents interface to build extensions to GFile which
will handle schemas that are absent in Glib/GVFS - such as "search:".</p>
<p>To use it the GFile implementation should also implement FmFile vtable
calls. The implementation should be added to list of known schemes via
call to <a class="link" href="FmFile.html#fm-file-add-vfs" title="fm_file_add_vfs ()"><code class="function">fm_file_add_vfs()</code></a> then calls such as <a class="link" href="FmFile.html#fm-file-new-for-uri" title="fm_file_new_for_uri ()"><code class="function">fm_file_new_for_uri()</code></a> can
use it.</p>
</div>
<div class="refsect1">
<a name="FmFile.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="fm-file-add-vfs"></a><h3>fm_file_add_vfs ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_file_add_vfs (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="FmFile.html#FmFileInitTable" title="struct FmFileInitTable"><span class="type">FmFileInitTable</span></a> *init</code></em>);</pre>
<p>Adds VFS to list of extensions that will be applied on next call to
<a class="link" href="FmFile.html#fm-file-new-for-uri" title="fm_file_new_for_uri ()"><code class="function">fm_file_new_for_uri()</code></a> or <a class="link" href="FmFile.html#fm-file-new-for-commandline-arg" title="fm_file_new_for_commandline_arg ()"><code class="function">fm_file_new_for_commandline_arg()</code></a>. The <em class="parameter"><code>name</code></em>
is a schema which will be handled by those calls.</p>
<div class="refsect3">
<a name="fm-file-add-vfs.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>name</p></td>
<td class="parameter_description"><p>scheme to act upon</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>init</p></td>
<td class="parameter_description"><p>table of functions</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-file-new-for-commandline-arg"></a><h3>fm_file_new_for_commandline_arg ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> *
fm_file_new_for_commandline_arg (<em class="parameter"><code>const <span class="type">char</span> *arg</code></em>);</pre>
<p>Creates a <a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> with the given argument from the command line.
The value of <em class="parameter"><code>arg</code></em>
can be either a URI, an absolute path or
a relative path resolved relative to the current working directory.
This operation never fails, but the returned object might not support
any I/O operation if <em class="parameter"><code>arg</code></em>
points to a malformed path.</p>
<div class="refsect3">
<a name="fm-file-new-for-commandline-arg.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>arg</p></td>
<td class="parameter_description"><p>a command line string</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fm-file-new-for-commandline-arg.returns"></a><h4>Returns</h4>
<p> a new <a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="type">GFile</span></a>.</p>
</div>
<p class="since">Since: 1.0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-file-new-for-uri"></a><h3>fm_file_new_for_uri ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> *
fm_file_new_for_uri (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>Constructs a <a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> for a given URI. This operation never fails,
but the returned object might not support any I/O operation if <em class="parameter"><code>uri</code></em>
is malformed or if the uri type is not supported.</p>
<div class="refsect3">
<a name="fm-file-new-for-uri.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>uri</p></td>
<td class="parameter_description"><p>a UTF8 string containing a URI</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fm-file-new-for-uri.returns"></a><h4>Returns</h4>
<p> a new <a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="type">GFile</span></a>.</p>
</div>
<p class="since">Since: 1.0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-file-wants-incremental"></a><h3>fm_file_wants_incremental ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_file_wants_incremental (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> *file</code></em>);</pre>
<p>Checks if contents of directory <em class="parameter"><code>file</code></em>
cannot be retrieved at once so
scanning it may be done in incremental manner for the best results.</p>
<div class="refsect3">
<a name="fm-file-wants-incremental.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>file</p></td>
<td class="parameter_description"><p>file to inspect</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fm-file-wants-incremental.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if retrieve of contents of <em class="parameter"><code>file</code></em>
will be incremental.</p>
</div>
<p class="since">Since: 1.0.2</p>
</div>
</div>
<div class="refsect1">
<a name="FmFile.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FmFile-struct"></a><h3>FmFile</h3>
<pre class="programlisting">typedef struct _FmFile FmFile;</pre>
</div>
<hr>
<div class="refsect2">
<a name="FmFileInitTable"></a><h3>struct FmFileInitTable</h3>
<pre class="programlisting">struct FmFileInitTable {
GFile * (*new_for_uri)(const char *uri);
};
</pre>
<p>Functions to initialize FmFile instance.</p>
<p>This structure is used for "vfs" module initialization. The key for
module of this type is scheme name to support.</p>
<div class="refsect3">
<a name="FmFileInitTable.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FmFileInitTable.new-for-uri"></a>new_for_uri</code></em> ()</p></td>
<td class="struct_member_description"><p>function to create new <a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> object from URI</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="FmFileInterface"></a><h3>struct FmFileInterface</h3>
<pre class="programlisting">struct FmFileInterface {
gboolean (*wants_incremental)(GFile* file);
};
</pre>
<div class="refsect3">
<a name="FmFileInterface.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FmFileInterface.wants-incremental"></a>wants_incremental</code></em> ()</p></td>
<td class="struct_member_description"><p>VTable func, see <a class="link" href="FmFile.html#fm-file-wants-incremental" title="fm_file_wants_incremental ()"><code class="function">fm_file_wants_incremental()</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="FM-MODULE-vfs-VERSION"></a><h3>FM_MODULE_vfs_VERSION</h3>
<pre class="programlisting">#define FM_MODULE_vfs_VERSION 1
</pre>
</div>
<hr>
<div class="refsect2">
<a name="fm-module-init-vfs"></a><h3>fm_module_init_vfs</h3>
<pre class="programlisting">extern FmFileInitTable fm_module_init_vfs;
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|