← 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/libebook/xml/e-book-view.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/libebook/xml/e-book-view.xml
5
5
<refmeta>
6
6
<refentrytitle role="top_of_page" id="EBookView.top_of_page">EBookView</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBEBOOK Library</refmiscinfo>
 
8
<refmiscinfo>
 
9
  LIBEBOOK Library
 
10
</refmiscinfo>
9
11
</refmeta>
10
 
 
11
12
<refnamediv>
12
13
<refname>EBookView</refname>
13
14
<refpurpose>Represents a search against an <link linkend="EBook"><type>EBook</type></link>.</refpurpose>
16
17
<refsynopsisdiv id="EBookView.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
18
19
 
19
 
<synopsis>
20
 
                    <link linkend="EBookView-struct">EBookView</link>;
21
 
<link linkend="EBookView">EBookView</link> *         <link linkend="e-book-view-new">e_book_view_new</link>                     (<link linkend="GNOME-Evolution-Addressbook-BookView">GNOME_Evolution_Addressbook_BookView</link> corba_book_view,
22
 
                                                         <link linkend="EBookViewListener">EBookViewListener</link> *listener);
23
 
<link linkend="void">void</link>                <link linkend="e-book-view-start">e_book_view_start</link>                   (<link linkend="EBookView">EBookView</link> *book_view);
24
 
<link linkend="void">void</link>                <link linkend="e-book-view-stop">e_book_view_stop</link>                    (<link linkend="EBookView">EBookView</link> *book_view);
25
 
<link linkend="void">void</link>                <link linkend="e-book-view-set-book">e_book_view_set_book</link>                (<link linkend="EBookView">EBookView</link> *book_view,
26
 
                                                         <link linkend="struct--EBook">struct _EBook</link> *book);
27
 
struct <link linkend="EBook">_EBook</link> *     <link linkend="e-book-view-get-book">e_book_view_get_book</link>                (<link linkend="EBookView">EBookView</link> *book_view);
 
20
<synopsis>                    <link linkend="EBookView-struct">EBookView</link>;
 
21
<link linkend="EBookView"><returnvalue>EBookView</returnvalue></link> *         <link linkend="e-book-view-new">e_book_view_new</link>                     (<parameter><link linkend="GNOME-Evolution-Addressbook-BookView"><type>GNOME_Evolution_Addressbook_BookView</type></link> corba_book_view</parameter>,
 
22
                                                         <parameter><link linkend="EBookViewListener"><type>EBookViewListener</type></link> *listener</parameter>);
 
23
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-view-start">e_book_view_start</link>                   (<parameter><link linkend="EBookView"><type>EBookView</type></link> *book_view</parameter>);
 
24
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-view-stop">e_book_view_stop</link>                    (<parameter><link linkend="EBookView"><type>EBookView</type></link> *book_view</parameter>);
 
25
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-view-set-book">e_book_view_set_book</link>                (<parameter><link linkend="EBookView"><type>EBookView</type></link> *book_view</parameter>,
 
26
                                                         <parameter><type>struct _EBook</type> *book</parameter>);
 
27
struct <link linkend="EBook"><returnvalue>_EBook</returnvalue></link> *     <link linkend="e-book-view-get-book">e_book_view_get_book</link>                (<parameter><link linkend="EBookView"><type>EBookView</type></link> *book_view</parameter>);
28
28
</synopsis>
29
29
</refsynopsisdiv>
30
 
 
31
30
<refsect1 id="EBookView.object-hierarchy" role="object_hierarchy">
32
31
<title role="object_hierarchy.title">Object Hierarchy</title>
33
32
<synopsis>
35
34
   +----EBookView
36
35
</synopsis>
37
36
</refsect1>
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
37
<refsect1 id="EBookView.signals" role="signal_proto">
45
38
<title role="signal_proto.title">Signals</title>
46
39
<synopsis>
52
45
</synopsis>
53
46
</refsect1>
54
47
 
55
 
 
56
48
<refsect1 id="EBookView.description" role="desc">
57
49
<title role="desc.title">Description</title>
58
50
<para>
61
53
addressbook itself.
62
54
</para>
63
55
</refsect1>
64
 
 
65
56
<refsect1 id="EBookView.details" role="details">
66
57
<title role="details.title">Details</title>
67
58
<refsect2 id="EBookView-struct" role="struct">
68
59
<title>EBookView</title>
69
 
<indexterm zone="EBookView-struct"><primary sortas="EBookView">EBookView</primary></indexterm><programlisting>typedef struct _EBookView EBookView;</programlisting>
 
60
<indexterm zone="EBookView-struct"><primary>EBookView</primary></indexterm>
 
61
<programlisting>typedef struct _EBookView EBookView;</programlisting>
70
62
<para>
71
63
<link linkend="EBookView"><type>EBookView</type></link> has no publicly available members.
72
64
</para></refsect2>
73
65
<refsect2 id="e-book-view-new" role="function">
74
66
<title>e_book_view_new ()</title>
75
 
<indexterm zone="e-book-view-new"><primary sortas="e_book_view_new">e_book_view_new</primary></indexterm><programlisting><link linkend="EBookView">EBookView</link> *         e_book_view_new                     (<link linkend="GNOME-Evolution-Addressbook-BookView">GNOME_Evolution_Addressbook_BookView</link> corba_book_view,
76
 
                                                         <link linkend="EBookViewListener">EBookViewListener</link> *listener);</programlisting>
 
67
<indexterm zone="e-book-view-new"><primary>e_book_view_new</primary></indexterm>
 
68
<programlisting><link linkend="EBookView"><returnvalue>EBookView</returnvalue></link> *         e_book_view_new                     (<parameter><link linkend="GNOME-Evolution-Addressbook-BookView"><type>GNOME_Evolution_Addressbook_BookView</type></link> corba_book_view</parameter>,
 
69
                                                         <parameter><link linkend="EBookViewListener"><type>EBookViewListener</type></link> *listener</parameter>);</programlisting>
77
70
<para>
78
71
Creates a new <link linkend="EBookView"><type>EBookView</type></link> based on <parameter>corba_book_view</parameter> and listening to
79
72
<parameter>listener</parameter>.  This is a private function, applications should call
80
73
<link linkend="e-book-get-book-view"><type>e_book_get_book_view</type></link> or <link linkend="e-book-async-get-book-view"><type>e_book_async_get_book_view</type></link>.</para>
81
 
<para>
82
 
</para><variablelist role="params">
 
74
<variablelist role="params">
83
75
<varlistentry><term><parameter>corba_book_view</parameter>&#160;:</term>
84
 
<listitem><simpara> a CORBA BookView object
 
76
<listitem><simpara>a CORBA BookView object
85
77
</simpara></listitem></varlistentry>
86
78
<varlistentry><term><parameter>listener</parameter>&#160;:</term>
87
 
<listitem><simpara> an <link linkend="EBookViewListener"><type>EBookViewListener</type></link>
 
79
<listitem><simpara>an <link linkend="EBookViewListener"><type>EBookViewListener</type></link>
88
80
</simpara></listitem></varlistentry>
89
81
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EBookView"><type>EBookView</type></link>.
90
82
</simpara></listitem></varlistentry>
91
83
</variablelist></refsect2>
92
84
<refsect2 id="e-book-view-start" role="function">
93
85
<title>e_book_view_start ()</title>
94
 
<indexterm zone="e-book-view-start"><primary sortas="e_book_view_start">e_book_view_start</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_view_start                   (<link linkend="EBookView">EBookView</link> *book_view);</programlisting>
 
86
<indexterm zone="e-book-view-start"><primary>e_book_view_start</primary></indexterm>
 
87
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_view_start                   (<parameter><link linkend="EBookView"><type>EBookView</type></link> *book_view</parameter>);</programlisting>
95
88
<para>
96
89
Tells <parameter>book_view</parameter> to start processing events.</para>
97
 
<para>
98
 
</para><variablelist role="params">
 
90
<variablelist role="params">
99
91
<varlistentry><term><parameter>book_view</parameter>&#160;:</term>
100
 
<listitem><simpara> an <link linkend="EBookView"><type>EBookView</type></link>
 
92
<listitem><simpara>an <link linkend="EBookView"><type>EBookView</type></link>
101
93
</simpara></listitem></varlistentry>
102
94
</variablelist></refsect2>
103
95
<refsect2 id="e-book-view-stop" role="function">
104
96
<title>e_book_view_stop ()</title>
105
 
<indexterm zone="e-book-view-stop"><primary sortas="e_book_view_stop">e_book_view_stop</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_view_stop                    (<link linkend="EBookView">EBookView</link> *book_view);</programlisting>
 
97
<indexterm zone="e-book-view-stop"><primary>e_book_view_stop</primary></indexterm>
 
98
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_view_stop                    (<parameter><link linkend="EBookView"><type>EBookView</type></link> *book_view</parameter>);</programlisting>
106
99
<para>
107
100
Tells <parameter>book_view</parameter> to stop processing events.</para>
108
 
<para>
109
 
</para><variablelist role="params">
 
101
<variablelist role="params">
110
102
<varlistentry><term><parameter>book_view</parameter>&#160;:</term>
111
 
<listitem><simpara> an <link linkend="EBookView"><type>EBookView</type></link>
 
103
<listitem><simpara>an <link linkend="EBookView"><type>EBookView</type></link>
112
104
</simpara></listitem></varlistentry>
113
105
</variablelist></refsect2>
114
106
<refsect2 id="e-book-view-set-book" role="function">
115
107
<title>e_book_view_set_book ()</title>
116
 
<indexterm zone="e-book-view-set-book"><primary sortas="e_book_view_set_book">e_book_view_set_book</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_view_set_book                (<link linkend="EBookView">EBookView</link> *book_view,
117
 
                                                         <link linkend="struct--EBook">struct _EBook</link> *book);</programlisting>
 
108
<indexterm zone="e-book-view-set-book"><primary>e_book_view_set_book</primary></indexterm>
 
109
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_view_set_book                (<parameter><link linkend="EBookView"><type>EBookView</type></link> *book_view</parameter>,
 
110
                                                         <parameter><type>struct _EBook</type> *book</parameter>);</programlisting>
118
111
<para>
119
112
Makes <parameter>book_view</parameter> listen to changes in <parameter>book</parameter>. This function apparently
120
113
has no effect for the time being.</para>
121
 
<para>
122
 
</para><variablelist role="params">
 
114
<variablelist role="params">
123
115
<varlistentry><term><parameter>book_view</parameter>&#160;:</term>
124
 
<listitem><simpara> an <link linkend="EBookView"><type>EBookView</type></link>
 
116
<listitem><simpara>an <link linkend="EBookView"><type>EBookView</type></link>
125
117
</simpara></listitem></varlistentry>
126
118
<varlistentry><term><parameter>book</parameter>&#160;:</term>
127
 
<listitem><simpara> an <link linkend="EBook"><type>EBook</type></link>
 
119
<listitem><simpara>an <link linkend="EBook"><type>EBook</type></link>
128
120
</simpara></listitem></varlistentry>
129
121
</variablelist></refsect2>
130
122
<refsect2 id="e-book-view-get-book" role="function">
131
123
<title>e_book_view_get_book ()</title>
132
 
<indexterm zone="e-book-view-get-book"><primary sortas="e_book_view_get_book">e_book_view_get_book</primary></indexterm><programlisting>struct <link linkend="EBook">_EBook</link> *     e_book_view_get_book                (<link linkend="EBookView">EBookView</link> *book_view);</programlisting>
 
124
<indexterm zone="e-book-view-get-book"><primary>e_book_view_get_book</primary></indexterm>
 
125
<programlisting>struct <link linkend="EBook"><returnvalue>_EBook</returnvalue></link> *     e_book_view_get_book                (<parameter><link linkend="EBookView"><type>EBookView</type></link> *book_view</parameter>);</programlisting>
133
126
<para>
134
127
Returns the <link linkend="EBook"><type>EBook</type></link> that this book view is monitoring.</para>
135
 
<para>
136
 
</para><variablelist role="params">
 
128
<variablelist role="params">
137
129
<varlistentry><term><parameter>book_view</parameter>&#160;:</term>
138
 
<listitem><simpara> an <link linkend="EBookView"><type>EBookView</type></link>
 
130
<listitem><simpara>an <link linkend="EBookView"><type>EBookView</type></link>
139
131
</simpara></listitem></varlistentry>
140
132
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an <link linkend="EBook"><type>EBook</type></link>.
141
133
</simpara></listitem></varlistentry>
142
134
</variablelist></refsect2>
143
135
 
144
136
</refsect1>
145
 
 
146
137
<refsect1 id="EBookView.signal-details" role="signals">
147
138
<title role="signals.title">Signal Details</title>
148
139
<refsect2 id="EBookView-contacts-added" role="signal"><title>The <literal>&quot;contacts-added&quot;</literal> signal</title>
149
 
<indexterm zone="EBookView-contacts-added"><primary sortas="EBookView::contacts-added">EBookView::contacts-added</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookView">EBookView</link> *ebookview,
150
 
                                                        <link linkend="gpointer">gpointer</link>   arg1,
151
 
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
 
140
<indexterm zone="EBookView-contacts-added"><primary>EBookView::contacts-added</primary></indexterm>
 
141
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="EBookView"><type>EBookView</type></link> *ebookview,
 
142
                                                        <link linkend="gpointer"><type>gpointer</type></link>   arg1,
 
143
                                                        <link linkend="gpointer"><type>gpointer</type></link>   user_data)      : Run Last</programlisting>
152
144
<para>
153
145
Fired when more contacts are found.  Each contact in the list will be unref'd
154
146
when done, and the list freed, so simply reference any contacts you want to
163
155
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
164
156
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
165
157
</variablelist></refsect2><refsect2 id="EBookView-contacts-changed" role="signal"><title>The <literal>&quot;contacts-changed&quot;</literal> signal</title>
166
 
<indexterm zone="EBookView-contacts-changed"><primary sortas="EBookView::contacts-changed">EBookView::contacts-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookView">EBookView</link> *ebookview,
167
 
                                                        <link linkend="gpointer">gpointer</link>   arg1,
168
 
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
 
158
<indexterm zone="EBookView-contacts-changed"><primary>EBookView::contacts-changed</primary></indexterm>
 
159
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="EBookView"><type>EBookView</type></link> *ebookview,
 
160
                                                        <link linkend="gpointer"><type>gpointer</type></link>   arg1,
 
161
                                                        <link linkend="gpointer"><type>gpointer</type></link>   user_data)      : Run Last</programlisting>
169
162
<para>
170
163
Fired when contacts are changed.  Each contact in the list will be unref'd
171
164
when done, and the list freed, so simply reference any contacts you want to
180
173
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
181
174
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
182
175
</variablelist></refsect2><refsect2 id="EBookView-contacts-removed" role="signal"><title>The <literal>&quot;contacts-removed&quot;</literal> signal</title>
183
 
<indexterm zone="EBookView-contacts-removed"><primary sortas="EBookView::contacts-removed">EBookView::contacts-removed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookView">EBookView</link> *ebookview,
184
 
                                                        <link linkend="gpointer">gpointer</link>   arg1,
185
 
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
 
176
<indexterm zone="EBookView-contacts-removed"><primary>EBookView::contacts-removed</primary></indexterm>
 
177
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="EBookView"><type>EBookView</type></link> *ebookview,
 
178
                                                        <link linkend="gpointer"><type>gpointer</type></link>   arg1,
 
179
                                                        <link linkend="gpointer"><type>gpointer</type></link>   user_data)      : Run Last</programlisting>
186
180
<para>
187
181
Fired when contacts are removed from the view.  The IDs and the list will be
188
182
freed, so copy any IDs you want to keep.
196
190
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
197
191
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
198
192
</variablelist></refsect2><refsect2 id="EBookView-sequence-complete" role="signal"><title>The <literal>&quot;sequence-complete&quot;</literal> signal</title>
199
 
<indexterm zone="EBookView-sequence-complete"><primary sortas="EBookView::sequence-complete">EBookView::sequence-complete</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookView">EBookView</link> *ebookview,
200
 
                                                        <link linkend="gint">gint</link>       arg1,
201
 
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
 
193
<indexterm zone="EBookView-sequence-complete"><primary>EBookView::sequence-complete</primary></indexterm>
 
194
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="EBookView"><type>EBookView</type></link> *ebookview,
 
195
                                                        <link linkend="gint"><type>gint</type></link>       arg1,
 
196
                                                        <link linkend="gpointer"><type>gpointer</type></link>   user_data)      : Run Last</programlisting>
202
197
<para>
203
198
Fired when there are currently no more contacts to send.  This is fired once
204
199
after the initial set of <link linkend="contacts-added"><type>contacts-added</type></link> signals, and after every future change.
212
207
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
213
208
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
214
209
</variablelist></refsect2><refsect2 id="EBookView-status-message" role="signal"><title>The <literal>&quot;status-message&quot;</literal> signal</title>
215
 
<indexterm zone="EBookView-status-message"><primary sortas="EBookView::status-message">EBookView::status-message</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookView">EBookView</link> *ebookview,
216
 
                                                        <link linkend="gchar">gchar</link>     *arg1,
217
 
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
 
210
<indexterm zone="EBookView-status-message"><primary>EBookView::status-message</primary></indexterm>
 
211
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="EBookView"><type>EBookView</type></link> *ebookview,
 
212
                                                        <link linkend="gchar"><type>gchar</type></link>     *arg1,
 
213
                                                        <link linkend="gpointer"><type>gpointer</type></link>   user_data)      : Run Last</programlisting>
218
214
<para>
219
215
Fired with a status message reporting the progress of the view.
220
216
</para><variablelist role="params">
228
224
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
229
225
</variablelist></refsect2>
230
226
</refsect1>
231
 
 
232
 
 
233
227
<refsect1 id="EBookView.see-also">
234
228
<title>See Also</title>
235
229
<para>