diff options
Diffstat (limited to 'doc/devel/calendar/cal-util')
-rw-r--r-- | doc/devel/calendar/cal-util/.cvsignore | 3 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/Makefile.am | 75 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/evolution-cal-util-decl.txt | 852 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/evolution-cal-util-sections.txt | 166 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/evolution-cal-util.args | 0 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/evolution-cal-util.hierarchy | 2 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/evolution-cal-util.signals | 0 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/evolution-cal-util.types | 4 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/tmpl/cal-component.sgml | 934 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/tmpl/cal-recur.sgml | 88 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/tmpl/cal-util.sgml | 62 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml | 0 | ||||
-rw-r--r-- | doc/devel/calendar/cal-util/tmpl/timeutil.sgml | 260 |
13 files changed, 2446 insertions, 0 deletions
diff --git a/doc/devel/calendar/cal-util/.cvsignore b/doc/devel/calendar/cal-util/.cvsignore new file mode 100644 index 0000000000..0842a93f7a --- /dev/null +++ b/doc/devel/calendar/cal-util/.cvsignore @@ -0,0 +1,3 @@ +sgml +Makefile +Makefile.in diff --git a/doc/devel/calendar/cal-util/Makefile.am b/doc/devel/calendar/cal-util/Makefile.am new file mode 100644 index 0000000000..8861aa03cb --- /dev/null +++ b/doc/devel/calendar/cal-util/Makefile.am @@ -0,0 +1,75 @@ +## Process this file with automake to produce Makefile.in + +# The name of the module. +DOC_MODULE=evolution-cal-util + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=evolution-cal-util.sgml + +# The directory containing the source code (if it contains documentation). +DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-util + +CFLAGS =" \ + -I$(top_srcdir)/calendar \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + -I$(top_builddir)/libical/src/libical \ + -I$(top_srcdir)/libical/src/libical \ + $(BONOBO_VFS_GNOME_CFLAGS) \ + " + +LDFLAGS=" \ + $(BONOBO_VFS_GNOME_LIBS) \ + $(top_builddir)/calendar/cal-util/.libs/libcal-util.a \ + $(top_builddir)/libical/src/libical/libical.a \ + $(top_builddir)/libversit/.libs/libversit.al \ + " + +HTML_DIR=$(datadir)/gnome/html + +TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) + +tmpl_sources = \ + tmpl/cal-util.sgml \ + tmpl/evolution-cal-util-unused.sgml + +evolution_cal_util_docdir = $(HTML_DIR) +evolution_cal_util_doc_DATA = \ + evolution-cal-util.hierarchy \ + evolution-cal-util.types \ + evolution-cal-util-decl.txt \ + evolution-cal-util-sections.txt + +EXTRA_DIST = \ + $(evolution_cal_util_doc_DATA) + +sgml/evolution-cal-util-doc.bottom: $(tmpl_sources) + $(MAKE) sgml + +scan: + -(cd $(srcdir) \ + && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ + gtkdoc-scanobj --module=$(DOC_MODULE) \ + && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="calobj.h icalendar-save.h icalendar.h" ) + +templates: scan + cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) + +sgml: + cd $(srcdir) \ + && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) + +clean-local: + rm -f *~ *.bak *.signals *-unused.txt + +maintainer-clean-local: clean + cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + +dist-hook: + mkdir $(distdir)/sgml + mkdir $(distdir)/tmpl + -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl + -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml + -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml + +.PHONY : sgml templates scan diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt new file mode 100644 index 0000000000..eb108b868f --- /dev/null +++ b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -0,0 +1,852 @@ +<MACRO> +<NAME>CAL_COMPONENT_TYPE</NAME> +#define CAL_COMPONENT_TYPE (cal_component_get_type ()) +</MACRO> +<MACRO> +<NAME>CAL_COMPONENT</NAME> +#define CAL_COMPONENT(obj) (GTK_CHECK_CAST ((obj), CAL_COMPONENT_TYPE, CalComponent)) +</MACRO> +<MACRO> +<NAME>CAL_COMPONENT_CLASS</NAME> +#define CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_COMPONENT_TYPE, \ + CalComponentClass)) +</MACRO> +<MACRO> +<NAME>IS_CAL_COMPONENT</NAME> +#define IS_CAL_COMPONENT(obj) (GTK_CHECK_TYPE ((obj), CAL_COMPONENT_TYPE)) +</MACRO> +<MACRO> +<NAME>IS_CAL_COMPONENT_CLASS</NAME> +#define IS_CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_COMPONENT_TYPE)) +</MACRO> +<ENUM> +<NAME>CalComponentVType</NAME> +typedef enum { + CAL_COMPONENT_NO_TYPE, + CAL_COMPONENT_EVENT, + CAL_COMPONENT_TODO, + CAL_COMPONENT_JOURNAL, + CAL_COMPONENT_FREEBUSY, + CAL_COMPONENT_TIMEZONE +} CalComponentVType; +</ENUM> +<ENUM> +<NAME>CalComponentField</NAME> +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_NUM_FIELDS +} CalComponentField; +</ENUM> +<ENUM> +<NAME>CalComponentClassification</NAME> +typedef enum { + CAL_COMPONENT_CLASS_NONE, + CAL_COMPONENT_CLASS_PUBLIC, + CAL_COMPONENT_CLASS_PRIVATE, + CAL_COMPONENT_CLASS_CONFIDENTIAL, + CAL_COMPONENT_CLASS_UNKNOWN +} CalComponentClassification; +</ENUM> +<TYPEDEF> +<NAME>CalComponentDateTime</NAME> +typedef struct { + /* Actual date/time value */ + struct icaltimetype *value; + + /* Timezone ID */ + const char *tzid; +} CalComponentDateTime; +</TYPEDEF> +<ENUM> +<NAME>CalComponentPeriodType</NAME> +typedef enum { + CAL_COMPONENT_PERIOD_DATETIME, + CAL_COMPONENT_PERIOD_DURATION +} CalComponentPeriodType; +</ENUM> +<TYPEDEF> +<NAME>CalComponentPeriod</NAME> +typedef struct { + CalComponentPeriodType type; + + struct icaltimetype start; + + union { + struct icaltimetype end; + struct icaldurationtype duration; + } u; +} CalComponentPeriod; +</TYPEDEF> +<TYPEDEF> +<NAME>CalComponentText</NAME> +typedef struct { + /* Description string */ + const char *value; + + /* Alternate representation URI */ + const char *altrep; +} CalComponentText; +</TYPEDEF> +<ENUM> +<NAME>CalComponentTransparency</NAME> +typedef enum { + CAL_COMPONENT_TRANSP_NONE, + CAL_COMPONENT_TRANSP_TRANSPARENT, + CAL_COMPONENT_TRANSP_OPAQUE, + CAL_COMPONENT_TRANSP_UNKNOWN +} CalComponentTransparency; +</ENUM> +<STRUCT> +<NAME>CalComponentAlarm</NAME> +</STRUCT> +<STRUCT> +<NAME>CalComponent</NAME> +</STRUCT> +<STRUCT> +<NAME>CalComponentClass</NAME> +</STRUCT> +<STRUCT> +<NAME>CalComponentPrivate</NAME> +</STRUCT> +<STRUCT> +<NAME>CalComponent</NAME> +struct CalComponent { + GtkObject object; + + /* Private data */ + CalComponentPrivate *priv; +}; +</STRUCT> +<FUNCTION> +<NAME>cal_component_get_type</NAME> +<RETURNS>GtkType </RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>cal_component_gen_uid</NAME> +<RETURNS>char *</RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>cal_component_new</NAME> +<RETURNS>CalComponent *</RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>cal_component_clone</NAME> +<RETURNS>CalComponent *</RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_new_vtype</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentVType type +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_icalcomponent</NAME> +<RETURNS>gboolean </RETURNS> +CalComponent *comp, icalcomponent *icalcomp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_icalcomponent</NAME> +<RETURNS>icalcomponent *</RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_vtype</NAME> +<RETURNS>CalComponentVType </RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_as_string</NAME> +<RETURNS>char *</RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_commit_sequence</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_uid</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, const char **uid +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_uid</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, const char *uid +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_categories_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList **categ_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_categories_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList *categ_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_classification</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentClassification *classif +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_classification</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentClassification classif +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_comment_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList **text_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_comment_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList *text_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_completed</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, struct icaltimetype **t +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_completed</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, struct icaltimetype *t +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_created</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, struct icaltimetype **t +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_created</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, struct icaltimetype *t +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_description_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList **text_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_description_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList *text_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_dtend</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentDateTime *dt +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_dtend</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentDateTime *dt +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_dtstamp</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, struct icaltimetype *t +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_dtstamp</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, struct icaltimetype *t +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_dtstart</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentDateTime *dt +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_dtstart</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentDateTime *dt +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_due</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentDateTime *dt +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_due</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentDateTime *dt +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_exdate_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList **exdate_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_exdate_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList *exdate_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_exrule_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_get_geo</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, struct icalgeotype **geo +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_geo</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, struct icalgeotype *geo +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_last_modified</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, struct icaltimetype **t +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_last_modified</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, struct icaltimetype *t +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_percent</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, int **percent +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_percent</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, int *percent +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_priority</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, int **priority +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_priority</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, int *priority +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_rdate_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList **period_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_rdate_list</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, GSList *period_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_has_rdates</NAME> +<RETURNS>gboolean </RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_rrule_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 +</FUNCTION> +<FUNCTION> +<NAME>cal_component_has_rrules</NAME> +<RETURNS>gboolean </RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_sequence</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, int **sequence +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_sequence</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, int *sequence +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_summary</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentText *summary +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_summary</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentText *summary +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_transparency</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentTransparency *transp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_transparency</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, CalComponentTransparency transp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_url</NAME> +<RETURNS>void </RETURNS> +CalComponent *comp, const char **url +</FUNCTION> +<FUNCTION> +<NAME>cal_component_set_url</NAME> +<RETURNS>void </RETURNS> +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 +</FUNCTION> +<FUNCTION> +<NAME>cal_component_free_datetime</NAME> +<RETURNS>void </RETURNS> +CalComponentDateTime *dt +</FUNCTION> +<FUNCTION> +<NAME>cal_component_free_exdate_list</NAME> +<RETURNS>void </RETURNS> +GSList *exdate_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_free_geo</NAME> +<RETURNS>void </RETURNS> +struct icalgeotype *geo +</FUNCTION> +<FUNCTION> +<NAME>cal_component_free_icaltimetype</NAME> +<RETURNS>void </RETURNS> +struct icaltimetype *t +</FUNCTION> +<FUNCTION> +<NAME>cal_component_free_percent</NAME> +<RETURNS>void </RETURNS> +int *percent +</FUNCTION> +<FUNCTION> +<NAME>cal_component_free_priority</NAME> +<RETURNS>void </RETURNS> +int *priority +</FUNCTION> +<FUNCTION> +<NAME>cal_component_free_period_list</NAME> +<RETURNS>void </RETURNS> +GSList *period_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_free_recur_list</NAME> +<RETURNS>void </RETURNS> +GSList *recur_list +</FUNCTION> +<FUNCTION> +<NAME>cal_component_free_sequence</NAME> +<RETURNS>void </RETURNS> +int *sequence +</FUNCTION> +<FUNCTION> +<NAME>cal_component_free_text_list</NAME> +<RETURNS>void </RETURNS> +GSList *text_list +</FUNCTION> +<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> +typedef enum { + CAL_COMPONENT_ALARM_TRIGGER_RELATIVE, + CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE +} CalComponentAlarmTriggerType; +</ENUM> +<ENUM> +<NAME>CalComponentAlarmTriggerRelated</NAME> +typedef enum { + CAL_COMPONENT_ALARM_TRIGGER_RELATED_START, + CAL_COMPONENT_ALARM_TRIGGER_RELATED_END +} CalComponentAlarmTriggerRelated; +</ENUM> +<TYPEDEF> +<NAME>CalComponentAlarmTrigger</NAME> +typedef struct { + CalComponentAlarmTriggerType type; + + union { + struct { + struct icaldurationtype duration; + CalComponentAlarmTriggerRelated related; + } relative; + + struct icaltimetype absolute; + } u; +} CalComponentAlarmTrigger; +</TYPEDEF> +<FUNCTION> +<NAME>cal_component_get_first_alarm</NAME> +<RETURNS>CalComponentAlarm *</RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_get_next_alarm</NAME> +<RETURNS>CalComponentAlarm *</RETURNS> +CalComponent *comp +</FUNCTION> +<FUNCTION> +<NAME>cal_component_alarm_free</NAME> +<RETURNS>void </RETURNS> +CalComponentAlarm *alarm +</FUNCTION> +<FUNCTION> +<NAME>cal_component_alarm_get_action</NAME> +<RETURNS>void </RETURNS> +CalComponentAlarm *alarm, CalComponentAlarmAction *action +</FUNCTION> +<FUNCTION> +<NAME>cal_component_alarm_set_action</NAME> +<RETURNS>void </RETURNS> +CalComponentAlarm *alarm, CalComponentAlarmAction action +</FUNCTION> +<FUNCTION> +<NAME>cal_component_alarm_get_trigger</NAME> +<RETURNS>void </RETURNS> +CalComponentAlarm *alarm, CalComponentAlarmTrigger **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 +</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, + 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> +<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 { + 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> +<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 { + 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>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 +</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>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 +</FUNCTION> +<FUNCTION> +<NAME>time_from_day</NAME> +<RETURNS>time_t </RETURNS> +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 +</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>parse_date</NAME> +<RETURNS>time_t </RETURNS> +char *str +</FUNCTION> +<FUNCTION> +<NAME>print_time_t</NAME> +<RETURNS>void </RETURNS> +time_t t +</FUNCTION> diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt new file mode 100644 index 0000000000..cd928fc7e3 --- /dev/null +++ b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt @@ -0,0 +1,166 @@ +<SECTION> +<FILE>cal-component</FILE> +CAL_COMPONENT +<TITLE>CalComponent</TITLE> + +CalComponentVType +CalComponentField +CalComponentClassification +CalComponentDateTime +CalComponentPeriodType +CalComponentPeriod +CalComponentText +CalComponentTransparency +CalComponentAlarm +CalComponentPrivate + +cal_component_gen_uid +cal_component_new +cal_component_clone +cal_component_set_new_vtype +cal_component_set_icalcomponent +cal_component_get_icalcomponent +cal_component_get_vtype +cal_component_get_as_string +cal_component_commit_sequence +cal_component_get_uid +cal_component_set_uid +cal_component_get_categories_list +cal_component_set_categories_list +cal_component_get_classification +cal_component_set_classification +cal_component_get_comment_list +cal_component_set_comment_list +cal_component_get_completed +cal_component_set_completed +cal_component_get_created +cal_component_set_created +cal_component_get_description_list +cal_component_set_description_list +cal_component_get_dtend +cal_component_set_dtend +cal_component_get_dtstamp +cal_component_set_dtstamp +cal_component_get_dtstart +cal_component_set_dtstart +cal_component_get_due +cal_component_set_due +cal_component_get_exdate_list +cal_component_set_exdate_list +cal_component_get_exrule_list +cal_component_set_exrule_list +cal_component_get_geo +cal_component_set_geo +cal_component_get_last_modified +cal_component_set_last_modified +cal_component_get_percent +cal_component_set_percent +cal_component_get_priority +cal_component_set_priority +cal_component_get_rdate_list +cal_component_set_rdate_list +cal_component_has_rdates +cal_component_get_rrule_list +cal_component_set_rrule_list +cal_component_has_rrules +cal_component_get_sequence +cal_component_set_sequence +cal_component_get_summary +cal_component_set_summary +cal_component_get_transparency +cal_component_set_transparency +cal_component_get_url +cal_component_set_url +cal_component_get_pilot_id +cal_component_set_pilot_id +cal_component_get_pilot_status +cal_component_set_pilot_status + +cal_component_free_categories_list +cal_component_free_datetime +cal_component_free_exdate_list +cal_component_free_geo +cal_component_free_icaltimetype +cal_component_free_percent +cal_component_free_priority +cal_component_free_period_list +cal_component_free_recur_list +cal_component_free_sequence +cal_component_free_text_list + +CalComponentAlarmAction +CalComponentAlarmTriggerType +CalComponentAlarmTriggerRelated +CalComponentAlarmTrigger + +cal_component_get_first_alarm +cal_component_get_next_alarm +cal_component_alarm_free +cal_component_alarm_get_action +cal_component_alarm_set_action +cal_component_alarm_get_trigger +cal_component_alarm_set_trigger +cal_component_alarm_free_trigger + +<SUBSECTION Standard> +CAL_COMPONENT_TYPE +CAL_COMPONENT_CLASS +IS_CAL_COMPONENT +IS_CAL_COMPONENT_CLASS +cal_component_get_type + +<SUBSECTION Private> +CalComponent + +</SECTION> + +<SECTION> +<FILE>cal-recur</FILE> +CalRecurType +CalRecurrence +CalObjTime +CalRecurInstanceFn +cal_recur_generate_instances +cal_recur_from_icalrecurrencetype +cal_recur_free +</SECTION> + +<SECTION> +<FILE>cal-util</FILE> +CalObjInstance +cal_obj_instance_list_free +CalAlarmInstance +cal_alarm_instance_list_free +CalObjType +cal_obj_uid_list_free +</SECTION> + +<SECTION> +<FILE>timeutil</FILE> +time_from_icaltimetype +time_from_isodate +time_from_start_duration +isodate_from_time_t +get_time_t_hour +isodiff_to_secs +isodiff_from_secs +time_add_minutes +time_add_day +time_add_week +time_add_month +time_add_year +format_simple_hour +time_days_in_month +time_from_day +time_day_hour +time_year_begin +time_year_end +time_month_begin +time_month_end +time_week_begin +time_week_end +time_day_begin +time_day_end +parse_date +print_time_t +</SECTION> diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.args b/doc/devel/calendar/cal-util/evolution-cal-util.args new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/devel/calendar/cal-util/evolution-cal-util.args diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy b/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy new file mode 100644 index 0000000000..cc235653f2 --- /dev/null +++ b/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy @@ -0,0 +1,2 @@ +GtkObject + CalComponent diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.signals b/doc/devel/calendar/cal-util/evolution-cal-util.signals new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/devel/calendar/cal-util/evolution-cal-util.signals diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.types b/doc/devel/calendar/cal-util/evolution-cal-util.types new file mode 100644 index 0000000000..52b2d9bf90 --- /dev/null +++ b/doc/devel/calendar/cal-util/evolution-cal-util.types @@ -0,0 +1,4 @@ +#include <gnome.h> +#include <cal-util/cal-component.h> + +cal_component_get_type diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml new file mode 100644 index 0000000000..2f800e583f --- /dev/null +++ b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml @@ -0,0 +1,934 @@ +<!-- ##### SECTION Title ##### --> +CalComponent + +<!-- ##### SECTION Short_Description ##### --> +RFC 2445 iCalendar component object. + +<!-- ##### SECTION Long_Description ##### --> + <para> + The #CalComponent object provides a wrapper over the &libical; + functions for manipulating calendar components. #CalComponent + presents a GTK+-like interface to calendar components according to + RFC 2445. + </para> + + <para> + While &libical; supports almost all of the features of the + iCalendar RFCs, applications are normally not interested in all + the mindless gunk that is there. Still, applications should do + their best not to drop extension fields from calendar components + or any other extra information they do not support (including + standard fields they are not interested in). The #CalComponent + object provides a wrapper over + <structname>icalcomponent</structname> structures from &libical; + so that no information in them will be lost even if the + application is not designed to handle it. Also, #CalComponent + provides a higher-level API to many of the &libical; operations so + as to make it less painful to deal with iCalendar components. + </para> + + <para> + A #CalComponent object starts out empty. It must be initialized + from an existing <structname>icalcomponent</structname> structure + by using the cal_component_set_icalcomponent() function, or from a + completely new data by specifying the desired component type to + the cal_component_set_new_vtype() function. + </para> + + <para> + #CalComponent will create an internal map of the properties in the + <structname>icalcomponent</structname> structure and then allow + random access to them via the #CalComponent API functions; + normally the &libical; API would have to be used by creating many + iterators and other unpleasant constructs. #CalComponent keeps + handles to the properties it scanned from the + <structname>icalcomponent</structname> and will let the parent + application modify them at any time without having to do any + iteration. + </para> + + <para> + Eventually a #CalComponent may be turned into the RFC 2445 string + representation of an iCalendar component by using the + cal_component_get_as_string() function. Applications can then + transfer this interoperable + <footnote> + <para> + “Interoperable.” Heavens, I love that word. + </para> + </footnote> + string to other programs that deal with iCalendar. + </para> + +<!-- ##### SECTION See_Also ##### --> + <para> + + </para> + +<!-- ##### MACRO CAL_COMPONENT ##### --> + <para> + Casts a #GtkObject to a #CalComponent. + </para> + +@obj: A GTK+ object. + + +<!-- ##### ENUM CalComponentVType ##### --> + <para> + Calendar component types as defined by RFC 2445. These values can + be used to create a new calendar component by passing them to the + cal_component_set_new_vtype() function. They are also the return + value of the cal_component_get_vtype() function. The only time + the @CAL_COMPONENT_NO_TYPE value is used is when querying the + vtype of an uninitialized #CalComponent. + </para> + +@CAL_COMPONENT_NO_TYPE: Returned from cal_component_get_vtype() to + indicate an uninitialized #CalComponent object. + +@CAL_COMPONENT_EVENT: Indicates a VEVENT component. +@CAL_COMPONENT_TODO: Indicates a VTODO component. +@CAL_COMPONENT_JOURNAL: Indicates a VJOURNAL component. +@CAL_COMPONENT_FREEBUSY: Indicates a VFREEBUSY component. +@CAL_COMPONENT_TIMEZONE: Indicates a VTIMEZOME component. + +<!-- ##### ENUM CalComponentField ##### --> + <para> + These values are used as identifiers for #ETable columns. These + are used by the calendar GUI code in Evolution. + </para> + +@CAL_COMPONENT_FIELD_CATEGORIES: Component's list of categories. +@CAL_COMPONENT_FIELD_CLASSIFICATION: Component's classification. +@CAL_COMPONENT_FIELD_COMPLETED: Component's completion date. +@CAL_COMPONENT_FIELD_DTEND: Component's ending date. +@CAL_COMPONENT_FIELD_DTSTART: Component's starting date. +@CAL_COMPONENT_FIELD_DUE: Component's due date. +@CAL_COMPONENT_FIELD_GEO: Component's geographical position. +@CAL_COMPONENT_FIELD_PERCENT: Component's percent completed value. +@CAL_COMPONENT_FIELD_PRIORITY: Component's priority. +@CAL_COMPONENT_FIELD_SUMMARY: Component's summary. +@CAL_COMPONENT_FIELD_TRANSPARENCY: Component's transparency value. +@CAL_COMPONENT_FIELD_URL: Component's URL. +@CAL_COMPONENT_FIELD_HAS_ALARMS: Whether the component has any alarms. +@CAL_COMPONENT_FIELD_ICON: Which icon to use for the component. +@CAL_COMPONENT_FIELD_COMPLETE: Whether the component has been completed. +@CAL_COMPONENT_FIELD_RECURRING: Whether the component has any recurrences. +@CAL_COMPONENT_FIELD_OVERDUE: Whether the component is overdue. +@CAL_COMPONENT_FIELD_COLOR: Which color to use for the component. +@CAL_COMPONENT_FIELD_NUM_FIELDS: Total number of enumerated fields. + +<!-- ##### ENUM CalComponentClassification ##### --> + <para> + Values for the access classification property of a calendar + component. + </para> + +@CAL_COMPONENT_CLASS_NONE: Indicates that no access classification has + been set for the corresponding component. + +@CAL_COMPONENT_CLASS_PUBLIC: Public access. +@CAL_COMPONENT_CLASS_PRIVATE: Private access. +@CAL_COMPONENT_CLASS_CONFIDENTIAL: Confidential access. + +@CAL_COMPONENT_CLASS_UNKNOWN: Unknown access classification value, + used when &libical; returns something #CalComponent does not know + about. + +<!-- ##### TYPEDEF CalComponentDateTime ##### --> + <para> + This structure defines a date and time value. + </para> + + +<!-- ##### ENUM CalComponentPeriodType ##### --> + <para> + Defines how a period of time is specified. + </para> + +@CAL_COMPONENT_PERIOD_DATETIME: Indicates that the period is specified + by starting and ending date/time values. + +@CAL_COMPONENT_PERIOD_DURATION: Indicates that the period is specified + as a starding date/time and a duration value. + +<!-- ##### TYPEDEF CalComponentPeriod ##### --> + <para> + This structure defines a period of time. + </para> + + +<!-- ##### TYPEDEF CalComponentText ##### --> + <para> + This structure defines the value of a text property that may have + an alternate representation parameter. + </para> + + +<!-- ##### ENUM CalComponentTransparency ##### --> +<para> + +</para> + +@CAL_COMPONENT_TRANSP_NONE: +@CAL_COMPONENT_TRANSP_TRANSPARENT: +@CAL_COMPONENT_TRANSP_OPAQUE: +@CAL_COMPONENT_TRANSP_UNKNOWN: + +<!-- ##### STRUCT CalComponentAlarm ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CalComponentPrivate ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION cal_component_gen_uid ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION cal_component_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION cal_component_clone ##### --> +<para> + +</para> + +@comp: +@Returns: + + +<!-- ##### FUNCTION cal_component_set_new_vtype ##### --> +<para> + +</para> + +@comp: +@type: + + +<!-- ##### FUNCTION cal_component_set_icalcomponent ##### --> +<para> + +</para> + +@comp: +@icalcomp: +@Returns: + + +<!-- ##### FUNCTION cal_component_get_icalcomponent ##### --> +<para> + +</para> + +@comp: +@Returns: + + +<!-- ##### FUNCTION cal_component_get_vtype ##### --> +<para> + +</para> + +@comp: +@Returns: + + +<!-- ##### FUNCTION cal_component_get_as_string ##### --> +<para> + +</para> + +@comp: +@Returns: + + +<!-- ##### FUNCTION cal_component_commit_sequence ##### --> +<para> + +</para> + +@comp: + + +<!-- ##### FUNCTION cal_component_get_uid ##### --> +<para> + +</para> + +@comp: +@uid: + + +<!-- ##### FUNCTION cal_component_set_uid ##### --> +<para> + +</para> + +@comp: +@uid: + + +<!-- ##### FUNCTION cal_component_get_categories_list ##### --> +<para> + +</para> + +@comp: +@categ_list: + + +<!-- ##### FUNCTION cal_component_set_categories_list ##### --> +<para> + +</para> + +@comp: +@categ_list: + + +<!-- ##### FUNCTION cal_component_get_classification ##### --> +<para> + +</para> + +@comp: +@classif: + + +<!-- ##### FUNCTION cal_component_set_classification ##### --> +<para> + +</para> + +@comp: +@classif: + + +<!-- ##### FUNCTION cal_component_get_comment_list ##### --> +<para> + +</para> + +@comp: +@text_list: + + +<!-- ##### FUNCTION cal_component_set_comment_list ##### --> +<para> + +</para> + +@comp: +@text_list: + + +<!-- ##### FUNCTION cal_component_get_completed ##### --> +<para> + +</para> + +@comp: +@t: + + +<!-- ##### FUNCTION cal_component_set_completed ##### --> +<para> + +</para> + +@comp: +@t: + + +<!-- ##### FUNCTION cal_component_get_created ##### --> +<para> + +</para> + +@comp: +@t: + + +<!-- ##### FUNCTION cal_component_set_created ##### --> +<para> + +</para> + +@comp: +@t: + + +<!-- ##### FUNCTION cal_component_get_description_list ##### --> +<para> + +</para> + +@comp: +@text_list: + + +<!-- ##### FUNCTION cal_component_set_description_list ##### --> +<para> + +</para> + +@comp: +@text_list: + + +<!-- ##### FUNCTION cal_component_get_dtend ##### --> +<para> + +</para> + +@comp: +@dt: + + +<!-- ##### FUNCTION cal_component_set_dtend ##### --> +<para> + +</para> + +@comp: +@dt: + + +<!-- ##### FUNCTION cal_component_get_dtstamp ##### --> +<para> + +</para> + +@comp: +@t: + + +<!-- ##### FUNCTION cal_component_set_dtstamp ##### --> +<para> + +</para> + +@comp: +@t: + + +<!-- ##### FUNCTION cal_component_get_dtstart ##### --> +<para> + +</para> + +@comp: +@dt: + + +<!-- ##### FUNCTION cal_component_set_dtstart ##### --> +<para> + +</para> + +@comp: +@dt: + + +<!-- ##### FUNCTION cal_component_get_due ##### --> +<para> + +</para> + +@comp: +@dt: + + +<!-- ##### FUNCTION cal_component_set_due ##### --> +<para> + +</para> + +@comp: +@dt: + + +<!-- ##### FUNCTION cal_component_get_exdate_list ##### --> +<para> + +</para> + +@comp: +@exdate_list: + + +<!-- ##### FUNCTION cal_component_set_exdate_list ##### --> +<para> + +</para> + +@comp: +@exdate_list: + + +<!-- ##### FUNCTION cal_component_get_exrule_list ##### --> +<para> + +</para> + +@comp: +@recur_list: + + +<!-- ##### FUNCTION cal_component_set_exrule_list ##### --> +<para> + +</para> + +@comp: +@recur_list: + + +<!-- ##### FUNCTION cal_component_get_geo ##### --> +<para> + +</para> + +@comp: +@geo: + + +<!-- ##### FUNCTION cal_component_set_geo ##### --> +<para> + +</para> + +@comp: +@geo: + + +<!-- ##### FUNCTION cal_component_get_last_modified ##### --> +<para> + +</para> + +@comp: +@t: + + +<!-- ##### FUNCTION cal_component_set_last_modified ##### --> +<para> + +</para> + +@comp: +@t: + + +<!-- ##### FUNCTION cal_component_get_percent ##### --> +<para> + +</para> + +@comp: +@percent: + + +<!-- ##### FUNCTION cal_component_set_percent ##### --> +<para> + +</para> + +@comp: +@percent: + + +<!-- ##### FUNCTION cal_component_get_priority ##### --> +<para> + +</para> + +@comp: +@priority: + + +<!-- ##### FUNCTION cal_component_set_priority ##### --> +<para> + +</para> + +@comp: +@priority: + + +<!-- ##### FUNCTION cal_component_get_rdate_list ##### --> +<para> + +</para> + +@comp: +@period_list: + + +<!-- ##### FUNCTION cal_component_set_rdate_list ##### --> +<para> + +</para> + +@comp: +@period_list: + + +<!-- ##### FUNCTION cal_component_has_rdates ##### --> +<para> + +</para> + +@comp: +@Returns: + + +<!-- ##### FUNCTION cal_component_get_rrule_list ##### --> +<para> + +</para> + +@comp: +@recur_list: + + +<!-- ##### FUNCTION cal_component_set_rrule_list ##### --> +<para> + +</para> + +@comp: +@recur_list: + + +<!-- ##### FUNCTION cal_component_has_rrules ##### --> +<para> + +</para> + +@comp: +@Returns: + + +<!-- ##### FUNCTION cal_component_get_sequence ##### --> +<para> + +</para> + +@comp: +@sequence: + + +<!-- ##### FUNCTION cal_component_set_sequence ##### --> +<para> + +</para> + +@comp: +@sequence: + + +<!-- ##### FUNCTION cal_component_get_summary ##### --> +<para> + +</para> + +@comp: +@summary: + + +<!-- ##### FUNCTION cal_component_set_summary ##### --> +<para> + +</para> + +@comp: +@summary: + + +<!-- ##### FUNCTION cal_component_get_transparency ##### --> +<para> + +</para> + +@comp: +@transp: + + +<!-- ##### FUNCTION cal_component_set_transparency ##### --> +<para> + +</para> + +@comp: +@transp: + + +<!-- ##### FUNCTION cal_component_get_url ##### --> +<para> + +</para> + +@comp: +@url: + + +<!-- ##### FUNCTION cal_component_set_url ##### --> +<para> + +</para> + +@comp: +@url: + + +<!-- ##### FUNCTION cal_component_get_pilot_id ##### --> +<para> + +</para> + +@comp: +@pilot_id: + + +<!-- ##### FUNCTION cal_component_set_pilot_id ##### --> +<para> + +</para> + +@comp: +@pilot_id: + + +<!-- ##### FUNCTION cal_component_get_pilot_status ##### --> +<para> + +</para> + +@comp: +@pilot_status: + + +<!-- ##### FUNCTION cal_component_set_pilot_status ##### --> +<para> + +</para> + +@comp: +@pilot_status: + + +<!-- ##### FUNCTION cal_component_free_categories_list ##### --> +<para> + +</para> + +@categ_list: + + +<!-- ##### FUNCTION cal_component_free_datetime ##### --> +<para> + +</para> + +@dt: + + +<!-- ##### FUNCTION cal_component_free_exdate_list ##### --> +<para> + +</para> + +@exdate_list: + + +<!-- ##### FUNCTION cal_component_free_geo ##### --> +<para> + +</para> + +@geo: + + +<!-- ##### FUNCTION cal_component_free_icaltimetype ##### --> +<para> + +</para> + +@t: + + +<!-- ##### FUNCTION cal_component_free_percent ##### --> +<para> + +</para> + +@percent: + + +<!-- ##### FUNCTION cal_component_free_priority ##### --> +<para> + +</para> + +@priority: + + +<!-- ##### FUNCTION cal_component_free_period_list ##### --> +<para> + +</para> + +@period_list: + + +<!-- ##### FUNCTION cal_component_free_recur_list ##### --> +<para> + +</para> + +@recur_list: + + +<!-- ##### FUNCTION cal_component_free_sequence ##### --> +<para> + +</para> + +@sequence: + + +<!-- ##### FUNCTION cal_component_free_text_list ##### --> +<para> + +</para> + +@text_list: + + +<!-- ##### ENUM CalComponentAlarmAction ##### --> +<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: + +<!-- ##### ENUM CalComponentAlarmTriggerType ##### --> +<para> + +</para> + +@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: +@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: + +<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### --> +<para> + +</para> + +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: + +<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION cal_component_get_first_alarm ##### --> +<para> + +</para> + +@comp: +@Returns: + + +<!-- ##### FUNCTION cal_component_get_next_alarm ##### --> +<para> + +</para> + +@comp: +@Returns: + + +<!-- ##### FUNCTION cal_component_alarm_free ##### --> +<para> + +</para> + +@alarm: + + +<!-- ##### FUNCTION cal_component_alarm_get_action ##### --> +<para> + +</para> + +@alarm: +@action: + + +<!-- ##### FUNCTION cal_component_alarm_set_action ##### --> +<para> + +</para> + +@alarm: +@action: + + +<!-- ##### FUNCTION cal_component_alarm_get_trigger ##### --> +<para> + +</para> + +@alarm: +@trigger: + + +<!-- ##### FUNCTION cal_component_alarm_set_trigger ##### --> +<para> + +</para> + +@alarm: +@trigger: + + +<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### --> +<para> + +</para> + +@trigger: + + +<!-- +Local variables: +mode: sgml +sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "") +End: +--> diff --git a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml new file mode 100644 index 0000000000..703f8b2b85 --- /dev/null +++ b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml @@ -0,0 +1,88 @@ +<!-- ##### SECTION Title ##### --> +cal-recur + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### ENUM CalRecurType ##### --> +<para> + +</para> + +@CAL_RECUR_YEARLY: +@CAL_RECUR_MONTHLY: +@CAL_RECUR_WEEKLY: +@CAL_RECUR_DAILY: +@CAL_RECUR_HOURLY: +@CAL_RECUR_MINUTELY: +@CAL_RECUR_SECONDLY: + +<!-- ##### TYPEDEF CalRecurrence ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CalObjTime ##### --> +<para> + +</para> + +@year: +@month: +@day: +@hour: +@minute: +@second: + +<!-- ##### USER_FUNCTION CalRecurInstanceFn ##### --> +<para> + +</para> + +@comp: +@instance_start: +@instace_end: +@data: +@Returns: + + +<!-- ##### FUNCTION cal_recur_generate_instances ##### --> +<para> + +</para> + +@comp: +@start: +@end: +@cb: +@cb_data: + + +<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### --> +<para> + +</para> + +@ir: +@Returns: + + +<!-- ##### FUNCTION cal_recur_free ##### --> +<para> + +</para> + +@r: + + diff --git a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml new file mode 100644 index 0000000000..8d4516c2ec --- /dev/null +++ b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml @@ -0,0 +1,62 @@ +<!-- ##### SECTION Title ##### --> +cal-util + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### TYPEDEF CalObjInstance ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION cal_obj_instance_list_free ##### --> +<para> + +</para> + +@list: + + +<!-- ##### TYPEDEF CalAlarmInstance ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION cal_alarm_instance_list_free ##### --> +<para> + +</para> + +@list: + + +<!-- ##### ENUM CalObjType ##### --> +<para> + +</para> + +@CALOBJ_TYPE_EVENT: +@CALOBJ_TYPE_TODO: +@CALOBJ_TYPE_JOURNAL: +@CALOBJ_TYPE_ANY: + +<!-- ##### FUNCTION cal_obj_uid_list_free ##### --> +<para> + +</para> + +@list: + + 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 new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml diff --git a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml new file mode 100644 index 0000000000..3b62fbba3f --- /dev/null +++ b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml @@ -0,0 +1,260 @@ +<!-- ##### SECTION Title ##### --> +timeutil + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION time_from_icaltimetype ##### --> +<para> + +</para> + +@itt: +@Returns: + + +<!-- ##### FUNCTION time_from_isodate ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION time_from_start_duration ##### --> +<para> + +</para> + +@start: +@duration: +@Returns: + + +<!-- ##### FUNCTION isodate_from_time_t ##### --> +<para> + +</para> + +@t: +@Returns: + + +<!-- ##### FUNCTION get_time_t_hour ##### --> +<para> + +</para> + +@t: +@Returns: + + +<!-- ##### FUNCTION isodiff_to_secs ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION isodiff_from_secs ##### --> +<para> + +</para> + +@secs: +@Returns: + + +<!-- ##### FUNCTION time_add_minutes ##### --> +<para> + +</para> + +@time: +@minutes: +@Returns: + + +<!-- ##### FUNCTION time_add_day ##### --> +<para> + +</para> + +@time: +@days: +@Returns: + + +<!-- ##### FUNCTION time_add_week ##### --> +<para> + +</para> + +@time: +@weeks: +@Returns: + + +<!-- ##### FUNCTION time_add_month ##### --> +<para> + +</para> + +@time: +@months: +@Returns: + + +<!-- ##### FUNCTION time_add_year ##### --> +<para> + +</para> + +@time: +@years: +@Returns: + + +<!-- ##### FUNCTION format_simple_hour ##### --> +<para> + +</para> + +@hour: +@use_am_pm: +@Returns: + + +<!-- ##### FUNCTION time_days_in_month ##### --> +<para> + +</para> + +@year: +@month: +@Returns: + + +<!-- ##### FUNCTION time_from_day ##### --> +<para> + +</para> + +@year: +@month: +@day: +@Returns: + + +<!-- ##### FUNCTION time_day_hour ##### --> +<para> + +</para> + +@t: +@hour: +@Returns: + + +<!-- ##### FUNCTION time_year_begin ##### --> +<para> + +</para> + +@t: +@Returns: + + +<!-- ##### FUNCTION time_year_end ##### --> +<para> + +</para> + +@t: +@Returns: + + +<!-- ##### FUNCTION time_month_begin ##### --> +<para> + +</para> + +@t: +@Returns: + + +<!-- ##### FUNCTION time_month_end ##### --> +<para> + +</para> + +@t: +@Returns: + + +<!-- ##### FUNCTION time_week_begin ##### --> +<para> + +</para> + +@t: +@Returns: + + +<!-- ##### FUNCTION time_week_end ##### --> +<para> + +</para> + +@t: +@Returns: + + +<!-- ##### FUNCTION time_day_begin ##### --> +<para> + +</para> + +@t: +@Returns: + + +<!-- ##### FUNCTION time_day_end ##### --> +<para> + +</para> + +@t: +@Returns: + + +<!-- ##### FUNCTION parse_date ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION print_time_t ##### --> +<para> + +</para> + +@t: + + |