← 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-listener.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-listener.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="EBookViewListener">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="EBookViewListener.top_of_page">EBookViewListener</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEBOOK Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>EBookViewListener</refname>
14
 
<refpurpose>Listens for call responses and event notifications from EBookView objects.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="EBookViewListener.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>                    <link linkend="EBookViewListener-struct">EBookViewListener</link>;
21
 
                    <link linkend="EBookViewListenerResponse">EBookViewListenerResponse</link>;
22
 
enum                <link linkend="EBookViewListenerOperation">EBookViewListenerOperation</link>;
23
 
<link linkend="EBookViewListener"><returnvalue>EBookViewListener</returnvalue></link> * <link linkend="e-book-view-listener-new">e_book_view_listener_new</link>            (<parameter><type>void</type></parameter>);
24
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-view-listener-start">e_book_view_listener_start</link>          (<parameter><link linkend="EBookViewListener"><type>EBookViewListener</type></link> *listener</parameter>);
25
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-view-listener-stop">e_book_view_listener_stop</link>           (<parameter><link linkend="EBookViewListener"><type>EBookViewListener</type></link> *listener</parameter>);
26
 
</synopsis>
27
 
</refsynopsisdiv>
28
 
<refsect1 id="EBookViewListener.object-hierarchy" role="object_hierarchy">
29
 
<title role="object_hierarchy.title">Object Hierarchy</title>
30
 
<synopsis>
31
 
  <link linkend="GObject">GObject</link>
32
 
   +----<link linkend="BonoboObject">BonoboObject</link>
33
 
         +----EBookViewListener
34
 
</synopsis>
35
 
</refsect1>
36
 
<refsect1 id="EBookViewListener.signals" role="signal_proto">
37
 
<title role="signal_proto.title">Signals</title>
38
 
<synopsis>
39
 
  &quot;<link linkend="EBookViewListener-response">response</link>&quot;                                       : Run Last
40
 
</synopsis>
41
 
</refsect1>
42
 
 
43
 
<refsect1 id="EBookViewListener.description" role="desc">
44
 
<title role="desc.title">Description</title>
45
 
<para>
46
 
Exposes the Evolution:BookViewListener interface. Contrast with the EBookListener.
47
 
</para>
48
 
</refsect1>
49
 
<refsect1 id="EBookViewListener.details" role="details">
50
 
<title role="details.title">Details</title>
51
 
<refsect2 id="EBookViewListener-struct" role="struct">
52
 
<title>EBookViewListener</title>
53
 
<indexterm zone="EBookViewListener-struct"><primary>EBookViewListener</primary></indexterm>
54
 
<programlisting>typedef struct _EBookViewListener EBookViewListener;</programlisting>
55
 
<para>
56
 
</para></refsect2>
57
 
<refsect2 id="EBookViewListenerResponse" role="struct">
58
 
<title>EBookViewListenerResponse</title>
59
 
<indexterm zone="EBookViewListenerResponse"><primary>EBookViewListenerResponse</primary></indexterm>
60
 
<programlisting>typedef struct {
61
 
        EBookViewListenerOperation  op;
62
 
 
63
 
        /* For SequenceComplete */
64
 
        EBookViewStatus             status;
65
 
 
66
 
        /* For ContactsRemovedEvent */
67
 
        GList                  *ids;
68
 
 
69
 
        /* For Contact[sAdded|Modified]Event */
70
 
        GList                  *contacts; /* Of type EContact. */
71
 
 
72
 
        /* For StatusMessageEvent */
73
 
        gchar                   *message;
74
 
} EBookViewListenerResponse;
75
 
</programlisting>
76
 
<para>
77
 
Data sent back to the e-book object.
78
 
</para></refsect2>
79
 
<refsect2 id="EBookViewListenerOperation" role="enum">
80
 
<title>enum EBookViewListenerOperation</title>
81
 
<indexterm zone="EBookViewListenerOperation"><primary>EBookViewListenerOperation</primary></indexterm>
82
 
<programlisting>typedef enum {
83
 
        /* Async events */
84
 
        ContactsAddedEvent,
85
 
        ContactsRemovedEvent,
86
 
        ContactsModifiedEvent,
87
 
        SequenceCompleteEvent,
88
 
        StatusMessageEvent
89
 
} EBookViewListenerOperation;
90
 
</programlisting>
91
 
<para>
92
 
Asynchronous events that are listened for.
93
 
</para></refsect2>
94
 
<refsect2 id="e-book-view-listener-new" role="function">
95
 
<title>e_book_view_listener_new ()</title>
96
 
<indexterm zone="e-book-view-listener-new"><primary>e_book_view_listener_new</primary></indexterm>
97
 
<programlisting><link linkend="EBookViewListener"><returnvalue>EBookViewListener</returnvalue></link> * e_book_view_listener_new            (<parameter><type>void</type></parameter>);</programlisting>
98
 
<para>
99
 
Creates and returns a new <link linkend="EBookViewListener"><type>EBookViewListener</type></link>.</para>
100
 
<variablelist role="params">
101
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="EBookViewListener"><type>EBookViewListener</type></link>
102
 
</simpara></listitem></varlistentry>
103
 
</variablelist></refsect2>
104
 
<refsect2 id="e-book-view-listener-start" role="function">
105
 
<title>e_book_view_listener_start ()</title>
106
 
<indexterm zone="e-book-view-listener-start"><primary>e_book_view_listener_start</primary></indexterm>
107
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_view_listener_start          (<parameter><link linkend="EBookViewListener"><type>EBookViewListener</type></link> *listener</parameter>);</programlisting>
108
 
<para>
109
 
Makes <parameter>listener</parameter> start generating events.</para>
110
 
<variablelist role="params">
111
 
<varlistentry><term><parameter>listener</parameter>&#160;:</term>
112
 
<listitem><simpara>an <link linkend="EBookViewListener"><type>EBookViewListener</type></link>
113
 
</simpara></listitem></varlistentry>
114
 
</variablelist></refsect2>
115
 
<refsect2 id="e-book-view-listener-stop" role="function">
116
 
<title>e_book_view_listener_stop ()</title>
117
 
<indexterm zone="e-book-view-listener-stop"><primary>e_book_view_listener_stop</primary></indexterm>
118
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_view_listener_stop           (<parameter><link linkend="EBookViewListener"><type>EBookViewListener</type></link> *listener</parameter>);</programlisting>
119
 
<para>
120
 
Makes <parameter>listener</parameter> stop generating events.</para>
121
 
<variablelist role="params">
122
 
<varlistentry><term><parameter>listener</parameter>&#160;:</term>
123
 
<listitem><simpara>an <link linkend="EBookViewListener"><type>EBookViewListener</type></link>
124
 
</simpara></listitem></varlistentry>
125
 
</variablelist></refsect2>
126
 
 
127
 
</refsect1>
128
 
<refsect1 id="EBookViewListener.signal-details" role="signals">
129
 
<title role="signals.title">Signal Details</title>
130
 
<refsect2 id="EBookViewListener-response" role="signal"><title>The <literal>&quot;response&quot;</literal> signal</title>
131
 
<indexterm zone="EBookViewListener-response"><primary>EBookViewListener::response</primary></indexterm>
132
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="EBookViewListener"><type>EBookViewListener</type></link> *ebookviewlistener,
133
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>           arg1,
134
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>           user_data)              : Run Last</programlisting>
135
 
<para>
136
 
</para><variablelist role="params">
137
 
<varlistentry><term><parameter>ebookviewlistener</parameter>&#160;:</term>
138
 
<listitem><simpara>the object which received the signal.
139
 
</simpara></listitem></varlistentry>
140
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
141
 
<listitem><simpara>
142
 
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
144
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
145
 
</variablelist></refsect2>
146
 
</refsect1>
147
 
<refsect1 id="EBookViewListener.see-also">
148
 
<title>See Also</title>
149
 
<para>
150
 
EBookListener
151
 
EBookTypes
152
 
</para>
153
 
</refsect1>
154
 
 
155
 
</refentry>