From bf9f26b7733b298c31415734d6f41d30e9213b54 Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Mon, 14 Aug 2000 23:59:13 +0000 Subject: Added the cal-util library to the documentation framework - Federico svn path=/trunk/; revision=4839 --- doc/devel/calendar/Makefile.am | 2 +- .../cal-client/evolution-cal-client-decl.txt | 13 +- .../cal-client/evolution-cal-client-sections.txt | 3 +- doc/devel/calendar/cal-client/tmpl/cal-client.sgml | 58 +- .../tmpl/evolution-cal-client-unused.sgml | 10 + doc/devel/calendar/cal-util/.cvsignore | 3 + doc/devel/calendar/cal-util/Makefile.am | 75 ++ .../calendar/cal-util/evolution-cal-util-decl.txt | 852 +++++++++++++++++++ .../cal-util/evolution-cal-util-sections.txt | 166 ++++ .../calendar/cal-util/evolution-cal-util.args | 0 .../calendar/cal-util/evolution-cal-util.hierarchy | 2 + .../calendar/cal-util/evolution-cal-util.signals | 0 .../calendar/cal-util/evolution-cal-util.types | 4 + .../calendar/cal-util/tmpl/cal-component.sgml | 934 +++++++++++++++++++++ doc/devel/calendar/cal-util/tmpl/cal-recur.sgml | 88 ++ doc/devel/calendar/cal-util/tmpl/cal-util.sgml | 62 ++ .../cal-util/tmpl/evolution-cal-util-unused.sgml | 0 doc/devel/calendar/cal-util/tmpl/timeutil.sgml | 260 ++++++ doc/devel/calendar/public-reference.sgml | 4 + doc/devel/calendar/reference.sgml | 4 + 20 files changed, 2516 insertions(+), 24 deletions(-) create mode 100644 doc/devel/calendar/cal-util/.cvsignore create mode 100644 doc/devel/calendar/cal-util/Makefile.am create mode 100644 doc/devel/calendar/cal-util/evolution-cal-util-decl.txt create mode 100644 doc/devel/calendar/cal-util/evolution-cal-util-sections.txt create mode 100644 doc/devel/calendar/cal-util/evolution-cal-util.args create mode 100644 doc/devel/calendar/cal-util/evolution-cal-util.hierarchy create mode 100644 doc/devel/calendar/cal-util/evolution-cal-util.signals create mode 100644 doc/devel/calendar/cal-util/evolution-cal-util.types create mode 100644 doc/devel/calendar/cal-util/tmpl/cal-component.sgml create mode 100644 doc/devel/calendar/cal-util/tmpl/cal-recur.sgml create mode 100644 doc/devel/calendar/cal-util/tmpl/cal-util.sgml create mode 100644 doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml create mode 100644 doc/devel/calendar/cal-util/tmpl/timeutil.sgml (limited to 'doc/devel/calendar') diff --git a/doc/devel/calendar/Makefile.am b/doc/devel/calendar/Makefile.am index 7efde02896..2220e1d59b 100644 --- a/doc/devel/calendar/Makefile.am +++ b/doc/devel/calendar/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = cal-client +SUBDIRS = cal-client cal-util EXTRA_DIST = \ architecture.sgml \ diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt index 9fffd4c201..0574d70678 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt @@ -83,7 +83,7 @@ CalClient *client, CalObjType type cal_client_get_object CalClientGetStatus -CalClient *client,const char *uid,iCalObject **ico +CalClient *client,const char *uid,CalComponent **comp cal_client_get_uid_by_pilot_id @@ -101,9 +101,14 @@ CalClient *client, char *uid,unsigned long pilot_id,unsigned long pilot_status CalClient *client, CalObjType type -cal_client_get_events_in_range +cal_client_get_objects_in_range GList * -CalClient *client, time_t start, time_t end +CalClient *client, CalObjType type,time_t start, time_t end + + +cal_client_generate_instances +void +CalClient *client, CalObjType type,time_t start, time_t end,CalRecurInstanceFn cb, gpointer cb_data cal_client_get_alarms_in_range @@ -118,7 +123,7 @@ CalClient *client, const char *uid,time_t start, time_t end,GList **alarms cal_client_update_object gboolean -CalClient *client, iCalObject *ico +CalClient *client, CalComponent *comp cal_client_remove_object diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt index 5496f2f0f2..c37b223247 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt @@ -12,10 +12,11 @@ cal_client_load_calendar cal_client_create_calendar cal_client_get_n_objects cal_client_get_object +cal_client_get_objects_in_range +cal_client_generate_instances cal_client_get_uid_by_pilot_id cal_client_update_pilot_id cal_client_get_uids -cal_client_get_events_in_range cal_client_get_alarms_in_range cal_client_get_alarms_for_object cal_client_update_object diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml index d2205b5b22..a146709b8a 100644 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml @@ -38,7 +38,6 @@ GTK+ object for communication with personal calendar server. - Casts a #GtkObject to a #CalClient. @@ -61,14 +60,11 @@ GTK+ object for communication with personal calendar server. @CAL_CLIENT_LOAD_SUCCESS: Indicates a successful load or create operation; the corresponding calendar is ready for use. - @CAL_CLIENT_LOAD_ERROR: Indicates an error while loading or creating the calendar. - @CAL_CLIENT_LOAD_IN_USE: Indicates that a create request failed because the specified calendar was already being used by another client. - @CAL_CLIENT_LOAD_METHOD_NOT_SUPPORTED: Indicates an error due to trying to load a calendar for which a backend type is not present. @@ -79,10 +75,8 @@ GTK+ object for communication with personal calendar server. @CAL_CLIENT_GET_SUCCESS: Indicates a successful get operation. - @CAL_CLIENT_GET_NOT_FOUND: Indicates that the requested object was not found. - @CAL_CLIENT_GET_SYNTAX_ERROR: Indicates a syntax error when parsing the requested object. This could indicate a bug in the calendar client libraries or in the Wombat server. @@ -132,10 +126,37 @@ GTK+ object for communication with personal calendar server. @client: @uid: +@comp: +@Returns: + @ico: + + + + + + + +@client: +@type: +@start: +@end: @Returns: + + + + + +@client: +@type: +@start: +@end: +@cb: +@cb_data: + + @@ -168,17 +189,6 @@ GTK+ object for communication with personal calendar server. @Returns: - - - - - -@client: -@start: -@end: -@Returns: - - @@ -209,8 +219,10 @@ GTK+ object for communication with personal calendar server. @client: -@ico: +@comp: @Returns: + +@ico: @@ -232,6 +244,9 @@ GTK+ object for communication with personal calendar server. request. +@calclient: the object which received the signal. +@arg1: + @client: Calendar client which received the notification. @status: Status of the request. See the description of #CalClientLoadStatus for more details. @@ -244,6 +259,9 @@ GTK+ object for communication with personal calendar server. new version of the object and update their display, for example. +@calclient: the object which received the signal. +@arg1: + @client: Calendar client which received the notification. @uid: Unique identifier of the calendar component that changed in the personal calendar server's storage. @@ -257,6 +275,9 @@ GTK+ object for communication with personal calendar server. example. +@calclient: the object which received the signal. +@arg1: + @client: Calendar client which received the notification. @uid: Unique identifier of the calendar component that was removed from the personal calendar server's storage. @@ -267,3 +288,4 @@ mode: sgml sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "") End: --> + 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 e69de29bb2..5576dbd57f 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 @@ -0,0 +1,10 @@ + + + + + +@client: +@start: +@end: +@Returns: + 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 @@ + +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_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; + + +CalComponentAlarm + + +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_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_get_exrule_list +void +CalComponent *comp, GSList **recur_list + + +cal_component_set_exrule_list +void +CalComponent *comp, GSList *recur_list + + +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_set_rrule_list +void +CalComponent *comp, GSList *recur_list + + +cal_component_has_rrules +gboolean +CalComponent *comp + + +cal_component_get_sequence +void +CalComponent *comp, int **sequence + + +cal_component_set_sequence +void +CalComponent *comp, int *sequence + + +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_get_pilot_id +void +CalComponent *comp, unsigned long *pilot_id + + +cal_component_set_pilot_id +void +CalComponent *comp, unsigned long pilot_id + + +cal_component_get_pilot_status +void +CalComponent *comp, unsigned long *pilot_status + + +cal_component_set_pilot_status +void +CalComponent *comp, unsigned long pilot_status + + +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 + + +CalComponentAlarmAction +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; + + +CalComponentAlarmTriggerType +typedef enum { + CAL_COMPONENT_ALARM_TRIGGER_RELATIVE, + CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE +} CalComponentAlarmTriggerType; + + +CalComponentAlarmTriggerRelated +typedef enum { + CAL_COMPONENT_ALARM_TRIGGER_RELATED_START, + CAL_COMPONENT_ALARM_TRIGGER_RELATED_END +} CalComponentAlarmTriggerRelated; + + +CalComponentAlarmTrigger +typedef struct { + CalComponentAlarmTriggerType type; + + union { + struct { + struct icaldurationtype duration; + CalComponentAlarmTriggerRelated related; + } relative; + + struct icaltimetype absolute; + } u; +} CalComponentAlarmTrigger; + + +cal_component_get_first_alarm +CalComponentAlarm * +CalComponent *comp + + +cal_component_get_next_alarm +CalComponentAlarm * +CalComponent *comp + + +cal_component_alarm_free +void +CalComponentAlarm *alarm + + +cal_component_alarm_get_action +void +CalComponentAlarm *alarm, CalComponentAlarmAction *action + + +cal_component_alarm_set_action +void +CalComponentAlarm *alarm, CalComponentAlarmAction action + + +cal_component_alarm_get_trigger +void +CalComponentAlarm *alarm, CalComponentAlarmTrigger **trigger + + +cal_component_alarm_set_trigger +void +CalComponentAlarm *alarm, CalComponentAlarmTrigger *trigger + + +cal_component_alarm_free_trigger +void +CalComponentAlarmTrigger *trigger + + +CalRecurType +typedef enum { + CAL_RECUR_YEARLY, + CAL_RECUR_MONTHLY, + CAL_RECUR_WEEKLY, + CAL_RECUR_DAILY, + CAL_RECUR_HOURLY, + CAL_RECUR_MINUTELY, + CAL_RECUR_SECONDLY +} CalRecurType; + + +CalRecurrence +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; + + +CalObjTime + + +CalObjTime +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) */ +}; + + +CalRecurInstanceFn +gboolean +CalComponent *comp, + time_t instance_start, + time_t instace_end, + gpointer data + + +cal_recur_generate_instances +void +CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data + + +cal_recur_from_icalrecurrencetype +CalRecurrence * +struct icalrecurrencetype *ir + + +cal_recur_free +void +CalRecurrence *r + + +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 + + +CalAlarmInstance +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; + + +cal_alarm_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 + + +time_from_icaltimetype +time_t +struct icaltimetype itt + + +time_from_isodate +time_t +char *str + + +time_from_start_duration +time_t +time_t start, char *duration + + +isodate_from_time_t +char * +time_t t + + +get_time_t_hour +int +time_t t + + +isodiff_to_secs +int +char *str + + +isodiff_from_secs +char * +int secs + + +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 + + +format_simple_hour +char * +int hour, int use_am_pm + + +time_days_in_month +int +int year, int month + + +time_from_day +time_t +int year, int month, int day + + +time_day_hour +time_t +time_t t, int hour + + +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 + + +parse_date +time_t +char *str + + +print_time_t +void +time_t t + 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 @@ +
+cal-component +CAL_COMPONENT +CalComponent + +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 + + +CAL_COMPONENT_TYPE +CAL_COMPONENT_CLASS +IS_CAL_COMPONENT +IS_CAL_COMPONENT_CLASS +cal_component_get_type + + +CalComponent + +
+ +
+cal-recur +CalRecurType +CalRecurrence +CalObjTime +CalRecurInstanceFn +cal_recur_generate_instances +cal_recur_from_icalrecurrencetype +cal_recur_free +
+ +
+cal-util +CalObjInstance +cal_obj_instance_list_free +CalAlarmInstance +cal_alarm_instance_list_free +CalObjType +cal_obj_uid_list_free +
+ +
+timeutil +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 +
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 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 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 +#include + +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 @@ + +CalComponent + + +RFC 2445 iCalendar component object. + + + + 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. + + + + 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 + icalcomponent 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. + + + + A #CalComponent object starts out empty. It must be initialized + from an existing icalcomponent 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. + + + + #CalComponent will create an internal map of the properties in the + icalcomponent 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 + icalcomponent and will let the parent + application modify them at any time without having to do any + iteration. + + + + 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 + + + “Interoperable.” Heavens, I love that word. + + + string to other programs that deal with iCalendar. + + + + + + + + + + Casts a #GtkObject to a #CalComponent. + + +@obj: A GTK+ object. + + + + + 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. + + +@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. + + + + These values are used as identifiers for #ETable columns. These + are used by the calendar GUI code in Evolution. + + +@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. + + + + Values for the access classification property of a calendar + component. + + +@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. + + + + This structure defines a date and time value. + + + + + + Defines how a period of time is specified. + + +@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. + + + + This structure defines a period of time. + + + + + + This structure defines the value of a text property that may have + an alternate representation parameter. + + + + + + + + +@CAL_COMPONENT_TRANSP_NONE: +@CAL_COMPONENT_TRANSP_TRANSPARENT: +@CAL_COMPONENT_TRANSP_OPAQUE: +@CAL_COMPONENT_TRANSP_UNKNOWN: + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@comp: +@Returns: + + + + + + + +@comp: +@type: + + + + + + + +@comp: +@icalcomp: +@Returns: + + + + + + + +@comp: +@Returns: + + + + + + + +@comp: +@Returns: + + + + + + + +@comp: +@Returns: + + + + + + + +@comp: + + + + + + + +@comp: +@uid: + + + + + + + +@comp: +@uid: + + + + + + + +@comp: +@categ_list: + + + + + + + +@comp: +@categ_list: + + + + + + + +@comp: +@classif: + + + + + + + +@comp: +@classif: + + + + + + + +@comp: +@text_list: + + + + + + + +@comp: +@text_list: + + + + + + + +@comp: +@t: + + + + + + + +@comp: +@t: + + + + + + + +@comp: +@t: + + + + + + + +@comp: +@t: + + + + + + + +@comp: +@text_list: + + + + + + + +@comp: +@text_list: + + + + + + + +@comp: +@dt: + + + + + + + +@comp: +@dt: + + + + + + + +@comp: +@t: + + + + + + + +@comp: +@t: + + + + + + + +@comp: +@dt: + + + + + + + +@comp: +@dt: + + + + + + + +@comp: +@dt: + + + + + + + +@comp: +@dt: + + + + + + + +@comp: +@exdate_list: + + + + + + + +@comp: +@exdate_list: + + + + + + + +@comp: +@recur_list: + + + + + + + +@comp: +@recur_list: + + + + + + + +@comp: +@geo: + + + + + + + +@comp: +@geo: + + + + + + + +@comp: +@t: + + + + + + + +@comp: +@t: + + + + + + + +@comp: +@percent: + + + + + + + +@comp: +@percent: + + + + + + + +@comp: +@priority: + + + + + + + +@comp: +@priority: + + + + + + + +@comp: +@period_list: + + + + + + + +@comp: +@period_list: + + + + + + + +@comp: +@Returns: + + + + + + + +@comp: +@recur_list: + + + + + + + +@comp: +@recur_list: + + + + + + + +@comp: +@Returns: + + + + + + + +@comp: +@sequence: + + + + + + + +@comp: +@sequence: + + + + + + + +@comp: +@summary: + + + + + + + +@comp: +@summary: + + + + + + + +@comp: +@transp: + + + + + + + +@comp: +@transp: + + + + + + + +@comp: +@url: + + + + + + + +@comp: +@url: + + + + + + + +@comp: +@pilot_id: + + + + + + + +@comp: +@pilot_id: + + + + + + + +@comp: +@pilot_status: + + + + + + + +@comp: +@pilot_status: + + + + + + + +@categ_list: + + + + + + + +@dt: + + + + + + + +@exdate_list: + + + + + + + +@geo: + + + + + + + +@t: + + + + + + + +@percent: + + + + + + + +@priority: + + + + + + + +@period_list: + + + + + + + +@recur_list: + + + + + + + +@sequence: + + + + + + + +@text_list: + + + + + + + +@CAL_COMPONENT_ALARM_NONE: +@CAL_COMPONENT_ALARM_AUDIO: +@CAL_COMPONENT_ALARM_DISPLAY: +@CAL_COMPONENT_ALARM_EMAIL: +@CAL_COMPONENT_ALARM_PROCEDURE: +@CAL_COMPONENT_ALARM_UNKNOWN: + + + + + + +@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: +@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: + + + + + + +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: + + + + + + + + + + + + +@comp: +@Returns: + + + + + + + +@comp: +@Returns: + + + + + + + +@alarm: + + + + + + + +@alarm: +@action: + + + + + + + +@alarm: +@action: + + + + + + + +@alarm: +@trigger: + + + + + + + +@alarm: +@trigger: + + + + + + + +@trigger: + + + 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 @@ + +cal-recur + + + + + + + + + + + + + + + + + + + +@CAL_RECUR_YEARLY: +@CAL_RECUR_MONTHLY: +@CAL_RECUR_WEEKLY: +@CAL_RECUR_DAILY: +@CAL_RECUR_HOURLY: +@CAL_RECUR_MINUTELY: +@CAL_RECUR_SECONDLY: + + + + + + + + + + + + +@year: +@month: +@day: +@hour: +@minute: +@second: + + + + + + +@comp: +@instance_start: +@instace_end: +@data: +@Returns: + + + + + + + +@comp: +@start: +@end: +@cb: +@cb_data: + + + + + + + +@ir: +@Returns: + + + + + + + +@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 @@ + +cal-util + + + + + + + + + + + + + + + + + + + + + + + + + +@list: + + + + + + + + + + + + + +@list: + + + + + + + +@CALOBJ_TYPE_EVENT: +@CALOBJ_TYPE_TODO: +@CALOBJ_TYPE_JOURNAL: +@CALOBJ_TYPE_ANY: + + + + + + +@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 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 @@ + +timeutil + + + + + + + + + + + + + + + + + + + +@itt: +@Returns: + + + + + + + +@str: +@Returns: + + + + + + + +@start: +@duration: +@Returns: + + + + + + + +@t: +@Returns: + + + + + + + +@t: +@Returns: + + + + + + + +@str: +@Returns: + + + + + + + +@secs: +@Returns: + + + + + + + +@time: +@minutes: +@Returns: + + + + + + + +@time: +@days: +@Returns: + + + + + + + +@time: +@weeks: +@Returns: + + + + + + + +@time: +@months: +@Returns: + + + + + + + +@time: +@years: +@Returns: + + + + + + + +@hour: +@use_am_pm: +@Returns: + + + + + + + +@year: +@month: +@Returns: + + + + + + + +@year: +@month: +@day: +@Returns: + + + + + + + +@t: +@hour: +@Returns: + + + + + + + +@t: +@Returns: + + + + + + + +@t: +@Returns: + + + + + + + +@t: +@Returns: + + + + + + + +@t: +@Returns: + + + + + + + +@t: +@Returns: + + + + + + + +@t: +@Returns: + + + + + + + +@t: +@Returns: + + + + + + + +@t: +@Returns: + + + + + + + +@str: +@Returns: + + + + + + + +@t: + + diff --git a/doc/devel/calendar/public-reference.sgml b/doc/devel/calendar/public-reference.sgml index afe3b85628..f8aa6e848d 100644 --- a/doc/devel/calendar/public-reference.sgml +++ b/doc/devel/calendar/public-reference.sgml @@ -10,6 +10,10 @@ &CalClient; + &CalComponent; + &cal-util; + &cal-recur; + &timeutil;