From 6ed6055392bd305b99ab52179911d66f68734eb6 Mon Sep 17 00:00:00 2001 From: Jeffrey Stedfast Date: Tue, 15 May 2001 19:34:22 +0000 Subject: yes, I am a dumbass svn path=/trunk/; revision=9826 --- .../calendar/cal-util/evolution-cal-util-decl.txt | 791 +++++++++++++++++++++ 1 file changed, 791 insertions(+) create mode 100644 help/devel/calendar/cal-util/evolution-cal-util-decl.txt (limited to 'help') diff --git a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt new file mode 100644 index 0000000000..6f6994d8c4 --- /dev/null +++ b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -0,0 +1,791 @@ + +CAL_COMPONENT_TYPE +#define CAL_COMPONENT_TYPE (cal_component_get_type ()) + + +CAL_COMPONENT +#define CAL_COMPONENT(obj) (GTK_CHECK_CAST ((obj), CAL_COMPONENT_TYPE, CalComponent)) + + +CAL_COMPONENT_CLASS +#define CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_COMPONENT_TYPE, \ + CalComponentClass)) + + +IS_CAL_COMPONENT +#define IS_CAL_COMPONENT(obj) (GTK_CHECK_TYPE ((obj), CAL_COMPONENT_TYPE)) + + +IS_CAL_COMPONENT_CLASS +#define IS_CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_COMPONENT_TYPE)) + + +CalComponentVType +typedef enum { + CAL_COMPONENT_NO_TYPE, + CAL_COMPONENT_EVENT, + CAL_COMPONENT_TODO, + CAL_COMPONENT_JOURNAL, + CAL_COMPONENT_FREEBUSY, + CAL_COMPONENT_TIMEZONE +} CalComponentVType; + + +CalComponentField +typedef enum { + CAL_COMPONENT_FIELD_CATEGORIES, /* concatenation of the categories list */ + CAL_COMPONENT_FIELD_CLASSIFICATION, + CAL_COMPONENT_FIELD_COMPLETED, + CAL_COMPONENT_FIELD_DTEND, + CAL_COMPONENT_FIELD_DTSTART, + CAL_COMPONENT_FIELD_DUE, + CAL_COMPONENT_FIELD_GEO, + CAL_COMPONENT_FIELD_PERCENT, + CAL_COMPONENT_FIELD_PRIORITY, + CAL_COMPONENT_FIELD_SUMMARY, + CAL_COMPONENT_FIELD_TRANSPARENCY, + CAL_COMPONENT_FIELD_URL, + CAL_COMPONENT_FIELD_HAS_ALARMS, /* not a real field */ + CAL_COMPONENT_FIELD_ICON, /* not a real field */ + CAL_COMPONENT_FIELD_COMPLETE, /* not a real field */ + CAL_COMPONENT_FIELD_RECURRING, /* not a real field */ + CAL_COMPONENT_FIELD_OVERDUE, /* not a real field */ + CAL_COMPONENT_FIELD_COLOR, /* not a real field */ + CAL_COMPONENT_FIELD_STATUS, + CAL_COMPONENT_FIELD_NUM_FIELDS +} CalComponentField; + + +CalComponentClassification +typedef enum { + CAL_COMPONENT_CLASS_NONE, + CAL_COMPONENT_CLASS_PUBLIC, + CAL_COMPONENT_CLASS_PRIVATE, + CAL_COMPONENT_CLASS_CONFIDENTIAL, + CAL_COMPONENT_CLASS_UNKNOWN +} CalComponentClassification; + + +CalComponentDateTime +typedef struct { + /* Actual date/time value */ + struct icaltimetype *value; + + /* Timezone ID */ + const char *tzid; +} CalComponentDateTime; + + +CalComponentPeriodType +typedef enum { + CAL_COMPONENT_PERIOD_DATETIME, + CAL_COMPONENT_PERIOD_DURATION +} CalComponentPeriodType; + + +CalComponentPeriod +typedef struct { + CalComponentPeriodType type; + + struct icaltimetype start; + + union { + struct icaltimetype end; + struct icaldurationtype duration; + } u; +} CalComponentPeriod; + + +CalComponentText +typedef struct { + /* Description string */ + const char *value; + + /* Alternate representation URI */ + const char *altrep; +} CalComponentText; + + +CalComponentTransparency +typedef enum { + CAL_COMPONENT_TRANSP_NONE, + CAL_COMPONENT_TRANSP_TRANSPARENT, + CAL_COMPONENT_TRANSP_OPAQUE, + CAL_COMPONENT_TRANSP_UNKNOWN +} CalComponentTransparency; + + +CalComponent + + +CalComponentClass + + +CalComponentPrivate + + +CalComponent +struct CalComponent { + GtkObject object; + + /* Private data */ + CalComponentPrivate *priv; +}; + + +cal_component_get_type +GtkType +void + + +cal_component_gen_uid +char * +void + + +cal_component_new +CalComponent * +void + + +cal_component_clone +CalComponent * +CalComponent *comp + + +cal_component_set_new_vtype +void +CalComponent *comp, CalComponentVType type + + +cal_component_set_icalcomponent +gboolean +CalComponent *comp, icalcomponent *icalcomp + + +cal_component_get_icalcomponent +icalcomponent * +CalComponent *comp + + +cal_component_get_vtype +CalComponentVType +CalComponent *comp + + +cal_component_get_as_string +char * +CalComponent *comp + + +cal_component_commit_sequence +void +CalComponent *comp + + +cal_component_get_uid +void +CalComponent *comp, const char **uid + + +cal_component_set_uid +void +CalComponent *comp, const char *uid + + +cal_component_get_categories +void +CalComponent *comp, const char **categories + + +cal_component_set_categories +void +CalComponent *comp, const char *categories + + +cal_component_get_categories_list +void +CalComponent *comp, GSList **categ_list + + +cal_component_set_categories_list +void +CalComponent *comp, GSList *categ_list + + +cal_component_get_classification +void +CalComponent *comp, CalComponentClassification *classif + + +cal_component_set_classification +void +CalComponent *comp, CalComponentClassification classif + + +cal_component_get_comment_list +void +CalComponent *comp, GSList **text_list + + +cal_component_set_comment_list +void +CalComponent *comp, GSList *text_list + + +cal_component_get_completed +void +CalComponent *comp, struct icaltimetype **t + + +cal_component_set_completed +void +CalComponent *comp, struct icaltimetype *t + + +cal_component_get_created +void +CalComponent *comp, struct icaltimetype **t + + +cal_component_set_created +void +CalComponent *comp, struct icaltimetype *t + + +cal_component_get_description_list +void +CalComponent *comp, GSList **text_list + + +cal_component_set_description_list +void +CalComponent *comp, GSList *text_list + + +cal_component_get_dtend +void +CalComponent *comp, CalComponentDateTime *dt + + +cal_component_set_dtend +void +CalComponent *comp, CalComponentDateTime *dt + + +cal_component_get_dtstamp +void +CalComponent *comp, struct icaltimetype *t + + +cal_component_set_dtstamp +void +CalComponent *comp, struct icaltimetype *t + + +cal_component_get_dtstart +void +CalComponent *comp, CalComponentDateTime *dt + + +cal_component_set_dtstart +void +CalComponent *comp, CalComponentDateTime *dt + + +cal_component_get_due +void +CalComponent *comp, CalComponentDateTime *dt + + +cal_component_set_due +void +CalComponent *comp, CalComponentDateTime *dt + + +cal_component_get_exdate_list +void +CalComponent *comp, GSList **exdate_list + + +cal_component_set_exdate_list +void +CalComponent *comp, GSList *exdate_list + + +cal_component_has_exdates +gboolean +CalComponent *comp + + +cal_component_get_exrule_list +void +CalComponent *comp, GSList **recur_list + + +cal_component_get_exrule_property_list +void +CalComponent *comp, GSList **recur_list + + +cal_component_set_exrule_list +void +CalComponent *comp, GSList *recur_list + + +cal_component_has_exrules +gboolean +CalComponent *comp + + +cal_component_has_exceptions +gboolean +CalComponent *comp + + +cal_component_get_geo +void +CalComponent *comp, struct icalgeotype **geo + + +cal_component_set_geo +void +CalComponent *comp, struct icalgeotype *geo + + +cal_component_get_last_modified +void +CalComponent *comp, struct icaltimetype **t + + +cal_component_set_last_modified +void +CalComponent *comp, struct icaltimetype *t + + +cal_component_get_percent +void +CalComponent *comp, int **percent + + +cal_component_set_percent +void +CalComponent *comp, int *percent + + +cal_component_get_priority +void +CalComponent *comp, int **priority + + +cal_component_set_priority +void +CalComponent *comp, int *priority + + +cal_component_get_rdate_list +void +CalComponent *comp, GSList **period_list + + +cal_component_set_rdate_list +void +CalComponent *comp, GSList *period_list + + +cal_component_has_rdates +gboolean +CalComponent *comp + + +cal_component_get_rrule_list +void +CalComponent *comp, GSList **recur_list + + +cal_component_get_rrule_property_list +void +CalComponent *comp, GSList **recur_list + + +cal_component_set_rrule_list +void +CalComponent *comp, GSList *recur_list + + +cal_component_has_rrules +gboolean +CalComponent *comp + + +cal_component_has_recurrences +gboolean +CalComponent *comp + + +cal_component_get_sequence +void +CalComponent *comp, int **sequence + + +cal_component_set_sequence +void +CalComponent *comp, int *sequence + + +cal_component_get_status +void +CalComponent *comp, icalproperty_status *status + + +cal_component_set_status +void +CalComponent *comp, icalproperty_status status + + +cal_component_get_summary +void +CalComponent *comp, CalComponentText *summary + + +cal_component_set_summary +void +CalComponent *comp, CalComponentText *summary + + +cal_component_get_transparency +void +CalComponent *comp, CalComponentTransparency *transp + + +cal_component_set_transparency +void +CalComponent *comp, CalComponentTransparency transp + + +cal_component_get_url +void +CalComponent *comp, const char **url + + +cal_component_set_url +void +CalComponent *comp, const char *url + + +cal_component_event_dates_match +gboolean +CalComponent *comp1, CalComponent *comp2 + + +cal_component_free_categories_list +void +GSList *categ_list + + +cal_component_free_datetime +void +CalComponentDateTime *dt + + +cal_component_free_exdate_list +void +GSList *exdate_list + + +cal_component_free_geo +void +struct icalgeotype *geo + + +cal_component_free_icaltimetype +void +struct icaltimetype *t + + +cal_component_free_percent +void +int *percent + + +cal_component_free_priority +void +int *priority + + +cal_component_free_period_list +void +GSList *period_list + + +cal_component_free_recur_list +void +GSList *recur_list + + +cal_component_free_sequence +void +int *sequence + + +cal_component_free_text_list +void +GSList *text_list + + +CalComponentAlarm + + +CalAlarmInstance +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; + + +CalComponentAlarms +typedef struct { + /* The actual component */ + CalComponent *comp; + + /* List of CalAlarmInstance structures */ + GSList *alarms; +} CalComponentAlarms; + + +CalAlarmAction +typedef enum { + CAL_ALARM_NONE, + CAL_ALARM_AUDIO, + CAL_ALARM_DISPLAY, + CAL_ALARM_EMAIL, + CAL_ALARM_PROCEDURE, + CAL_ALARM_UNKNOWN +} CalAlarmAction; + + +CalAlarmTriggerType +typedef enum { + CAL_ALARM_TRIGGER_NONE, + CAL_ALARM_TRIGGER_RELATIVE_START, + CAL_ALARM_TRIGGER_RELATIVE_END, + CAL_ALARM_TRIGGER_ABSOLUTE +} CalAlarmTriggerType; + + +CalAlarmTrigger +typedef struct { + CalAlarmTriggerType type; + + union { + struct icaldurationtype rel_duration; + struct icaltimetype abs_time; + } u; +} CalAlarmTrigger; + + +cal_component_has_alarms +gboolean +CalComponent *comp + + +cal_component_add_alarm +void +CalComponent *comp, CalComponentAlarm *alarm + + +cal_component_remove_alarm +void +CalComponent *comp, const char *auid + + +cal_component_get_alarm_uids +GList * +CalComponent *comp + + +cal_component_get_alarm +CalComponentAlarm * +CalComponent *comp, const char *auid + + +cal_component_free_alarm_uids +void +GList *alarm_uids + + +cal_component_alarms_free +void +CalComponentAlarms *alarms + + +cal_component_alarm_new +CalComponentAlarm * +void + + +cal_component_alarm_get_uid +const char * +CalComponentAlarm *alarm + + +cal_component_alarm_get_action +void +CalComponentAlarm *alarm, CalAlarmAction *action + + +cal_component_alarm_set_action +void +CalComponentAlarm *alarm, CalAlarmAction action + + +cal_component_alarm_get_trigger +void +CalComponentAlarm *alarm, CalAlarmTrigger *trigger + + +cal_component_alarm_set_trigger +void +CalComponentAlarm *alarm, CalAlarmTrigger trigger + + +cal_component_alarm_free +void +CalComponentAlarm *alarm + + +CalRecurInstanceFn +gboolean +CalComponent *comp, + time_t instance_start, + time_t instance_end, + gpointer data + + +cal_recur_generate_instances +void +CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer 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 + + +isodate_from_time_t +char * +time_t t + + +time_from_isodate +time_t +const char *str + + +time_add_minutes +time_t +time_t time, int minutes + + +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_add_year +time_t +time_t time, int years + + +time_days_in_month +int +int year, int month + + +time_from_day +time_t +int year, int month, int day + + +time_year_begin +time_t +time_t t + + +time_year_end +time_t +time_t t + + +time_month_begin +time_t +time_t t + + +time_month_end +time_t +time_t t + + +time_week_begin +time_t +time_t t + + +time_week_end +time_t +time_t t + + +time_day_begin +time_t +time_t t + + +time_day_end +time_t +time_t t + + +print_time_t +void +time_t t + -- cgit v1.2.3