← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libedata-book/xml/e-data-book-factory.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/addressbook/libedata-book/xml/e-data-book-factory.xml
5
5
<refmeta>
6
6
<refentrytitle role="top_of_page" id="libedata-book-EDataBookFactory.top_of_page">EDataBookFactory</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBEDATA-BOOK Library</refmiscinfo>
 
8
<refmiscinfo>
 
9
  LIBEDATA-BOOK Library
 
10
</refmiscinfo>
9
11
</refmeta>
10
 
 
11
12
<refnamediv>
12
13
<refname>EDataBookFactory</refname>
13
14
<refpurpose></refpurpose>
16
17
<refsynopsisdiv id="libedata-book-EDataBookFactory.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
18
19
 
19
 
<synopsis>
20
 
                    <link linkend="EDataBookFactory">EDataBookFactory</link>;
21
 
<link linkend="EDataBookFactory">EDataBookFactory</link> *  <link linkend="e-data-book-factory-new">e_data_book_factory_new</link>             (void);
22
 
<link linkend="void">void</link>                <link linkend="e-data-book-factory-register-backend">e_data_book_factory_register_backend</link>
23
 
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
24
 
                                                         <link linkend="EBookBackendFactory">EBookBackendFactory</link> *backend_factory);
25
 
<link linkend="gint">gint</link>                <link linkend="e-data-book-factory-get-n-backends">e_data_book_factory_get_n_backends</link>  (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);
26
 
<link linkend="void">void</link>                <link linkend="e-data-book-factory-register-backends">e_data_book_factory_register_backends</link>
27
 
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);
28
 
<link linkend="void">void</link>                <link linkend="e-data-book-factory-dump-active-backends">e_data_book_factory_dump_active_backends</link>
29
 
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);
30
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-data-book-factory-activate">e_data_book_factory_activate</link>        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
31
 
                                                         const <link linkend="gchar">gchar</link> *iid);
32
 
<link linkend="void">void</link>                <link linkend="e-data-book-factory-set-backend-mode">e_data_book_factory_set_backend_mode</link>
33
 
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
34
 
                                                         <link linkend="gint">gint</link> mode);
 
20
<synopsis>                    <link linkend="EDataBookFactory">EDataBookFactory</link>;
 
21
<link linkend="EDataBookFactory"><returnvalue>EDataBookFactory</returnvalue></link> *  <link linkend="e-data-book-factory-new">e_data_book_factory_new</link>             (<parameter><type>void</type></parameter>);
 
22
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-data-book-factory-register-backend">e_data_book_factory_register_backend</link>
 
23
                                                        (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>,
 
24
                                                         <parameter><link linkend="EBookBackendFactory"><type>EBookBackendFactory</type></link> *backend_factory</parameter>);
 
25
<link linkend="gint"><returnvalue>gint</returnvalue></link>                <link linkend="e-data-book-factory-get-n-backends">e_data_book_factory_get_n_backends</link>  (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>);
 
26
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-data-book-factory-register-backends">e_data_book_factory_register_backends</link>
 
27
                                                        (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>);
 
28
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-data-book-factory-dump-active-backends">e_data_book_factory_dump_active_backends</link>
 
29
                                                        (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>);
 
30
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-data-book-factory-activate">e_data_book_factory_activate</link>        (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>,
 
31
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *iid</parameter>);
 
32
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-data-book-factory-set-backend-mode">e_data_book_factory_set_backend_mode</link>
 
33
                                                        (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>,
 
34
                                                         <parameter><link linkend="gint"><type>gint</type></link> mode</parameter>);
35
35
</synopsis>
36
36
</refsynopsisdiv>
37
37
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
38
<refsect1 id="libedata-book-EDataBookFactory.description" role="desc">
47
39
<title role="desc.title">Description</title>
48
40
<para>
49
41
</para>
50
42
</refsect1>
51
 
 
52
43
<refsect1 id="libedata-book-EDataBookFactory.details" role="details">
53
44
<title role="details.title">Details</title>
54
45
<refsect2 id="EDataBookFactory" role="struct">
55
46
<title>EDataBookFactory</title>
56
 
<indexterm zone="EDataBookFactory"><primary sortas="EDataBookFactory">EDataBookFactory</primary></indexterm><programlisting>typedef struct {
 
47
<indexterm zone="EDataBookFactory"><primary>EDataBookFactory</primary></indexterm>
 
48
<programlisting>typedef struct {
57
49
        BonoboObject            parent_object;
58
50
        EDataBookFactoryPrivate *priv;
59
51
} EDataBookFactory;
62
54
</para></refsect2>
63
55
<refsect2 id="e-data-book-factory-new" role="function">
64
56
<title>e_data_book_factory_new ()</title>
65
 
<indexterm zone="e-data-book-factory-new"><primary sortas="e_data_book_factory_new">e_data_book_factory_new</primary></indexterm><programlisting><link linkend="EDataBookFactory">EDataBookFactory</link> *  e_data_book_factory_new             (void);</programlisting>
 
57
<indexterm zone="e-data-book-factory-new"><primary>e_data_book_factory_new</primary></indexterm>
 
58
<programlisting><link linkend="EDataBookFactory"><returnvalue>EDataBookFactory</returnvalue></link> *  e_data_book_factory_new             (<parameter><type>void</type></parameter>);</programlisting>
66
59
<para>
67
60
Create a new <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>.</para>
68
 
<para>
69
 
</para><variablelist role="params">
 
61
<variablelist role="params">
70
62
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>.
71
63
</simpara></listitem></varlistentry>
72
64
</variablelist></refsect2>
73
65
<refsect2 id="e-data-book-factory-register-backend" role="function">
74
66
<title>e_data_book_factory_register_backend ()</title>
75
 
<indexterm zone="e-data-book-factory-register-backend"><primary sortas="e_data_book_factory_register_backend">e_data_book_factory_register_backend</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_book_factory_register_backend
76
 
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
77
 
                                                         <link linkend="EBookBackendFactory">EBookBackendFactory</link> *backend_factory);</programlisting>
 
67
<indexterm zone="e-data-book-factory-register-backend"><primary>e_data_book_factory_register_backend</primary></indexterm>
 
68
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_data_book_factory_register_backend
 
69
                                                        (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>,
 
70
                                                         <parameter><link linkend="EBookBackendFactory"><type>EBookBackendFactory</type></link> *backend_factory</parameter>);</programlisting>
78
71
<para>
79
72
Registers <parameter>backend_factory</parameter> with <parameter>factory</parameter>.</para>
80
 
<para>
81
 
</para><variablelist role="params">
 
73
<variablelist role="params">
82
74
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
83
 
<listitem><simpara> an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
 
75
<listitem><simpara>an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
84
76
</simpara></listitem></varlistentry>
85
77
<varlistentry><term><parameter>backend_factory</parameter>&#160;:</term>
86
 
<listitem><simpara> an <link linkend="EBookBackendFactory"><type>EBookBackendFactory</type></link>
 
78
<listitem><simpara>an <link linkend="EBookBackendFactory"><type>EBookBackendFactory</type></link>
87
79
</simpara></listitem></varlistentry>
88
80
</variablelist></refsect2>
89
81
<refsect2 id="e-data-book-factory-get-n-backends" role="function">
90
82
<title>e_data_book_factory_get_n_backends ()</title>
91
 
<indexterm zone="e-data-book-factory-get-n-backends"><primary sortas="e_data_book_factory_get_n_backends">e_data_book_factory_get_n_backends</primary></indexterm><programlisting><link linkend="gint">gint</link>                e_data_book_factory_get_n_backends  (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);</programlisting>
 
83
<indexterm zone="e-data-book-factory-get-n-backends"><primary>e_data_book_factory_get_n_backends</primary></indexterm>
 
84
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link>                e_data_book_factory_get_n_backends  (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>);</programlisting>
92
85
<para>
93
86
Queries the number of running addressbook backends in an addressbook factory.</para>
94
 
<para>
95
 
</para><variablelist role="params">
 
87
<variablelist role="params">
96
88
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
97
 
<listitem><simpara> An addressbook factory.
 
89
<listitem><simpara>An addressbook factory.
98
90
</simpara></listitem></varlistentry>
99
91
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Number of running backends.
100
92
</simpara></listitem></varlistentry>
101
93
</variablelist></refsect2>
102
94
<refsect2 id="e-data-book-factory-register-backends" role="function">
103
95
<title>e_data_book_factory_register_backends ()</title>
104
 
<indexterm zone="e-data-book-factory-register-backends"><primary sortas="e_data_book_factory_register_backends">e_data_book_factory_register_backends</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_book_factory_register_backends
105
 
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);</programlisting>
 
96
<indexterm zone="e-data-book-factory-register-backends"><primary>e_data_book_factory_register_backends</primary></indexterm>
 
97
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_data_book_factory_register_backends
 
98
                                                        (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>);</programlisting>
106
99
<para>
107
100
Register the backends supported by the Evolution Data Server,
108
101
with <parameter>book_factory</parameter>.</para>
109
 
<para>
110
 
</para><variablelist role="params">
 
102
<variablelist role="params">
111
103
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
112
104
<listitem><simpara>
113
105
</simpara></listitem></varlistentry>
114
106
</variablelist></refsect2>
115
107
<refsect2 id="e-data-book-factory-dump-active-backends" role="function">
116
108
<title>e_data_book_factory_dump_active_backends ()</title>
117
 
<indexterm zone="e-data-book-factory-dump-active-backends"><primary sortas="e_data_book_factory_dump_active_backends">e_data_book_factory_dump_active_backends</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_book_factory_dump_active_backends
118
 
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);</programlisting>
 
109
<indexterm zone="e-data-book-factory-dump-active-backends"><primary>e_data_book_factory_dump_active_backends</primary></indexterm>
 
110
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_data_book_factory_dump_active_backends
 
111
                                                        (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>);</programlisting>
119
112
<para>
120
113
Dump the list of active backends registered with <parameter>factory</parameter>
121
114
to stdout. This is a debugging function.</para>
122
 
<para>
123
 
</para><variablelist role="params">
 
115
<variablelist role="params">
124
116
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
125
 
<listitem><simpara> an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
 
117
<listitem><simpara>an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
126
118
</simpara></listitem></varlistentry>
127
119
</variablelist></refsect2>
128
120
<refsect2 id="e-data-book-factory-activate" role="function">
129
121
<title>e_data_book_factory_activate ()</title>
130
 
<indexterm zone="e-data-book-factory-activate"><primary sortas="e_data_book_factory_activate">e_data_book_factory_activate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_data_book_factory_activate        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
131
 
                                                         const <link linkend="gchar">gchar</link> *iid);</programlisting>
 
122
<indexterm zone="e-data-book-factory-activate"><primary>e_data_book_factory_activate</primary></indexterm>
 
123
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_data_book_factory_activate        (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>,
 
124
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *iid</parameter>);</programlisting>
132
125
<para>
133
126
Activates the factory specified by <parameter>iid</parameter>, using Bonobo.</para>
134
 
<para>
135
 
</para><variablelist role="params">
 
127
<variablelist role="params">
136
128
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
137
 
<listitem><simpara> an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
 
129
<listitem><simpara>an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
138
130
</simpara></listitem></varlistentry>
139
131
<varlistentry><term><parameter>iid</parameter>&#160;:</term>
140
 
<listitem><simpara> the OAF ID of the factory to activate
 
132
<listitem><simpara>the OAF ID of the factory to activate
141
133
</simpara></listitem></varlistentry>
142
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> for success, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
134
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> for success, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
143
135
</simpara></listitem></varlistentry>
144
136
</variablelist></refsect2>
145
137
<refsect2 id="e-data-book-factory-set-backend-mode" role="function">
146
138
<title>e_data_book_factory_set_backend_mode ()</title>
147
 
<indexterm zone="e-data-book-factory-set-backend-mode"><primary sortas="e_data_book_factory_set_backend_mode">e_data_book_factory_set_backend_mode</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_book_factory_set_backend_mode
148
 
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
149
 
                                                         <link linkend="gint">gint</link> mode);</programlisting>
 
139
<indexterm zone="e-data-book-factory-set-backend-mode"><primary>e_data_book_factory_set_backend_mode</primary></indexterm>
 
140
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_data_book_factory_set_backend_mode
 
141
                                                        (<parameter><link linkend="EDataBookFactory"><type>EDataBookFactory</type></link> *factory</parameter>,
 
142
                                                         <parameter><link linkend="gint"><type>gint</type></link> mode</parameter>);</programlisting>
150
143
<para>
151
144
Sets all the backends associated with <parameter>factory</parameter> to be either online
152
145
or offline. <parameter>mode</parameter> should be passed as 1 for offline, or 2 for
153
146
online.</para>
154
 
<para>
155
 
</para><variablelist role="params">
 
147
<variablelist role="params">
156
148
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
157
 
<listitem><simpara> an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
 
149
<listitem><simpara>an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
158
150
</simpara></listitem></varlistentry>
159
151
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
160
 
<listitem><simpara> a connection status
 
152
<listitem><simpara>a connection status
161
153
</simpara></listitem></varlistentry>
162
154
</variablelist></refsect2>
163
155
 
164
156
</refsect1>
165
157
 
166
 
 
167
 
 
168
 
 
169
158
</refentry>