From 0d98ffff7025693ccdf75fd11fe05b34b1d8fc6e Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Wed, 17 Jan 2001 10:48:30 +0000 Subject: Ximianified. 2001-01-17 Federico Mena Quintero * evolution-devel-guide.sgml: Ximianified. * calendar/evolution-calendar.sgml: Ditto. * calendar/cal-util/evolution-cal-util-sections.txt: Updated. * calendar/cal-client/evolution-cal-client-sections.txt: Updated. svn path=/trunk/; revision=7573 --- doc/devel/ChangeLog | 10 + .../cal-client/evolution-cal-client-decl.txt | 73 +++--- .../cal-client/evolution-cal-client-sections.txt | 9 +- .../cal-client/evolution-cal-client.hierarchy | 3 - .../cal-client/evolution-cal-client.signals | 8 +- doc/devel/calendar/cal-client/tmpl/cal-client.sgml | 58 ++--- .../tmpl/evolution-cal-client-unused.sgml | 62 ++++- .../calendar/cal-util/evolution-cal-util-decl.txt | 250 ++++++++++----------- .../cal-util/evolution-cal-util-sections.txt | 2 + .../calendar/cal-util/tmpl/cal-component.sgml | 18 ++ .../cal-util/tmpl/evolution-cal-util-unused.sgml | 164 +++++++------- doc/devel/calendar/evolution-calendar.sgml | 2 +- doc/devel/evolution-devel-guide.sgml | 7 +- 13 files changed, 376 insertions(+), 290 deletions(-) (limited to 'doc/devel') diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog index 15d8cfe1cc..3c06aedc0b 100644 --- a/doc/devel/ChangeLog +++ b/doc/devel/ChangeLog @@ -1,3 +1,13 @@ +2001-01-17 Federico Mena Quintero + + * evolution-devel-guide.sgml: Ximianified. + + * calendar/evolution-calendar.sgml: Ditto. + + * calendar/cal-util/evolution-cal-util-sections.txt: Updated. + + * calendar/cal-client/evolution-cal-client-sections.txt: Updated. + 2001-01-10 Federico Mena Quintero * Makefile.am: Make it work when gtk-doc is not installed. 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 @@ - -CalClientChangeType -typedef enum { - CAL_CLIENT_CHANGE_ADDED = 1 << 0, - CAL_CLIENT_CHANGE_MODIFIED = 1 << 1, - CAL_CLIENT_CHANGE_DELETED = 1 << 2 -} CalClientChangeType; - - -cal_client_change_list_free -void -GList *list - CAL_CLIENT_TYPE #define CAL_CLIENT_TYPE (cal_client_get_type ()) @@ -41,13 +28,13 @@ GList *list CalClientPrivate -CalClientLoadStatus +CalClientOpenStatus 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; CalClientGetStatus @@ -57,6 +44,14 @@ typedef enum { CAL_CLIENT_GET_SYNTAX_ERROR } CalClientGetStatus; + +CalClientLoadState +typedef enum { + CAL_CLIENT_LOAD_NOT_LOADED, + CAL_CLIENT_LOAD_LOADING, + CAL_CLIENT_LOAD_LOADED +} CalClientLoadState; + CalClient struct CalClient { @@ -66,19 +61,6 @@ struct CalClient { CalClientPrivate *priv; }; - -CalClientClass -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); -}; - cal_client_get_type GtkType @@ -95,18 +77,18 @@ CalClient *client void -cal_client_load_calendar +cal_client_open_calendar gboolean -CalClient *client, const char *str_uri +CalClient *client, const char *str_uri, gboolean only_if_exists -cal_client_create_calendar -gboolean -CalClient *client, const char *str_uri +cal_client_get_load_state +CalClientLoadState +CalClient *client -cal_client_is_loaded -gboolean +cal_client_get_uri +const char * CalClient *client @@ -164,3 +146,16 @@ CalClient *client, CalComponent *comp gboolean CalClient *client, const char *uid + +CalClientChangeType +typedef enum { + CAL_CLIENT_CHANGE_ADDED = 1 << 0, + CAL_CLIENT_CHANGE_MODIFIED = 1 << 1, + CAL_CLIENT_CHANGE_DELETED = 1 << 2 +} CalClientChangeType; + + +cal_client_change_list_free +void +GList *list + 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 CalClient -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 @@ -CalClient::cal-loaded +CalClient::cal-opened void CalClient *calclient -GtkEnum arg1 +gint arg1 CalClient::obj-updated void CalClient *calclient -GtkString arg1 +gchar *arg1 CalClient::obj-removed void CalClient *calclient -GtkString arg1 +gchar *arg1 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. - - - 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. - + + + + +@CAL_CLIENT_OPEN_SUCCESS: +@CAL_CLIENT_OPEN_ERROR: +@CAL_CLIENT_OPEN_NOT_FOUND: +@CAL_CLIENT_OPEN_METHOD_NOT_SUPPORTED: @@ -68,12 +65,27 @@ GTK+ object for communication with personal calendar server. function. +@CAL_CLIENT_GET_SUCCESS: +@CAL_CLIENT_GET_NOT_FOUND: +@CAL_CLIENT_GET_SYNTAX_ERROR: + + + + + + +@CAL_CLIENT_LOAD_NOT_LOADED: +@CAL_CLIENT_LOAD_LOADING: +@CAL_CLIENT_LOAD_LOADED: +@CAL_CLIENT_CHANGE_ADDED: +@CAL_CLIENT_CHANGE_MODIFIED: +@CAL_CLIENT_CHANGE_DELETED: @@ -83,27 +95,27 @@ GTK+ object for communication with personal calendar server. @Returns: - + @client: @str_uri: +@only_if_exists: @Returns: - + @client: -@str_uri: @Returns: - + @@ -243,21 +255,13 @@ GTK+ object for communication with personal calendar server. @Returns: - - - 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. - + + + + @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. 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 @@ + + + + + +@client: +@uid: +@pilot_id: +@pilot_status: + @@ -8,15 +18,59 @@ @end: @Returns: - + @client: -@uid: -@pilot_id: -@pilot_status: +@str_uri: +@Returns: + + + + 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. + + +@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. + + + + + + +@client: +@Returns: + + + + 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. + + + + + + + + +@client: +@str_uri: +@Returns: 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 @@ - -CalObjInstance -typedef struct { - char *uid; /* UID of the object */ - time_t start; /* Start time of instance */ - time_t end; /* End time of instance */ -} CalObjInstance; - - -cal_obj_instance_list_free -void -GList *list - - -CalObjType -typedef enum { - CALOBJ_TYPE_EVENT = 1 << 0, - CALOBJ_TYPE_TODO = 1 << 1, - CALOBJ_TYPE_JOURNAL = 1 << 2, - CALOBJ_TYPE_ANY = 0x07 -} CalObjType; - - -cal_obj_uid_list_free -void -GList *list - - -isodate_from_time_t -char * -time_t t - - -time_add_minutes -time_t -time_t time, int minutes - - -time_add_day -time_t -time_t time, int days - - -time_add_week -time_t -time_t time, int weeks - - -time_add_month -time_t -time_t time, int months - - -time_add_year -time_t -time_t time, int years - - -time_days_in_month -int -int year, int month - - -time_from_day -time_t -int year, int month, int day - - -time_year_begin -time_t -time_t t - - -time_year_end -time_t -time_t t - - -time_month_begin -time_t -time_t t - - -time_month_end -time_t -time_t t - - -time_week_begin -time_t -time_t t - - -time_week_end -time_t -time_t t - - -time_day_begin -time_t -time_t t - - -time_day_end -time_t -time_t t - - -print_time_t -void -time_t t - - -CalRecurInstanceFn -gboolean -CalComponent *comp, - time_t instance_start, - time_t instance_end, - gpointer data - - -cal_recur_generate_instances -void -CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data - CAL_COMPONENT_TYPE #define CAL_COMPONENT_TYPE (cal_component_get_type ()) @@ -758,3 +633,128 @@ CalComponentAlarm *alarm, CalAlarmTrigger *trigger void CalComponentAlarm *alarm, CalAlarmTrigger trigger + +CalRecurInstanceFn +gboolean +CalComponent *comp, + time_t instance_start, + time_t instance_end, + gpointer data + + +cal_recur_generate_instances +void +CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data + + +CalObjInstance +typedef struct { + char *uid; /* UID of the object */ + time_t start; /* Start time of instance */ + time_t end; /* End time of instance */ +} CalObjInstance; + + +cal_obj_instance_list_free +void +GList *list + + +CalObjType +typedef enum { + CALOBJ_TYPE_EVENT = 1 << 0, + CALOBJ_TYPE_TODO = 1 << 1, + CALOBJ_TYPE_JOURNAL = 1 << 2, + CALOBJ_TYPE_ANY = 0x07 +} CalObjType; + + +cal_obj_uid_list_free +void +GList *list + + +isodate_from_time_t +char * +time_t t + + +time_add_minutes +time_t +time_t time, int minutes + + +time_add_day +time_t +time_t time, int days + + +time_add_week +time_t +time_t time, int weeks + + +time_add_month +time_t +time_t time, int months + + +time_add_year +time_t +time_t time, int years + + +time_days_in_month +int +int year, int month + + +time_from_day +time_t +int year, int month, int day + + +time_year_begin +time_t +time_t t + + +time_year_end +time_t +time_t t + + +time_month_begin +time_t +time_t t + + +time_month_end +time_t +time_t t + + +time_week_begin +time_t +time_t t + + +time_week_end +time_t +time_t t + + +time_day_begin +time_t +time_t t + + +time_day_end +time_t +time_t t + + +print_time_t +void +time_t t + 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: + + + + + +@comp: +@categories: + + + + + + + +@comp: +@categories: + + 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 @@ - + -@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: - + -@str: -@Returns: +@r: - + -@comp: -@pilot_status: +@CAL_RECUR_YEARLY: +@CAL_RECUR_MONTHLY: +@CAL_RECUR_WEEKLY: +@CAL_RECUR_DAILY: +@CAL_RECUR_HOURLY: +@CAL_RECUR_MINUTELY: +@CAL_RECUR_SECONDLY: - + -@ir: -@Returns: + + + + + + +@comp: +@pilot_id: @@ -42,29 +48,28 @@ @t: @Returns: - + -@start: -@duration: -@Returns: +@trigger: - + -@CAL_RECUR_YEARLY: -@CAL_RECUR_MONTHLY: -@CAL_RECUR_WEEKLY: -@CAL_RECUR_DAILY: -@CAL_RECUR_HOURLY: -@CAL_RECUR_MINUTELY: -@CAL_RECUR_SECONDLY: +@t: +@hour: +@Returns: - + @@ -72,108 +77,113 @@ @str: @Returns: - + @comp: -@pilot_id: +@pilot_status: - + -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: +@year: +@month: +@day: +@hour: +@minute: +@second: - + -@str: -@Returns: - + -@r: +@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: +@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: - + -@itt: +@ir: @Returns: - + -@t: -@hour: -@Returns: +@list: - + -@comp: +@str: @Returns: - + +@comp: +@Returns: - + -@secs: -@Returns: - + -@trigger: +@comp: +@Returns: - + +@itt: +@Returns: - + -@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: - + -@comp: -@pilot_status: +@start: +@duration: +@Returns: @@ -183,17 +193,13 @@ End: @comp: @pilot_id: - + -@year: -@month: -@day: -@hour: -@minute: -@second: +@secs: +@Returns: @@ -204,25 +210,19 @@ End: @use_am_pm: @Returns: - + @comp: -@Returns: - - - - - - -@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: -@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: +@pilot_status: - + +@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 @@ Mena Quintero
- federico@helixcode.com + federico@ximian.com
diff --git a/doc/devel/evolution-devel-guide.sgml b/doc/devel/evolution-devel-guide.sgml index 0798375c98..a932839120 100644 --- a/doc/devel/evolution-devel-guide.sgml +++ b/doc/devel/evolution-devel-guide.sgml @@ -26,7 +26,7 @@ - Helix Code, Inc. + Ximian, Inc. @@ -35,6 +35,11 @@ Helix Code, Inc. + + 2001 + Ximian, Inc. + + Permission is granted to copy, distribute and/or modify this -- cgit v1.2.3