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