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.h>
  26 #include <libecal/e-cal-recur.h>
  27 #include <libecal/e-cal-util.h>
  28 #include <libecal/e-cal-view.h>
  29 #include <libecal/e-cal-types.h>
  30
  31 G_BEGIN_DECLS
  32
  33 \f
  34
  35 #define E_TYPE_CAL            (e_cal_get_type ())
  36 #define E_CAL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_TYPE_CAL, ECal))
  37 #define E_CAL_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), E_TYPE_CAL, ECalClass))
  38 #define E_IS_CAL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), E_TYPE_CAL))
  39 #define E_IS_CAL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), E_TYPE_CAL))
  40
  41 #define E_CAL_SET_MODE_STATUS_ENUM_TYPE (e_cal_set_mode_status_enum_get_type ())
  42 #define CAL_MODE_ENUM_TYPE                   (cal_mode_enum_get_type ())
  43
  44 typedef struct _ECal ECal;
  45 typedef struct _ECalClass ECalClass;
  46 typedef struct _ECalPrivate ECalPrivate;
  47
  48 typedef enum {
  49         E_CAL_SOURCE_TYPE_EVENT,
  50         E_CAL_SOURCE_TYPE_TODO,
  51         E_CAL_SOURCE_TYPE_JOURNAL,
  52         E_CAL_SOURCE_TYPE_LAST
  53 } ECalSourceType;
  54
  55 /* Set mode status for the e_cal_set_mode function */
  56 typedef enum {
  57         E_CAL_SET_MODE_SUCCESS,
  58         E_CAL_SET_MODE_ERROR,
  59         E_CAL_SET_MODE_NOT_SUPPORTED
  60 } ECalSetModeStatus;
  61
  62 /* Whether the ecal is not loaded, is being loaded, or is already loaded */
  63 typedef enum {
  64         E_CAL_LOAD_NOT_LOADED,
  65         E_CAL_LOAD_AUTHENTICATING,
  66         E_CAL_LOAD_LOADING,
  67         E_CAL_LOAD_LOADED
  68 } ECalLoadState;
  69
  70 struct _ECal {
  71         GObject object;
  72
  73         /*< private >*/
  74         ECalPrivate *priv;
  75 };
  76
  77 struct _ECalClass {
  78         GObjectClass parent_class;
  79
  80         /* Notification signals */
  81
  82         void (* cal_opened) (ECal *ecal, ECalendarStatus status);
  83         void (* cal_set_mode) (ECal *ecal, ECalSetModeStatus status, CalMode mode);
  84
  85         void (* backend_error) (ECal *ecal, const char *message);
  86
  87         void (* categories_changed) (ECal *ecal, GPtrArray *categories);
  88
  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
 106 void e_cal_set_auth_func (ECal *ecal, ECalAuthFunc func, gpointer data);
 107
 108 gboolean e_cal_open (ECal *ecal, gboolean only_if_exists, GError **error);
 109 void e_cal_open_async (ECal *ecal, gboolean only_if_exists);
 110 gboolean e_cal_remove_calendar (ECal *ecal, GError **error);
 111
 112 GList *e_cal_uri_list (ECal *ecal, CalMode mode);
 113
 114 ECalLoadState e_cal_get_load_state (ECal *ecal);
 115
 116 ESource *e_cal_get_source (ECal *ecal);
 117 const char *e_cal_get_uri (ECal *ecal);
 118
 119 gboolean e_cal_is_read_only (ECal *ecal, gboolean *read_only, GError **error);
 120 gboolean e_cal_get_cal_address (ECal *ecal, char **cal_address, GError **error);
 121 gboolean e_cal_get_alarm_email_address (ECal *ecal, char **alarm_address, GError **error);
 122 gboolean e_cal_get_ldap_attribute (ECal *ecal, char **ldap_attribute, GError **error);
 123
 124 gboolean e_cal_get_one_alarm_only (ECal *ecal);
 125 gboolean e_cal_get_organizer_must_attend (ECal *ecal);
 126 gboolean e_cal_get_save_schedules (ECal *ecal);
 127 gboolean e_cal_get_static_capability (ECal *ecal, const char *cap);
 128
 129 gboolean e_cal_set_mode (ECal *ecal, CalMode mode);
 130
 131 gboolean e_cal_get_default_object (ECal *ecal,
 132                                    icalcomponent **icalcomp, GError **error);
 133
 134 gboolean e_cal_get_object (ECal *ecal,
 135                            const char *uid,
 136                            const char *rid,
 137                            icalcomponent **icalcomp,
 138                            GError **error);
 139
 140 gboolean e_cal_get_changes (ECal *ecal, const char *change_id, GList **changes, GError **error);
 141 void e_cal_free_change_list (GList *list);
 142
 143 gboolean e_cal_get_object_list (ECal *ecal, const char *query, GList **objects, GError **error);
 144 gboolean e_cal_get_object_list_as_comp (ECal *ecal, const char *query, GList **objects, GError **error);
 145 void e_cal_free_object_list (GList *objects);
 146
 147 gboolean e_cal_get_free_busy (ECal *ecal, GList *users, time_t start, time_t end,
 148                               GList **freebusy, GError **error);
 149
 150 void e_cal_generate_instances (ECal *ecal, time_t start, time_t end,
 151                                ECalRecurInstanceFn cb, gpointer cb_data);
 152
 153 GSList *e_cal_get_alarms_in_range (ECal *ecal, time_t start, time_t end);
 154
 155 void e_cal_free_alarms (GSList *comp_alarms);
 156
 157 gboolean e_cal_get_alarms_for_object (ECal *ecal, const char *uid,
 158                                       time_t start, time_t end,
 159                                       ECalComponentAlarms **alarms);
 160
 161 gboolean e_cal_create_object (ECal *ecal, icalcomponent *icalcomp, char **uid, GError **error);
 162 gboolean e_cal_modify_object (ECal *ecal, icalcomponent *icalcomp, CalObjModType mod, GError **error);
 163 gboolean e_cal_remove_object (ECal *ecal, const char *uid, GError **error);
 164 gboolean e_cal_remove_object_with_mod (ECal *ecal, const char *uid, const char *rid, CalObjModType mod, GError **error);
 165
 166 gboolean e_cal_discard_alarm (ECal *ecal, ECalComponent *comp, const char *auid, GError **error);
 167
 168 gboolean e_cal_receive_objects (ECal *ecal, icalcomponent *icalcomp, GError **error);
 169 gboolean e_cal_send_objects (ECal *ecal, icalcomponent *icalcomp, GError **error);
 170
 171 gboolean e_cal_get_timezone (ECal *ecal, const char *tzid, icaltimezone **zone, GError **error);
 172 gboolean e_cal_add_timezone (ECal *ecal, icaltimezone *izone, GError **error);
 173 /* Sets the default timezone to use to resolve DATE and floating DATE-TIME
 174    values. This will typically be from the user's timezone setting. Call this
 175    before using any other functions. It will pass the default timezone on to
 176    the server. Returns TRUE on success. */
 177 gboolean e_cal_set_default_timezone (ECal *ecal, icaltimezone *zone, GError **error);
 178
 179 gboolean e_cal_get_query (ECal *ecal, const char *sexp, ECalView **query, GError **error);
 180
 181 /* Resolves TZIDs for the recurrence generator. */
 182 icaltimezone *e_cal_resolve_tzid_cb (const char *tzid, gpointer data);
 183
 184 /* Returns a complete VCALENDAR for a VEVENT/VTODO including all VTIMEZONEs
 185    used by the component. It also includes a 'METHOD:PUBLISH' property. */
 186 char* e_cal_get_component_as_string (ECal *ecal, icalcomponent *icalcomp);
 187
 188 const char * e_cal_get_error_message (ECalendarStatus status);
 189
 190 G_END_DECLS
 191
 192 #endif