diff options
Diffstat (limited to 'help/devel/calendar/cal-util/evolution-cal-util-decl.txt')
| -rw-r--r-- | help/devel/calendar/cal-util/evolution-cal-util-decl.txt | 320 |
1 files changed, 109 insertions, 211 deletions
diff --git a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt index eb108b868f..f190d325fc 100644 --- a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -114,9 +114,6 @@ typedef enum { } CalComponentTransparency; </ENUM> <STRUCT> -<NAME>CalComponentAlarm</NAME> -</STRUCT> -<STRUCT> <NAME>CalComponent</NAME> </STRUCT> <STRUCT> @@ -305,16 +302,36 @@ CalComponent *comp, GSList **exdate_list CalComponent *comp, GSList *exdate_list </FUNCTION> <FUNCTION> +<NAME>cal_component_has_exdates</NAME> +<RETURNS>gboolean </RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> <NAME>cal_component_get_exrule_list</NAME> <RETURNS>void </RETURNS> CalComponent *comp, GSList **recur_list </FUNCTION> <FUNCTION> +<NAME>cal_component_get_exrule_property_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList **recur_list +</FUNCTION> +<FUNCTION> <NAME>cal_component_set_exrule_list</NAME> <RETURNS>void </RETURNS> CalComponent *comp, GSList *recur_list </FUNCTION> <FUNCTION> +<NAME>cal_component_has_exrules</NAME> +<RETURNS>gboolean </RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_has_exceptions</NAME> +<RETURNS>gboolean </RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> <NAME>cal_component_get_geo</NAME> <RETURNS>void </RETURNS> CalComponent *comp, struct icalgeotype **geo @@ -375,6 +392,11 @@ CalComponent *comp CalComponent *comp, GSList **recur_list </FUNCTION> <FUNCTION> +<NAME>cal_component_get_rrule_property_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList **recur_list +</FUNCTION> +<FUNCTION> <NAME>cal_component_set_rrule_list</NAME> <RETURNS>void </RETURNS> CalComponent *comp, GSList *recur_list @@ -385,6 +407,11 @@ CalComponent *comp, GSList *recur_list CalComponent *comp </FUNCTION> <FUNCTION> +<NAME>cal_component_has_recurrences</NAME> +<RETURNS>gboolean </RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> <NAME>cal_component_get_sequence</NAME> <RETURNS>void </RETURNS> CalComponent *comp, int **sequence @@ -395,6 +422,16 @@ CalComponent *comp, int **sequence CalComponent *comp, int *sequence </FUNCTION> <FUNCTION> +<NAME>cal_component_get_status</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, icalproperty_status *status +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_status</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, icalproperty_status status +</FUNCTION> +<FUNCTION> <NAME>cal_component_get_summary</NAME> <RETURNS>void </RETURNS> CalComponent *comp, CalComponentText *summary @@ -425,26 +462,6 @@ CalComponent *comp, const char **url CalComponent *comp, const char *url </FUNCTION> <FUNCTION> -<NAME>cal_component_get_pilot_id</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, unsigned long *pilot_id -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_pilot_id</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, unsigned long pilot_id -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_pilot_status</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, unsigned long *pilot_status -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_pilot_status</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, unsigned long pilot_status -</FUNCTION> -<FUNCTION> <NAME>cal_component_free_categories_list</NAME> <RETURNS>void </RETURNS> GSList *categ_list @@ -499,167 +516,119 @@ int *sequence <RETURNS>void </RETURNS> GSList *text_list </FUNCTION> +<STRUCT> +<NAME>CalComponentAlarm</NAME> +</STRUCT> +<TYPEDEF> +<NAME>CalAlarmInstance</NAME> +typedef struct { + /* UID of the alarm that triggered */ + const char *auid; + + /* Trigger time, i.e. "5 minutes before the appointment" */ + time_t trigger; + + /* Actual event occurrence to which this trigger corresponds */ + time_t occur; +} CalAlarmInstance; +</TYPEDEF> +<TYPEDEF> +<NAME>CalComponentAlarms</NAME> +typedef struct { + /* The actual component */ + CalComponent *comp; + + /* List of CalAlarmInstance structures */ + GSList *alarms; +} CalComponentAlarms; +</TYPEDEF> <ENUM> -<NAME>CalComponentAlarmAction</NAME> -typedef enum { - CAL_COMPONENT_ALARM_NONE, - CAL_COMPONENT_ALARM_AUDIO, - CAL_COMPONENT_ALARM_DISPLAY, - CAL_COMPONENT_ALARM_EMAIL, - CAL_COMPONENT_ALARM_PROCEDURE, - CAL_COMPONENT_ALARM_UNKNOWN -} CalComponentAlarmAction; -</ENUM> -<ENUM> -<NAME>CalComponentAlarmTriggerType</NAME> +<NAME>CalAlarmAction</NAME> typedef enum { - CAL_COMPONENT_ALARM_TRIGGER_RELATIVE, - CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE -} CalComponentAlarmTriggerType; + CAL_ALARM_NONE, + CAL_ALARM_AUDIO, + CAL_ALARM_DISPLAY, + CAL_ALARM_EMAIL, + CAL_ALARM_PROCEDURE, + CAL_ALARM_UNKNOWN +} CalAlarmAction; </ENUM> <ENUM> -<NAME>CalComponentAlarmTriggerRelated</NAME> +<NAME>CalAlarmTriggerType</NAME> typedef enum { - CAL_COMPONENT_ALARM_TRIGGER_RELATED_START, - CAL_COMPONENT_ALARM_TRIGGER_RELATED_END -} CalComponentAlarmTriggerRelated; + CAL_ALARM_TRIGGER_NONE, + CAL_ALARM_TRIGGER_RELATIVE_START, + CAL_ALARM_TRIGGER_RELATIVE_END, + CAL_ALARM_TRIGGER_ABSOLUTE +} CalAlarmTriggerType; </ENUM> <TYPEDEF> -<NAME>CalComponentAlarmTrigger</NAME> +<NAME>CalAlarmTrigger</NAME> typedef struct { - CalComponentAlarmTriggerType type; + CalAlarmTriggerType type; union { - struct { - struct icaldurationtype duration; - CalComponentAlarmTriggerRelated related; - } relative; - - struct icaltimetype absolute; + struct icaldurationtype rel_duration; + struct icaltimetype abs_time; } u; -} CalComponentAlarmTrigger; +} CalAlarmTrigger; </TYPEDEF> <FUNCTION> -<NAME>cal_component_get_first_alarm</NAME> -<RETURNS>CalComponentAlarm *</RETURNS> +<NAME>cal_component_has_alarms</NAME> +<RETURNS>gboolean </RETURNS> CalComponent *comp </FUNCTION> <FUNCTION> -<NAME>cal_component_get_next_alarm</NAME> -<RETURNS>CalComponentAlarm *</RETURNS> +<NAME>cal_component_get_alarm_uids</NAME> +<RETURNS>GList *</RETURNS> CalComponent *comp </FUNCTION> <FUNCTION> +<NAME>cal_component_get_alarm</NAME> +<RETURNS>CalComponentAlarm *</RETURNS> +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_get_uid</NAME> +<RETURNS>const char *</RETURNS> +CalComponentAlarm *alarm +</FUNCTION> +<FUNCTION> <NAME>cal_component_alarm_get_action</NAME> <RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentAlarmAction *action +CalComponentAlarm *alarm, CalAlarmAction *action </FUNCTION> <FUNCTION> <NAME>cal_component_alarm_set_action</NAME> <RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentAlarmAction action +CalComponentAlarm *alarm, CalAlarmAction action </FUNCTION> <FUNCTION> <NAME>cal_component_alarm_get_trigger</NAME> <RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentAlarmTrigger **trigger +CalComponentAlarm *alarm, CalAlarmTrigger *trigger </FUNCTION> <FUNCTION> <NAME>cal_component_alarm_set_trigger</NAME> <RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentAlarmTrigger *trigger -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_free_trigger</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarmTrigger *trigger +CalComponentAlarm *alarm, CalAlarmTrigger trigger </FUNCTION> -<ENUM> -<NAME>CalRecurType</NAME> -typedef enum { - CAL_RECUR_YEARLY, - CAL_RECUR_MONTHLY, - CAL_RECUR_WEEKLY, - CAL_RECUR_DAILY, - CAL_RECUR_HOURLY, - CAL_RECUR_MINUTELY, - CAL_RECUR_SECONDLY -} CalRecurType; -</ENUM> -<TYPEDEF> -<NAME>CalRecurrence</NAME> -typedef struct { - CalRecurType type; - - int interval; - - /* Specifies the end of the recurrence. No occurrences are generated - after this date. If it is 0, the event recurs forever. */ - time_t enddate; - - /* WKST property - the week start day: 0 = Monday to 6 = Sunday. */ - gint week_start_day; - - - /* NOTE: I've used GList's here, but it doesn't matter if we use - other data structures like arrays. The code should be easy to - change. So long as it is easy to see if the modifier is set. */ - - /* For BYMONTH modifier. A list of GINT_TO_POINTERs, 0-11. */ - GList *bymonth; - - /* For BYWEEKNO modifier. A list of GINT_TO_POINTERs, [+-]1-53. */ - GList *byweekno; - - /* For BYYEARDAY modifier. A list of GINT_TO_POINTERs, [+-]1-366. */ - GList *byyearday; - - /* For BYMONTHDAY modifier. A list of GINT_TO_POINTERs, [+-]1-31. */ - GList *bymonthday; - - /* For BYDAY modifier. A list of GINT_TO_POINTERs, in pairs. - The first of each pair is the weekday, 0 = Monday to 6 = Sunday. - The second of each pair is the week number [+-]0-53. */ - GList *byday; - - /* For BYHOUR modifier. A list of GINT_TO_POINTERs, 0-23. */ - GList *byhour; - - /* For BYMINUTE modifier. A list of GINT_TO_POINTERs, 0-59. */ - GList *byminute; - - /* For BYSECOND modifier. A list of GINT_TO_POINTERs, 0-60. */ - GList *bysecond; - - /* For BYSETPOS modifier. A list of GINT_TO_POINTERs, +ve or -ve. */ - GList *bysetpos; -} CalRecurrence; -</TYPEDEF> -<STRUCT> -<NAME>CalObjTime</NAME> -</STRUCT> -<STRUCT> -<NAME>CalObjTime</NAME> -struct CalObjTime { - guint16 year; - guint8 month; /* 0 - 11 */ - guint8 day; /* 1 - 31 */ - guint8 hour; /* 0 - 23 */ - guint8 minute; /* 0 - 59 */ - guint8 second; /* 0 - 59 (maybe 60 for leap second) */ -}; -</STRUCT> <USER_FUNCTION> <NAME>CalRecurInstanceFn</NAME> <RETURNS>gboolean </RETURNS> CalComponent *comp, time_t instance_start, - time_t instace_end, + time_t instance_end, gpointer data </USER_FUNCTION> <FUNCTION> @@ -667,16 +636,6 @@ CalComponent *comp, <RETURNS>void </RETURNS> CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data </FUNCTION> -<FUNCTION> -<NAME>cal_recur_from_icalrecurrencetype</NAME> -<RETURNS>CalRecurrence *</RETURNS> -struct icalrecurrencetype *ir -</FUNCTION> -<FUNCTION> -<NAME>cal_recur_free</NAME> -<RETURNS>void </RETURNS> -CalRecurrence *r -</FUNCTION> <TYPEDEF> <NAME>CalObjInstance</NAME> typedef struct { @@ -690,22 +649,6 @@ typedef struct { <RETURNS>void </RETURNS> GList *list </FUNCTION> -<TYPEDEF> -<NAME>CalAlarmInstance</NAME> -typedef struct { - char *uid; /* UID of object */ -#if 0 - enum AlarmType type; /* Type of alarm */ -#endif - time_t trigger; /* Alarm trigger time */ - time_t occur; /* Occurrence time */ -} CalAlarmInstance; -</TYPEDEF> -<FUNCTION> -<NAME>cal_alarm_instance_list_free</NAME> -<RETURNS>void </RETURNS> -GList *list -</FUNCTION> <ENUM> <NAME>CalObjType</NAME> typedef enum { @@ -721,41 +664,11 @@ typedef enum { GList *list </FUNCTION> <FUNCTION> -<NAME>time_from_icaltimetype</NAME> -<RETURNS>time_t </RETURNS> -struct icaltimetype itt -</FUNCTION> -<FUNCTION> -<NAME>time_from_isodate</NAME> -<RETURNS>time_t </RETURNS> -char *str -</FUNCTION> -<FUNCTION> -<NAME>time_from_start_duration</NAME> -<RETURNS>time_t </RETURNS> -time_t start, char *duration -</FUNCTION> -<FUNCTION> <NAME>isodate_from_time_t</NAME> <RETURNS>char *</RETURNS> time_t t </FUNCTION> <FUNCTION> -<NAME>get_time_t_hour</NAME> -<RETURNS>int </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>isodiff_to_secs</NAME> -<RETURNS>int </RETURNS> -char *str -</FUNCTION> -<FUNCTION> -<NAME>isodiff_from_secs</NAME> -<RETURNS>char *</RETURNS> -int secs -</FUNCTION> -<FUNCTION> <NAME>time_add_minutes</NAME> <RETURNS>time_t </RETURNS> time_t time, int minutes @@ -781,11 +694,6 @@ time_t time, int months time_t time, int years </FUNCTION> <FUNCTION> -<NAME>format_simple_hour</NAME> -<RETURNS>char *</RETURNS> -int hour, int use_am_pm -</FUNCTION> -<FUNCTION> <NAME>time_days_in_month</NAME> <RETURNS>int </RETURNS> int year, int month @@ -796,11 +704,6 @@ int year, int month int year, int month, int day </FUNCTION> <FUNCTION> -<NAME>time_day_hour</NAME> -<RETURNS>time_t </RETURNS> -time_t t, int hour -</FUNCTION> -<FUNCTION> <NAME>time_year_begin</NAME> <RETURNS>time_t </RETURNS> time_t t @@ -841,11 +744,6 @@ time_t t time_t t </FUNCTION> <FUNCTION> -<NAME>parse_date</NAME> -<RETURNS>time_t </RETURNS> -char *str -</FUNCTION> -<FUNCTION> <NAME>print_time_t</NAME> <RETURNS>void </RETURNS> time_t t |