← 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-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-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="EBookListener">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="EBookListener.top_of_page">EBookListener</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEBOOK Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>EBookListener</refname>
14
 
<refpurpose>Listens for call responses and event notifications from EBook objects.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="EBookListener.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>                    <link linkend="EBookListener-struct">EBookListener</link>;
21
 
                    <link linkend="EBookListenerResponse">EBookListenerResponse</link>;
22
 
enum                <link linkend="EBookListenerOperation">EBookListenerOperation</link>;
23
 
<link linkend="EBookListener"><returnvalue>EBookListener</returnvalue></link> *     <link linkend="e-book-listener-new">e_book_listener_new</link>                 (<parameter><type>void</type></parameter>);
24
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-listener-stop">e_book_listener_stop</link>                (<parameter><link linkend="EBookListener"><type>EBookListener</type></link> *listener</parameter>);
25
 
</synopsis>
26
 
</refsynopsisdiv>
27
 
<refsect1 id="EBookListener.object-hierarchy" role="object_hierarchy">
28
 
<title role="object_hierarchy.title">Object Hierarchy</title>
29
 
<synopsis>
30
 
  <link linkend="GObject">GObject</link>
31
 
   +----<link linkend="BonoboObject">BonoboObject</link>
32
 
         +----EBookListener
33
 
</synopsis>
34
 
</refsect1>
35
 
<refsect1 id="EBookListener.signals" role="signal_proto">
36
 
<title role="signal_proto.title">Signals</title>
37
 
<synopsis>
38
 
  &quot;<link linkend="EBookListener-response">response</link>&quot;                                       : Run Last
39
 
</synopsis>
40
 
</refsect1>
41
 
 
42
 
<refsect1 id="EBookListener.description" role="desc">
43
 
<title role="desc.title">Description</title>
44
 
<para>
45
 
Exposes the Evolution:BookListener interface. Contrast with EBookViewListener.
46
 
</para>
47
 
</refsect1>
48
 
<refsect1 id="EBookListener.details" role="details">
49
 
<title role="details.title">Details</title>
50
 
<refsect2 id="EBookListener-struct" role="struct">
51
 
<title>EBookListener</title>
52
 
<indexterm zone="EBookListener-struct"><primary>EBookListener</primary></indexterm>
53
 
<programlisting>typedef struct _EBookListener EBookListener;</programlisting>
54
 
<para>
55
 
</para></refsect2>
56
 
<refsect2 id="EBookListenerResponse" role="struct">
57
 
<title>EBookListenerResponse</title>
58
 
<indexterm zone="EBookListenerResponse"><primary>EBookListenerResponse</primary></indexterm>
59
 
<programlisting>typedef struct {
60
 
        EBookListenerOperation  op;
61
 
 
62
 
        /* The tag that e_book_* assigned to the operation this is a
63
 
           response for */
64
 
        guint32                 opid;
65
 
 
66
 
        /* For most Response notifications */
67
 
        EBookStatus             status;
68
 
 
69
 
        /* For GetBookViewReponse */
70
 
        GNOME_Evolution_Addressbook_BookView      book_view;
71
 
 
72
 
        /* For GetSupportedFields/GetSupportedAuthMethods */
73
 
        GList                                    *list;
74
 
 
75
 
        /* For ProgressEvent */
76
 
        gchar                   *msg;
77
 
        short                   percent;
78
 
 
79
 
        /* For LinkStatusEvent */
80
 
        gboolean                connected;
81
 
 
82
 
        /* For WritableStatusEvent */
83
 
        gboolean                writable;
84
 
 
85
 
        /* For Card[Added|Removed|Modified]Event */
86
 
        gchar                   *id;
87
 
        gchar                   *vcard;
88
 
} EBookListenerResponse;
89
 
</programlisting>
90
 
<para>
91
 
</para></refsect2>
92
 
<refsect2 id="EBookListenerOperation" role="enum">
93
 
<title>enum EBookListenerOperation</title>
94
 
<indexterm zone="EBookListenerOperation"><primary>EBookListenerOperation</primary></indexterm>
95
 
<programlisting>typedef enum {
96
 
        /* Async responses */
97
 
        OpenBookResponse,
98
 
        RemoveBookResponse,
99
 
        CreateContactResponse,
100
 
        RemoveContactResponse,
101
 
        ModifyContactResponse,
102
 
        GetContactResponse,
103
 
        GetContactListResponse,
104
 
        GetBookViewResponse,
105
 
        GetChangesResponse,
106
 
        AuthenticationResponse,
107
 
        GetSupportedFieldsResponse,
108
 
        GetRequiredFieldsResponse,
109
 
        GetSupportedAuthMethodsResponse,
110
 
 
111
 
        /* Async events */
112
 
        LinkStatusEvent,
113
 
        WritableStatusEvent,
114
 
        AuthRequiredEvent,
115
 
        ProgressEvent
116
 
} EBookListenerOperation;
117
 
</programlisting>
118
 
<para>
119
 
</para></refsect2>
120
 
<refsect2 id="e-book-listener-new" role="function">
121
 
<title>e_book_listener_new ()</title>
122
 
<indexterm zone="e-book-listener-new"><primary>e_book_listener_new</primary></indexterm>
123
 
<programlisting><link linkend="EBookListener"><returnvalue>EBookListener</returnvalue></link> *     e_book_listener_new                 (<parameter><type>void</type></parameter>);</programlisting>
124
 
<para>
125
 
Creates and returns a new <link linkend="EBookListener"><type>EBookListener</type></link>.</para>
126
 
<variablelist role="params">
127
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="EBookListener"><type>EBookListener</type></link>
128
 
</simpara></listitem></varlistentry>
129
 
</variablelist></refsect2>
130
 
<refsect2 id="e-book-listener-stop" role="function">
131
 
<title>e_book_listener_stop ()</title>
132
 
<indexterm zone="e-book-listener-stop"><primary>e_book_listener_stop</primary></indexterm>
133
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_listener_stop                (<parameter><link linkend="EBookListener"><type>EBookListener</type></link> *listener</parameter>);</programlisting>
134
 
<para>
135
 
Stops <parameter>listener</parameter> from generating events.</para>
136
 
<variablelist role="params">
137
 
<varlistentry><term><parameter>listener</parameter>&#160;:</term>
138
 
<listitem><simpara>an <link linkend="EBookListener"><type>EBookListener</type></link>
139
 
</simpara></listitem></varlistentry>
140
 
</variablelist></refsect2>
141
 
 
142
 
</refsect1>
143
 
<refsect1 id="EBookListener.signal-details" role="signals">
144
 
<title role="signals.title">Signal Details</title>
145
 
<refsect2 id="EBookListener-response" role="signal"><title>The <literal>&quot;response&quot;</literal> signal</title>
146
 
<indexterm zone="EBookListener-response"><primary>EBookListener::response</primary></indexterm>
147
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="EBookListener"><type>EBookListener</type></link> *ebooklistener,
148
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>       arg1,
149
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>       user_data)          : Run Last</programlisting>
150
 
<para>
151
 
</para><variablelist role="params">
152
 
<varlistentry><term><parameter>ebooklistener</parameter>&#160;:</term>
153
 
<listitem><simpara>the object which received the signal.
154
 
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
156
 
<listitem><simpara>
157
 
</simpara></listitem></varlistentry>
158
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
159
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
160
 
</variablelist></refsect2>
161
 
</refsect1>
162
 
 
163
 
</refentry>