aboutsummaryrefslogtreecommitdiffstats
path: root/calendar/pcs/cal-backend.h
blob: 5b4e59a6a8fddccd34ba288f8a66dbb86ba82013 (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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* Evolution calendar - generic backend class
 *
 * Copyright (C) 2000 Ximian, Inc.
 * Copyright (C) 2000 Ximian, Inc.
 *
 * Authors: Federico Mena-Quintero <federico@ximian.com>
 *          Rodrigo Moya <rodrigo@ximian.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef CAL_BACKEND_H
#define CAL_BACKEND_H

#include <e-util/e-list.h>
#include <cal-util/cal-util.h>
#include <cal-util/cal-component.h>
#include "pcs/evolution-calendar.h"
#include "pcs/cal-common.h"
#include "pcs/cal.h"
#include "pcs/query.h"

G_BEGIN_DECLS



#define CAL_BACKEND_TYPE            (cal_backend_get_type ())
#define CAL_BACKEND(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), CAL_BACKEND_TYPE, CalBackend))
#define CAL_BACKEND_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), CAL_BACKEND_TYPE,        \
                     CalBackendClass))
#define IS_CAL_BACKEND(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CAL_BACKEND_TYPE))
#define IS_CAL_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CAL_BACKEND_TYPE))

typedef struct _CalBackendPrivate CalBackendPrivate;

struct _CalBackend {
    GObject object;

    CalBackendPrivate *priv;
};

struct _CalBackendClass {
    GObjectClass parent_class;

    /* Notification signals */
    void (* last_client_gone) (CalBackend *backend);
    void (* cal_added) (CalBackend *backend, Cal *cal);

    gboolean (* is_loaded) (CalBackend *backend);

    /* FIXME What to pass back here */
    void (* opened) (CalBackend *backend, int status);
    void (* removed) (CalBackend *backend, int status);
    void (* obj_updated) (CalBackend *backend, const char *uid);

    /* Virtual methods */
    void (* is_read_only) (CalBackend *backend, Cal *cal);
    void (* get_cal_address) (CalBackend *backend, Cal *cal);
    void (* get_alarm_email_address) (CalBackend *backend, Cal *cal);
    void (* get_ldap_attribute) (CalBackend *backend, Cal *cal);
    void (* get_static_capabilities) (CalBackend *backend, Cal *cal);
    
    void (* open) (CalBackend *backend, Cal *cal, gboolean only_if_exists);
    void (* remove) (CalBackend *backend, Cal *cal);

    /* Object related virtual methods */
    void (* create_object) (CalBackend *backend, Cal *cal, const char *calobj);
    void (* modify_object) (CalBackend *backend, Cal *cal, const char *calobj, CalObjModType mod);
    void (* remove_object) (CalBackend *backend, Cal *cal, const char *uid, const char *rid, CalObjModType mod);

    void (* discard_alarm) (CalBackend *backend, Cal *cal, const char *uid, const char *auid);

    void (* receive_objects) (CalBackend *backend, Cal *cal, const char *calobj);
    void (* send_objects) (CalBackend *backend, Cal *cal, const char *calobj);

    void (* get_default_object) (CalBackend *backend, Cal *cal);
    void (* get_object) (CalBackend *backend, Cal *cal, const char *uid, const char *rid);  
    void (* get_object_list) (CalBackend *backend, Cal *cal, const char *sexp);

    /* Timezone related virtual methods */
    void (* get_timezone) (CalBackend *backend, Cal *cal, const char *tzid);
    void (* add_timezone) (CalBackend *backend, Cal *cal, const char *object);
    void (* set_default_timezone) (CalBackend *backend, Cal *cal, const char *tzid);

    void (* start_query) (CalBackend *backend, Query *query);

    /* Mode relate virtual methods */
    CalMode (* get_mode) (CalBackend *backend);
    void    (* set_mode) (CalBackend *backend, CalMode mode);

    void (* get_free_busy) (CalBackend *backend, Cal *cal, GList *users, time_t start, time_t end);
    void (* get_changes) (CalBackend *backend, Cal *cal, const char *change_id);

    /* Internal methods for use only in the pcs */
    icaltimezone *(* internal_get_default_timezone) (CalBackend *backend);
    icaltimezone *(* internal_get_timezone) (CalBackend *backend, const char *tzid);
};

GType cal_backend_get_type (void);

const char *cal_backend_get_uri (CalBackend *backend);
icalcomponent_kind cal_backend_get_kind (CalBackend *backend);

void cal_backend_add_client (CalBackend *backend, Cal *cal);
void cal_backend_remove_client (CalBackend *backend, Cal *cal);

void cal_backend_add_query (CalBackend *backend, Query *query);
EList *cal_backend_get_queries (CalBackend *backend);

void cal_backend_is_read_only (CalBackend *backend, Cal *cal);
void cal_backend_get_cal_address (CalBackend *backend, Cal *cal);
void cal_backend_get_alarm_email_address (CalBackend *backend, Cal *cal);
void cal_backend_get_ldap_attribute (CalBackend *backend, Cal *cal);
void cal_backend_get_static_capabilities (CalBackend *backend, Cal *cal);

void cal_backend_open (CalBackend *backend, Cal *cal, gboolean only_if_exists);
void cal_backend_remove (CalBackend *backend, Cal *cal);

void cal_backend_create_object (CalBackend *backend, Cal *cal, const char *calobj);
void cal_backend_modify_object (CalBackend *backend, Cal *cal, const char *calobj, CalObjModType mod);
void cal_backend_remove_object (CalBackend *backend, Cal *cal, const char *uid, const char *rid, CalObjModType mod);

void cal_backend_discard_alarm (CalBackend *backend, Cal *cal, const char *uid, const char *auid);

void cal_backend_receive_objects (CalBackend *backend, Cal *cal, const char *calobj);
void cal_backend_send_objects (CalBackend *backend, Cal *cal, const char *calobj);

void cal_backend_get_default_object (CalBackend *backend, Cal *cal);
void cal_backend_get_object (CalBackend *backend, Cal *cal, const char *uid, const char *rid);
void cal_backend_get_object_list (CalBackend *backend, Cal *cal, const char *sexp);

gboolean cal_backend_is_loaded (CalBackend *backend);

void cal_backend_start_query (CalBackend *backend, Query *query);

CalMode cal_backend_get_mode (CalBackend *backend);
void cal_backend_set_mode (CalBackend *backend, CalMode mode);

void cal_backend_get_timezone (CalBackend *backend, Cal *cal, const char *tzid);
void cal_backend_add_timezone (CalBackend *backend, Cal *cal, const char *object);
void cal_backend_set_default_timezone (CalBackend *backend, Cal *cal, const char *tzid);

void cal_backend_get_changes (CalBackend *backend, Cal *cal, const char *change_id);
void cal_backend_get_free_busy (CalBackend *backend, Cal *cal, GList *users, time_t start, time_t end);

icaltimezone* cal_backend_internal_get_default_timezone (CalBackend *backend);
icaltimezone* cal_backend_internal_get_timezone (CalBackend *backend, const char *tzid);

void cal_backend_last_client_gone (CalBackend *backend);

void cal_backend_notify_object_created  (CalBackend *backend, const char *calobj);
void cal_backend_notify_object_modified (CalBackend *backend, const char *old_object, const char *object);
void cal_backend_notify_object_removed  (CalBackend *backend, const char *uid, const char *old_object);

void cal_backend_notify_mode      (CalBackend *backend,
                   GNOME_Evolution_Calendar_Listener_SetModeStatus status, 
                   GNOME_Evolution_Calendar_CalMode mode);
void cal_backend_notify_error     (CalBackend *backend, const char *message);
void cal_backend_ref_categories   (CalBackend *backend, GSList *categories);
void cal_backend_unref_categories (CalBackend *backend, GSList *categories);



G_END_DECLS

#endif