← Back to branch summary

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

« 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: 2009-07-27 16:04:20 UTC
  • mfrom: (1.1.70 upstream)
  • Revision ID: james.westby@ubuntu.com-20090727160420-dr27rzbz6ddjqo04
Tags: 2.27.5-0ubuntu1
* New upstream version: 
  Bug Fixes:
  Address Book:
  - #587558 - Removing a picture of a contact in an LDAP addressbook
              crashes evolution 
  - #589325 - Evolution Contacts reports ambiguous error on Google
              Contacts authentication failure with bad password 
  Calendar:
  - #572176 - Allow local iCal files to be selected as calendar source
  - #586342 - CalDAV backend does not support attachments 
  - #588857 - CalDAV for Google calendars should allow email notifications
  Mail:
  - #524219 (bnc) - Unable to read forward groupwise mails in other clients.
  - #588220 - Evolution crashed when starting with local account configured 
  - #588573 - NULL string comparison in camel-search-sql-sexp.c
  Miscellaneous:
  - #583374 - The broken Google calendar import should be replaced by
              the working CalDAV support 
  - #588277 - Unnecessary special-purpose configure flag 
  Other Fixes:
  Handle quota error messages. 
  Return the proper timezone to get the counts right in all timezones.
  CamelVeeFolder - pass exceptions to functions instead of NULL
  Migrate caldav, groupwise, http, weather backends to ECalBackendStore.   
  Translations

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/addressbook/libebook/xml/e-book-view.xml
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>LIBEBOOK Library</refmiscinfo>
9
9
</refmeta>
 
10
 
10
11
<refnamediv>
11
12
<refname>EBookView</refname>
12
13
<refpurpose>Represents a search against an <link linkend="EBook"><type>EBook</type></link>.</refpurpose>
15
16
<refsynopsisdiv id="EBookView.synopsis" role="synopsis">
16
17
<title role="synopsis.title">Synopsis</title>
17
18
 
18
 
<synopsis>                    <link linkend="EBookView-struct">EBookView</link>;
 
19
<synopsis>
 
20
                    <link linkend="EBookView-struct">EBookView</link>;
19
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,
20
22
                                                         <link linkend="EBookViewListener">EBookViewListener</link> *listener);
21
23
<link linkend="void">void</link>                <link linkend="e-book-view-start">e_book_view_start</link>                   (<link linkend="EBookView">EBookView</link> *book_view);
25
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);
26
28
</synopsis>
27
29
</refsynopsisdiv>
 
30
 
28
31
<refsect1 id="EBookView.object-hierarchy" role="object_hierarchy">
29
32
<title role="object_hierarchy.title">Object Hierarchy</title>
30
33
<synopsis>
32
35
   +----EBookView
33
36
</synopsis>
34
37
</refsect1>
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
35
44
<refsect1 id="EBookView.signals" role="signal_proto">
36
45
<title role="signal_proto.title">Signals</title>
37
46
<synopsis>
43
52
</synopsis>
44
53
</refsect1>
45
54
 
 
55
 
46
56
<refsect1 id="EBookView.description" role="desc">
47
57
<title role="desc.title">Description</title>
48
58
<para>
51
61
addressbook itself.
52
62
</para>
53
63
</refsect1>
 
64
 
54
65
<refsect1 id="EBookView.details" role="details">
55
66
<title role="details.title">Details</title>
56
67
<refsect2 id="EBookView-struct" role="struct">
57
68
<title>EBookView</title>
58
 
<indexterm zone="EBookView-struct"><primary>EBookView</primary></indexterm>
59
 
<programlisting>typedef struct _EBookView EBookView;</programlisting>
 
69
<indexterm zone="EBookView-struct"><primary sortas="EBookView">EBookView</primary></indexterm><programlisting>typedef struct _EBookView EBookView;</programlisting>
60
70
<para>
61
71
<link linkend="EBookView"><type>EBookView</type></link> has no publicly available members.
62
72
</para></refsect2>
63
73
<refsect2 id="e-book-view-new" role="function">
64
74
<title>e_book_view_new ()</title>
65
 
<indexterm zone="e-book-view-new"><primary>e_book_view_new</primary></indexterm>
66
 
<programlisting><link linkend="EBookView">EBookView</link> *         e_book_view_new                     (<link linkend="GNOME-Evolution-Addressbook-BookView">GNOME_Evolution_Addressbook_BookView</link> corba_book_view,
 
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,
67
76
                                                         <link linkend="EBookViewListener">EBookViewListener</link> *listener);</programlisting>
68
77
<para>
69
78
Creates a new <link linkend="EBookView"><type>EBookView</type></link> based on <parameter>corba_book_view</parameter> and listening to
82
91
</variablelist></refsect2>
83
92
<refsect2 id="e-book-view-start" role="function">
84
93
<title>e_book_view_start ()</title>
85
 
<indexterm zone="e-book-view-start"><primary>e_book_view_start</primary></indexterm>
86
 
<programlisting><link linkend="void">void</link>                e_book_view_start                   (<link linkend="EBookView">EBookView</link> *book_view);</programlisting>
 
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>
87
95
<para>
88
96
Tells <parameter>book_view</parameter> to start processing events.</para>
89
97
<para>
94
102
</variablelist></refsect2>
95
103
<refsect2 id="e-book-view-stop" role="function">
96
104
<title>e_book_view_stop ()</title>
97
 
<indexterm zone="e-book-view-stop"><primary>e_book_view_stop</primary></indexterm>
98
 
<programlisting><link linkend="void">void</link>                e_book_view_stop                    (<link linkend="EBookView">EBookView</link> *book_view);</programlisting>
 
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>
99
106
<para>
100
107
Tells <parameter>book_view</parameter> to stop processing events.</para>
101
108
<para>
106
113
</variablelist></refsect2>
107
114
<refsect2 id="e-book-view-set-book" role="function">
108
115
<title>e_book_view_set_book ()</title>
109
 
<indexterm zone="e-book-view-set-book"><primary>e_book_view_set_book</primary></indexterm>
110
 
<programlisting><link linkend="void">void</link>                e_book_view_set_book                (<link linkend="EBookView">EBookView</link> *book_view,
 
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,
111
117
                                                         <link linkend="struct--EBook">struct _EBook</link> *book);</programlisting>
112
118
<para>
113
119
Makes <parameter>book_view</parameter> listen to changes in <parameter>book</parameter>. This function apparently
123
129
</variablelist></refsect2>
124
130
<refsect2 id="e-book-view-get-book" role="function">
125
131
<title>e_book_view_get_book ()</title>
126
 
<indexterm zone="e-book-view-get-book"><primary>e_book_view_get_book</primary></indexterm>
127
 
<programlisting>struct <link linkend="EBook">_EBook</link> *     e_book_view_get_book                (<link linkend="EBookView">EBookView</link> *book_view);</programlisting>
 
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>
128
133
<para>
129
134
Returns the <link linkend="EBook"><type>EBook</type></link> that this book view is monitoring.</para>
130
135
<para>
137
142
</variablelist></refsect2>
138
143
 
139
144
</refsect1>
 
145
 
140
146
<refsect1 id="EBookView.signal-details" role="signals">
141
147
<title role="signals.title">Signal Details</title>
142
148
<refsect2 id="EBookView-contacts-added" role="signal"><title>The <literal>&quot;contacts-added&quot;</literal> signal</title>
143
 
<indexterm zone="EBookView-contacts-added"><primary>EBookView::contacts-added</primary></indexterm>
144
 
<programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookView">EBookView</link> *ebookview,
 
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,
145
150
                                                        <link linkend="gpointer">gpointer</link>   arg1,
146
151
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
147
152
<para>
158
163
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
159
164
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
160
165
</variablelist></refsect2><refsect2 id="EBookView-contacts-changed" role="signal"><title>The <literal>&quot;contacts-changed&quot;</literal> signal</title>
161
 
<indexterm zone="EBookView-contacts-changed"><primary>EBookView::contacts-changed</primary></indexterm>
162
 
<programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookView">EBookView</link> *ebookview,
 
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,
163
167
                                                        <link linkend="gpointer">gpointer</link>   arg1,
164
168
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
165
169
<para>
176
180
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
177
181
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
178
182
</variablelist></refsect2><refsect2 id="EBookView-contacts-removed" role="signal"><title>The <literal>&quot;contacts-removed&quot;</literal> signal</title>
179
 
<indexterm zone="EBookView-contacts-removed"><primary>EBookView::contacts-removed</primary></indexterm>
180
 
<programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookView">EBookView</link> *ebookview,
 
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,
181
184
                                                        <link linkend="gpointer">gpointer</link>   arg1,
182
185
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
183
186
<para>
193
196
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
194
197
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
195
198
</variablelist></refsect2><refsect2 id="EBookView-sequence-complete" role="signal"><title>The <literal>&quot;sequence-complete&quot;</literal> signal</title>
196
 
<indexterm zone="EBookView-sequence-complete"><primary>EBookView::sequence-complete</primary></indexterm>
197
 
<programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookView">EBookView</link> *ebookview,
 
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,
198
200
                                                        <link linkend="gint">gint</link>       arg1,
199
201
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
200
202
<para>
210
212
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
211
213
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
212
214
</variablelist></refsect2><refsect2 id="EBookView-status-message" role="signal"><title>The <literal>&quot;status-message&quot;</literal> signal</title>
213
 
<indexterm zone="EBookView-status-message"><primary>EBookView::status-message</primary></indexterm>
214
 
<programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookView">EBookView</link> *ebookview,
 
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,
215
216
                                                        <link linkend="gchar">gchar</link>     *arg1,
216
217
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
217
218
<para>
227
228
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
228
229
</variablelist></refsect2>
229
230
</refsect1>
 
231
 
 
232
 
230
233
<refsect1 id="EBookView.see-also">
231
234
<title>See Also</title>
232
235
<para>