2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
<refentry id="EDestination">
6
<refentrytitle role="top_of_page" id="EDestination.top_of_page">EDestination</refentrytitle>
7
<manvolnum>3</manvolnum>
13
<refname>EDestination</refname>
14
<refpurpose></refpurpose>
17
<refsynopsisdiv id="EDestination.synopsis" role="synopsis">
18
<title role="synopsis.title">Synopsis</title>
20
<synopsis> <link linkend="EDestination-struct">EDestination</link>;
21
<link linkend="EDestination"><returnvalue>EDestination</returnvalue></link> * <link linkend="e-destination-copy">e_destination_copy</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
22
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-destination-empty">e_destination_empty</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
23
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-destination-equal">e_destination_equal</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *a</parameter>,
24
<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *b</parameter>);
25
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-destination-export">e_destination_export</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
26
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-export-to-vcard-attribute">e_destination_export_to_vcard_attribute</link>
27
(<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
28
<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
29
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-destination-exportv">e_destination_exportv</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> **destv</parameter>);
30
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-freev">e_destination_freev</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> **destv</parameter>);
31
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-destination-get-address">e_destination_get_address</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
32
<link linkend="EContact"><returnvalue>EContact</returnvalue></link> * <link linkend="e-destination-get-contact">e_destination_get_contact</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
33
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-destination-get-contact-uid">e_destination_get_contact_uid</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
34
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-destination-get-email">e_destination_get_email</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
35
<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="e-destination-get-email-num">e_destination_get_email_num</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
36
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-destination-get-html-mail-pref">e_destination_get_html_mail_pref</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
37
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-destination-get-name">e_destination_get_name</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
38
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-destination-get-source-uid">e_destination_get_source_uid</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
39
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-destination-get-textrep">e_destination_get_textrep</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
40
<parameter><link linkend="gboolean"><type>gboolean</type></link> include_email</parameter>);
41
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-destination-get-textrepv">e_destination_get_textrepv</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> **destv</parameter>);
42
<link linkend="EDestination"><returnvalue>EDestination</returnvalue></link> * <link linkend="e-destination-import">e_destination_import</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>);
43
<link linkend="EDestination"><returnvalue>EDestination</returnvalue></link> ** <link linkend="e-destination-importv">e_destination_importv</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>);
44
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-destination-is-auto-recipient">e_destination_is_auto_recipient</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
45
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-destination-is-evolution-list">e_destination_is_evolution_list</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
46
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-destination-is-ignored">e_destination_is_ignored</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
47
const <link linkend="GList"><returnvalue>GList</returnvalue></link> * <link linkend="e-destination-list-get-dests">e_destination_list_get_dests</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
48
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-destination-list-show-addresses">e_destination_list_show_addresses</link> (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);
49
<link linkend="EDestination"><returnvalue>EDestination</returnvalue></link> * <link linkend="e-destination-new">e_destination_new</link> (<parameter><type>void</type></parameter>);
50
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-set-auto-recipient">e_destination_set_auto_recipient</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
51
<parameter><link linkend="gboolean"><type>gboolean</type></link> value</parameter>);
52
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-set-book">e_destination_set_book</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
53
<parameter><link linkend="EBook"><type>EBook</type></link> *book</parameter>);
54
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-set-contact">e_destination_set_contact</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
55
<parameter><link linkend="EContact"><type>EContact</type></link> *contact</parameter>,
56
<parameter><link linkend="gint"><type>gint</type></link> email_num</parameter>);
57
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-set-contact-uid">e_destination_set_contact_uid</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
58
<parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
59
<parameter><link linkend="gint"><type>gint</type></link> email_num</parameter>);
60
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-set-email">e_destination_set_email</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
61
<parameter>const <link linkend="gchar"><type>gchar</type></link> *email</parameter>);
62
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-set-html-mail-pref">e_destination_set_html_mail_pref</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
63
<parameter><link linkend="gboolean"><type>gboolean</type></link> flag</parameter>);
64
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-set-ignored">e_destination_set_ignored</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
65
<parameter><link linkend="gboolean"><type>gboolean</type></link> ignored</parameter>);
66
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-set-name">e_destination_set_name</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
67
<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);
68
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-destination-set-raw">e_destination_set_raw</link> (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
69
<parameter>const <link linkend="gchar"><type>gchar</type></link> *raw</parameter>);
72
<refsect1 id="EDestination.object-hierarchy" role="object_hierarchy">
73
<title role="object_hierarchy.title">Object Hierarchy</title>
75
<link linkend="GObject">GObject</link>
79
<refsect1 id="EDestination.signals" role="signal_proto">
80
<title role="signal_proto.title">Signals</title>
82
"<link linkend="EDestination-changed">changed</link>" : Run Last
86
<refsect1 id="EDestination.description" role="desc">
87
<title role="desc.title">Description</title>
91
<refsect1 id="EDestination.details" role="details">
92
<title role="details.title">Details</title>
93
<refsect2 id="EDestination-struct" role="struct">
94
<title>EDestination</title>
95
<indexterm zone="EDestination-struct"><primary>EDestination</primary></indexterm>
96
<programlisting>typedef struct _EDestination EDestination;</programlisting>
99
<refsect2 id="e-destination-copy" role="function">
100
<title>e_destination_copy ()</title>
101
<indexterm zone="e-destination-copy"><primary>e_destination_copy</primary></indexterm>
102
<programlisting><link linkend="EDestination"><returnvalue>EDestination</returnvalue></link> * e_destination_copy (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
104
Creates a new <link linkend="EDestination"><type>EDestination</type></link> identical to <parameter>dest</parameter>.</para>
105
<variablelist role="params">
106
<varlistentry><term><parameter>dest</parameter> :</term>
107
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
108
</simpara></listitem></varlistentry>
109
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly created <link linkend="EDestination"><type>EDestination</type></link>, identical to <parameter>dest</parameter>.
110
</simpara></listitem></varlistentry>
111
</variablelist></refsect2>
112
<refsect2 id="e-destination-empty" role="function">
113
<title>e_destination_empty ()</title>
114
<indexterm zone="e-destination-empty"><primary>e_destination_empty</primary></indexterm>
115
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_destination_empty (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
117
Checks if <parameter>dest</parameter> is blank.</para>
118
<variablelist role="params">
119
<varlistentry><term><parameter>dest</parameter> :</term>
120
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
121
</simpara></listitem></varlistentry>
122
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>dest</parameter> is empty, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
123
</simpara></listitem></varlistentry>
124
</variablelist></refsect2>
125
<refsect2 id="e-destination-equal" role="function">
126
<title>e_destination_equal ()</title>
127
<indexterm zone="e-destination-equal"><primary>e_destination_equal</primary></indexterm>
128
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_destination_equal (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *a</parameter>,
129
<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *b</parameter>);</programlisting>
131
Checks if <parameter>a</parameter> and <parameter>b</parameter> are equal.</para>
132
<variablelist role="params">
133
<varlistentry><term><parameter>a</parameter> :</term>
134
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
135
</simpara></listitem></varlistentry>
136
<varlistentry><term><parameter>b</parameter> :</term>
137
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
138
</simpara></listitem></varlistentry>
139
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the destinations are equal, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
140
</simpara></listitem></varlistentry>
141
</variablelist></refsect2>
142
<refsect2 id="e-destination-export" role="function">
143
<title>e_destination_export ()</title>
144
<indexterm zone="e-destination-export"><primary>e_destination_export</primary></indexterm>
145
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_destination_export (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
147
Exports a destination to an XML document.</para>
148
<variablelist role="params">
149
<varlistentry><term><parameter>dest</parameter> :</term>
150
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
151
</simpara></listitem></varlistentry>
152
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An XML string, allocated with g_malloc.
153
</simpara></listitem></varlistentry>
154
</variablelist></refsect2>
155
<refsect2 id="e-destination-export-to-vcard-attribute" role="function">
156
<title>e_destination_export_to_vcard_attribute ()</title>
157
<indexterm zone="e-destination-export-to-vcard-attribute"><primary>e_destination_export_to_vcard_attribute</primary></indexterm>
158
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_export_to_vcard_attribute
159
(<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
160
<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
162
Exports the contact information from <parameter>dest</parameter> to parameters
163
and values in <parameter>attr</parameter>, suitable for an address book.</para>
164
<variablelist role="params">
165
<varlistentry><term><parameter>dest</parameter> :</term>
166
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
167
</simpara></listitem></varlistentry>
168
<varlistentry><term><parameter>attr</parameter> :</term>
169
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
170
</simpara></listitem></varlistentry>
171
</variablelist></refsect2>
172
<refsect2 id="e-destination-exportv" role="function">
173
<title>e_destination_exportv ()</title>
174
<indexterm zone="e-destination-exportv"><primary>e_destination_exportv</primary></indexterm>
175
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_destination_exportv (<parameter><link linkend="EDestination"><type>EDestination</type></link> **destv</parameter>);</programlisting>
177
Exports multiple <link linkend="EDestination"><type>EDestination</type></link> elements to a single XML document.</para>
178
<variablelist role="params">
179
<varlistentry><term><parameter>destv</parameter> :</term>
180
<listitem><simpara>a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated array of pointers to <link linkend="EDestination"><type>EDestination</type></link>
181
</simpara></listitem></varlistentry>
182
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An XML string, allocated with g_malloc.
183
</simpara></listitem></varlistentry>
184
</variablelist></refsect2>
185
<refsect2 id="e-destination-freev" role="function">
186
<title>e_destination_freev ()</title>
187
<indexterm zone="e-destination-freev"><primary>e_destination_freev</primary></indexterm>
188
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_freev (<parameter><link linkend="EDestination"><type>EDestination</type></link> **destv</parameter>);</programlisting>
190
Unrefs the elements of <parameter>destv</parameter> and frees <parameter>destv</parameter> itself.</para>
191
<variablelist role="params">
192
<varlistentry><term><parameter>destv</parameter> :</term>
193
<listitem><simpara>a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated array of pointers to <link linkend="EDestination"><type>EDestination</type></link>
194
</simpara></listitem></varlistentry>
195
</variablelist></refsect2>
196
<refsect2 id="e-destination-get-address" role="function">
197
<title>e_destination_get_address ()</title>
198
<indexterm zone="e-destination-get-address"><primary>e_destination_get_address</primary></indexterm>
199
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_destination_get_address (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
201
Gets the formatted name and e-mail address, or in the case of
202
lists, the formatted list of e-mail addresses, from <parameter>dest</parameter>.</para>
203
<variablelist role="params">
204
<varlistentry><term><parameter>dest</parameter> :</term>
205
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
206
</simpara></listitem></varlistentry>
207
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A formatted destination string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the destination was empty.
208
</simpara></listitem></varlistentry>
209
</variablelist></refsect2>
210
<refsect2 id="e-destination-get-contact" role="function">
211
<title>e_destination_get_contact ()</title>
212
<indexterm zone="e-destination-get-contact"><primary>e_destination_get_contact</primary></indexterm>
213
<programlisting><link linkend="EContact"><returnvalue>EContact</returnvalue></link> * e_destination_get_contact (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
215
Gets the contact <parameter>dest</parameter> is pointing to, if any.</para>
216
<variablelist role="params">
217
<varlistentry><term><parameter>dest</parameter> :</term>
218
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
219
</simpara></listitem></varlistentry>
220
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="EContact"><type>EContact</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none was set.
221
</simpara></listitem></varlistentry>
222
</variablelist></refsect2>
223
<refsect2 id="e-destination-get-contact-uid" role="function">
224
<title>e_destination_get_contact_uid ()</title>
225
<indexterm zone="e-destination-get-contact-uid"><primary>e_destination_get_contact_uid</primary></indexterm>
226
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_destination_get_contact_uid (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
228
Gets the unique contact ID <parameter>dest</parameter> is pointing to, if any.</para>
229
<variablelist role="params">
230
<varlistentry><term><parameter>dest</parameter> :</term>
231
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
232
</simpara></listitem></varlistentry>
233
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A unique contact ID, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none was set.
234
</simpara></listitem></varlistentry>
235
</variablelist></refsect2>
236
<refsect2 id="e-destination-get-email" role="function">
237
<title>e_destination_get_email ()</title>
238
<indexterm zone="e-destination-get-email"><primary>e_destination_get_email</primary></indexterm>
239
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_destination_get_email (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
241
Gets the e-mail address of <parameter>dest</parameter>'s addressee.</para>
242
<variablelist role="params">
243
<varlistentry><term><parameter>dest</parameter> :</term>
244
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
245
</simpara></listitem></varlistentry>
246
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An e-mail address, or an empty string if none was set.
247
</simpara></listitem></varlistentry>
248
</variablelist></refsect2>
249
<refsect2 id="e-destination-get-email-num" role="function">
250
<title>e_destination_get_email_num ()</title>
251
<indexterm zone="e-destination-get-email-num"><primary>e_destination_get_email_num</primary></indexterm>
252
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> e_destination_get_email_num (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
254
Gets the index of the e-mail address of the contact that
255
<parameter>dest</parameter> is pointing to, if any.</para>
256
<variablelist role="params">
257
<varlistentry><term><parameter>dest</parameter> :</term>
258
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
259
</simpara></listitem></varlistentry>
260
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The e-mail index, or -1 if none was set.
261
</simpara></listitem></varlistentry>
262
</variablelist></refsect2>
263
<refsect2 id="e-destination-get-html-mail-pref" role="function">
264
<title>e_destination_get_html_mail_pref ()</title>
265
<indexterm zone="e-destination-get-html-mail-pref"><primary>e_destination_get_html_mail_pref</primary></indexterm>
266
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_destination_get_html_mail_pref (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
268
Check if <parameter>dest</parameter> wants to get mail formatted as HTML.</para>
269
<variablelist role="params">
270
<varlistentry><term><parameter>dest</parameter> :</term>
271
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
272
</simpara></listitem></varlistentry>
273
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if destination wants HTML, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not.
274
</simpara></listitem></varlistentry>
275
</variablelist></refsect2>
276
<refsect2 id="e-destination-get-name" role="function">
277
<title>e_destination_get_name ()</title>
278
<indexterm zone="e-destination-get-name"><primary>e_destination_get_name</primary></indexterm>
279
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_destination_get_name (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
281
Gets the full name of <parameter>dest</parameter>'s addressee, or if the addressee is
282
a contact list, the name the list was filed under.</para>
283
<variablelist role="params">
284
<varlistentry><term><parameter>dest</parameter> :</term>
285
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
286
</simpara></listitem></varlistentry>
287
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The full name of the addressee, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none was set.
288
</simpara></listitem></varlistentry>
289
</variablelist></refsect2>
290
<refsect2 id="e-destination-get-source-uid" role="function">
291
<title>e_destination_get_source_uid ()</title>
292
<indexterm zone="e-destination-get-source-uid"><primary>e_destination_get_source_uid</primary></indexterm>
293
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_destination_get_source_uid (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
295
Gets the unique source ID <parameter>dest</parameter> is pointing to, if any. The source
296
ID specifies which address book <parameter>dest</parameter>'s contact came from.</para>
297
<variablelist role="params">
298
<varlistentry><term><parameter>dest</parameter> :</term>
299
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
300
</simpara></listitem></varlistentry>
301
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A unique source ID, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none was set.
302
</simpara></listitem></varlistentry>
303
</variablelist></refsect2>
304
<refsect2 id="e-destination-get-textrep" role="function">
305
<title>e_destination_get_textrep ()</title>
306
<indexterm zone="e-destination-get-textrep"><primary>e_destination_get_textrep</primary></indexterm>
307
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_destination_get_textrep (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
308
<parameter><link linkend="gboolean"><type>gboolean</type></link> include_email</parameter>);</programlisting>
310
Generates a textual representation of <parameter>dest</parameter>, suitable for referring
311
to the destination during user interaction.</para>
312
<variablelist role="params">
313
<varlistentry><term><parameter>dest</parameter> :</term>
314
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
315
</simpara></listitem></varlistentry>
316
<varlistentry><term><parameter>include_email</parameter> :</term>
317
<listitem><simpara>whether to include the e-mail address
318
</simpara></listitem></varlistentry>
319
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A textual representation of the destination.
320
</simpara></listitem></varlistentry>
321
</variablelist></refsect2>
322
<refsect2 id="e-destination-get-textrepv" role="function">
323
<title>e_destination_get_textrepv ()</title>
324
<indexterm zone="e-destination-get-textrepv"><primary>e_destination_get_textrepv</primary></indexterm>
325
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_destination_get_textrepv (<parameter><link linkend="EDestination"><type>EDestination</type></link> **destv</parameter>);</programlisting>
327
Generates a joint text representation of all the <link linkend="EDestination"><type>EDestination</type></link>
328
elements in <parameter>destv</parameter>.</para>
329
<variablelist role="params">
330
<varlistentry><term><parameter>destv</parameter> :</term>
331
<listitem><simpara><link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated array of pointers to <link linkend="EDestination"><type>EDestination</type></link>
332
</simpara></listitem></varlistentry>
333
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The text representation of <parameter>destv</parameter>.
334
</simpara></listitem></varlistentry>
335
</variablelist></refsect2>
336
<refsect2 id="e-destination-import" role="function">
337
<title>e_destination_import ()</title>
338
<indexterm zone="e-destination-import"><primary>e_destination_import</primary></indexterm>
339
<programlisting><link linkend="EDestination"><returnvalue>EDestination</returnvalue></link> * e_destination_import (<parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>);</programlisting>
341
Creates an <link linkend="EDestination"><type>EDestination</type></link> from an XML document.</para>
342
<variablelist role="params">
343
<varlistentry><term><parameter>str</parameter> :</term>
344
<listitem><simpara>an XML string
345
</simpara></listitem></varlistentry>
346
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="EDestination"><type>EDestination</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the document was not well-formed.
347
</simpara></listitem></varlistentry>
348
</variablelist></refsect2>
349
<refsect2 id="e-destination-importv" role="function">
350
<title>e_destination_importv ()</title>
351
<indexterm zone="e-destination-importv"><primary>e_destination_importv</primary></indexterm>
352
<programlisting><link linkend="EDestination"><returnvalue>EDestination</returnvalue></link> ** e_destination_importv (<parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>);</programlisting>
354
Creates an array of pointers to <link linkend="EDestination"><type>EDestination</type></link> elements
355
from an XML document.</para>
356
<variablelist role="params">
357
<varlistentry><term><parameter>str</parameter> :</term>
358
<listitem><simpara>an XML string
359
</simpara></listitem></varlistentry>
360
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated array of pointers to <link linkend="EDestination"><type>EDestination</type></link> elements.
361
</simpara></listitem></varlistentry>
362
</variablelist></refsect2>
363
<refsect2 id="e-destination-is-auto-recipient" role="function">
364
<title>e_destination_is_auto_recipient ()</title>
365
<indexterm zone="e-destination-is-auto-recipient"><primary>e_destination_is_auto_recipient</primary></indexterm>
366
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_destination_is_auto_recipient (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
368
Checks if <parameter>dest</parameter> is flagged as an automatic recipient, meaning
369
it was not explicitly specified by the user. This can be used
370
to hide it from some UI elements.</para>
371
<variablelist role="params">
372
<varlistentry><term><parameter>dest</parameter> :</term>
373
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
374
</simpara></listitem></varlistentry>
375
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if destination is an auto recipient, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
376
</simpara></listitem></varlistentry>
377
</variablelist></refsect2>
378
<refsect2 id="e-destination-is-evolution-list" role="function">
379
<title>e_destination_is_evolution_list ()</title>
380
<indexterm zone="e-destination-is-evolution-list"><primary>e_destination_is_evolution_list</primary></indexterm>
381
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_destination_is_evolution_list (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
383
Checks if <parameter>dest</parameter> is a list of addresses.</para>
384
<variablelist role="params">
385
<varlistentry><term><parameter>dest</parameter> :</term>
386
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
387
</simpara></listitem></varlistentry>
388
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if destination is a list, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if it is an individual.
389
</simpara></listitem></varlistentry>
390
</variablelist></refsect2>
391
<refsect2 id="e-destination-is-ignored" role="function">
392
<title>e_destination_is_ignored ()</title>
393
<indexterm zone="e-destination-is-ignored"><primary>e_destination_is_ignored</primary></indexterm>
394
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_destination_is_ignored (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
396
Check if <parameter>dest</parameter> is to be ignored.</para>
397
<variablelist role="params">
398
<varlistentry><term><parameter>dest</parameter> :</term>
399
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
400
</simpara></listitem></varlistentry>
401
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if this destination should be ignored, else <link linkend="FALSE:CAPS"><type>FALSE</type></link>.
402
</simpara></listitem></varlistentry>
403
</variablelist></refsect2>
404
<refsect2 id="e-destination-list-get-dests" role="function">
405
<title>e_destination_list_get_dests ()</title>
406
<indexterm zone="e-destination-list-get-dests"><primary>e_destination_list_get_dests</primary></indexterm>
407
<programlisting>const <link linkend="GList"><returnvalue>GList</returnvalue></link> * e_destination_list_get_dests (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
409
If <parameter>dest</parameter> is a list, gets the list of destinations. The list
410
and its elements belong to <parameter>dest</parameter>, and should not be freed.</para>
411
<variablelist role="params">
412
<varlistentry><term><parameter>dest</parameter> :</term>
413
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
414
</simpara></listitem></varlistentry>
415
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A list of elements of type <link linkend="EDestination"><type>EDestination</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
416
</simpara></listitem></varlistentry>
417
</variablelist></refsect2>
418
<refsect2 id="e-destination-list-show-addresses" role="function">
419
<title>e_destination_list_show_addresses ()</title>
420
<indexterm zone="e-destination-list-show-addresses"><primary>e_destination_list_show_addresses</primary></indexterm>
421
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_destination_list_show_addresses (<parameter>const <link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>);</programlisting>
423
If <parameter>dest</parameter> is a list, checks if the addresses in the list
424
should be presented to the user during interaction.</para>
425
<variablelist role="params">
426
<varlistentry><term><parameter>dest</parameter> :</term>
427
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
428
</simpara></listitem></varlistentry>
429
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if addresses should be shown, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
430
</simpara></listitem></varlistentry>
431
</variablelist></refsect2>
432
<refsect2 id="e-destination-new" role="function">
433
<title>e_destination_new ()</title>
434
<indexterm zone="e-destination-new"><primary>e_destination_new</primary></indexterm>
435
<programlisting><link linkend="EDestination"><returnvalue>EDestination</returnvalue></link> * e_destination_new (<parameter><type>void</type></parameter>);</programlisting>
437
Creates a new <link linkend="EDestination"><type>EDestination</type></link> with blank values.</para>
438
<variablelist role="params">
439
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly created <link linkend="EDestination"><type>EDestination</type></link>.
440
</simpara></listitem></varlistentry>
441
</variablelist></refsect2>
442
<refsect2 id="e-destination-set-auto-recipient" role="function">
443
<title>e_destination_set_auto_recipient ()</title>
444
<indexterm zone="e-destination-set-auto-recipient"><primary>e_destination_set_auto_recipient</primary></indexterm>
445
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_set_auto_recipient (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
446
<parameter><link linkend="gboolean"><type>gboolean</type></link> value</parameter>);</programlisting>
448
Sets the flag indicating if <parameter>dest</parameter> is an automatic recipient, meaning
449
it was not explicitly specified by the user. This can be used
450
to hide it from some UI elements.</para>
451
<variablelist role="params">
452
<varlistentry><term><parameter>dest</parameter> :</term>
453
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
454
</simpara></listitem></varlistentry>
455
<varlistentry><term><parameter>value</parameter> :</term>
456
<listitem><simpara>the auto recipient flag
457
</simpara></listitem></varlistentry>
458
</variablelist></refsect2>
459
<refsect2 id="e-destination-set-book" role="function">
460
<title>e_destination_set_book ()</title>
461
<indexterm zone="e-destination-set-book"><primary>e_destination_set_book</primary></indexterm>
462
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_set_book (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
463
<parameter><link linkend="EBook"><type>EBook</type></link> *book</parameter>);</programlisting>
465
Specify the source <parameter>dest</parameter>'s contact comes from. This is useful
466
if you need to update the contact later.</para>
467
<variablelist role="params">
468
<varlistentry><term><parameter>dest</parameter> :</term>
469
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
470
</simpara></listitem></varlistentry>
471
<varlistentry><term><parameter>book</parameter> :</term>
472
<listitem><simpara>an <link linkend="EBook"><type>EBook</type></link>
473
</simpara></listitem></varlistentry>
474
</variablelist></refsect2>
475
<refsect2 id="e-destination-set-contact" role="function">
476
<title>e_destination_set_contact ()</title>
477
<indexterm zone="e-destination-set-contact"><primary>e_destination_set_contact</primary></indexterm>
478
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_set_contact (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
479
<parameter><link linkend="EContact"><type>EContact</type></link> *contact</parameter>,
480
<parameter><link linkend="gint"><type>gint</type></link> email_num</parameter>);</programlisting>
482
Sets <parameter>dest</parameter> to point to one of <parameter>contact</parameter>'s e-mail addresses
483
indicated by <parameter>email_num</parameter>.</para>
484
<variablelist role="params">
485
<varlistentry><term><parameter>dest</parameter> :</term>
486
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
487
</simpara></listitem></varlistentry>
488
<varlistentry><term><parameter>contact</parameter> :</term>
489
<listitem><simpara>an <link linkend="EContact"><type>EContact</type></link>
490
</simpara></listitem></varlistentry>
491
<varlistentry><term><parameter>email_num</parameter> :</term>
492
<listitem><simpara>an email index
493
</simpara></listitem></varlistentry>
494
</variablelist></refsect2>
495
<refsect2 id="e-destination-set-contact-uid" role="function">
496
<title>e_destination_set_contact_uid ()</title>
497
<indexterm zone="e-destination-set-contact-uid"><primary>e_destination_set_contact_uid</primary></indexterm>
498
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_set_contact_uid (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
499
<parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
500
<parameter><link linkend="gint"><type>gint</type></link> email_num</parameter>);</programlisting>
502
Sets <parameter>dest</parameter> to point to one of the contact specified by <parameter>uid</parameter>'s e-mail
503
addresses indicated by <parameter>email_num</parameter>.</para>
504
<variablelist role="params">
505
<varlistentry><term><parameter>dest</parameter> :</term>
506
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
507
</simpara></listitem></varlistentry>
508
<varlistentry><term><parameter>uid</parameter> :</term>
509
<listitem><simpara>a unique contact ID
510
</simpara></listitem></varlistentry>
511
<varlistentry><term><parameter>email_num</parameter> :</term>
512
<listitem><simpara>an email index
513
</simpara></listitem></varlistentry>
514
</variablelist></refsect2>
515
<refsect2 id="e-destination-set-email" role="function">
516
<title>e_destination_set_email ()</title>
517
<indexterm zone="e-destination-set-email"><primary>e_destination_set_email</primary></indexterm>
518
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_set_email (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
519
<parameter>const <link linkend="gchar"><type>gchar</type></link> *email</parameter>);</programlisting>
521
Sets the e-mail address of <parameter>dest</parameter>'s addressee.</para>
522
<variablelist role="params">
523
<varlistentry><term><parameter>dest</parameter> :</term>
524
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
525
</simpara></listitem></varlistentry>
526
<varlistentry><term><parameter>email</parameter> :</term>
527
<listitem><simpara>the destination's e-mail address
528
</simpara></listitem></varlistentry>
529
</variablelist></refsect2>
530
<refsect2 id="e-destination-set-html-mail-pref" role="function">
531
<title>e_destination_set_html_mail_pref ()</title>
532
<indexterm zone="e-destination-set-html-mail-pref"><primary>e_destination_set_html_mail_pref</primary></indexterm>
533
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_set_html_mail_pref (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
534
<parameter><link linkend="gboolean"><type>gboolean</type></link> flag</parameter>);</programlisting>
536
Specifies whether <parameter>dest</parameter> wants to get mail formatted as HTML.</para>
537
<variablelist role="params">
538
<varlistentry><term><parameter>dest</parameter> :</term>
539
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
540
</simpara></listitem></varlistentry>
541
<varlistentry><term><parameter>flag</parameter> :</term>
542
<listitem><simpara>whether the destination wants HTML mail
543
</simpara></listitem></varlistentry>
544
</variablelist></refsect2>
545
<refsect2 id="e-destination-set-ignored" role="function">
546
<title>e_destination_set_ignored ()</title>
547
<indexterm zone="e-destination-set-ignored"><primary>e_destination_set_ignored</primary></indexterm>
548
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_set_ignored (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
549
<parameter><link linkend="gboolean"><type>gboolean</type></link> ignored</parameter>);</programlisting>
551
Set the ignore flag on a <link linkend="EDestination"><type>EDestination</type></link>.</para>
552
<variablelist role="params">
553
<varlistentry><term><parameter>dest</parameter> :</term>
554
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
555
</simpara></listitem></varlistentry>
556
<varlistentry><term><parameter>ignored</parameter> :</term>
557
<listitem><simpara><link linkend="TRUE:CAPS"><type>TRUE</type></link> if this <link linkend="EDestination"><type>EDestination</type></link> should be ignored.
558
</simpara></listitem></varlistentry>
559
</variablelist></refsect2>
560
<refsect2 id="e-destination-set-name" role="function">
561
<title>e_destination_set_name ()</title>
562
<indexterm zone="e-destination-set-name"><primary>e_destination_set_name</primary></indexterm>
563
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_set_name (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
564
<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
566
Sets the full name of <parameter>dest</parameter>'s addressee.</para>
567
<variablelist role="params">
568
<varlistentry><term><parameter>dest</parameter> :</term>
569
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
570
</simpara></listitem></varlistentry>
571
<varlistentry><term><parameter>name</parameter> :</term>
572
<listitem><simpara>the destination's full name
573
</simpara></listitem></varlistentry>
574
</variablelist></refsect2>
575
<refsect2 id="e-destination-set-raw" role="function">
576
<title>e_destination_set_raw ()</title>
577
<indexterm zone="e-destination-set-raw"><primary>e_destination_set_raw</primary></indexterm>
578
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_destination_set_raw (<parameter><link linkend="EDestination"><type>EDestination</type></link> *dest</parameter>,
579
<parameter>const <link linkend="gchar"><type>gchar</type></link> *raw</parameter>);</programlisting>
581
Sets <parameter>dest</parameter> to point to the name and e-mail address resulting from
582
parsing the supplied string. Useful for user input.</para>
583
<variablelist role="params">
584
<varlistentry><term><parameter>dest</parameter> :</term>
585
<listitem><simpara>an <link linkend="EDestination"><type>EDestination</type></link>
586
</simpara></listitem></varlistentry>
587
<varlistentry><term><parameter>raw</parameter> :</term>
588
<listitem><simpara>an unparsed string
589
</simpara></listitem></varlistentry>
590
</variablelist></refsect2>
593
<refsect1 id="EDestination.signal-details" role="signals">
594
<title role="signals.title">Signal Details</title>
595
<refsect2 id="EDestination-changed" role="signal"><title>The <literal>"changed"</literal> signal</title>
596
<indexterm zone="EDestination-changed"><primary>EDestination::changed</primary></indexterm>
597
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="EDestination"><type>EDestination</type></link> *edestination,
598
<link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting>
600
</para><variablelist role="params">
601
<varlistentry><term><parameter>edestination</parameter> :</term>
602
<listitem><simpara>the object which received the signal.
603
</simpara></listitem></varlistentry>
604
<varlistentry><term><parameter>user_data</parameter> :</term>
605
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
606
</variablelist></refsect2>
added
removed
docs/reference/addressbook/libebook/xml/e-destination.xml
