From 8836050e99af77f97260fdfae1a37d3fdfb0924d Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Mon, 29 Oct 2001 22:21:24 +0000 Subject: Updated docs for repeating alarms. 2001-10-29 Federico Mena Quintero * calendar/alarm-generation.sgml: Updated docs for repeating alarms. svn path=/trunk/; revision=14367 --- doc/devel/ChangeLog | 5 + doc/devel/calendar/alarm-generation.sgml | 16 + .../cal-client/evolution-cal-client-decl.txt | 145 +++++++- doc/devel/calendar/cal-client/tmpl/cal-client.sgml | 9 + .../calendar/cal-util/evolution-cal-util-decl.txt | 402 +++++++++++---------- .../calendar/cal-util/tmpl/cal-component.sgml | 1 + doc/devel/calendar/cal-util/tmpl/cal-recur.sgml | 1 + .../cal-util/tmpl/evolution-cal-util-unused.sgml | 34 ++ doc/devel/calendar/cal-util/tmpl/timeutil.sgml | 38 -- 9 files changed, 425 insertions(+), 226 deletions(-) (limited to 'doc/devel') diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog index 265dac5ce7..673dbd1156 100644 --- a/doc/devel/ChangeLog +++ b/doc/devel/ChangeLog @@ -1,3 +1,8 @@ +2001-10-29 Federico Mena Quintero + + * calendar/alarm-generation.sgml: Updated docs for repeating + alarms. + 2001-07-31 Ettore Perazzoli * Makefile.am (dist-hook): Remove the copying of the diff --git a/doc/devel/calendar/alarm-generation.sgml b/doc/devel/calendar/alarm-generation.sgml index 77d35258da..46f7e4bff1 100644 --- a/doc/devel/calendar/alarm-generation.sgml +++ b/doc/devel/calendar/alarm-generation.sgml @@ -100,6 +100,22 @@ time, and if so, we take that trigger occurrence into account for the final result. + + + In addition, alarms may specify a number of repetitions and a + duration time. For example, an alarm may be configured to + repeat 3 extra times after the original occurrence with 5 + minutes between each repetition. Again, for absolute triggers + this does not present a problem, as we can just generate the + repetitions starting from the absolute trigger time. For + relative triggers, we expand the range as described above and + also add the total offset for the repetitions to the start of + the range, i.e. 15 extra minutes for the case of 3 repetitions + with 5 minutes between each. We do not need to modify the end + of the range because alarm repetitions always have positive + offsets, so they are equivalent to relative alarm triggers + with positive offsets. + diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt index 5511d9fb74..bf42dee8d2 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt @@ -1,3 +1,116 @@ + +CAL_CLIENT_MULTI_TYPE +#define CAL_CLIENT_MULTI_TYPE (cal_client_multi_get_type ()) + + +CAL_CLIENT_MULTI +#define CAL_CLIENT_MULTI(obj) (GTK_CHECK_CAST ((obj), CAL_CLIENT_MULTI_TYPE, CalClientMulti)) + + +CAL_CLIENT_MULTI_CLASS +#define CAL_CLIENT_MULTI_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_CLIENT_MULTI_TYPE, CalClientMultiClass)) + + +IS_CAL_CLIENT_MULTI +#define IS_CAL_CLIENT_MULTI(obj) (GTK_CHECK_TYPE ((obj), CAL_CLIENT_MULTI_TYPE)) + + +IS_CAL_CLIENT_MULTI_CLASS +#define IS_CAL_CLIENT_MULTI_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_CLIENT_MULTI_TYPE)) + + +CalClientMulti + + +CalClientMultiClass + + +CalClientMultiPrivate + + +CalClientMulti +struct CalClientMulti { + GtkObject object; + + /* Private data */ + CalClientMultiPrivate *priv; +}; + + +cal_client_multi_get_type +GtkType +void + + +cal_client_multi_new +CalClientMulti * +void + + +cal_client_multi_add_client +void +CalClientMulti *multi, CalClient *client + + +cal_client_multi_set_auth_func +void +CalClientMulti *multi,CalClientAuthFunc func,gpointer user_data + + +cal_client_multi_open_calendar +CalClient * +CalClientMulti *multi,const char *str_uri,gboolean only_if_exists + + +cal_client_multi_get_client_for_uri +CalClient * +CalClientMulti *multi,const char *uri + + +cal_client_multi_get_n_objects +int +CalClientMulti *multi, CalObjType type + + +cal_client_multi_get_object +CalClientGetStatus +CalClientMulti *multi,const char *uid,CalComponent **comp + + +cal_client_multi_get_timezone +CalClientGetStatus +CalClientMulti *multi,const char *tzid,icaltimezone **zone + + +cal_client_multi_get_uids +GList * +CalClientMulti *multi, CalObjType type + + +cal_client_multi_get_changes +GList * +CalClientMulti *multi,CalObjType type,const char *change_id + + +cal_client_multi_get_objects_in_range +GList * +CalClientMulti *multi,CalObjType type,time_t start,time_t end + + +cal_client_multi_get_free_busy +GList * +CalClientMulti *multi,GList *users,time_t start,time_t end + + +cal_client_multi_generate_instances +void +CalClientMulti *multi,CalObjType type,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data + + +cal_client_multi_get_alarms_in_range +GSList * +CalClientMulti *multi,time_t start, time_t end + CalClientChangeType typedef enum { @@ -50,6 +163,14 @@ typedef enum { } CalClientOpenStatus; +CalClientSetModeStatus +typedef enum { + CAL_CLIENT_SET_MODE_SUCCESS, + CAL_CLIENT_SET_MODE_ERROR, + CAL_CLIENT_SET_MODE_NOT_SUPPORTED +} CalClientSetModeStatus; + + CalClientGetStatus typedef enum { CAL_CLIENT_GET_SUCCESS, @@ -103,11 +224,21 @@ void CalClient *client, CalClientAuthFunc func, gpointer data +cal_client_set_default_timezone +gboolean +CalClient *client, icaltimezone *zone + + cal_client_open_calendar gboolean CalClient *client, const char *str_uri, gboolean only_if_exists +cal_client_uri_list +GList * +CalClient *client, CalMode mode + + cal_client_get_load_state CalClientLoadState CalClient *client @@ -118,6 +249,11 @@ CalClient *client CalClient *client +cal_client_set_mode +gboolean +CalClient *client, CalMode mode + + cal_client_get_n_objects int CalClient *client, CalObjType type @@ -149,8 +285,8 @@ CalClient *client, CalObjType type,time_t start, time_t end cal_client_get_free_busy -CalClientGetStatus -CalClient *client, time_t start, time_t end,CalComponent **comp +GList * +CalClient *client, GList *users,time_t start, time_t end cal_client_generate_instances @@ -197,6 +333,11 @@ CalClient *client, const char *sexp icaltimezone * const char *tzid, gpointer data + +cal_client_get_component_as_string +char * +CalClient *client,CalComponent *comp + CAL_QUERY_TYPE #define CAL_QUERY_TYPE (cal_query_get_type ()) diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml index dac080cca1..4426d6c478 100644 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml @@ -273,6 +273,15 @@ GTK+ object for communication with personal calendar server. @calclient: the object which received the signal. @arg1: + + + + + +@calclient: the object which received the signal. +@arg1: +@arg2: + This signal is emitted when the calendar clients receives diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt index 608c328755..77268db8b1 100644 --- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -1,3 +1,188 @@ + +CalRecurInstanceFn +gboolean +CalComponent *comp, + time_t instance_start, + time_t instance_end, + gpointer data + + +CalRecurResolveTimezoneFn +icaltimezone * +const char *tzid, + gpointer data + + +cal_recur_generate_instances +void +CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data,CalRecurResolveTimezoneFn tz_cb,gpointer tz_cb_data,icaltimezone *default_timezone + + +CalObjInstance +typedef struct { + char *uid; /* UID of the object */ + time_t start; /* Start time of instance */ + time_t end; /* End time of instance */ +} CalObjInstance; + + +cal_obj_instance_list_free +void +GList *list + + +CalObjType +typedef enum { + CALOBJ_TYPE_EVENT = 1 << 0, + CALOBJ_TYPE_TODO = 1 << 1, + CALOBJ_TYPE_JOURNAL = 1 << 2, + CALOBJ_TYPE_ANY = 0x07 +} CalObjType; + + +CalMode +typedef enum { + CAL_MODE_INVALID = -1, + CAL_MODE_LOCAL = 1 << 0, + CAL_MODE_REMOTE = 1 << 1, + CAL_MODE_ANY = 0x07 +} CalMode; + + +cal_obj_uid_list_free +void +GList *list + + +cal_util_new_top_level +icalcomponent * +void + + +cal_util_generate_alarms_for_comp +CalComponentAlarms * +CalComponent *comp,time_t start,time_t end,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data,icaltimezone *default_timezone + + +cal_util_generate_alarms_for_list +int +GList *comps,time_t start,time_t end,GSList **comp_alarms,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data,icaltimezone *default_timezone + + +cal_util_resolve_tzid +icaltimezone * +const char *tzid, gpointer data + + +cal_util_priority_to_string +char * +int priority + + +cal_util_priority_from_string +int +const char *string + + +time_days_in_month +int +int year, int month + + +time_day_of_year +int +int day, int month, int year + + +time_day_of_week +int +int day, int month, int year + + +time_is_leap_year +gboolean +int year + + +time_leap_years_up_to +int +int year + + +isodate_from_time_t +char * +time_t t + + +time_from_isodate +time_t +const char *str + + +time_add_day +time_t +time_t time, int days + + +time_add_week +time_t +time_t time, int weeks + + +time_day_begin +time_t +time_t t + + +time_day_end +time_t +time_t t + + +time_add_day_with_zone +time_t +time_t time, int days, icaltimezone *zone + + +time_add_week_with_zone +time_t +time_t time, int weeks, icaltimezone *zone + + +time_add_month_with_zone +time_t +time_t time, int months, icaltimezone *zone + + +time_year_begin_with_zone +time_t +time_t time, icaltimezone *zone + + +time_month_begin_with_zone +time_t +time_t time, icaltimezone *zone + + +time_week_begin_with_zone +time_t +time_t time, int week_start_day,icaltimezone *zone + + +time_day_begin_with_zone +time_t +time_t time, icaltimezone *zone + + +time_day_end_with_zone +time_t +time_t time, icaltimezone *zone + + +time_to_gdate_with_zone +void +GDate *date, time_t time, icaltimezone *zone + CAL_COMPONENT_TYPE #define CAL_COMPONENT_TYPE (cal_component_get_type ()) @@ -53,6 +238,7 @@ typedef enum { CAL_COMPONENT_FIELD_COLOR, /* not a real field */ CAL_COMPONENT_FIELD_STATUS, CAL_COMPONENT_FIELD_COMPONENT, /* not a real field */ + CAL_COMPONENT_FIELD_LOCATION, CAL_COMPONENT_FIELD_NUM_FIELDS } CalComponentField; @@ -212,6 +398,11 @@ CalComponent *comp, icalcomponent *icalcomp CalComponent *comp +cal_component_rescan +void +CalComponent *comp + + cal_component_get_vtype CalComponentVType CalComponent *comp @@ -427,6 +618,11 @@ CalComponent *comp, CalComponentOrganizer *organizer CalComponent *comp, CalComponentOrganizer *organizer +cal_component_has_organizer +gboolean +CalComponent *comp + + cal_component_get_percent void CalComponent *comp, int **percent @@ -557,6 +753,21 @@ CalComponent *comp, GSList **attendee_list CalComponent *comp, GSList *attendee_list +cal_component_has_attendees +gboolean +CalComponent *comp + + +cal_component_get_location +void +CalComponent *comp, const char **location + + +cal_component_set_location +void +CalComponent *comp, const char *location + + cal_component_event_dates_match gboolean CalComponent *comp1, CalComponent *comp2 @@ -705,6 +916,11 @@ CalComponent *comp, CalComponentAlarm *alarm CalComponent *comp, const char *auid +cal_component_remove_all_alarms +void +CalComponent *comp + + cal_component_get_alarm_uids GList * CalComponent *comp @@ -789,189 +1005,3 @@ CalComponentAlarm *alarm, CalAlarmTrigger *trigger void CalComponentAlarm *alarm, CalAlarmTrigger trigger - -CalRecurInstanceFn -gboolean -CalComponent *comp, - time_t instance_start, - time_t instance_end, - gpointer data - - -CalRecurResolveTimezoneFn -icaltimezone * -const char *tzid, - gpointer data - - -cal_recur_generate_instances -void -CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data,CalRecurResolveTimezoneFn tz_cb,gpointer tz_cb_data - - -CalObjInstance -typedef struct { - char *uid; /* UID of the object */ - time_t start; /* Start time of instance */ - time_t end; /* End time of instance */ -} CalObjInstance; - - -cal_obj_instance_list_free -void -GList *list - - -CalObjType -typedef enum { - CALOBJ_TYPE_EVENT = 1 << 0, - CALOBJ_TYPE_TODO = 1 << 1, - CALOBJ_TYPE_JOURNAL = 1 << 2, - CALOBJ_TYPE_ANY = 0x07 -} CalObjType; - - -cal_obj_uid_list_free -void -GList *list - - -cal_util_new_top_level -icalcomponent * -void - - -cal_util_generate_alarms_for_comp -CalComponentAlarms * -CalComponent *comp,time_t start,time_t end,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data - - -cal_util_generate_alarms_for_list -int -GList *comps,time_t start,time_t end,GSList **comp_alarms,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data - - -cal_util_resolve_tzid -icaltimezone * -const char *tzid, gpointer data - - -time_days_in_month -int -int year, int month - - -time_day_of_year -int -int day, int month, int year - - -time_day_of_week -int -int day, int month, int year - - -time_is_leap_year -gboolean -int year - - -time_leap_years_up_to -int -int year - - -isodate_from_time_t -char * -time_t t - - -time_from_isodate -time_t -const char *str - - -time_add_day -time_t -time_t time, int days - - -time_add_week -time_t -time_t time, int weeks - - -time_add_month -time_t -time_t time, int months - - -time_year_begin -time_t -time_t t - - -time_month_begin -time_t -time_t t - - -time_week_begin -time_t -time_t t, int week_start_day - - -time_day_begin -time_t -time_t t - - -time_day_end -time_t -time_t t - - -time_add_day_with_zone -time_t -time_t time, int days, icaltimezone *zone - - -time_add_week_with_zone -time_t -time_t time, int weeks, icaltimezone *zone - - -time_add_month_with_zone -time_t -time_t time, int months, icaltimezone *zone - - -time_year_begin_with_zone -time_t -time_t time, icaltimezone *zone - - -time_month_begin_with_zone -time_t -time_t time, icaltimezone *zone - - -time_week_begin_with_zone -time_t -time_t time, int week_start_day,icaltimezone *zone - - -time_day_begin_with_zone -time_t -time_t time, icaltimezone *zone - - -time_day_end_with_zone -time_t -time_t time, icaltimezone *zone - - -time_to_gdate_with_zone -void -GDate *date, time_t time, icaltimezone *zone - diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml index 0bd957e9c2..df864035e7 100644 --- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml +++ b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml @@ -116,6 +116,7 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_FIELD_COLOR: @CAL_COMPONENT_FIELD_STATUS: @CAL_COMPONENT_FIELD_COMPONENT: +@CAL_COMPONENT_FIELD_LOCATION: @CAL_COMPONENT_FIELD_NUM_FIELDS: diff --git a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml index a8e7cf1620..214b24cbf7 100644 --- a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml +++ b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml @@ -40,5 +40,6 @@ cal-recur @cb_data: @tz_cb: @tz_cb_data: +@default_timezone: diff --git a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml index 878273b0aa..757b46b170 100644 --- a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml +++ b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml @@ -208,6 +208,15 @@ End: @minutes: @Returns: + + + + + +@time: +@months: +@Returns: + @@ -261,6 +270,14 @@ End: @duration: @Returns: + + + + + +@t: +@Returns: + @@ -269,6 +286,15 @@ End: @t: @Returns: + + + + + +@t: +@week_start_day: +@Returns: + @@ -278,6 +304,14 @@ End: @week_start_day: @Returns: + + + + + +@t: +@Returns: + diff --git a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml index e2dba5224f..e118c438eb 100644 --- a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml +++ b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml @@ -43,16 +43,6 @@ timeutil @Returns: - - - - - -@time: -@months: -@Returns: - - @@ -63,34 +53,6 @@ timeutil @Returns: - - - - - -@t: -@Returns: - - - - - - - -@t: -@Returns: - - - - - - - -@t: -@week_start_day: -@Returns: - - -- cgit