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