From 3532a74349645ca733bafe1417822ba2bfb9bd26 Mon Sep 17 00:00:00 2001
From: JP Rosevear <jpr@ximian.com>
Date: Fri, 19 Jan 2001 14:57:09 +0000
Subject: create a new cal component alarm (cal_component_add_alarm): add alarm
 to

2001-01-19  JP Rosevear  <jpr@ximian.com>

	* cal-util/cal-component.c (cal_component_alarm_new): create a new
	cal component alarm
	(cal_component_add_alarm): add alarm to the cal component
	(cal_component_remove_alarm): remove alarm from the cal component
	(remove_alarm): remove alarm from hash

	* cal-util/cal-component.h: new protos

	* conduits/calendar/calendar-conduit.c (comp_from_remote_record):
	add alarm information, still needs to be hacked to replace an already
	existing alarm.  questions abound about the heuristic for doing this.

2001-01-17  JP Rosevear  <jpr@ximian.com>

	* README: Update package requirements

svn path=/trunk/; revision=7647
---
 .../tmpl/evolution-cal-client-unused.sgml          |  42 ++--
 .../calendar/cal-util/evolution-cal-util-decl.txt  | 269 +++++++++++----------
 .../cal-util/tmpl/evolution-cal-util-unused.sgml   | 164 ++++++-------
 3 files changed, 245 insertions(+), 230 deletions(-)

(limited to 'doc/devel/calendar')

diff --git a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
index 56bcf3aff5..f8f1f1408e 100644
--- a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
+++ b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
@@ -1,14 +1,13 @@
-<!-- ##### FUNCTION cal_client_update_pilot_id ##### -->
+<!-- ##### FUNCTION cal_client_load_calendar ##### -->
 <para>
 
 </para>
 
 @client: 
-@uid: 
-@pilot_id: 
-@pilot_status: 
+@str_uri: 
+@Returns: 
 
-<!-- ##### FUNCTION cal_client_load_calendar ##### -->
+<!-- ##### FUNCTION cal_client_create_calendar ##### -->
 <para>
 
 </para>
@@ -17,19 +16,6 @@
 @str_uri: 
 @Returns: 
 
-<!-- ##### ENUM CalClientLoadStatus ##### -->
-  <para>
-    These values describe the status of a calendar load or create
-    request.  After asking a calendar factory to load or create a
-    calendar, the provided listener will get notification about the
-    result in asynchronous fashion.  Such notification is represented
-    by one of these enumeration values.  For values other than
-    #CAL_CLIENT_LOAD_SUCCESS, the #CalClient object will not accept
-    any other operations on the calendar and it should just be
-    destroyed.
-  </para>
-
-
 <!-- ##### FUNCTION cal_client_get_events_in_range ##### -->
 <para>
 
@@ -63,14 +49,28 @@
 @client: 
 @Returns: 
 
-<!-- ##### FUNCTION cal_client_create_calendar ##### -->
+<!-- ##### FUNCTION cal_client_update_pilot_id ##### -->
 <para>
 
 </para>
 
 @client: 
-@str_uri: 
-@Returns: 
+@uid: 
+@pilot_id: 
+@pilot_status: 
+
+<!-- ##### ENUM CalClientLoadStatus ##### -->
+  <para>
+    These values describe the status of a calendar load or create
+    request.  After asking a calendar factory to load or create a
+    calendar, the provided listener will get notification about the
+    result in asynchronous fashion.  Such notification is represented
+    by one of these enumeration values.  For values other than
+    #CAL_CLIENT_LOAD_SUCCESS, the #CalClient object will not accept
+    any other operations on the calendar and it should just be
+    destroyed.
+  </para>
+
 
 <!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### -->
 <para>
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 114129515b..9439f57fac 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,128 @@
+<USER_FUNCTION>
+<NAME>CalRecurInstanceFn</NAME>
+<RETURNS>gboolean </RETURNS>
+CalComponent *comp,
+					 time_t        instance_start,
+					 time_t        instance_end,
+					 gpointer      data
+</USER_FUNCTION>
+<FUNCTION>
+<NAME>cal_recur_generate_instances</NAME>
+<RETURNS>void 	</RETURNS>
+CalComponent		*comp,time_t			 start,time_t			 end,CalRecurInstanceFn	 cb,gpointer                cb_data
+</FUNCTION>
+<TYPEDEF>
+<NAME>CalObjInstance</NAME>
+typedef struct {
+	char *uid;			/* UID of the object */
+	time_t start;			/* Start time of instance */
+	time_t end;			/* End time of instance */
+} CalObjInstance;
+</TYPEDEF>
+<FUNCTION>
+<NAME>cal_obj_instance_list_free</NAME>
+<RETURNS>void  </RETURNS>
+GList *list
+</FUNCTION>
+<ENUM>
+<NAME>CalObjType</NAME>
+typedef enum {
+	CALOBJ_TYPE_EVENT   = 1 << 0,
+	CALOBJ_TYPE_TODO    = 1 << 1,
+	CALOBJ_TYPE_JOURNAL = 1 << 2,
+	CALOBJ_TYPE_ANY     = 0x07
+} CalObjType;
+</ENUM>
+<FUNCTION>
+<NAME>cal_obj_uid_list_free</NAME>
+<RETURNS>void  </RETURNS>
+GList *list
+</FUNCTION>
+<FUNCTION>
+<NAME>isodate_from_time_t</NAME>
+<RETURNS>char    *</RETURNS>
+time_t t
+</FUNCTION>
+<FUNCTION>
+<NAME>time_add_minutes</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t time, int minutes
+</FUNCTION>
+<FUNCTION>
+<NAME>time_add_day</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t time, int days
+</FUNCTION>
+<FUNCTION>
+<NAME>time_add_week</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t time, int weeks
+</FUNCTION>
+<FUNCTION>
+<NAME>time_add_month</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t time, int months
+</FUNCTION>
+<FUNCTION>
+<NAME>time_add_year</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t time, int years
+</FUNCTION>
+<FUNCTION>
+<NAME>time_days_in_month</NAME>
+<RETURNS>int  </RETURNS>
+int year, int month
+</FUNCTION>
+<FUNCTION>
+<NAME>time_from_day</NAME>
+<RETURNS>time_t  </RETURNS>
+int year, int month, int day
+</FUNCTION>
+<FUNCTION>
+<NAME>time_year_begin</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t t
+</FUNCTION>
+<FUNCTION>
+<NAME>time_year_end</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t t
+</FUNCTION>
+<FUNCTION>
+<NAME>time_month_begin</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t t
+</FUNCTION>
+<FUNCTION>
+<NAME>time_month_end</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t t
+</FUNCTION>
+<FUNCTION>
+<NAME>time_week_begin</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t t
+</FUNCTION>
+<FUNCTION>
+<NAME>time_week_end</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t t
+</FUNCTION>
+<FUNCTION>
+<NAME>time_day_begin</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t t
+</FUNCTION>
+<FUNCTION>
+<NAME>time_day_end</NAME>
+<RETURNS>time_t  </RETURNS>
+time_t t
+</FUNCTION>
+<FUNCTION>
+<NAME>print_time_t</NAME>
+<RETURNS>void  </RETURNS>
+time_t t
+</FUNCTION>
 <MACRO>
 <NAME>CAL_COMPONENT_TYPE</NAME>
 #define CAL_COMPONENT_TYPE            (cal_component_get_type ())
@@ -594,6 +719,16 @@ typedef struct {
 CalComponent *comp
 </FUNCTION>
 <FUNCTION>
+<NAME>cal_component_add_alarm</NAME>
+<RETURNS>void  </RETURNS>
+CalComponent *comp, CalComponentAlarm *alarm
+</FUNCTION>
+<FUNCTION>
+<NAME>cal_component_remove_alarm</NAME>
+<RETURNS>void  </RETURNS>
+CalComponent *comp, const char *auid
+</FUNCTION>
+<FUNCTION>
 <NAME>cal_component_get_alarm_uids</NAME>
 <RETURNS>GList  *</RETURNS>
 CalComponent *comp
@@ -604,16 +739,16 @@ CalComponent *comp
 CalComponent *comp, const char *auid
 </FUNCTION>
 <FUNCTION>
-<NAME>cal_component_alarm_free</NAME>
-<RETURNS>void  </RETURNS>
-CalComponentAlarm *alarm
-</FUNCTION>
-<FUNCTION>
 <NAME>cal_component_alarms_free</NAME>
 <RETURNS>void  </RETURNS>
 CalComponentAlarms *alarms
 </FUNCTION>
 <FUNCTION>
+<NAME>cal_component_alarm_new</NAME>
+<RETURNS>CalComponentAlarm  *</RETURNS>
+void
+</FUNCTION>
+<FUNCTION>
 <NAME>cal_component_alarm_get_uid</NAME>
 <RETURNS>const char  *</RETURNS>
 CalComponentAlarm *alarm
@@ -638,128 +773,8 @@ CalComponentAlarm *alarm, CalAlarmTrigger *trigger
 <RETURNS>void  </RETURNS>
 CalComponentAlarm *alarm, CalAlarmTrigger trigger
 </FUNCTION>
-<USER_FUNCTION>
-<NAME>CalRecurInstanceFn</NAME>
-<RETURNS>gboolean </RETURNS>
-CalComponent *comp,
-					 time_t        instance_start,
-					 time_t        instance_end,
-					 gpointer      data
-</USER_FUNCTION>
-<FUNCTION>
-<NAME>cal_recur_generate_instances</NAME>
-<RETURNS>void 	</RETURNS>
-CalComponent		*comp,time_t			 start,time_t			 end,CalRecurInstanceFn	 cb,gpointer                cb_data
-</FUNCTION>
-<TYPEDEF>
-<NAME>CalObjInstance</NAME>
-typedef struct {
-	char *uid;			/* UID of the object */
-	time_t start;			/* Start time of instance */
-	time_t end;			/* End time of instance */
-} CalObjInstance;
-</TYPEDEF>
-<FUNCTION>
-<NAME>cal_obj_instance_list_free</NAME>
-<RETURNS>void  </RETURNS>
-GList *list
-</FUNCTION>
-<ENUM>
-<NAME>CalObjType</NAME>
-typedef enum {
-	CALOBJ_TYPE_EVENT   = 1 << 0,
-	CALOBJ_TYPE_TODO    = 1 << 1,
-	CALOBJ_TYPE_JOURNAL = 1 << 2,
-	CALOBJ_TYPE_ANY     = 0x07
-} CalObjType;
-</ENUM>
-<FUNCTION>
-<NAME>cal_obj_uid_list_free</NAME>
-<RETURNS>void  </RETURNS>
-GList *list
-</FUNCTION>
-<FUNCTION>
-<NAME>isodate_from_time_t</NAME>
-<RETURNS>char    *</RETURNS>
-time_t t
-</FUNCTION>
-<FUNCTION>
-<NAME>time_add_minutes</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t time, int minutes
-</FUNCTION>
-<FUNCTION>
-<NAME>time_add_day</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t time, int days
-</FUNCTION>
-<FUNCTION>
-<NAME>time_add_week</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t time, int weeks
-</FUNCTION>
-<FUNCTION>
-<NAME>time_add_month</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t time, int months
-</FUNCTION>
-<FUNCTION>
-<NAME>time_add_year</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t time, int years
-</FUNCTION>
-<FUNCTION>
-<NAME>time_days_in_month</NAME>
-<RETURNS>int  </RETURNS>
-int year, int month
-</FUNCTION>
-<FUNCTION>
-<NAME>time_from_day</NAME>
-<RETURNS>time_t  </RETURNS>
-int year, int month, int day
-</FUNCTION>
-<FUNCTION>
-<NAME>time_year_begin</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t t
-</FUNCTION>
-<FUNCTION>
-<NAME>time_year_end</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t t
-</FUNCTION>
-<FUNCTION>
-<NAME>time_month_begin</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t t
-</FUNCTION>
-<FUNCTION>
-<NAME>time_month_end</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t t
-</FUNCTION>
 <FUNCTION>
-<NAME>time_week_begin</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t t
-</FUNCTION>
-<FUNCTION>
-<NAME>time_week_end</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t t
-</FUNCTION>
-<FUNCTION>
-<NAME>time_day_begin</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t t
-</FUNCTION>
-<FUNCTION>
-<NAME>time_day_end</NAME>
-<RETURNS>time_t  </RETURNS>
-time_t t
-</FUNCTION>
-<FUNCTION>
-<NAME>print_time_t</NAME>
+<NAME>cal_component_alarm_free</NAME>
 <RETURNS>void  </RETURNS>
-time_t t
+CalComponentAlarm *alarm
 </FUNCTION>
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 ff68fae99d..93625da7df 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
@@ -1,44 +1,38 @@
-<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### -->
-<para>
-
-</para>
-
-@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: 
-@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: 
-
-<!-- ##### FUNCTION cal_recur_free ##### -->
+<!-- ##### ENUM CalComponentAlarmAction ##### -->
 <para>
 
 </para>
 
-@r: 
+@CAL_COMPONENT_ALARM_NONE: 
+@CAL_COMPONENT_ALARM_AUDIO: 
+@CAL_COMPONENT_ALARM_DISPLAY: 
+@CAL_COMPONENT_ALARM_EMAIL: 
+@CAL_COMPONENT_ALARM_PROCEDURE: 
+@CAL_COMPONENT_ALARM_UNKNOWN: 
 
-<!-- ##### ENUM CalRecurType ##### -->
+<!-- ##### FUNCTION time_from_isodate ##### -->
 <para>
 
 </para>
 
-@CAL_RECUR_YEARLY: 
-@CAL_RECUR_MONTHLY: 
-@CAL_RECUR_WEEKLY: 
-@CAL_RECUR_DAILY: 
-@CAL_RECUR_HOURLY: 
-@CAL_RECUR_MINUTELY: 
-@CAL_RECUR_SECONDLY: 
+@str: 
+@Returns: 
 
-<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### -->
+<!-- ##### FUNCTION cal_component_get_pilot_status ##### -->
 <para>
 
 </para>
 
+@comp: 
+@pilot_status: 
 
-<!-- ##### FUNCTION cal_component_get_pilot_id ##### -->
+<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### -->
 <para>
 
 </para>
 
-@comp: 
-@pilot_id: 
+@ir: 
+@Returns: 
 
 <!-- ##### FUNCTION get_time_t_hour ##### -->
 <para>
@@ -48,28 +42,29 @@
 @t: 
 @Returns: 
 
-<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### -->
+<!-- ##### FUNCTION time_from_start_duration ##### -->
 <para>
 
 </para>
 
-@trigger: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "")
-End:
--->
+@start: 
+@duration: 
+@Returns: 
 
-<!-- ##### FUNCTION time_day_hour ##### -->
+<!-- ##### ENUM CalRecurType ##### -->
 <para>
 
 </para>
 
-@t: 
-@hour: 
-@Returns: 
+@CAL_RECUR_YEARLY: 
+@CAL_RECUR_MONTHLY: 
+@CAL_RECUR_WEEKLY: 
+@CAL_RECUR_DAILY: 
+@CAL_RECUR_HOURLY: 
+@CAL_RECUR_MINUTELY: 
+@CAL_RECUR_SECONDLY: 
 
-<!-- ##### FUNCTION time_from_isodate ##### -->
+<!-- ##### FUNCTION parse_date ##### -->
 <para>
 
 </para>
@@ -77,113 +72,108 @@ End:
 @str: 
 @Returns: 
 
-<!-- ##### FUNCTION cal_component_get_pilot_status ##### -->
+<!-- ##### FUNCTION cal_component_get_pilot_id ##### -->
 <para>
 
 </para>
 
 @comp: 
-@pilot_status: 
+@pilot_id: 
 
-<!-- ##### STRUCT CalObjTime ##### -->
+<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### -->
 <para>
 
 </para>
 
-@year: 
-@month: 
-@day: 
-@hour: 
-@minute: 
-@second: 
+@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: 
+@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: 
 
-<!-- ##### STRUCT CalComponentPrivate ##### -->
+<!-- ##### FUNCTION isodiff_to_secs ##### -->
 <para>
 
 </para>
 
+@str: 
+@Returns: 
 
-<!-- ##### ENUM CalComponentAlarmTriggerType ##### -->
+<!-- ##### FUNCTION cal_recur_free ##### -->
 <para>
 
 </para>
 
-@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: 
-@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: 
+@r: 
 
-<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### -->
+<!-- ##### FUNCTION time_from_icaltimetype ##### -->
 <para>
 
 </para>
 
-@ir: 
+@itt: 
 @Returns: 
 
-<!-- ##### FUNCTION cal_alarm_instance_list_free ##### -->
+<!-- ##### FUNCTION time_day_hour ##### -->
 <para>
 
 </para>
 
-@list: 
+@t: 
+@hour: 
+@Returns: 
 
-<!-- ##### FUNCTION isodiff_to_secs ##### -->
+<!-- ##### FUNCTION cal_component_get_first_alarm ##### -->
 <para>
 
 </para>
 
-@str: 
+@comp: 
 @Returns: 
 
-<!-- ##### FUNCTION cal_component_get_first_alarm ##### -->
+<!-- ##### STRUCT CalComponentPrivate ##### -->
 <para>
 
 </para>
 
-@comp: 
-@Returns: 
 
-<!-- ##### TYPEDEF CalRecurrence ##### -->
+<!-- ##### FUNCTION isodiff_from_secs ##### -->
 <para>
 
 </para>
 
+@secs: 
+@Returns: 
 
-<!-- ##### FUNCTION cal_component_get_next_alarm ##### -->
+<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### -->
 <para>
 
 </para>
 
-@comp: 
-@Returns: 
+@trigger: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "")
+End:
+-->
 
-<!-- ##### FUNCTION time_from_icaltimetype ##### -->
+<!-- ##### TYPEDEF CalRecurrence ##### -->
 <para>
 
 </para>
 
-@itt: 
-@Returns: 
 
-<!-- ##### ENUM CalComponentAlarmAction ##### -->
+<!-- ##### FUNCTION cal_alarm_instance_list_free ##### -->
 <para>
 
 </para>
 
-@CAL_COMPONENT_ALARM_NONE: 
-@CAL_COMPONENT_ALARM_AUDIO: 
-@CAL_COMPONENT_ALARM_DISPLAY: 
-@CAL_COMPONENT_ALARM_EMAIL: 
-@CAL_COMPONENT_ALARM_PROCEDURE: 
-@CAL_COMPONENT_ALARM_UNKNOWN: 
+@list: 
 
-<!-- ##### FUNCTION time_from_start_duration ##### -->
+<!-- ##### FUNCTION cal_component_set_pilot_status ##### -->
 <para>
 
 </para>
 
-@start: 
-@duration: 
-@Returns: 
+@comp: 
+@pilot_status: 
 
 <!-- ##### FUNCTION cal_component_set_pilot_id ##### -->
 <para>
@@ -193,13 +183,17 @@ End:
 @comp: 
 @pilot_id: 
 
-<!-- ##### FUNCTION isodiff_from_secs ##### -->
+<!-- ##### STRUCT CalObjTime ##### -->
 <para>
 
 </para>
 
-@secs: 
-@Returns: 
+@year: 
+@month: 
+@day: 
+@hour: 
+@minute: 
+@second: 
 
 <!-- ##### FUNCTION format_simple_hour ##### -->
 <para>
@@ -210,19 +204,25 @@ End:
 @use_am_pm: 
 @Returns: 
 
-<!-- ##### FUNCTION cal_component_set_pilot_status ##### -->
+<!-- ##### FUNCTION cal_component_get_next_alarm ##### -->
 <para>
 
 </para>
 
 @comp: 
-@pilot_status: 
+@Returns: 
 
-<!-- ##### FUNCTION parse_date ##### -->
+<!-- ##### ENUM CalComponentAlarmTriggerType ##### -->
+<para>
+
+</para>
+
+@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: 
+@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: 
+
+<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### -->
 <para>
 
 </para>
 
-@str: 
-@Returns: 
 
-- 
cgit