calendar/libecal/e-cal.h

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