/usr/share/gtk-doc/html/libgda-5.0/GdaDataModelDir.html is in libgda-5.0-doc 5.2.4-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaDataModelDir: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="data_models.html" title="Data handling">
<link rel="prev" href="libgda-5.0-GdaDataModelBdb.html" title="GdaDataModelBdb">
<link rel="next" href="GdaDataProxy.html" title="GdaDataProxy">
<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="#GdaDataModelDir.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GdaDataModelDir.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GdaDataModelDir.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GdaDataModelDir.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="data_models.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgda-5.0-GdaDataModelBdb.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaDataProxy.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdaDataModelDir"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaDataModelDir.top_of_page"></a>GdaDataModelDir</span></h2>
<p>GdaDataModelDir — GdaDataModel to list files in filesystem</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdaDataModelDir.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdaDataModelDir.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="GdaDataModel.html" title="GdaDataModel"><span class="returnvalue">GdaDataModel</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaDataModelDir.html#gda-data-model-dir-new" title="gda_data_model_dir_new ()">gda_data_model_dir_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaDataModelDir.html#gda-data-model-dir-get-errors" title="gda_data_model_dir_get_errors ()">gda_data_model_dir_get_errors</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="GdaDataModelDir.html#gda-data-model-dir-clean-errors" title="gda_data_model_dir_clean_errors ()">gda_data_model_dir_clean_errors</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaDataModelDir.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" 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">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GdaDataModelDir.html#GdaDataModelDir--basedir" title="The “basedir” property">basedir</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaDataModelDir.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">struct</td>
<td class="function_name"><a class="link" href="GdaDataModelDir.html#GdaDataModelDir-struct" title="struct GdaDataModelDir">GdaDataModelDir</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdaDataModelDir.html#GdaDataModelDirClass" title="struct GdaDataModelDirClass">GdaDataModelDirClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GdaDataModelDir.html#GdaDataModelDirPrivate" title="GdaDataModelDirPrivate">GdaDataModelDirPrivate</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaDataModelDir.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> GdaDataModelDir
</pre>
</div>
<div class="refsect1">
<a name="GdaDataModelDir.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdaDataModelDir implements
<a class="link" href="GdaDataModel.html" title="GdaDataModel">GdaDataModel</a>.</p>
</div>
<div class="refsect1">
<a name="GdaDataModelDir.description"></a><h2>Description</h2>
<p>The <a class="link" href="GdaDataModelDir.html" title="GdaDataModelDir"><span class="type">GdaDataModelDir</span></a> object lists files on a filesystem which are located
below a "basedir" directory, one file per row. The data model has the following columns:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>the "dir_name" column (G_TYPE_STRING): contains the dirname part of the file</p></li>
<li class="listitem"><p>the "file_name" column (G_TYPE_STRING): contains the file name part of the file</p></li>
<li class="listitem"><p>the "size" column (G_TYPE_UINT): contains the size in bytes of the file</p></li>
<li class="listitem"><p>the "mime_type" column (G_TYPE_STRING): contains the mime type of the file (if GnomeVFS has been found, and NULL otherwise)</p></li>
<li class="listitem"><p>the "md5sum" column (G_TYPE_STRING): contains the MD5 hash of each file (if LibGCrypt has been found, and NULL otherwise)</p></li>
<li class="listitem"><p>the "data" column (GDA_TYPE_BLOB): contains the contents of each file</p></li>
</ul></div>
<p>Note that the actual values of the "mime_type", "md5sum" and "data" columns are computed only when they
are requested to help with performances.</p>
</div>
<div class="refsect1">
<a name="GdaDataModelDir.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-data-model-dir-new"></a><h3>gda_data_model_dir_new ()</h3>
<pre class="programlisting"><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="returnvalue">GdaDataModel</span></a> *
gda_data_model_dir_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *basedir</code></em>);</pre>
<p>Creates a new <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object to list all the files starting from <em class="parameter"><code>basedir</code></em>
</p>
<div class="refsect3">
<a name="gda-data-model-dir-new.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>basedir</p></td>
<td class="parameter_description"><p>a directory</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-data-model-dir-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-dir-get-errors"></a><h3>gda_data_model_dir_get_errors ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
gda_data_model_dir_get_errors (<em class="parameter"><code><a class="link" href="GdaDataModelDir.html" title="GdaDataModelDir"><span class="type">GdaDataModelDir</span></a> *model</code></em>);</pre>
<p>Get the list of errors which have occurred while using <em class="parameter"><code>model</code></em>
</p>
<div class="refsect3">
<a name="gda-data-model-dir-get-errors.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>model</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaDataModelDir.html" title="GdaDataModelDir"><span class="type">GdaDataModelDir</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-data-model-dir-get-errors.returns"></a><h4>Returns</h4>
<p> (transfer none) (element-type GLib.Error) : a read-only list of <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> pointers, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no error has occurred</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-dir-clean-errors"></a><h3>gda_data_model_dir_clean_errors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_data_model_dir_clean_errors (<em class="parameter"><code><a class="link" href="GdaDataModelDir.html" title="GdaDataModelDir"><span class="type">GdaDataModelDir</span></a> *model</code></em>);</pre>
<p>Reset the list of errors which have occurred while using <em class="parameter"><code>model</code></em>
</p>
<div class="refsect3">
<a name="gda-data-model-dir-clean-errors.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>model</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaDataModelDir.html" title="GdaDataModelDir"><span class="type">GdaDataModelDir</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdaDataModelDir.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaDataModelDir-struct"></a><h3>struct GdaDataModelDir</h3>
<pre class="programlisting">struct GdaDataModelDir;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelDirClass"></a><h3>struct GdaDataModelDirClass</h3>
<pre class="programlisting">struct GdaDataModelDirClass {
GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelDirPrivate"></a><h3>GdaDataModelDirPrivate</h3>
<pre class="programlisting">typedef struct _GdaDataModelDirPrivate GdaDataModelDirPrivate;</pre>
</div>
</div>
<div class="refsect1">
<a name="GdaDataModelDir.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdaDataModelDir--basedir"></a><h3>The <code class="literal">“basedir”</code> property</h3>
<pre class="programlisting"> “basedir” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Base directory.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GdaDataModelDir.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|