aboutsummaryrefslogtreecommitdiffstats
path: root/addressbook/backend/ebook/e-book.h
blob: b1549f4f8e11625aa5570ac74513e8fc9a2c8a98 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * The Evolution addressbook client object.
 *
 * Author:
 *   Nat Friedman (nat@ximian.com)
 *
 * Copyright 1999, 2000, Ximian, Inc.
 */

#ifndef __E_BOOK_H__
#define __E_BOOK_H__

#include <libgnome/gnome-defs.h>

#include <addressbook/backend/ebook/e-card.h>
#include <addressbook/backend/ebook/e-card-cursor.h>
#include <addressbook/backend/ebook/e-book-view.h>
#include <addressbook/backend/ebook/e-book-types.h>

BEGIN_GNOME_DECLS

typedef struct _EBook        EBook;
typedef struct _EBookClass   EBookClass;
typedef struct _EBookPrivate EBookPrivate;

struct _EBook {
    GtkObject     parent;
    EBookPrivate *priv;
};

struct _EBookClass {
    GtkObjectClass parent;

    /*
     * Signals.
     */
    void (* open_progress)   (EBook *book, const char *msg, short percent);
    void (* link_status)     (EBook *book, gboolean connected);
    void (* writable_status) (EBook *book, gboolean writable);
};

/* Callbacks for asynchronous functions. */
typedef void (*EBookCallback) (EBook *book, EBookStatus status, gpointer closure);
typedef void (*EBookOpenProgressCallback)     (EBook          *book,
                           const char     *status_message,
                           short           percent,
                           gpointer        closure);
typedef void (*EBookIdCallback)       (EBook *book, EBookStatus status, const char *id, gpointer closure);
typedef void (*EBookCardCallback)     (EBook *book, EBookStatus status, ECard *card, gpointer closure);
typedef void (*EBookCursorCallback)   (EBook *book, EBookStatus status, ECardCursor *cursor, gpointer closure);
typedef void (*EBookBookViewCallback) (EBook *book, EBookStatus status, EBookView *book_view, gpointer closure);
typedef void (*EBookFieldsCallback)   (EBook *book, EBookStatus status, EList *fields, gpointer closure);

/* Creating a new addressbook. */
EBook    *e_book_new                      (void);

gboolean  e_book_load_uri                 (EBook                 *book,
                       const char            *uri,
                       EBookCallback          open_response,
                       gpointer               closure);
void      e_book_unload_uri               (EBook                 *book);

const char *e_book_get_uri                (EBook                 *book);

char     *e_book_get_static_capabilities  (EBook                 *book);

guint     e_book_get_supported_fields     (EBook                 *book,
                       EBookFieldsCallback    cb,
                       gpointer               closure);


/* User authentication. */
void      e_book_authenticate_user        (EBook                 *book,
                       const char            *user,
                       const char            *passwd,
                       const char            *auth_method,
                       EBookCallback         cb,
                       gpointer              closure);

/* Fetching cards. */
guint     e_book_get_card                 (EBook                 *book,
                       const char            *id,
                       EBookCardCallback      cb,
                       gpointer               closure);

/* Deleting cards. */
gboolean  e_book_remove_card              (EBook                 *book,
                       ECard                 *card,
                       EBookCallback          cb,
                       gpointer               closure);
gboolean  e_book_remove_card_by_id        (EBook                 *book,
                       const char            *id,
                       EBookCallback          cb,
                       gpointer               closure);

/* Adding cards. */
gboolean  e_book_add_card                 (EBook                 *book,
                       ECard                 *card,
                       EBookIdCallback        cb,
                       gpointer               closure);
gboolean  e_book_add_vcard                (EBook                 *book,
                       const char            *vcard,
                       EBookIdCallback        cb,
                       gpointer               closure);

/* Modifying cards. */
gboolean  e_book_commit_card              (EBook                 *book,
                       ECard                 *card,
                       EBookCallback          cb,
                       gpointer               closure);
gboolean  e_book_commit_vcard             (EBook                 *book,
                       const char            *vcard,
                       EBookCallback          cb,
                       gpointer               closure);

/* Checking to see if we're connected to the card repository. */
gboolean  e_book_check_connection         (EBook                 *book);
guint     e_book_get_cursor               (EBook                 *book,
                       char                  *query,
                       EBookCursorCallback    cb,
                       gpointer               closure);

guint     e_book_get_book_view            (EBook                 *book,
                       const gchar           *query,
                       EBookBookViewCallback  cb,
                       gpointer               closure);

guint     e_book_get_completion_view      (EBook                 *book,
                       const gchar           *query,
                       EBookBookViewCallback  cb,
                       gpointer               closure);

guint     e_book_get_changes              (EBook                 *book,
                       char                  *changeid,
                       EBookBookViewCallback  cb,
                       gpointer               closure);

/* Cancel a pending operation. */
void      e_book_cancel                   (EBook                 *book,
                       guint                  tag);


/* Getting the name of the repository. */
char     *e_book_get_name                 (EBook                 *book);

GtkType   e_book_get_type                 (void);

#define E_BOOK_TYPE        (e_book_get_type ())
#define E_BOOK(o)          (GTK_CHECK_CAST ((o), E_BOOK_TYPE, EBook))
#define E_BOOK_CLASS(k)    (GTK_CHECK_CLASS_CAST((k), E_BOOK_TYPE, EBookClass))
#define E_IS_BOOK(o)       (GTK_CHECK_TYPE ((o), E_BOOK_TYPE))
#define E_IS_BOOK_CLASS(k) (GTK_CHECK_CLASS_TYPE ((k), E_BOOK_TYPE))

END_GNOME_DECLS

#endif /* ! __E_BOOK_H__ */