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 #ifndef E_CAL_DISABLE_DEPRECATED
  26
  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_TYPE_CAL_SOURCE_TYPE (e_cal_source_type_enum_get_type ())
  44 #define E_CAL_SET_MODE_STATUS_ENUM_TYPE (e_cal_set_mode_status_enum_get_type ())
  45 #define CAL_MODE_ENUM_TYPE                   (cal_mode_enum_get_type ())
  46
  47 typedef struct _ECal ECal;
  48 typedef struct _ECalClass ECalClass;
  49 typedef struct _ECalPrivate ECalPrivate;
  50
  51 typedef enum {
  52         E_CAL_SOURCE_TYPE_EVENT,
  53         E_CAL_SOURCE_TYPE_TODO,
  54         E_CAL_SOURCE_TYPE_JOURNAL,
  55         E_CAL_SOURCE_TYPE_LAST
  56 } ECalSourceType;
  57
  58 /* Set mode status for the e_cal_set_mode function */
  59 typedef enum {
  60         E_CAL_SET_MODE_SUCCESS,
  61         E_CAL_SET_MODE_ERROR,
  62         E_CAL_SET_MODE_NOT_SUPPORTED
  63 } ECalSetModeStatus;
  64
  65 /* Whether the ecal is not loaded, is being loaded, or is already loaded */
  66 typedef enum {
  67         E_CAL_LOAD_NOT_LOADED,
  68         E_CAL_LOAD_LOADING,
  69         E_CAL_LOAD_LOADED
  70 } ECalLoadState;
  71
  72 /**
  73  * EDataCalMode:
  74  *
  75  * FIXME: Document me.
  76  *
  77  * Since: 3.2
  78  **/
  79 typedef enum {
  80         Local = 1 << 0,
  81         Remote = 1 << 1,
  82         AnyMode = 0x07
  83 } EDataCalMode;
  84
  85 struct _ECal {
  86         GObject object;
  87
  88         /*< private >*/
  89         ECalPrivate *priv;
  90 };
  91
  92 struct _ECalClass {
  93         GObjectClass parent_class;
  94
  95         /* Notification signals */
  96
  97         #ifndef E_CAL_DISABLE_DEPRECATED
  98         void (* cal_opened) (ECal *ecal, ECalendarStatus status);
  99         #endif
 100         void (* cal_opened_ex) (ECal *ecal, const GError *error);
 101         void (* cal_set_mode) (ECal *ecal, ECalSetModeStatus status, CalMode mode);
 102
 103         void (* backend_error) (ECal *ecal, const gchar *message);
 104         void (* backend_died) (ECal *ecal);
 105 };
 106
 107 GType e_cal_get_type (void);
 108
 109 GType e_cal_source_type_enum_get_type (void);
 110 GType e_cal_set_mode_status_enum_get_type (void);
 111 GType cal_mode_enum_get_type (void);
 112
 113 ECal *e_cal_new (ESource *source, ECalSourceType type);
 114
 115 gboolean e_cal_open (ECal *ecal, gboolean only_if_exists, GError **error);
 116 void e_cal_open_async (ECal *ecal, gboolean only_if_exists);
 117 gboolean e_cal_refresh (ECal *ecal, GError **error);
 118 gboolean e_cal_remove (ECal *ecal, GError **error);
 119
 120 GList *e_cal_uri_list (ECal *ecal, CalMode mode);
 121
 122 ECalSourceType e_cal_get_source_type (ECal *ecal);
 123 ECalLoadState e_cal_get_load_state (ECal *ecal);
 124
 125 ESource *e_cal_get_source (ECal *ecal);
 126
 127 gboolean e_cal_is_read_only (ECal *ecal, gboolean *read_only, GError **error);
 128 gboolean e_cal_get_cal_address (ECal *ecal, gchar **cal_address, GError **error);
 129 gboolean e_cal_get_alarm_email_address (ECal *ecal, gchar **alarm_address, GError **error);
 130 gboolean e_cal_get_ldap_attribute (ECal *ecal, gchar **ldap_attribute, GError **error);
 131
 132 gboolean e_cal_get_one_alarm_only (ECal *ecal);
 133 gboolean e_cal_get_organizer_must_attend (ECal *ecal);
 134 gboolean e_cal_get_save_schedules (ECal *ecal);
 135 gboolean e_cal_get_static_capability (ECal *ecal, const gchar *cap);
 136 gboolean e_cal_get_organizer_must_accept (ECal *ecal);
 137 gboolean e_cal_get_refresh_supported (ECal *ecal);
 138
 139 gboolean e_cal_set_mode (ECal *ecal, CalMode mode);
 140
 141 gboolean e_cal_get_default_object (ECal *ecal,
 142                                    icalcomponent **icalcomp, GError **error);
 143
 144 gboolean e_cal_get_object (ECal *ecal,
 145                            const gchar *uid,
 146                            const gchar *rid,
 147                            icalcomponent **icalcomp,
 148                            GError **error);
 149 gboolean e_cal_get_objects_for_uid (ECal *ecal,
 150                                     const gchar *uid,
 151                                     GList **objects,
 152                                     GError **error);
 153
 154 gboolean e_cal_get_changes (ECal *ecal, const gchar *change_id, GList **changes, GError **error);
 155 void e_cal_free_change_list (GList *list);
 156
 157 gboolean e_cal_get_object_list (ECal *ecal, const gchar *query, GList **objects, GError **error);
 158 gboolean e_cal_get_object_list_as_comp (ECal *ecal, const gchar *query, GList **objects, GError **error);
 159 void e_cal_free_object_list (GList *objects);
 160
 161 gboolean e_cal_get_free_busy (ECal *ecal, GList *users, time_t start, time_t end,
 162                               GList **freebusy, GError **error);
 163
 164 void e_cal_generate_instances (ECal *ecal, time_t start, time_t end,
 165                                ECalRecurInstanceFn cb, gpointer cb_data);
 166 void e_cal_generate_instances_for_object (ECal *ecal, icalcomponent *icalcomp,
 167                                           time_t start, time_t end,
 168                                           ECalRecurInstanceFn cb, gpointer cb_data);
 169
 170 GSList *e_cal_get_alarms_in_range (ECal *ecal, time_t start, time_t end);
 171
 172 void e_cal_free_alarms (GSList *comp_alarms);
 173
 174 gboolean e_cal_get_alarms_for_object (ECal *ecal, const ECalComponentId *id,
 175                                       time_t start, time_t end,
 176                                       ECalComponentAlarms **alarms);
 177
 178 gboolean e_cal_create_object (ECal *ecal, icalcomponent *icalcomp, gchar **uid, GError **error);
 179 gboolean e_cal_modify_object (ECal *ecal, icalcomponent *icalcomp, CalObjModType mod, GError **error);
 180 gboolean e_cal_remove_object (ECal *ecal, const gchar *uid, GError **error);
 181 gboolean e_cal_remove_object_with_mod (ECal *ecal, const gchar *uid, const gchar *rid, CalObjModType mod, GError **error);
 182
 183 gboolean e_cal_discard_alarm (ECal *ecal, ECalComponent *comp, const gchar *auid, GError **error);
 184
 185 gboolean e_cal_receive_objects (ECal *ecal, icalcomponent *icalcomp, GError **error);
 186 gboolean e_cal_send_objects (ECal *ecal, icalcomponent *icalcomp, GList **users, icalcomponent **modified_icalcomp, GError **error);
 187
 188 gboolean e_cal_get_timezone (ECal *ecal, const gchar *tzid, icaltimezone **zone, GError **error);
 189 gboolean e_cal_add_timezone (ECal *ecal, icaltimezone *izone, GError **error);
 190 /* Sets the default timezone to use to resolve DATE and floating DATE-TIME
 191  * values. This will typically be from the user's timezone setting. Call this
 192  * before using any other functions. It will pass the default timezone on to
 193  * the server. Returns TRUE on success. */
 194 gboolean e_cal_set_default_timezone (ECal *ecal, icaltimezone *zone, GError **error);
 195
 196 gboolean e_cal_get_query (ECal *ecal, const gchar *sexp, ECalView **query, GError **error);
 197
 198 /* Resolves TZIDs for the recurrence generator. */
 199 icaltimezone *e_cal_resolve_tzid_cb (const gchar *tzid, gpointer data);
 200
 201 /* Returns a complete VCALENDAR for a VEVENT/VTODO including all VTIMEZONEs
 202  * used by the component. It also includes a 'METHOD:PUBLISH' property. */
 203 gchar * e_cal_get_component_as_string (ECal *ecal, icalcomponent *icalcomp);
 204
 205 const gchar * e_cal_get_error_message (ECalendarStatus status);
 206
 207 /* Calendar/Tasks Discovery */
 208 const gchar * e_cal_get_local_attachment_store (ECal *ecal);
 209 gboolean e_cal_get_recurrences_no_master (ECal *ecal);
 210 gboolean e_cal_get_attachments_for_comp (ECal *ecal, const gchar *uid, const gchar *rid, GSList **list, GError **error);
 211
 212 G_END_DECLS
 213
 214 #endif /* E_CAL_DISABLE_DEPRECATED */
 215
 216 #endif