~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-types.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
* 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:
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="libebook-e-book-types">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libebook-e-book-types.top_of_page">e-book-types</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEBOOK Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>e-book-types</refname>
14
 
<refpurpose>Client-side GOBject which exposes the
15
 
Evolution:BookListener interface.</refpurpose>
16
 
</refnamediv>
17
 
 
18
 
<refsynopsisdiv id="libebook-e-book-types.synopsis" role="synopsis">
19
 
<title role="synopsis.title">Synopsis</title>
20
 
 
21
 
<synopsis>#define             <link linkend="E-BOOK-ERROR:CAPS">E_BOOK_ERROR</link>
22
 
<link linkend="GQuark"><returnvalue>GQuark</returnvalue></link>              <link linkend="e-book-error-quark">e_book_error_quark</link>                  (<parameter><type>void</type></parameter>);
23
 
enum                <link linkend="EBookStatus">EBookStatus</link>;
24
 
enum                <link linkend="EBookViewStatus">EBookViewStatus</link>;
25
 
enum                <link linkend="EBookChangeType">EBookChangeType</link>;
26
 
                    <link linkend="EBookChange">EBookChange</link>;
27
 
</synopsis>
28
 
</refsynopsisdiv>
29
 
 
30
 
<refsect1 id="libebook-e-book-types.description" role="desc">
31
 
<title role="desc.title">Description</title>
32
 
<para>
33
 
</para>
34
 
</refsect1>
35
 
<refsect1 id="libebook-e-book-types.details" role="details">
36
 
<title role="details.title">Details</title>
37
 
<refsect2 id="E-BOOK-ERROR:CAPS" role="macro">
38
 
<title>E_BOOK_ERROR</title>
39
 
<indexterm zone="E-BOOK-ERROR:CAPS"><primary>E_BOOK_ERROR</primary></indexterm>
40
 
<programlisting>#define E_BOOK_ERROR e_book_error_quark()
41
 
</programlisting>
42
 
<para>
43
 
</para></refsect2>
44
 
<refsect2 id="e-book-error-quark" role="function">
45
 
<title>e_book_error_quark ()</title>
46
 
<indexterm zone="e-book-error-quark"><primary>e_book_error_quark</primary></indexterm>
47
 
<programlisting><link linkend="GQuark"><returnvalue>GQuark</returnvalue></link>              e_book_error_quark                  (<parameter><type>void</type></parameter>);</programlisting>
48
 
<para>
49
 
</para><variablelist role="params">
50
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
51
 
</simpara></listitem></varlistentry>
52
 
</variablelist></refsect2>
53
 
<refsect2 id="EBookStatus" role="enum">
54
 
<title>enum EBookStatus</title>
55
 
<indexterm zone="EBookStatus"><primary>EBookStatus</primary></indexterm>
56
 
<programlisting>typedef enum {
57
 
        E_BOOK_ERROR_OK,
58
 
        E_BOOK_ERROR_INVALID_ARG,
59
 
        E_BOOK_ERROR_BUSY,
60
 
        E_BOOK_ERROR_REPOSITORY_OFFLINE,
61
 
        E_BOOK_ERROR_NO_SUCH_BOOK,
62
 
        E_BOOK_ERROR_NO_SELF_CONTACT,
63
 
        E_BOOK_ERROR_SOURCE_NOT_LOADED,
64
 
        E_BOOK_ERROR_SOURCE_ALREADY_LOADED,
65
 
        E_BOOK_ERROR_PERMISSION_DENIED,
66
 
        E_BOOK_ERROR_CONTACT_NOT_FOUND,
67
 
        E_BOOK_ERROR_CONTACT_ID_ALREADY_EXISTS,
68
 
        E_BOOK_ERROR_PROTOCOL_NOT_SUPPORTED,
69
 
        E_BOOK_ERROR_CANCELLED,
70
 
        E_BOOK_ERROR_COULD_NOT_CANCEL,
71
 
        E_BOOK_ERROR_AUTHENTICATION_FAILED,
72
 
        E_BOOK_ERROR_AUTHENTICATION_REQUIRED,
73
 
        E_BOOK_ERROR_TLS_NOT_AVAILABLE,
74
 
        E_BOOK_ERROR_CORBA_EXCEPTION,
75
 
        E_BOOK_ERROR_NO_SUCH_SOURCE,
76
 
        E_BOOK_ERROR_OFFLINE_UNAVAILABLE,
77
 
        E_BOOK_ERROR_OTHER_ERROR,
78
 
        E_BOOK_ERROR_INVALID_SERVER_VERSION,
79
 
        E_BOOK_ERROR_UNSUPPORTED_AUTHENTICATION_METHOD,
80
 
        E_BOOK_ERROR_NO_SPACE
81
 
} EBookStatus;
82
 
</programlisting>
83
 
<para>
84
 
</para></refsect2>
85
 
<refsect2 id="EBookViewStatus" role="enum">
86
 
<title>enum EBookViewStatus</title>
87
 
<indexterm zone="EBookViewStatus"><primary>EBookViewStatus</primary></indexterm>
88
 
<programlisting>typedef enum {
89
 
        E_BOOK_VIEW_STATUS_OK,
90
 
        E_BOOK_VIEW_STATUS_TIME_LIMIT_EXCEEDED,
91
 
        E_BOOK_VIEW_STATUS_SIZE_LIMIT_EXCEEDED,
92
 
        E_BOOK_VIEW_ERROR_INVALID_QUERY,
93
 
        E_BOOK_VIEW_ERROR_QUERY_REFUSED,
94
 
        E_BOOK_VIEW_ERROR_OTHER_ERROR
95
 
} EBookViewStatus;
96
 
</programlisting>
97
 
<para>
98
 
</para></refsect2>
99
 
<refsect2 id="EBookChangeType" role="enum">
100
 
<title>enum EBookChangeType</title>
101
 
<indexterm zone="EBookChangeType"><primary>EBookChangeType</primary></indexterm>
102
 
<programlisting>typedef enum {
103
 
        E_BOOK_CHANGE_CARD_ADDED,
104
 
        E_BOOK_CHANGE_CARD_DELETED,
105
 
        E_BOOK_CHANGE_CARD_MODIFIED
106
 
} EBookChangeType;
107
 
</programlisting>
108
 
<para>
109
 
</para></refsect2>
110
 
<refsect2 id="EBookChange" role="struct">
111
 
<title>EBookChange</title>
112
 
<indexterm zone="EBookChange"><primary>EBookChange</primary></indexterm>
113
 
<programlisting>typedef struct {
114
 
        EBookChangeType  change_type;
115
 
        EContact        *contact;
116
 
} EBookChange;
117
 
</programlisting>
118
 
<para>
119
 
</para></refsect2>
120
 
 
121
 
</refsect1>
122
 
 
123
 
</refentry>