diff options
Diffstat (limited to 'help/devel/calendar/cal-util')
4 files changed, 144 insertions, 168 deletions
diff --git a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt index 5ffc920dd4..a8fdbd7b72 100644 --- a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -1,3 +1,128 @@ +<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> +<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>isodate_from_time_t</NAME> +<RETURNS>char *</RETURNS> +time_t t +</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>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_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>print_time_t</NAME> +<RETURNS>void </RETURNS> +time_t t +</FUNCTION> +<USER_FUNCTION> +<NAME>CalRecurInstanceFn</NAME> +<RETURNS>gboolean </RETURNS> +CalComponent *comp, + time_t instance_start, + time_t instance_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> <MACRO> <NAME>CAL_COMPONENT_TYPE</NAME> #define CAL_COMPONENT_TYPE (cal_component_get_type ()) @@ -64,7 +189,7 @@ typedef enum { CAL_COMPONENT_CLASS_UNKNOWN } CalComponentClassification; </ENUM> -<STRUCT> +<TYPEDEF> <NAME>CalComponentDateTime</NAME> typedef struct { /* Actual date/time value */ @@ -73,7 +198,7 @@ typedef struct { /* Timezone ID */ const char *tzid; } CalComponentDateTime; -</STRUCT> +</TYPEDEF> <ENUM> <NAME>CalComponentPeriodType</NAME> typedef enum { @@ -81,7 +206,7 @@ typedef enum { CAL_COMPONENT_PERIOD_DURATION } CalComponentPeriodType; </ENUM> -<STRUCT> +<TYPEDEF> <NAME>CalComponentPeriod</NAME> typedef struct { CalComponentPeriodType type; @@ -93,8 +218,8 @@ typedef struct { struct icaldurationtype duration; } u; } CalComponentPeriod; -</STRUCT> -<STRUCT> +</TYPEDEF> +<TYPEDEF> <NAME>CalComponentText</NAME> typedef struct { /* Description string */ @@ -103,7 +228,7 @@ typedef struct { /* Alternate representation URI */ const char *altrep; } CalComponentText; -</STRUCT> +</TYPEDEF> <ENUM> <NAME>CalComponentTransparency</NAME> typedef enum { @@ -131,12 +256,6 @@ struct CalComponent { CalComponentPrivate *priv; }; </STRUCT> -<STRUCT> -<NAME>CalComponentClass</NAME> -struct CalComponentClass { - GtkObjectClass parent_class; -}; -</STRUCT> <FUNCTION> <NAME>cal_component_get_type</NAME> <RETURNS>GtkType </RETURNS> @@ -535,7 +654,7 @@ GSList *text_list <STRUCT> <NAME>CalComponentAlarm</NAME> </STRUCT> -<STRUCT> +<TYPEDEF> <NAME>CalAlarmInstance</NAME> typedef struct { /* UID of the alarm that triggered */ @@ -547,8 +666,8 @@ typedef struct { /* Actual event occurrence to which this trigger corresponds */ time_t occur; } CalAlarmInstance; -</STRUCT> -<STRUCT> +</TYPEDEF> +<TYPEDEF> <NAME>CalComponentAlarms</NAME> typedef struct { /* The actual component */ @@ -557,7 +676,7 @@ typedef struct { /* List of CalAlarmInstance structures */ GSList *alarms; } CalComponentAlarms; -</STRUCT> +</TYPEDEF> <ENUM> <NAME>CalAlarmAction</NAME> typedef enum { @@ -578,7 +697,7 @@ typedef enum { CAL_ALARM_TRIGGER_ABSOLUTE } CalAlarmTriggerType; </ENUM> -<STRUCT> +<TYPEDEF> <NAME>CalAlarmTrigger</NAME> typedef struct { CalAlarmTriggerType type; @@ -588,7 +707,7 @@ typedef struct { struct icaltimetype abs_time; } u; } CalAlarmTrigger; -</STRUCT> +</TYPEDEF> <FUNCTION> <NAME>cal_component_has_alarms</NAME> <RETURNS>gboolean </RETURNS> @@ -639,128 +758,3 @@ CalComponentAlarm *alarm, CalAlarmTrigger *trigger <RETURNS>void </RETURNS> CalComponentAlarm *alarm, CalAlarmTrigger trigger </FUNCTION> -<USER_FUNCTION> -<NAME>CalRecurInstanceFn</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp, - time_t instance_start, - time_t instance_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> -<STRUCT> -<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; -</STRUCT> -<FUNCTION> -<NAME>cal_obj_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>isodate_from_time_t</NAME> -<RETURNS>char *</RETURNS> -time_t t -</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>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_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>print_time_t</NAME> -<RETURNS>void </RETURNS> -time_t t -</FUNCTION> diff --git a/help/devel/calendar/cal-util/evolution-cal-util.hierarchy b/help/devel/calendar/cal-util/evolution-cal-util.hierarchy index 469eb0f478..cc235653f2 100644 --- a/help/devel/calendar/cal-util/evolution-cal-util.hierarchy +++ b/help/devel/calendar/cal-util/evolution-cal-util.hierarchy @@ -1,5 +1,2 @@ GtkObject - GtkWidget - GtkRange - GtkContainer CalComponent diff --git a/help/devel/calendar/cal-util/tmpl/cal-component.sgml b/help/devel/calendar/cal-util/tmpl/cal-component.sgml index cb0362f2d3..b38745bbca 100644 --- a/help/devel/calendar/cal-util/tmpl/cal-component.sgml +++ b/help/devel/calendar/cal-util/tmpl/cal-component.sgml @@ -128,13 +128,11 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_CLASS_CONFIDENTIAL: @CAL_COMPONENT_CLASS_UNKNOWN: -<!-- ##### STRUCT CalComponentDateTime ##### --> +<!-- ##### TYPEDEF CalComponentDateTime ##### --> <para> This structure defines a date and time value. </para> -@value: -@tzid: <!-- ##### ENUM CalComponentPeriodType ##### --> <para> @@ -144,22 +142,18 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_PERIOD_DATETIME: @CAL_COMPONENT_PERIOD_DURATION: -<!-- ##### STRUCT CalComponentPeriod ##### --> +<!-- ##### TYPEDEF CalComponentPeriod ##### --> <para> This structure defines a period of time. </para> -@type: -@start: -<!-- ##### STRUCT CalComponentText ##### --> +<!-- ##### TYPEDEF CalComponentText ##### --> <para> This structure defines the value of a text property that may have an alternate representation parameter. </para> -@value: -@altrep: <!-- ##### ENUM CalComponentTransparency ##### --> <para> @@ -848,22 +842,17 @@ RFC 2445 iCalendar component object. </para> -<!-- ##### STRUCT CalAlarmInstance ##### --> +<!-- ##### TYPEDEF CalAlarmInstance ##### --> <para> </para> -@auid: -@trigger: -@occur: -<!-- ##### STRUCT CalComponentAlarms ##### --> +<!-- ##### TYPEDEF CalComponentAlarms ##### --> <para> </para> -@comp: -@alarms: <!-- ##### ENUM CalAlarmAction ##### --> <para> @@ -887,12 +876,11 @@ RFC 2445 iCalendar component object. @CAL_ALARM_TRIGGER_RELATIVE_END: @CAL_ALARM_TRIGGER_ABSOLUTE: -<!-- ##### STRUCT CalAlarmTrigger ##### --> +<!-- ##### TYPEDEF CalAlarmTrigger ##### --> <para> </para> -@type: <!-- ##### FUNCTION cal_component_has_alarms ##### --> <para> diff --git a/help/devel/calendar/cal-util/tmpl/cal-util.sgml b/help/devel/calendar/cal-util/tmpl/cal-util.sgml index d0742746e5..ccd35fac2e 100644 --- a/help/devel/calendar/cal-util/tmpl/cal-util.sgml +++ b/help/devel/calendar/cal-util/tmpl/cal-util.sgml @@ -14,14 +14,11 @@ Miscellaneous utilities </para> -<!-- ##### STRUCT CalObjInstance ##### --> +<!-- ##### TYPEDEF CalObjInstance ##### --> <para> </para> -@uid: -@start: -@end: <!-- ##### FUNCTION cal_obj_instance_list_free ##### --> <para> |