← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/camel/xml/camel-text-index.xml

  • Committer: Bazaar Package Importer
  • Author(s): Yves-Alexis Perez
  • Date: 2010-03-08 23:15:54 UTC
  • mfrom: (1.10.5 upstream)
  • mto: (1.2.11 sid)
  • mto: This revision was merged to the branch mainline in revision 128.
  • Revision ID: james.westby@ubuntu.com-20100308231554-kqlody4h3laayg0j
Tags: 2.29.92-1
* New upstream release candidate.
* debian/control:
  - add build-dep on gperf for imapx backend.
* debian/libcamel1.2-14.shlibs: bump shlibs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/xml/camel-text-index.xml
 
1
<refentry id="camel-CamelTextIndexName">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page" id="camel-CamelTextIndexName.top_of_page">CamelTextIndex</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>CAMEL Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>CamelTextIndex</refname>
 
10
<refpurpose></refpurpose>
 
11
</refnamediv>
 
12
 
 
13
<refsynopsisdiv id="camel-CamelTextIndexName.synopsis" role="synopsis">
 
14
<title role="synopsis.title">Synopsis</title>
 
15
 
 
16
<synopsis>
 
17
<link linkend="void">void</link>                (<link linkend="CamelTextIndexFunc">*CamelTextIndexFunc</link>)               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx,
 
18
                                                         const <link linkend="gchar">gchar</link> *word,
 
19
                                                         <link linkend="gchar">gchar</link> *buffer);
 
20
                    <link linkend="CamelTextIndex">CamelTextIndex</link>;
 
21
                    <link linkend="CamelTextIndexCursor">CamelTextIndexCursor</link>;
 
22
                    <link linkend="CamelTextIndexKeyCursor">CamelTextIndexKeyCursor</link>;
 
23
                    <link linkend="CamelTextIndexName">CamelTextIndexName</link>;
 
24
<link linkend="CamelTextIndex">CamelTextIndex</link> *    <link linkend="camel-text-index-new">camel_text_index_new</link>                (const <link linkend="gchar">gchar</link> *path,
 
25
                                                         <link linkend="gint">gint</link> flags);
 
26
<link linkend="gint">gint</link>                <link linkend="camel-text-index-check">camel_text_index_check</link>              (const <link linkend="gchar">gchar</link> *path);
 
27
<link linkend="gint">gint</link>                <link linkend="camel-text-index-rename">camel_text_index_rename</link>             (const <link linkend="gchar">gchar</link> *old,
 
28
                                                         const <link linkend="gchar">gchar</link> *new);
 
29
<link linkend="gint">gint</link>                <link linkend="camel-text-index-remove">camel_text_index_remove</link>             (const <link linkend="gchar">gchar</link> *old);
 
30
<link linkend="void">void</link>                <link linkend="camel-text-index-dump">camel_text_index_dump</link>               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);
 
31
<link linkend="void">void</link>                <link linkend="camel-text-index-info">camel_text_index_info</link>               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);
 
32
<link linkend="void">void</link>                <link linkend="camel-text-index-validate">camel_text_index_validate</link>           (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);
 
33
</synopsis>
 
34
</refsynopsisdiv>
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
<refsect1 id="camel-CamelTextIndexName.description" role="desc">
 
45
<title role="desc.title">Description</title>
 
46
<para>
 
47
</para>
 
48
</refsect1>
 
49
 
 
50
<refsect1 id="camel-CamelTextIndexName.details" role="details">
 
51
<title role="details.title">Details</title>
 
52
<refsect2 id="CamelTextIndexFunc" role="function">
 
53
<title>CamelTextIndexFunc ()</title>
 
54
<indexterm zone="CamelTextIndexFunc"><primary sortas="CamelTextIndexFunc">CamelTextIndexFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*CamelTextIndexFunc)               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx,
 
55
                                                         const <link linkend="gchar">gchar</link> *word,
 
56
                                                         <link linkend="gchar">gchar</link> *buffer);</programlisting>
 
57
<para>
 
58
</para><variablelist role="params">
 
59
<varlistentry><term><parameter>idx</parameter>&#160;:</term>
 
60
<listitem><simpara>
 
61
</simpara></listitem></varlistentry>
 
62
<varlistentry><term><parameter>word</parameter>&#160;:</term>
 
63
<listitem><simpara>
 
64
</simpara></listitem></varlistentry>
 
65
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
 
66
<listitem><simpara>
 
67
</simpara></listitem></varlistentry>
 
68
</variablelist></refsect2>
 
69
<refsect2 id="CamelTextIndex" role="struct">
 
70
<title>CamelTextIndex</title>
 
71
<indexterm zone="CamelTextIndex"><primary sortas="CamelTextIndex">CamelTextIndex</primary></indexterm><programlisting>typedef struct {
 
72
        CamelIndex parent;
 
73
 
 
74
        struct _CamelTextIndexPrivate *priv;
 
75
} CamelTextIndex;
 
76
</programlisting>
 
77
<para>
 
78
</para></refsect2>
 
79
<refsect2 id="CamelTextIndexCursor" role="struct">
 
80
<title>CamelTextIndexCursor</title>
 
81
<indexterm zone="CamelTextIndexCursor"><primary sortas="CamelTextIndexCursor">CamelTextIndexCursor</primary></indexterm><programlisting>typedef struct {
 
82
        CamelIndexCursor parent;
 
83
 
 
84
        struct _CamelTextIndexCursorPrivate *priv;
 
85
} CamelTextIndexCursor;
 
86
</programlisting>
 
87
<para>
 
88
</para></refsect2>
 
89
<refsect2 id="CamelTextIndexKeyCursor" role="struct">
 
90
<title>CamelTextIndexKeyCursor</title>
 
91
<indexterm zone="CamelTextIndexKeyCursor"><primary sortas="CamelTextIndexKeyCursor">CamelTextIndexKeyCursor</primary></indexterm><programlisting>typedef struct {
 
92
        CamelIndexCursor parent;
 
93
 
 
94
        struct _CamelTextIndexKeyCursorPrivate *priv;
 
95
} CamelTextIndexKeyCursor;
 
96
</programlisting>
 
97
<para>
 
98
</para></refsect2>
 
99
<refsect2 id="CamelTextIndexName" role="struct">
 
100
<title>CamelTextIndexName</title>
 
101
<indexterm zone="CamelTextIndexName"><primary sortas="CamelTextIndexName">CamelTextIndexName</primary></indexterm><programlisting>typedef struct {
 
102
        CamelIndexName parent;
 
103
 
 
104
        struct _CamelTextIndexNamePrivate *priv;
 
105
} CamelTextIndexName;
 
106
</programlisting>
 
107
<para>
 
108
</para></refsect2>
 
109
<refsect2 id="camel-text-index-new" role="function">
 
110
<title>camel_text_index_new ()</title>
 
111
<indexterm zone="camel-text-index-new"><primary sortas="camel_text_index_new">camel_text_index_new</primary></indexterm><programlisting><link linkend="CamelTextIndex">CamelTextIndex</link> *    camel_text_index_new                (const <link linkend="gchar">gchar</link> *path,
 
112
                                                         <link linkend="gint">gint</link> flags);</programlisting>
 
113
<para>
 
114
</para><variablelist role="params">
 
115
<varlistentry><term><parameter>path</parameter>&#160;:</term>
 
116
<listitem><simpara>
 
117
</simpara></listitem></varlistentry>
 
118
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
 
119
<listitem><simpara>
 
120
</simpara></listitem></varlistentry>
 
121
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
122
</simpara></listitem></varlistentry>
 
123
</variablelist></refsect2>
 
124
<refsect2 id="camel-text-index-check" role="function">
 
125
<title>camel_text_index_check ()</title>
 
126
<indexterm zone="camel-text-index-check"><primary sortas="camel_text_index_check">camel_text_index_check</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_text_index_check              (const <link linkend="gchar">gchar</link> *path);</programlisting>
 
127
<para>
 
128
</para><variablelist role="params">
 
129
<varlistentry><term><parameter>path</parameter>&#160;:</term>
 
130
<listitem><simpara>
 
131
</simpara></listitem></varlistentry>
 
132
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
133
</simpara></listitem></varlistentry>
 
134
</variablelist></refsect2>
 
135
<refsect2 id="camel-text-index-rename" role="function">
 
136
<title>camel_text_index_rename ()</title>
 
137
<indexterm zone="camel-text-index-rename"><primary sortas="camel_text_index_rename">camel_text_index_rename</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_text_index_rename             (const <link linkend="gchar">gchar</link> *old,
 
138
                                                         const <link linkend="gchar">gchar</link> *new);</programlisting>
 
139
<para>
 
140
</para><variablelist role="params">
 
141
<varlistentry><term><parameter>old</parameter>&#160;:</term>
 
142
<listitem><simpara>
 
143
</simpara></listitem></varlistentry>
 
144
<varlistentry><term><parameter>new</parameter>&#160;:</term>
 
145
<listitem><simpara>
 
146
</simpara></listitem></varlistentry>
 
147
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
148
</simpara></listitem></varlistentry>
 
149
</variablelist></refsect2>
 
150
<refsect2 id="camel-text-index-remove" role="function">
 
151
<title>camel_text_index_remove ()</title>
 
152
<indexterm zone="camel-text-index-remove"><primary sortas="camel_text_index_remove">camel_text_index_remove</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_text_index_remove             (const <link linkend="gchar">gchar</link> *old);</programlisting>
 
153
<para>
 
154
</para><variablelist role="params">
 
155
<varlistentry><term><parameter>old</parameter>&#160;:</term>
 
156
<listitem><simpara>
 
157
</simpara></listitem></varlistentry>
 
158
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
159
</simpara></listitem></varlistentry>
 
160
</variablelist></refsect2>
 
161
<refsect2 id="camel-text-index-dump" role="function">
 
162
<title>camel_text_index_dump ()</title>
 
163
<indexterm zone="camel-text-index-dump"><primary sortas="camel_text_index_dump">camel_text_index_dump</primary></indexterm><programlisting><link linkend="void">void</link>                camel_text_index_dump               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);</programlisting>
 
164
<para>
 
165
</para><variablelist role="params">
 
166
<varlistentry><term><parameter>idx</parameter>&#160;:</term>
 
167
<listitem><simpara>
 
168
</simpara></listitem></varlistentry>
 
169
</variablelist></refsect2>
 
170
<refsect2 id="camel-text-index-info" role="function">
 
171
<title>camel_text_index_info ()</title>
 
172
<indexterm zone="camel-text-index-info"><primary sortas="camel_text_index_info">camel_text_index_info</primary></indexterm><programlisting><link linkend="void">void</link>                camel_text_index_info               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);</programlisting>
 
173
<para>
 
174
</para><variablelist role="params">
 
175
<varlistentry><term><parameter>idx</parameter>&#160;:</term>
 
176
<listitem><simpara>
 
177
</simpara></listitem></varlistentry>
 
178
</variablelist></refsect2>
 
179
<refsect2 id="camel-text-index-validate" role="function">
 
180
<title>camel_text_index_validate ()</title>
 
181
<indexterm zone="camel-text-index-validate"><primary sortas="camel_text_index_validate">camel_text_index_validate</primary></indexterm><programlisting><link linkend="void">void</link>                camel_text_index_validate           (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);</programlisting>
 
182
<para>
 
183
</para><variablelist role="params">
 
184
<varlistentry><term><parameter>idx</parameter>&#160;:</term>
 
185
<listitem><simpara>
 
186
</simpara></listitem></varlistentry>
 
187
</variablelist></refsect2>
 
188
 
 
189
</refsect1>
 
190
 
 
191
 
 
192
 
 
193
 
 
194
</refentry>