aboutsummaryrefslogtreecommitdiffstats
path: root/doc/devel/calendar/cal-util
diff options
context:
space:
mode:
authorFederico Mena Quintero <federico@src.gnome.org>2001-06-25 07:54:24 +0800
committerFederico Mena Quintero <federico@src.gnome.org>2001-06-25 07:54:24 +0800
commitf08f4c88be0ffdf26639a5100e8ffb31bbb6668b (patch)
treede3f65f67889edb76706a1bce705dc6c99d9a163 /doc/devel/calendar/cal-util
parentf0df1441553d79218d1c7de679003109090cc203 (diff)
downloadgsoc2013-evolution-f08f4c88be0ffdf26639a5100e8ffb31bbb6668b.tar
gsoc2013-evolution-f08f4c88be0ffdf26639a5100e8ffb31bbb6668b.tar.gz
gsoc2013-evolution-f08f4c88be0ffdf26639a5100e8ffb31bbb6668b.tar.bz2
gsoc2013-evolution-f08f4c88be0ffdf26639a5100e8ffb31bbb6668b.tar.lz
gsoc2013-evolution-f08f4c88be0ffdf26639a5100e8ffb31bbb6668b.tar.xz
gsoc2013-evolution-f08f4c88be0ffdf26639a5100e8ffb31bbb6668b.tar.zst
gsoc2013-evolution-f08f4c88be0ffdf26639a5100e8ffb31bbb6668b.zip
Sync - Federico
svn path=/trunk/; revision=10455
Diffstat (limited to 'doc/devel/calendar/cal-util')
-rw-r--r--doc/devel/calendar/cal-util/evolution-cal-util-decl.txt126
-rw-r--r--doc/devel/calendar/cal-util/tmpl/cal-component.sgml1
-rw-r--r--doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml146
-rw-r--r--doc/devel/calendar/cal-util/tmpl/timeutil.sgml2
4 files changed, 195 insertions, 80 deletions
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 6f6994d8c4..b40d57f8b4 100644
--- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt
+++ b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt
@@ -52,6 +52,7 @@ typedef enum {
CAL_COMPONENT_FIELD_OVERDUE, /* not a real field */
CAL_COMPONENT_FIELD_COLOR, /* not a real field */
CAL_COMPONENT_FIELD_STATUS,
+ CAL_COMPONENT_FIELD_COMPONENT, /* not a real field */
CAL_COMPONENT_FIELD_NUM_FIELDS
} CalComponentField;
</ENUM>
@@ -95,6 +96,22 @@ typedef struct {
} u;
} CalComponentPeriod;
</TYPEDEF>
+<ENUM>
+<NAME>CalComponentRangeType</NAME>
+typedef enum {
+ CAL_COMPONENT_RANGE_SINGLE,
+ CAL_COMPONENT_RANGE_THISPRIOR,
+ CAL_COMPONENT_RANGE_THISFUTURE,
+} CalComponentRangeType;
+</ENUM>
+<TYPEDEF>
+<NAME>CalComponentRange</NAME>
+typedef struct {
+ CalComponentRangeType type;
+
+ CalComponentDateTime *datetime;
+} CalComponentRange;
+</TYPEDEF>
<TYPEDEF>
<NAME>CalComponentText</NAME>
typedef struct {
@@ -114,6 +131,66 @@ typedef enum {
CAL_COMPONENT_TRANSP_UNKNOWN
} CalComponentTransparency;
</ENUM>
+<ENUM>
+<NAME>CalComponentCUType</NAME>
+typedef enum {
+ CAL_COMPONENT_CUTYPE_INDIVIDUAL,
+ CAL_COMPONENT_CUTYPE_GROUP,
+ CAL_COMPONENT_CUTYPE_RESOURCE,
+ CAL_COMPONENT_CUTYPE_ROOM,
+ CAL_COMPONENT_CUTYPE_UNKNOWN
+} CalComponentCUType;
+</ENUM>
+<ENUM>
+<NAME>CalComponentRole</NAME>
+typedef enum {
+ CAL_COMPONENT_ROLE_CHAIR,
+ CAL_COMPONENT_ROLE_REQUIRED,
+ CAL_COMPONENT_ROLE_OPTIONAL,
+ CAL_COMPONENT_ROLE_NON,
+ CAL_COMPONENT_ROLE_UNKNOWN
+} CalComponentRole;
+</ENUM>
+<ENUM>
+<NAME>CalComponentPartStat</NAME>
+typedef enum {
+ CAL_COMPONENT_PARTSTAT_NEEDSACTION,
+ CAL_COMPONENT_PARTSTAT_ACCEPTED,
+ CAL_COMPONENT_PARTSTAT_DECLINED,
+ CAL_COMPONENT_PARTSTAT_TENTATIVE,
+ CAL_COMPONENT_PARTSTAT_DELEGATED,
+ CAL_COMPONENT_PARTSTAT_COMPLETED,
+ CAL_COMPONENT_PARTSTAT_INPROCESS,
+ CAL_COMPONENT_PARTSTAT_UNKNOWN
+} CalComponentPartStat;
+</ENUM>
+<TYPEDEF>
+<NAME>CalComponentAttendee</NAME>
+typedef struct {
+ const char *value;
+
+ const char *member;
+ CalComponentCUType cutype;
+ CalComponentRole role;
+ CalComponentPartStat status;
+ gboolean rsvp;
+
+ const char *delto;
+ const char *delfrom;
+ const char *sentby;
+ const char *cn;
+ const char *language;
+} CalComponentAttendee;
+</TYPEDEF>
+<TYPEDEF>
+<NAME>CalComponentOrganizer</NAME>
+typedef struct {
+ const char *value;
+ const char *sentby;
+ const char *cn;
+ const char *language;
+} CalComponentOrganizer;
+</TYPEDEF>
<STRUCT>
<NAME>CalComponent</NAME>
</STRUCT>
@@ -363,6 +440,16 @@ CalComponent *comp, struct icaltimetype **t
CalComponent *comp, struct icaltimetype *t
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_get_organizer</NAME>
+<RETURNS>void </RETURNS>
+CalComponent *comp, CalComponentOrganizer *organizer
+</FUNCTION>
+<FUNCTION>
+<NAME>cal_component_set_organizer</NAME>
+<RETURNS>void </RETURNS>
+CalComponent *comp, CalComponentOrganizer *organizer
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_get_percent</NAME>
<RETURNS>void </RETURNS>
CalComponent *comp, int **percent
@@ -383,6 +470,16 @@ CalComponent *comp, int **priority
CalComponent *comp, int *priority
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_get_recurid</NAME>
+<RETURNS>void </RETURNS>
+CalComponent *comp, CalComponentRange **recur_id
+</FUNCTION>
+<FUNCTION>
+<NAME>cal_component_set_recurid</NAME>
+<RETURNS>void </RETURNS>
+CalComponent *comp, CalComponentRange *recur_id
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_get_rdate_list</NAME>
<RETURNS>void </RETURNS>
CalComponent *comp, GSList **period_list
@@ -473,6 +570,16 @@ CalComponent *comp, const char **url
CalComponent *comp, const char *url
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_get_attendee_list</NAME>
+<RETURNS>void </RETURNS>
+CalComponent *comp, GSList **attendee_list
+</FUNCTION>
+<FUNCTION>
+<NAME>cal_component_set_attendee_list</NAME>
+<RETURNS>void </RETURNS>
+CalComponent *comp, GSList *attendee_list
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_event_dates_match</NAME>
<RETURNS>gboolean </RETURNS>
CalComponent *comp1, CalComponent *comp2
@@ -532,6 +639,11 @@ int *sequence
<RETURNS>void </RETURNS>
GSList *text_list
</FUNCTION>
+<FUNCTION>
+<NAME>cal_component_free_attendee_list</NAME>
+<RETURNS>void </RETURNS>
+GSList *attendee_list
+</FUNCTION>
<STRUCT>
<NAME>CalComponentAlarm</NAME>
</STRUCT>
@@ -615,11 +727,6 @@ CalComponent *comp
CalComponent *comp, const char *auid
</FUNCTION>
<FUNCTION>
-<NAME>cal_component_free_alarm_uids</NAME>
-<RETURNS>void </RETURNS>
-GList *alarm_uids
-</FUNCTION>
-<FUNCTION>
<NAME>cal_component_alarms_free</NAME>
<RETURNS>void </RETURNS>
CalComponentAlarms *alarms
@@ -630,6 +737,11 @@ CalComponentAlarms *alarms
void
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_alarm_clone</NAME>
+<RETURNS>CalComponentAlarm *</RETURNS>
+CalComponentAlarm *alarm
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_alarm_get_uid</NAME>
<RETURNS>const char *</RETURNS>
CalComponentAlarm *alarm
@@ -767,12 +879,12 @@ time_t t
<FUNCTION>
<NAME>time_week_begin</NAME>
<RETURNS>time_t </RETURNS>
-time_t t
+time_t t, int week_start_day
</FUNCTION>
<FUNCTION>
<NAME>time_week_end</NAME>
<RETURNS>time_t </RETURNS>
-time_t t
+time_t t, int week_start_day
</FUNCTION>
<FUNCTION>
<NAME>time_day_begin</NAME>
diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml
index 004e48674e..0bd957e9c2 100644
--- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml
+++ b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml
@@ -115,6 +115,7 @@ RFC 2445 iCalendar component object.
@CAL_COMPONENT_FIELD_OVERDUE:
@CAL_COMPONENT_FIELD_COLOR:
@CAL_COMPONENT_FIELD_STATUS:
+@CAL_COMPONENT_FIELD_COMPONENT:
@CAL_COMPONENT_FIELD_NUM_FIELDS:
<!-- ##### ENUM CalComponentClassification ##### -->
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 93625da7df..98c3ac55dd 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
@@ -10,46 +10,45 @@
@CAL_COMPONENT_ALARM_PROCEDURE:
@CAL_COMPONENT_ALARM_UNKNOWN:
-<!-- ##### FUNCTION time_from_isodate ##### -->
+<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### -->
<para>
</para>
-@str:
-@Returns:
-<!-- ##### FUNCTION cal_component_get_pilot_status ##### -->
+<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### -->
<para>
</para>
-@comp:
-@pilot_status:
+@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START:
+@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END:
-<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### -->
+<!-- ##### ENUM CalComponentAlarmTriggerType ##### -->
<para>
</para>
-@ir:
-@Returns:
+@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE:
+@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE:
-<!-- ##### FUNCTION get_time_t_hour ##### -->
+<!-- ##### STRUCT CalComponentPrivate ##### -->
<para>
</para>
-@t:
-@Returns:
-<!-- ##### FUNCTION time_from_start_duration ##### -->
+<!-- ##### STRUCT CalObjTime ##### -->
<para>
</para>
-@start:
-@duration:
-@Returns:
+@year:
+@month:
+@day:
+@hour:
+@minute:
+@second:
<!-- ##### ENUM CalRecurType ##### -->
<para>
@@ -64,165 +63,166 @@
@CAL_RECUR_MINUTELY:
@CAL_RECUR_SECONDLY:
-<!-- ##### FUNCTION parse_date ##### -->
+<!-- ##### TYPEDEF CalRecurrence ##### -->
<para>
</para>
-@str:
-@Returns:
-<!-- ##### FUNCTION cal_component_get_pilot_id ##### -->
+<!-- ##### FUNCTION cal_alarm_instance_list_free ##### -->
<para>
</para>
-@comp:
-@pilot_id:
+@list:
-<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### -->
+<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### -->
<para>
</para>
-@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START:
-@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END:
+@trigger: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "")
+End:
+-->
-<!-- ##### FUNCTION isodiff_to_secs ##### -->
+<!-- ##### FUNCTION cal_component_get_first_alarm ##### -->
<para>
</para>
-@str:
+@comp:
@Returns:
-<!-- ##### FUNCTION cal_recur_free ##### -->
+<!-- ##### FUNCTION cal_component_get_next_alarm ##### -->
<para>
</para>
-@r:
+@comp:
+@Returns:
-<!-- ##### FUNCTION time_from_icaltimetype ##### -->
+<!-- ##### FUNCTION cal_component_get_pilot_id ##### -->
<para>
</para>
-@itt:
-@Returns:
+@comp:
+@pilot_id:
-<!-- ##### FUNCTION time_day_hour ##### -->
+<!-- ##### FUNCTION cal_component_get_pilot_status ##### -->
<para>
</para>
-@t:
-@hour:
-@Returns:
+@comp:
+@pilot_status:
-<!-- ##### FUNCTION cal_component_get_first_alarm ##### -->
+<!-- ##### FUNCTION cal_component_set_pilot_id ##### -->
<para>
</para>
@comp:
-@Returns:
+@pilot_id:
-<!-- ##### STRUCT CalComponentPrivate ##### -->
+<!-- ##### FUNCTION cal_component_set_pilot_status ##### -->
<para>
</para>
+@comp:
+@pilot_status:
-<!-- ##### FUNCTION isodiff_from_secs ##### -->
+<!-- ##### FUNCTION cal_recur_free ##### -->
<para>
</para>
-@secs:
-@Returns:
+@r:
-<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### -->
+<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### -->
<para>
</para>
-@trigger: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "")
-End:
--->
+@ir:
+@Returns:
-<!-- ##### TYPEDEF CalRecurrence ##### -->
+<!-- ##### FUNCTION format_simple_hour ##### -->
<para>
</para>
+@hour:
+@use_am_pm:
+@Returns:
-<!-- ##### FUNCTION cal_alarm_instance_list_free ##### -->
+<!-- ##### FUNCTION get_time_t_hour ##### -->
<para>
</para>
-@list:
+@t:
+@Returns:
-<!-- ##### FUNCTION cal_component_set_pilot_status ##### -->
+<!-- ##### FUNCTION isodiff_from_secs ##### -->
<para>
</para>
-@comp:
-@pilot_status:
+@secs:
+@Returns:
-<!-- ##### FUNCTION cal_component_set_pilot_id ##### -->
+<!-- ##### FUNCTION isodiff_to_secs ##### -->
<para>
</para>
-@comp:
-@pilot_id:
+@str:
+@Returns:
-<!-- ##### STRUCT CalObjTime ##### -->
+<!-- ##### FUNCTION parse_date ##### -->
<para>
</para>
-@year:
-@month:
-@day:
-@hour:
-@minute:
-@second:
+@str:
+@Returns:
-<!-- ##### FUNCTION format_simple_hour ##### -->
+<!-- ##### FUNCTION time_day_hour ##### -->
<para>
</para>
+@t:
@hour:
-@use_am_pm:
@Returns:
-<!-- ##### FUNCTION cal_component_get_next_alarm ##### -->
+<!-- ##### FUNCTION time_from_icaltimetype ##### -->
<para>
</para>
-@comp:
+@itt:
@Returns:
-<!-- ##### ENUM CalComponentAlarmTriggerType ##### -->
+<!-- ##### FUNCTION time_from_isodate ##### -->
<para>
</para>
-@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE:
-@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE:
+@str:
+@Returns:
-<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### -->
+<!-- ##### FUNCTION time_from_start_duration ##### -->
<para>
</para>
+@start:
+@duration:
+@Returns:
diff --git a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml
index 2b197ad685..2e7e15988d 100644
--- a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml
+++ b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml
@@ -136,6 +136,7 @@ timeutil
</para>
@t:
+@week_start_day:
@Returns:
@@ -145,6 +146,7 @@ timeutil
</para>
@t:
+@week_start_day:
@Returns: