calendar/libecal/e-cal.h

   1 /* Evolution calendar ecal
   2  *
   3  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
   4  *
   5  * Authors: Federico Mena-Quintero <federico@ximian.com>
   6  *          Rodrigo Moya <rodrigo@novell.com>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of version 2 of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  */
  21
  22 #ifndef E_CAL_H
  23 #define E_CAL_H
  24
  25 #include <glib-object.h>
  26 #include "libedataserver/e-source-list.h"
  27 #include "libedataserver/e-source.h"
  28 #include <libecal/e-cal-recur.h>
  29 #include <libecal/e-cal-util.h>
  30 #include <libecal/e-cal-view.h>
  31 #include <libecal/e-cal-types.h>
  32
  33 G_BEGIN_DECLS
  34
  35 \f
  36
  37 #define E_TYPE_CAL            (e_cal_get_type ())
  38 #define E_CAL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_TYPE_CAL, ECal))
  39 #define E_CAL_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), E_TYPE_CAL, ECalClass))
  40 #define E_IS_CAL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), E_TYPE_CAL))
  41 #define E_IS_CAL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), E_TYPE_CAL))
  42
  43 #define E_CAL_SET_MODE_STATUS_ENUM_TYPE (e_cal_set_mode_status_enum_get_type ())
  44 #define CAL_MODE_ENUM_TYPE                   (cal_mode_enum_get_type ())
  45
  46 typedef struct _ECal ECal;
  47 typedef struct _ECalClass ECalClass;
  48 typedef struct _ECalPrivate ECalPrivate;
  49
  50 typedef enum {
  51         E_CAL_SOURCE_TYPE_EVENT,
  52         E_CAL_SOURCE_TYPE_TODO,
  53         E_CAL_SOURCE_TYPE_JOURNAL,
  54         E_CAL_SOURCE_TYPE_LAST
  55 } ECalSourceType;
  56
  57 /* Set mode status for the e_cal_set_mode function */
  58 typedef enum {
  59         E_CAL_SET_MODE_SUCCESS,
  60         E_CAL_SET_MODE_ERROR,
  61         E_CAL_SET_MODE_NOT_SUPPORTED
  62 } ECalSetModeStatus;
  63
  64 /* Whether the ecal is not loaded, is being loaded, or is already loaded */
  65 typedef enum {
  66         E_CAL_LOAD_NOT_LOADED,
  67         E_CAL_LOAD_AUTHENTICATING,
  68         E_CAL_LOAD_LOADING,
  69         E_CAL_LOAD_LOADED
  70 } ECalLoadState;
  71
  72 struct _ECal {
  73         GObject object;
  74
  75         /*< private >*/
  76         ECalPrivate *priv;
  77 };
  78
  79 struct _ECalClass {
  80         GObjectClass parent_class;
  81
  82         /* Notification signals */
  83
  84         void (* cal_opened) (ECal *ecal, ECalendarStatus status);
  85         void (* cal_set_mode) (ECal *ecal, ECalSetModeStatus status, CalMode mode);
  86
  87         void (* backend_error) (ECal *ecal, const gchar *message);
  88         void (* backend_died) (ECal *ecal);
  89 };
  90
  91 typedef gchar * (* ECalAuthFunc) (ECal *ecal,
  92                                  const gchar *prompt,
  93                                  const gchar *key,
  94                                  gpointer user_data);
  95
  96 GType e_cal_get_type (void);
  97
  98 GType e_cal_open_status_enum_get_type (void);
  99 GType e_cal_source_type_enum_get_type (void);
 100 GType e_cal_set_mode_status_enum_get_type (void);
 101 GType cal_mode_enum_get_type (void);
 102
 103 ECal *e_cal_new (ESource *source, ECalSourceType type);
 104 ECal *e_cal_new_from_uri (const gchar *uri, ECalSourceType type);
 105 ECal *e_cal_new_system_calendar (void);
 106 ECal *e_cal_new_system_tasks (void);
 107 ECal *e_cal_new_system_memos (void);
 108
 109 void e_cal_set_auth_func (ECal *ecal, ECalAuthFunc func, gpointer data);
 110
 111 gboolean e_cal_open (ECal *ecal, gboolean only_if_exists, GError **error);
 112 void e_cal_open_async (ECal *ecal, gboolean only_if_exists);
 113 gboolean e_cal_refresh (ECal *ecal, GError **error);
 114 gboolean e_cal_remove (ECal *ecal, GError **error);
 115
 116 GList *e_cal_uri_list (ECal *ecal, CalMode mode);
 117
 118 ECalSourceType e_cal_get_source_type (ECal *ecal);
 119 ECalLoadState e_cal_get_load_state (ECal *ecal);
 120
 121 ESource *e_cal_get_source (ECal *ecal);
 122 const gchar *e_cal_get_uri (ECal *ecal);
 123
 124 gboolean e_cal_is_read_only (ECal *ecal, gboolean *read_only, GError **error);
 125 gboolean e_cal_get_cal_address (ECal *ecal, gchar **cal_address, GError **error);
 126 gboolean e_cal_get_alarm_email_address (ECal *ecal, gchar **alarm_address, GError **error);
 127 gboolean e_cal_get_ldap_attribute (ECal *ecal, gchar **ldap_attribute, GError **error);
 128
 129 gboolean e_cal_get_one_alarm_only (ECal *ecal);
 130 gboolean e_cal_get_organizer_must_attend (ECal *ecal);
 131 gboolean e_cal_get_save_schedules (ECal *ecal);
 132 gboolean e_cal_get_static_capability (ECal *ecal, const gchar *cap);
 133 gboolean e_cal_get_organizer_must_accept (ECal *ecal);
 134 gboolean e_cal_get_refresh_supported (ECal *ecal);
 135
 136 gboolean e_cal_set_mode (ECal *ecal, CalMode mode);
 137
 138 gboolean e_cal_get_default_object (ECal *ecal,
 139                                    icalcomponent **icalcomp, GError **error);
 140
 141 gboolean e_cal_get_object (ECal *ecal,
 142                            const gchar *uid,
 143                            const gchar *rid,
 144                            icalcomponent **icalcomp,
 145                            GError **error);
 146 gboolean e_cal_get_objects_for_uid (ECal *ecal,
 147                                     const gchar *uid,
 148                                     GList **objects,
 149                                     GError **error);
 150
 151 gboolean e_cal_get_changes (ECal *ecal, const gchar *change_id, GList **changes, GError **error);
 152 void e_cal_free_change_list (GList *list);
 153
 154 gboolean e_cal_get_object_list (ECal *ecal, const gchar *query, GList **objects, GError **error);
 155 gboolean e_cal_get_object_list_as_comp (ECal *ecal, const gchar *query, GList **objects, GError **error);
 156 void e_cal_free_object_list (GList *objects);
 157
 158 gboolean e_cal_get_free_busy (ECal *ecal, GList *users, time_t start, time_t end,
 159                               GList **freebusy, GError **error);
 160
 161 void e_cal_generate_instances (ECal *ecal, time_t start, time_t end,
 162                                ECalRecurInstanceFn cb, gpointer cb_data);
 163 void e_cal_generate_instances_for_object (ECal *ecal, icalcomponent *icalcomp,
 164                                           time_t start, time_t end,
 165                                           ECalRecurInstanceFn cb, gpointer cb_data);
 166
 167 GSList *e_cal_get_alarms_in_range (ECal *ecal, time_t start, time_t end);
 168
 169 void e_cal_free_alarms (GSList *comp_alarms);
 170
 171 gboolean e_cal_get_alarms_for_object (ECal *ecal, const ECalComponentId *id,
 172                                       time_t start, time_t end,
 173                                       ECalComponentAlarms **alarms);
 174
 175 gboolean e_cal_create_object (ECal *ecal, icalcomponent *icalcomp, gchar **uid, GError **error);
 176 gboolean e_cal_modify_object (ECal *ecal, icalcomponent *icalcomp, CalObjModType mod, GError **error);
 177 gboolean e_cal_remove_object (ECal *ecal, const gchar *uid, GError **error);
 178 gboolean e_cal_remove_object_with_mod (ECal *ecal, const gchar *uid, const gchar *rid, CalObjModType mod, GError **error);
 179
 180 gboolean e_cal_discard_alarm (ECal *ecal, ECalComponent *comp, const gchar *auid, GError **error);
 181
 182 gboolean e_cal_receive_objects (ECal *ecal, icalcomponent *icalcomp, GError **error);
 183 gboolean e_cal_send_objects (ECal *ecal, icalcomponent *icalcomp, GList **users, icalcomponent **modified_icalcomp, GError **error);
 184
 185 gboolean e_cal_get_timezone (ECal *ecal, const gchar *tzid, icaltimezone **zone, GError **error);
 186 gboolean e_cal_add_timezone (ECal *ecal, icaltimezone *izone, GError **error);
 187 /* Sets the default timezone to use to resolve DATE and floating DATE-TIME
 188    values. This will typically be from the user's timezone setting. Call this
 189    before using any other functions. It will pass the default timezone on to
 190    the server. Returns TRUE on success. */
 191 gboolean e_cal_set_default_timezone (ECal *ecal, icaltimezone *zone, GError **error);
 192
 193 gboolean e_cal_get_query (ECal *ecal, const gchar *sexp, ECalView **query, GError **error);
 194
 195 /* Resolves TZIDs for the recurrence generator. */
 196 icaltimezone *e_cal_resolve_tzid_cb (const gchar *tzid, gpointer data);
 197
 198 /* Returns a complete VCALENDAR for a VEVENT/VTODO including all VTIMEZONEs
 199    used by the component. It also includes a 'METHOD:PUBLISH' property. */
 200 gchar * e_cal_get_component_as_string (ECal *ecal, icalcomponent *icalcomp);
 201
 202 const gchar * e_cal_get_error_message (ECalendarStatus status);
 203
 204 /* Calendar/Tasks Discovery */
 205 gboolean    e_cal_open_default (ECal **ecal, ECalSourceType type, ECalAuthFunc func, gpointer data, GError **error);
 206 gboolean    e_cal_set_default (ECal  *ecal, GError **error);
 207 gboolean    e_cal_set_default_source (ESource *source, ECalSourceType type, GError **error);
 208 gboolean    e_cal_get_sources (ESourceList **sources, ECalSourceType type, GError **error);
 209 const gchar * e_cal_get_local_attachment_store (ECal *ecal);
 210 gboolean e_cal_get_recurrences_no_master (ECal *ecal);
 211 gboolean e_cal_get_attachments_for_comp (ECal *ecal, const gchar *uid, const gchar *rid, GSList **list, GError **error);
 212
 213 G_END_DECLS
 214
 215 #endif