diff options
Diffstat (limited to 'doc/devel/calendar')
11 files changed, 360 insertions, 289 deletions
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 54de988830..0bc30e6462 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt @@ -1,16 +1,3 @@ -<ENUM> -<NAME>CalClientChangeType</NAME> -typedef enum { - CAL_CLIENT_CHANGE_ADDED = 1 << 0, - CAL_CLIENT_CHANGE_MODIFIED = 1 << 1, - CAL_CLIENT_CHANGE_DELETED = 1 << 2 -} CalClientChangeType; -</ENUM> -<FUNCTION> -<NAME>cal_client_change_list_free</NAME> -<RETURNS>void </RETURNS> -GList *list -</FUNCTION> <MACRO> <NAME>CAL_CLIENT_TYPE</NAME> #define CAL_CLIENT_TYPE (cal_client_get_type ()) @@ -41,13 +28,13 @@ GList *list <NAME>CalClientPrivate</NAME> </STRUCT> <ENUM> -<NAME>CalClientLoadStatus</NAME> +<NAME>CalClientOpenStatus</NAME> typedef enum { - CAL_CLIENT_LOAD_SUCCESS, - CAL_CLIENT_LOAD_ERROR, - CAL_CLIENT_LOAD_IN_USE, - CAL_CLIENT_LOAD_METHOD_NOT_SUPPORTED -} CalClientLoadStatus; + CAL_CLIENT_OPEN_SUCCESS, + CAL_CLIENT_OPEN_ERROR, + CAL_CLIENT_OPEN_NOT_FOUND, + CAL_CLIENT_OPEN_METHOD_NOT_SUPPORTED +} CalClientOpenStatus; </ENUM> <ENUM> <NAME>CalClientGetStatus</NAME> @@ -57,6 +44,14 @@ typedef enum { CAL_CLIENT_GET_SYNTAX_ERROR } CalClientGetStatus; </ENUM> +<ENUM> +<NAME>CalClientLoadState</NAME> +typedef enum { + CAL_CLIENT_LOAD_NOT_LOADED, + CAL_CLIENT_LOAD_LOADING, + CAL_CLIENT_LOAD_LOADED +} CalClientLoadState; +</ENUM> <STRUCT> <NAME>CalClient</NAME> struct CalClient { @@ -66,19 +61,6 @@ struct CalClient { CalClientPrivate *priv; }; </STRUCT> -<STRUCT> -<NAME>CalClientClass</NAME> -struct CalClientClass { - GtkObjectClass parent_class; - - /* Notification signals */ - - void (* cal_loaded) (CalClient *client, CalClientLoadStatus status); - - void (* obj_updated) (CalClient *client, const char *uid); - void (* obj_removed) (CalClient *client, const char *uid); -}; -</STRUCT> <FUNCTION> <NAME>cal_client_get_type</NAME> <RETURNS>GtkType </RETURNS> @@ -95,18 +77,18 @@ CalClient *client void </FUNCTION> <FUNCTION> -<NAME>cal_client_load_calendar</NAME> +<NAME>cal_client_open_calendar</NAME> <RETURNS>gboolean </RETURNS> -CalClient *client, const char *str_uri +CalClient *client, const char *str_uri, gboolean only_if_exists </FUNCTION> <FUNCTION> -<NAME>cal_client_create_calendar</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *str_uri +<NAME>cal_client_get_load_state</NAME> +<RETURNS>CalClientLoadState </RETURNS> +CalClient *client </FUNCTION> <FUNCTION> -<NAME>cal_client_is_loaded</NAME> -<RETURNS>gboolean </RETURNS> +<NAME>cal_client_get_uri</NAME> +<RETURNS>const char *</RETURNS> CalClient *client </FUNCTION> <FUNCTION> @@ -164,3 +146,16 @@ CalClient *client, CalComponent *comp <RETURNS>gboolean </RETURNS> CalClient *client, const char *uid </FUNCTION> +<ENUM> +<NAME>CalClientChangeType</NAME> +typedef enum { + CAL_CLIENT_CHANGE_ADDED = 1 << 0, + CAL_CLIENT_CHANGE_MODIFIED = 1 << 1, + CAL_CLIENT_CHANGE_DELETED = 1 << 2 +} CalClientChangeType; +</ENUM> +<FUNCTION> +<NAME>cal_client_change_list_free</NAME> +<RETURNS>void </RETURNS> +GList *list +</FUNCTION> 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 3e4eafbf48..0ce8d9427d 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt @@ -5,15 +5,16 @@ CAL_CLIENT <TITLE>CalClient</TITLE> -CalClientLoadStatus +CalClientOpenStatus CalClientGetStatus +CalClientLoadState CalClientChangeType cal_client_new -cal_client_load_calendar -cal_client_create_calendar -cal_client_is_loaded +cal_client_open_calendar +cal_client_get_load_state +cal_client_get_uri cal_client_get_n_objects cal_client_get_uids cal_client_get_object diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy b/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy index 21651b5e89..88efa3e673 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy +++ b/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy @@ -1,5 +1,2 @@ GtkObject - GtkWidget - GtkRange - GtkContainer CalClient diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.signals b/doc/devel/calendar/cal-client/evolution-cal-client.signals index 97e360b6a2..65d142777a 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client.signals +++ b/doc/devel/calendar/cal-client/evolution-cal-client.signals @@ -1,21 +1,21 @@ <SIGNAL> -<NAME>CalClient::cal-loaded</NAME> +<NAME>CalClient::cal-opened</NAME> <RETURNS>void</RETURNS> CalClient *calclient -GtkEnum arg1 +gint arg1 </SIGNAL> <SIGNAL> <NAME>CalClient::obj-updated</NAME> <RETURNS>void</RETURNS> CalClient *calclient -GtkString arg1 +gchar *arg1 </SIGNAL> <SIGNAL> <NAME>CalClient::obj-removed</NAME> <RETURNS>void</RETURNS> CalClient *calclient -GtkString arg1 +gchar *arg1 </SIGNAL> diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml index d3ef7c8113..06195ca454 100644 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml @@ -49,18 +49,15 @@ GTK+ object for communication with personal calendar server. @obj: A GTK+ object. -<!-- ##### ENUM CalClientLoadStatus ##### --> - <para> - These values describe the status of a calendar load or create - request. After asking a calendar factory to load or create a - calendar, the provided listener will get notification about the - result in asynchronous fashion. Such notification is represented - by one of these enumeration values. For values other than - #CAL_CLIENT_LOAD_SUCCESS, the #CalClient object will not accept - any other operations on the calendar and it should just be - destroyed. - </para> +<!-- ##### ENUM CalClientOpenStatus ##### --> +<para> + +</para> +@CAL_CLIENT_OPEN_SUCCESS: +@CAL_CLIENT_OPEN_ERROR: +@CAL_CLIENT_OPEN_NOT_FOUND: +@CAL_CLIENT_OPEN_METHOD_NOT_SUPPORTED: <!-- ##### ENUM CalClientGetStatus ##### --> <para> @@ -68,12 +65,27 @@ GTK+ object for communication with personal calendar server. function. </para> +@CAL_CLIENT_GET_SUCCESS: +@CAL_CLIENT_GET_NOT_FOUND: +@CAL_CLIENT_GET_SYNTAX_ERROR: + +<!-- ##### ENUM CalClientLoadState ##### --> +<para> + +</para> + +@CAL_CLIENT_LOAD_NOT_LOADED: +@CAL_CLIENT_LOAD_LOADING: +@CAL_CLIENT_LOAD_LOADED: <!-- ##### ENUM CalClientChangeType ##### --> <para> </para> +@CAL_CLIENT_CHANGE_ADDED: +@CAL_CLIENT_CHANGE_MODIFIED: +@CAL_CLIENT_CHANGE_DELETED: <!-- ##### FUNCTION cal_client_new ##### --> <para> @@ -83,27 +95,27 @@ GTK+ object for communication with personal calendar server. @Returns: -<!-- ##### FUNCTION cal_client_load_calendar ##### --> +<!-- ##### FUNCTION cal_client_open_calendar ##### --> <para> </para> @client: @str_uri: +@only_if_exists: @Returns: -<!-- ##### FUNCTION cal_client_create_calendar ##### --> +<!-- ##### FUNCTION cal_client_get_load_state ##### --> <para> </para> @client: -@str_uri: @Returns: -<!-- ##### FUNCTION cal_client_is_loaded ##### --> +<!-- ##### FUNCTION cal_client_get_uri ##### --> <para> </para> @@ -243,21 +255,13 @@ GTK+ object for communication with personal calendar server. @Returns: -<!-- ##### SIGNAL CalClient::cal-loaded ##### --> - <para> - This signal is emitted some time after the calendar clients sends - a load or create request to the personal calendar server. The - server will notify the client asynchronously of the completion of - the request. The @status parameter indicates the status of the - request. - </para> +<!-- ##### SIGNAL CalClient::cal-opened ##### --> +<para> + +</para> @calclient: the object which received the signal. @arg1: -<!-- # Unused Parameters # --> -@client: Calendar client which received the notification. -@status: Status of the request. See the description of - #CalClientLoadStatus for more details. <!-- ##### SIGNAL CalClient::obj-updated ##### --> <para> 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 77eb4a2b15..ccfb33de4d 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 @@ -1,3 +1,13 @@ +<!-- ##### FUNCTION cal_client_update_pilot_id ##### --> +<para> + +</para> + +@client: +@uid: +@pilot_id: +@pilot_status: + <!-- ##### FUNCTION cal_client_get_events_in_range ##### --> <para> @@ -8,15 +18,59 @@ @end: @Returns: -<!-- ##### FUNCTION cal_client_update_pilot_id ##### --> +<!-- ##### FUNCTION cal_client_load_calendar ##### --> <para> </para> @client: -@uid: -@pilot_id: -@pilot_status: +@str_uri: +@Returns: + +<!-- ##### SIGNAL CalClient::cal-loaded ##### --> + <para> + This signal is emitted some time after the calendar clients sends + a load or create request to the personal calendar server. The + server will notify the client asynchronously of the completion of + the request. The @status parameter indicates the status of the + request. + </para> + +@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. + +<!-- ##### FUNCTION cal_client_is_loaded ##### --> +<para> + +</para> + +@client: +@Returns: + +<!-- ##### ENUM CalClientLoadStatus ##### --> + <para> + These values describe the status of a calendar load or create + request. After asking a calendar factory to load or create a + calendar, the provided listener will get notification about the + result in asynchronous fashion. Such notification is represented + by one of these enumeration values. For values other than + #CAL_CLIENT_LOAD_SUCCESS, the #CalClient object will not accept + any other operations on the calendar and it should just be + destroyed. + </para> + + +<!-- ##### FUNCTION cal_client_create_calendar ##### --> +<para> + +</para> + +@client: +@str_uri: +@Returns: <!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### --> <para> diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt index a8fdbd7b72..573ce73a65 100644 --- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -1,128 +1,3 @@ -<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 ()) @@ -758,3 +633,128 @@ 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> +<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> diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt index 130209e71c..1a03226591 100644 --- a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt +++ b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt @@ -23,6 +23,8 @@ cal_component_get_as_string cal_component_commit_sequence cal_component_get_uid cal_component_set_uid +cal_component_get_categories +cal_component_set_categories cal_component_get_categories_list cal_component_set_categories_list cal_component_get_classification diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml index b38745bbca..0cf6089d60 100644 --- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml +++ b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml @@ -262,6 +262,24 @@ RFC 2445 iCalendar component object. @uid: +<!-- ##### FUNCTION cal_component_get_categories ##### --> +<para> + +</para> + +@comp: +@categories: + + +<!-- ##### FUNCTION cal_component_set_categories ##### --> +<para> + +</para> + +@comp: +@categories: + + <!-- ##### FUNCTION cal_component_get_categories_list ##### --> <para> 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 index 93625da7df..ff68fae99d 100644 --- a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml +++ b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml @@ -1,38 +1,44 @@ -<!-- ##### ENUM CalComponentAlarmAction ##### --> +<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### --> <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: +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: -<!-- ##### FUNCTION time_from_isodate ##### --> +<!-- ##### FUNCTION cal_recur_free ##### --> <para> </para> -@str: -@Returns: +@r: -<!-- ##### FUNCTION cal_component_get_pilot_status ##### --> +<!-- ##### ENUM CalRecurType ##### --> <para> </para> -@comp: -@pilot_status: +@CAL_RECUR_YEARLY: +@CAL_RECUR_MONTHLY: +@CAL_RECUR_WEEKLY: +@CAL_RECUR_DAILY: +@CAL_RECUR_HOURLY: +@CAL_RECUR_MINUTELY: +@CAL_RECUR_SECONDLY: -<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### --> +<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### --> <para> </para> -@ir: -@Returns: + +<!-- ##### FUNCTION cal_component_get_pilot_id ##### --> +<para> + +</para> + +@comp: +@pilot_id: <!-- ##### FUNCTION get_time_t_hour ##### --> <para> @@ -42,29 +48,28 @@ @t: @Returns: -<!-- ##### FUNCTION time_from_start_duration ##### --> +<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### --> <para> </para> -@start: -@duration: -@Returns: +@trigger: <!-- +Local variables: +mode: sgml +sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "") +End: +--> -<!-- ##### ENUM CalRecurType ##### --> +<!-- ##### FUNCTION time_day_hour ##### --> <para> </para> -@CAL_RECUR_YEARLY: -@CAL_RECUR_MONTHLY: -@CAL_RECUR_WEEKLY: -@CAL_RECUR_DAILY: -@CAL_RECUR_HOURLY: -@CAL_RECUR_MINUTELY: -@CAL_RECUR_SECONDLY: +@t: +@hour: +@Returns: -<!-- ##### FUNCTION parse_date ##### --> +<!-- ##### FUNCTION time_from_isodate ##### --> <para> </para> @@ -72,108 +77,113 @@ @str: @Returns: -<!-- ##### FUNCTION cal_component_get_pilot_id ##### --> +<!-- ##### FUNCTION cal_component_get_pilot_status ##### --> <para> </para> @comp: -@pilot_id: +@pilot_status: -<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### --> +<!-- ##### STRUCT CalObjTime ##### --> <para> </para> -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: +@year: +@month: +@day: +@hour: +@minute: +@second: -<!-- ##### FUNCTION isodiff_to_secs ##### --> +<!-- ##### STRUCT CalComponentPrivate ##### --> <para> </para> -@str: -@Returns: -<!-- ##### FUNCTION cal_recur_free ##### --> +<!-- ##### ENUM CalComponentAlarmTriggerType ##### --> <para> </para> -@r: +@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: +@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: -<!-- ##### FUNCTION time_from_icaltimetype ##### --> +<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### --> <para> </para> -@itt: +@ir: @Returns: -<!-- ##### FUNCTION time_day_hour ##### --> +<!-- ##### FUNCTION cal_alarm_instance_list_free ##### --> <para> </para> -@t: -@hour: -@Returns: +@list: -<!-- ##### FUNCTION cal_component_get_first_alarm ##### --> +<!-- ##### FUNCTION isodiff_to_secs ##### --> <para> </para> -@comp: +@str: @Returns: -<!-- ##### STRUCT CalComponentPrivate ##### --> +<!-- ##### FUNCTION cal_component_get_first_alarm ##### --> <para> </para> +@comp: +@Returns: -<!-- ##### FUNCTION isodiff_from_secs ##### --> +<!-- ##### TYPEDEF CalRecurrence ##### --> <para> </para> -@secs: -@Returns: -<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### --> +<!-- ##### FUNCTION cal_component_get_next_alarm ##### --> <para> </para> -@trigger: <!-- -Local variables: -mode: sgml -sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "") -End: ---> +@comp: +@Returns: -<!-- ##### TYPEDEF CalRecurrence ##### --> +<!-- ##### FUNCTION time_from_icaltimetype ##### --> <para> </para> +@itt: +@Returns: -<!-- ##### FUNCTION cal_alarm_instance_list_free ##### --> +<!-- ##### ENUM CalComponentAlarmAction ##### --> <para> </para> -@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: -<!-- ##### FUNCTION cal_component_set_pilot_status ##### --> +<!-- ##### FUNCTION time_from_start_duration ##### --> <para> </para> -@comp: -@pilot_status: +@start: +@duration: +@Returns: <!-- ##### FUNCTION cal_component_set_pilot_id ##### --> <para> @@ -183,17 +193,13 @@ End: @comp: @pilot_id: -<!-- ##### STRUCT CalObjTime ##### --> +<!-- ##### FUNCTION isodiff_from_secs ##### --> <para> </para> -@year: -@month: -@day: -@hour: -@minute: -@second: +@secs: +@Returns: <!-- ##### FUNCTION format_simple_hour ##### --> <para> @@ -204,25 +210,19 @@ End: @use_am_pm: @Returns: -<!-- ##### FUNCTION cal_component_get_next_alarm ##### --> +<!-- ##### FUNCTION cal_component_set_pilot_status ##### --> <para> </para> @comp: -@Returns: - -<!-- ##### ENUM CalComponentAlarmTriggerType ##### --> -<para> - -</para> - -@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: -@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: +@pilot_status: -<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### --> +<!-- ##### FUNCTION parse_date ##### --> <para> </para> +@str: +@Returns: diff --git a/doc/devel/calendar/evolution-calendar.sgml b/doc/devel/calendar/evolution-calendar.sgml index 019fef9ea4..ea0d8c7127 100644 --- a/doc/devel/calendar/evolution-calendar.sgml +++ b/doc/devel/calendar/evolution-calendar.sgml @@ -6,7 +6,7 @@ <surname>Mena Quintero</surname> <affiliation> <address> - <email>federico@helixcode.com</email> + <email>federico@ximian.com</email> </address> </affiliation> </author> |