← Back to branch summary

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

« 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): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

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