← Back to branch summary

~ubuntu-branches/ubuntu/karmic/libgda4/karmic

« back to all changes in this revision

Viewing changes to doc/C/xml/gda-data-model-dir.xml

  • Committer: Bazaar Package Importer
  • Author(s): Chris Coulson
  • Date: 2009-09-18 14:41:56 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20090918144156-z5uaoazrotyye0t1
Tags: 4.0.4-1ubuntu1
https://launchpad.net/bugs/432169
* Re-base on Debian unstable (LP: #432169), remaining changes:
  - debian/control: 
    + Change MySQL build-dep to 5.1 in main.
    + Add various conflicts/replaces to handle new binary package names.
    + Build-depend on rarian-compat rather than scrollkeeper.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/C/xml/gda-data-model-dir.xml
8
8
<refnamediv>
9
9
<refname>GdaDataModelDir</refname>
10
10
<refpurpose>GdaDataModel to list files in filesystem</refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
11
</refnamediv>
13
12
 
14
13
<refsynopsisdiv id="GdaDataModelDir.synopsis" role="synopsis">
18
17
                    <link linkend="GdaDataModelDir-struct">GdaDataModelDir</link>;
19
18
                    <link linkend="GdaDataModelDirClass">GdaDataModelDirClass</link>;
20
19
                    <link linkend="GdaDataModelDirPrivate">GdaDataModelDirPrivate</link>;
21
 
<link linkend="GdaDataModel">GdaDataModel</link>*       <link linkend="gda-data-model-dir-new">gda_data_model_dir_new</link>              (const <link linkend="gchar">gchar</link> *basedir);
22
 
const <link linkend="GSList">GSList</link>*       <link linkend="gda-data-model-dir-get-errors">gda_data_model_dir_get_errors</link>       (<link linkend="GdaDataModelDir">GdaDataModelDir</link> *model);
 
20
<link linkend="GdaDataModel">GdaDataModel</link> *      <link linkend="gda-data-model-dir-new">gda_data_model_dir_new</link>              (const <link linkend="gchar">gchar</link> *basedir);
 
21
const <link linkend="GSList">GSList</link> *      <link linkend="gda-data-model-dir-get-errors">gda_data_model_dir_get_errors</link>       (<link linkend="GdaDataModelDir">GdaDataModelDir</link> *model);
23
22
<link linkend="void">void</link>                <link linkend="gda-data-model-dir-clean-errors">gda_data_model_dir_clean_errors</link>     (<link linkend="GdaDataModelDir">GdaDataModelDir</link> *model);
24
23
</synopsis>
25
24
</refsynopsisdiv>
30
29
  <link linkend="GObject">GObject</link>
31
30
   +----GdaDataModelDir
32
31
</synopsis>
33
 
 
34
32
</refsect1>
35
33
 
36
34
 
40
38
<para>
41
39
GdaDataModelDir implements
42
40
 <link linkend="GdaDataModel">GdaDataModel</link>.</para>
43
 
 
44
41
</refsect1>
45
42
 
46
43
 
67
64
  <listitem><para>the "data" column (GDA_TYPE_BLOB): contains the contents of each file</para></listitem>
68
65
</itemizedlist>
69
66
</para>
70
 
 
71
67
<para>
72
68
Note that the actual values of the "mime_type", "md5sum" and "data" columns are computed only when they are requested to
73
69
help with performances.
78
74
<title role="details.title">Details</title>
79
75
<refsect2 id="GdaDataModelDir-struct" role="struct">
80
76
<title>GdaDataModelDir</title>
81
 
<indexterm zone="GdaDataModelDir-struct"><primary>GdaDataModelDir</primary></indexterm><programlisting>typedef struct _GdaDataModelDir GdaDataModelDir;</programlisting>
 
77
<indexterm zone="GdaDataModelDir-struct"><primary sortas="GdaDataModelDir">GdaDataModelDir</primary></indexterm><programlisting>typedef struct _GdaDataModelDir GdaDataModelDir;</programlisting>
82
78
<para>
83
 
 
84
79
</para></refsect2>
85
80
<refsect2 id="GdaDataModelDirClass" role="struct">
86
81
<title>GdaDataModelDirClass</title>
87
 
<indexterm zone="GdaDataModelDirClass"><primary>GdaDataModelDirClass</primary></indexterm><programlisting>typedef struct {
 
82
<indexterm zone="GdaDataModelDirClass"><primary sortas="GdaDataModelDirClass">GdaDataModelDirClass</primary></indexterm><programlisting>typedef struct {
88
83
        GObjectClass            parent_class;
89
84
 
90
85
        /* Padding for future expansion */
95
90
} GdaDataModelDirClass;
96
91
</programlisting>
97
92
<para>
98
 
 
99
93
</para></refsect2>
100
94
<refsect2 id="GdaDataModelDirPrivate" role="struct">
101
95
<title>GdaDataModelDirPrivate</title>
102
 
<indexterm zone="GdaDataModelDirPrivate"><primary>GdaDataModelDirPrivate</primary></indexterm><programlisting>typedef struct _GdaDataModelDirPrivate GdaDataModelDirPrivate;</programlisting>
 
96
<indexterm zone="GdaDataModelDirPrivate"><primary sortas="GdaDataModelDirPrivate">GdaDataModelDirPrivate</primary></indexterm><programlisting>typedef struct _GdaDataModelDirPrivate GdaDataModelDirPrivate;</programlisting>
103
97
<para>
104
 
 
105
98
</para></refsect2>
106
99
<refsect2 id="gda-data-model-dir-new" role="function">
107
100
<title>gda_data_model_dir_new ()</title>
108
 
<indexterm zone="gda-data-model-dir-new"><primary>gda_data_model_dir_new</primary></indexterm><programlisting><link linkend="GdaDataModel">GdaDataModel</link>*       gda_data_model_dir_new              (const <link linkend="gchar">gchar</link> *basedir);</programlisting>
 
101
<indexterm zone="gda-data-model-dir-new"><primary sortas="gda_data_model_dir_new">gda_data_model_dir_new</primary></indexterm><programlisting><link linkend="GdaDataModel">GdaDataModel</link> *      gda_data_model_dir_new              (const <link linkend="gchar">gchar</link> *basedir);</programlisting>
109
102
<para>
110
103
Creates a new <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object to list all the files starting from <parameter>basedir</parameter></para>
111
104
<para>
112
 
 
113
105
</para><variablelist role="params">
114
 
<varlistentry><term><parameter>basedir</parameter>&nbsp;:</term>
 
106
<varlistentry><term><parameter>basedir</parameter>&#160;:</term>
115
107
<listitem><simpara> a directory
116
108
</simpara></listitem></varlistentry>
117
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GdaDataModel"><type>GdaDataModel</type></link>
 
109
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GdaDataModel"><type>GdaDataModel</type></link>
118
110
</simpara></listitem></varlistentry>
119
111
</variablelist></refsect2>
120
112
<refsect2 id="gda-data-model-dir-get-errors" role="function">
121
113
<title>gda_data_model_dir_get_errors ()</title>
122
 
<indexterm zone="gda-data-model-dir-get-errors"><primary>gda_data_model_dir_get_errors</primary></indexterm><programlisting>const <link linkend="GSList">GSList</link>*       gda_data_model_dir_get_errors       (<link linkend="GdaDataModelDir">GdaDataModelDir</link> *model);</programlisting>
 
114
<indexterm zone="gda-data-model-dir-get-errors"><primary sortas="gda_data_model_dir_get_errors">gda_data_model_dir_get_errors</primary></indexterm><programlisting>const <link linkend="GSList">GSList</link> *      gda_data_model_dir_get_errors       (<link linkend="GdaDataModelDir">GdaDataModelDir</link> *model);</programlisting>
123
115
<para>
124
116
Get the list of errors which have occurred while using <parameter>model</parameter></para>
125
117
<para>
126
 
 
127
118
</para><variablelist role="params">
128
 
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
119
<varlistentry><term><parameter>model</parameter>&#160;:</term>
129
120
<listitem><simpara> a <link linkend="GdaDataModelDir"><type>GdaDataModelDir</type></link> object
130
121
</simpara></listitem></varlistentry>
131
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a read-only list of <link linkend="GError"><type>GError</type></link> pointers, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no error has occurred
 
122
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a read-only list of <link linkend="GError"><type>GError</type></link> pointers, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no error has occurred
132
123
</simpara></listitem></varlistentry>
133
124
</variablelist></refsect2>
134
125
<refsect2 id="gda-data-model-dir-clean-errors" role="function">
135
126
<title>gda_data_model_dir_clean_errors ()</title>
136
 
<indexterm zone="gda-data-model-dir-clean-errors"><primary>gda_data_model_dir_clean_errors</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_dir_clean_errors     (<link linkend="GdaDataModelDir">GdaDataModelDir</link> *model);</programlisting>
 
127
<indexterm zone="gda-data-model-dir-clean-errors"><primary sortas="gda_data_model_dir_clean_errors">gda_data_model_dir_clean_errors</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_dir_clean_errors     (<link linkend="GdaDataModelDir">GdaDataModelDir</link> *model);</programlisting>
137
128
<para>
138
129
Reset the list of errors which have occurred while using <parameter>model</parameter></para>
139
130
<para>
140
 
 
141
131
</para><variablelist role="params">
142
 
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
132
<varlistentry><term><parameter>model</parameter>&#160;:</term>
143
133
<listitem><simpara> a <link linkend="GdaDataModelDir"><type>GdaDataModelDir</type></link> object
144
134
</simpara></listitem></varlistentry>
145
135
</variablelist></refsect2>
147
137
</refsect1>
148
138
<refsect1 id="GdaDataModelDir.property-details" role="property_details">
149
139
<title role="property_details.title">Property Details</title>
150
 
<refsect2 id="GdaDataModelDir--basedir"><title>The <literal>&quot;basedir&quot;</literal> property</title>
151
 
<indexterm zone="GdaDataModelDir--basedir"><primary>GdaDataModelDir:basedir</primary></indexterm><programlisting>  &quot;basedir&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
140
<refsect2 id="GdaDataModelDir--basedir" role="property"><title>The <literal>&quot;basedir&quot;</literal> property</title>
 
141
<indexterm zone="GdaDataModelDir--basedir"><primary sortas="GdaDataModelDir:basedir">GdaDataModelDir:basedir</primary></indexterm><programlisting>  &quot;basedir&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
152
142
<para>Base directory.</para><para>Default value: NULL</para>
153
143
</refsect2>
154
 
 
155
144
</refsect1>
156
145
 
157
146