16
17
<refsynopsisdiv id="EContactStore.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
20
<link linkend="EContactStore-struct">EContactStore</link>;
21
<link linkend="EContactStore">EContactStore</link> * <link linkend="e-contact-store-new">e_contact_store_new</link> (void);
22
<link linkend="EBook">EBook</link> * <link linkend="e-contact-store-get-book">e_contact_store_get_book</link> (<link linkend="EContactStore">EContactStore</link> *contact_store,
23
<link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
24
<link linkend="EContact">EContact</link> * <link linkend="e-contact-store-get-contact">e_contact_store_get_contact</link> (<link linkend="EContactStore">EContactStore</link> *contact_store,
25
<link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
26
<link linkend="gboolean">gboolean</link> <link linkend="e-contact-store-find-contact">e_contact_store_find_contact</link> (<link linkend="EContactStore">EContactStore</link> *contact_store,
27
const <link linkend="gchar">gchar</link> *uid,
28
<link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
29
<link linkend="GList">GList</link> * <link linkend="e-contact-store-get-books">e_contact_store_get_books</link> (<link linkend="EContactStore">EContactStore</link> *contact_store);
30
<link linkend="void">void</link> <link linkend="e-contact-store-add-book">e_contact_store_add_book</link> (<link linkend="EContactStore">EContactStore</link> *contact_store,
31
<link linkend="EBook">EBook</link> *book);
32
<link linkend="void">void</link> <link linkend="e-contact-store-remove-book">e_contact_store_remove_book</link> (<link linkend="EContactStore">EContactStore</link> *contact_store,
33
<link linkend="EBook">EBook</link> *book);
34
<link linkend="void">void</link> <link linkend="e-contact-store-set-query">e_contact_store_set_query</link> (<link linkend="EContactStore">EContactStore</link> *contact_store,
35
<link linkend="EBookQuery">EBookQuery</link> *book_query);
36
<link linkend="EBookQuery">EBookQuery</link> * <link linkend="e-contact-store-peek-query">e_contact_store_peek_query</link> (<link linkend="EContactStore">EContactStore</link> *contact_store);
37
<link linkend="EBookView">EBookView</link> * <link linkend="find-contact-source-by-book-return-view">find_contact_source_by_book_return_view</link>
38
(<link linkend="EContactStore">EContactStore</link> *contact_store,
39
<link linkend="EBook">EBook</link> *book);
20
<synopsis> <link linkend="EContactStore-struct">EContactStore</link>;
21
<link linkend="EContactStore"><returnvalue>EContactStore</returnvalue></link> * <link linkend="e-contact-store-new">e_contact_store_new</link> (<parameter><type>void</type></parameter>);
22
<link linkend="EBook"><returnvalue>EBook</returnvalue></link> * <link linkend="e-contact-store-get-book">e_contact_store_get_book</link> (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
23
<parameter><link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> *iter</parameter>);
24
<link linkend="EContact"><returnvalue>EContact</returnvalue></link> * <link linkend="e-contact-store-get-contact">e_contact_store_get_contact</link> (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
25
<parameter><link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> *iter</parameter>);
26
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-contact-store-find-contact">e_contact_store_find_contact</link> (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
27
<parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
28
<parameter><link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> *iter</parameter>);
29
<link linkend="GList"><returnvalue>GList</returnvalue></link> * <link linkend="e-contact-store-get-books">e_contact_store_get_books</link> (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>);
30
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-contact-store-add-book">e_contact_store_add_book</link> (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
31
<parameter><link linkend="EBook"><type>EBook</type></link> *book</parameter>);
32
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-contact-store-remove-book">e_contact_store_remove_book</link> (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
33
<parameter><link linkend="EBook"><type>EBook</type></link> *book</parameter>);
34
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-contact-store-set-query">e_contact_store_set_query</link> (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
35
<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *book_query</parameter>);
36
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link> * <link linkend="e-contact-store-peek-query">e_contact_store_peek_query</link> (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>);
37
<link linkend="EBookView"><returnvalue>EBookView</returnvalue></link> * <link linkend="find-contact-source-by-book-return-view">find_contact_source_by_book_return_view</link>
38
(<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
39
<parameter><link linkend="EBook"><type>EBook</type></link> *book</parameter>);
43
42
<refsect1 id="EContactStore.object-hierarchy" role="object_hierarchy">
44
43
<title role="object_hierarchy.title">Object Hierarchy</title>
57
53
<link linkend="GtkTreeModel">GtkTreeModel</link>.</para>
64
56
<refsect1 id="EContactStore.description" role="desc">
65
57
<title role="desc.title">Description</title>
70
61
<refsect1 id="EContactStore.details" role="details">
71
62
<title role="details.title">Details</title>
72
63
<refsect2 id="EContactStore-struct" role="struct">
73
64
<title>EContactStore</title>
74
<indexterm zone="EContactStore-struct"><primary sortas="EContactStore">EContactStore</primary></indexterm><programlisting>typedef struct _EContactStore EContactStore;</programlisting>
65
<indexterm zone="EContactStore-struct"><primary>EContactStore</primary></indexterm>
66
<programlisting>typedef struct _EContactStore EContactStore;</programlisting>
77
69
<refsect2 id="e-contact-store-new" role="function">
78
70
<title>e_contact_store_new ()</title>
79
<indexterm zone="e-contact-store-new"><primary sortas="e_contact_store_new">e_contact_store_new</primary></indexterm><programlisting><link linkend="EContactStore">EContactStore</link> * e_contact_store_new (void);</programlisting>
71
<indexterm zone="e-contact-store-new"><primary>e_contact_store_new</primary></indexterm>
72
<programlisting><link linkend="EContactStore"><returnvalue>EContactStore</returnvalue></link> * e_contact_store_new (<parameter><type>void</type></parameter>);</programlisting>
81
74
Creates a new <link linkend="EContactStore"><type>EContactStore</type></link>.</para>
83
</para><variablelist role="params">
75
<variablelist role="params">
84
76
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="EContactStore"><type>EContactStore</type></link>.
85
77
</simpara></listitem></varlistentry>
86
78
</variablelist></refsect2>
87
79
<refsect2 id="e-contact-store-get-book" role="function">
88
80
<title>e_contact_store_get_book ()</title>
89
<indexterm zone="e-contact-store-get-book"><primary sortas="e_contact_store_get_book">e_contact_store_get_book</primary></indexterm><programlisting><link linkend="EBook">EBook</link> * e_contact_store_get_book (<link linkend="EContactStore">EContactStore</link> *contact_store,
90
<link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
81
<indexterm zone="e-contact-store-get-book"><primary>e_contact_store_get_book</primary></indexterm>
82
<programlisting><link linkend="EBook"><returnvalue>EBook</returnvalue></link> * e_contact_store_get_book (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
83
<parameter><link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> *iter</parameter>);</programlisting>
92
85
Gets the <link linkend="EBook"><type>EBook</type></link> that provided the contact at <parameter>iter</parameter>.</para>
94
</para><variablelist role="params">
86
<variablelist role="params">
95
87
<varlistentry><term><parameter>contact_store</parameter> :</term>
96
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
88
<listitem><simpara>an <link linkend="EContactStore"><type>EContactStore</type></link>
97
89
</simpara></listitem></varlistentry>
98
90
<varlistentry><term><parameter>iter</parameter> :</term>
99
<listitem><simpara> a <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> from <parameter>contact_store</parameter>
91
<listitem><simpara>a <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> from <parameter>contact_store</parameter>
100
92
</simpara></listitem></varlistentry>
101
93
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="EBook"><type>EBook</type></link>.
102
94
</simpara></listitem></varlistentry>
103
95
</variablelist></refsect2>
104
96
<refsect2 id="e-contact-store-get-contact" role="function">
105
97
<title>e_contact_store_get_contact ()</title>
106
<indexterm zone="e-contact-store-get-contact"><primary sortas="e_contact_store_get_contact">e_contact_store_get_contact</primary></indexterm><programlisting><link linkend="EContact">EContact</link> * e_contact_store_get_contact (<link linkend="EContactStore">EContactStore</link> *contact_store,
107
<link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
98
<indexterm zone="e-contact-store-get-contact"><primary>e_contact_store_get_contact</primary></indexterm>
99
<programlisting><link linkend="EContact"><returnvalue>EContact</returnvalue></link> * e_contact_store_get_contact (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
100
<parameter><link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> *iter</parameter>);</programlisting>
109
102
Gets the <link linkend="EContact"><type>EContact</type></link> at <parameter>iter</parameter>.</para>
111
</para><variablelist role="params">
103
<variablelist role="params">
112
104
<varlistentry><term><parameter>contact_store</parameter> :</term>
113
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
105
<listitem><simpara>an <link linkend="EContactStore"><type>EContactStore</type></link>
114
106
</simpara></listitem></varlistentry>
115
107
<varlistentry><term><parameter>iter</parameter> :</term>
116
<listitem><simpara> a <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> from <parameter>contact_store</parameter>
108
<listitem><simpara>a <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> from <parameter>contact_store</parameter>
117
109
</simpara></listitem></varlistentry>
118
110
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="EContact"><type>EContact</type></link>.
119
111
</simpara></listitem></varlistentry>
120
112
</variablelist></refsect2>
121
113
<refsect2 id="e-contact-store-find-contact" role="function">
122
114
<title>e_contact_store_find_contact ()</title>
123
<indexterm zone="e-contact-store-find-contact"><primary sortas="e_contact_store_find_contact">e_contact_store_find_contact</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_contact_store_find_contact (<link linkend="EContactStore">EContactStore</link> *contact_store,
124
const <link linkend="gchar">gchar</link> *uid,
125
<link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
115
<indexterm zone="e-contact-store-find-contact"><primary>e_contact_store_find_contact</primary></indexterm>
116
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_contact_store_find_contact (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
117
<parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
118
<parameter><link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> *iter</parameter>);</programlisting>
127
120
Sets <parameter>iter</parameter> to point to the contact row matching <parameter>uid</parameter>.</para>
129
</para><variablelist role="params">
121
<variablelist role="params">
130
122
<varlistentry><term><parameter>contact_store</parameter> :</term>
131
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
123
<listitem><simpara>an <link linkend="EContactStore"><type>EContactStore</type></link>
132
124
</simpara></listitem></varlistentry>
133
125
<varlistentry><term><parameter>uid</parameter> :</term>
134
<listitem><simpara> a unique contact identifier
126
<listitem><simpara>a unique contact identifier
135
127
</simpara></listitem></varlistentry>
136
128
<varlistentry><term><parameter>iter</parameter> :</term>
137
<listitem><simpara> a destination <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> to set
129
<listitem><simpara>a destination <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> to set
138
130
</simpara></listitem></varlistentry>
139
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the contact was found, and <parameter>iter</parameter> was set. <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
131
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the contact was found, and <parameter>iter</parameter> was set. <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
140
132
</simpara></listitem></varlistentry>
141
133
</variablelist></refsect2>
142
134
<refsect2 id="e-contact-store-get-books" role="function">
143
135
<title>e_contact_store_get_books ()</title>
144
<indexterm zone="e-contact-store-get-books"><primary sortas="e_contact_store_get_books">e_contact_store_get_books</primary></indexterm><programlisting><link linkend="GList">GList</link> * e_contact_store_get_books (<link linkend="EContactStore">EContactStore</link> *contact_store);</programlisting>
136
<indexterm zone="e-contact-store-get-books"><primary>e_contact_store_get_books</primary></indexterm>
137
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link> * e_contact_store_get_books (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>);</programlisting>
146
139
Gets the list of books that provide contacts for <parameter>contact_store</parameter>.</para>
148
</para><variablelist role="params">
140
<variablelist role="params">
149
141
<varlistentry><term><parameter>contact_store</parameter> :</term>
150
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
142
<listitem><simpara>an <link linkend="EContactStore"><type>EContactStore</type></link>
151
143
</simpara></listitem></varlistentry>
152
144
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of pointers to <link linkend="EBook"><type>EBook</type></link>. The caller owns the list,
153
145
but not the books.
155
147
</variablelist></refsect2>
156
148
<refsect2 id="e-contact-store-add-book" role="function">
157
149
<title>e_contact_store_add_book ()</title>
158
<indexterm zone="e-contact-store-add-book"><primary sortas="e_contact_store_add_book">e_contact_store_add_book</primary></indexterm><programlisting><link linkend="void">void</link> e_contact_store_add_book (<link linkend="EContactStore">EContactStore</link> *contact_store,
159
<link linkend="EBook">EBook</link> *book);</programlisting>
150
<indexterm zone="e-contact-store-add-book"><primary>e_contact_store_add_book</primary></indexterm>
151
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_contact_store_add_book (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
152
<parameter><link linkend="EBook"><type>EBook</type></link> *book</parameter>);</programlisting>
161
154
Adds <parameter>book</parameter> to the list of books that provide contacts for <parameter>contact_store</parameter>.</para>
163
</para><variablelist role="params">
155
<variablelist role="params">
164
156
<varlistentry><term><parameter>contact_store</parameter> :</term>
165
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
157
<listitem><simpara>an <link linkend="EContactStore"><type>EContactStore</type></link>
166
158
</simpara></listitem></varlistentry>
167
159
<varlistentry><term><parameter>book</parameter> :</term>
168
<listitem><simpara> an <link linkend="EBook"><type>EBook</type></link>
160
<listitem><simpara>an <link linkend="EBook"><type>EBook</type></link>
169
161
</simpara></listitem></varlistentry>
170
162
</variablelist></refsect2>
171
163
<refsect2 id="e-contact-store-remove-book" role="function">
172
164
<title>e_contact_store_remove_book ()</title>
173
<indexterm zone="e-contact-store-remove-book"><primary sortas="e_contact_store_remove_book">e_contact_store_remove_book</primary></indexterm><programlisting><link linkend="void">void</link> e_contact_store_remove_book (<link linkend="EContactStore">EContactStore</link> *contact_store,
174
<link linkend="EBook">EBook</link> *book);</programlisting>
165
<indexterm zone="e-contact-store-remove-book"><primary>e_contact_store_remove_book</primary></indexterm>
166
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_contact_store_remove_book (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
167
<parameter><link linkend="EBook"><type>EBook</type></link> *book</parameter>);</programlisting>
176
169
Removes <parameter>book</parameter> from the list of books that provide contacts for <parameter>contact_store</parameter>.</para>
178
</para><variablelist role="params">
170
<variablelist role="params">
179
171
<varlistentry><term><parameter>contact_store</parameter> :</term>
180
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
172
<listitem><simpara>an <link linkend="EContactStore"><type>EContactStore</type></link>
181
173
</simpara></listitem></varlistentry>
182
174
<varlistentry><term><parameter>book</parameter> :</term>
183
<listitem><simpara> an <link linkend="EBook"><type>EBook</type></link>
175
<listitem><simpara>an <link linkend="EBook"><type>EBook</type></link>
184
176
</simpara></listitem></varlistentry>
185
177
</variablelist></refsect2>
186
178
<refsect2 id="e-contact-store-set-query" role="function">
187
179
<title>e_contact_store_set_query ()</title>
188
<indexterm zone="e-contact-store-set-query"><primary sortas="e_contact_store_set_query">e_contact_store_set_query</primary></indexterm><programlisting><link linkend="void">void</link> e_contact_store_set_query (<link linkend="EContactStore">EContactStore</link> *contact_store,
189
<link linkend="EBookQuery">EBookQuery</link> *book_query);</programlisting>
180
<indexterm zone="e-contact-store-set-query"><primary>e_contact_store_set_query</primary></indexterm>
181
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_contact_store_set_query (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
182
<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *book_query</parameter>);</programlisting>
191
184
Sets <parameter>book_query</parameter> to be the query used to fetch contacts from the books
192
185
assigned to <parameter>contact_store</parameter>.</para>
194
</para><variablelist role="params">
186
<variablelist role="params">
195
187
<varlistentry><term><parameter>contact_store</parameter> :</term>
196
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
188
<listitem><simpara>an <link linkend="EContactStore"><type>EContactStore</type></link>
197
189
</simpara></listitem></varlistentry>
198
190
<varlistentry><term><parameter>book_query</parameter> :</term>
199
<listitem><simpara> an <link linkend="EBookQuery"><type>EBookQuery</type></link>
191
<listitem><simpara>an <link linkend="EBookQuery"><type>EBookQuery</type></link>
200
192
</simpara></listitem></varlistentry>
201
193
</variablelist></refsect2>
202
194
<refsect2 id="e-contact-store-peek-query" role="function">
203
195
<title>e_contact_store_peek_query ()</title>
204
<indexterm zone="e-contact-store-peek-query"><primary sortas="e_contact_store_peek_query">e_contact_store_peek_query</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link> * e_contact_store_peek_query (<link linkend="EContactStore">EContactStore</link> *contact_store);</programlisting>
196
<indexterm zone="e-contact-store-peek-query"><primary>e_contact_store_peek_query</primary></indexterm>
197
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link> * e_contact_store_peek_query (<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>);</programlisting>
206
199
Gets the query that's being used to fetch contacts from the books
207
200
assigned to <parameter>contact_store</parameter>.</para>
209
</para><variablelist role="params">
201
<variablelist role="params">
210
202
<varlistentry><term><parameter>contact_store</parameter> :</term>
211
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
203
<listitem><simpara>an <link linkend="EContactStore"><type>EContactStore</type></link>
212
204
</simpara></listitem></varlistentry>
213
205
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="EBookQuery"><type>EBookQuery</type></link> being used.
214
206
</simpara></listitem></varlistentry>
215
207
</variablelist></refsect2>
216
208
<refsect2 id="find-contact-source-by-book-return-view" role="function">
217
209
<title>find_contact_source_by_book_return_view ()</title>
218
<indexterm zone="find-contact-source-by-book-return-view"><primary sortas="find_contact_source_by_book_return_view">find_contact_source_by_book_return_view</primary></indexterm><programlisting><link linkend="EBookView">EBookView</link> * find_contact_source_by_book_return_view
219
(<link linkend="EContactStore">EContactStore</link> *contact_store,
220
<link linkend="EBook">EBook</link> *book);</programlisting>
210
<indexterm zone="find-contact-source-by-book-return-view"><primary>find_contact_source_by_book_return_view</primary></indexterm>
211
<programlisting><link linkend="EBookView"><returnvalue>EBookView</returnvalue></link> * find_contact_source_by_book_return_view
212
(<parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>,
213
<parameter><link linkend="EBook"><type>EBook</type></link> *book</parameter>);</programlisting>
222
215
</para><variablelist role="params">
223
216
<varlistentry><term><parameter>contact_store</parameter> :</term>