From f08f4c88be0ffdf26639a5100e8ffb31bbb6668b Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Sun, 24 Jun 2001 23:54:24 +0000 Subject: Sync - Federico svn path=/trunk/; revision=10455 --- .../cal-client/evolution-cal-client-decl.txt | 18 +++ .../cal-client/evolution-cal-client-sections.txt | 25 ++++ .../devel/calendar/cal-client/tmpl/cal-client.sgml | 64 +++++++++ .../tmpl/evolution-cal-client-unused.sgml | 122 ++++++----------- .../calendar/cal-util/evolution-cal-util-decl.txt | 126 +++++++++++++++++- .../calendar/cal-util/tmpl/cal-component.sgml | 1 + .../cal-util/tmpl/evolution-cal-util-unused.sgml | 146 ++++++++++----------- help/devel/calendar/cal-util/tmpl/timeutil.sgml | 2 + help/devel/evolution-devel-guide.sgml | 13 +- 9 files changed, 348 insertions(+), 169 deletions(-) (limited to 'help/devel') diff --git a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt b/help/devel/calendar/cal-client/evolution-cal-client-decl.txt index d2f3663315..b6aeb89512 100644 --- a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ b/help/devel/calendar/cal-client/evolution-cal-client-decl.txt @@ -74,6 +74,14 @@ struct CalClient { CalClientPrivate *priv; }; + +CalClientAuthFunc +gchar * +CalClient *client, + const gchar *prompt, + const gchar *key, + gpointer user_data + cal_client_get_type GtkType @@ -90,6 +98,11 @@ CalClient *client void +cal_client_set_auth_func +void +CalClient *client, CalClientAuthFunc func, gpointer data + + cal_client_open_calendar gboolean CalClient *client, const char *str_uri, gboolean only_if_exists @@ -130,6 +143,11 @@ CalClient *client, CalObjType type, const char *change_id CalClient *client, CalObjType type,time_t start, time_t end +cal_client_get_free_busy +CalClientGetStatus +CalClient *client, time_t start, time_t end,CalComponent **comp + + cal_client_generate_instances void CalClient *client, CalObjType type,time_t start, time_t end,CalRecurInstanceFn cb, gpointer cb_data diff --git a/help/devel/calendar/cal-client/evolution-cal-client-sections.txt b/help/devel/calendar/cal-client/evolution-cal-client-sections.txt index 0ce8d9427d..8e33be4933 100644 --- a/help/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ b/help/devel/calendar/cal-client/evolution-cal-client-sections.txt @@ -27,6 +27,7 @@ cal_client_free_alarms cal_client_get_alarms_for_object cal_client_update_object cal_client_remove_object +cal_client_get_query @@ -42,3 +43,27 @@ CalClient CalClientPrivate + + +
+cal-query +CAL_QUERY +CalQuery + +CalQueryDoneStatus +cal_query_new + + + +CAL_QUERY_TYPE +IS_CAL_QUERY +CAL_QUERY_CLASS +IS_CAL_QUERY_CLASS +cal_query_get_type +cal_query_construct + + +CalQuery +CalQueryPrivate + +
diff --git a/help/devel/calendar/cal-client/tmpl/cal-client.sgml b/help/devel/calendar/cal-client/tmpl/cal-client.sgml index e29fd8811f..27b0c28f98 100644 --- a/help/devel/calendar/cal-client/tmpl/cal-client.sgml +++ b/help/devel/calendar/cal-client/tmpl/cal-client.sgml @@ -255,3 +255,67 @@ GTK+ object for communication with personal calendar server. @Returns: + + + + + +@client: +@sexp: +@Returns: + + + + + + + +@calclient: the object which received the signal. +@arg1: + + + + This signal is emitted when the calendar clients receives + notification of a calendar component's data being changed in the + personal calendar server. Graphical clients may want to get the + 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. + + + + This signal is emitted when the calendar client receives + notification for a calendar component being removed from the + storage in the personal calendar server. Graphical clients may + want to delete the corresponding object from 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 was removed + from the personal calendar server's storage. + + + + + + + + +@calclient: the object which received the signal. +@arg1: + diff --git a/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml index 3d050e171b..3e8ce25ee6 100644 --- a/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ b/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml @@ -1,11 +1,30 @@ - - + + + 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. + + + + 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: @@ -16,14 +35,6 @@ @str_uri: @Returns: - - - - - -@calclient: the object which received the signal. -@arg1: - @@ -34,20 +45,15 @@ @end: @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: +@pilot_id: +@uid: +@Returns: @@ -57,72 +63,22 @@ @client: @Returns: - - - This signal is emitted when the calendar clients receives - notification of a calendar component's data being changed in the - personal calendar server. Graphical clients may want to get the - 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. - - + @client: -@uid: -@pilot_id: -@pilot_status: - - - - 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. - - +@str_uri: +@Returns: - + @client: -@pilot_id: @uid: -@Returns: - - - - This signal is emitted when the calendar client receives - notification for a calendar component being removed from the - storage in the personal calendar server. Graphical clients may - want to delete the corresponding object from 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 was removed - from the personal calendar server's storage. - - +@pilot_id: +@pilot_status: 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 6f6994d8c4..b40d57f8b4 100644 --- a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -52,6 +52,7 @@ typedef enum { CAL_COMPONENT_FIELD_OVERDUE, /* not a real field */ CAL_COMPONENT_FIELD_COLOR, /* not a real field */ CAL_COMPONENT_FIELD_STATUS, + CAL_COMPONENT_FIELD_COMPONENT, /* not a real field */ CAL_COMPONENT_FIELD_NUM_FIELDS } CalComponentField; @@ -95,6 +96,22 @@ typedef struct { } u; } CalComponentPeriod; + +CalComponentRangeType +typedef enum { + CAL_COMPONENT_RANGE_SINGLE, + CAL_COMPONENT_RANGE_THISPRIOR, + CAL_COMPONENT_RANGE_THISFUTURE, +} CalComponentRangeType; + + +CalComponentRange +typedef struct { + CalComponentRangeType type; + + CalComponentDateTime *datetime; +} CalComponentRange; + CalComponentText typedef struct { @@ -114,6 +131,66 @@ typedef enum { CAL_COMPONENT_TRANSP_UNKNOWN } CalComponentTransparency; + +CalComponentCUType +typedef enum { + CAL_COMPONENT_CUTYPE_INDIVIDUAL, + CAL_COMPONENT_CUTYPE_GROUP, + CAL_COMPONENT_CUTYPE_RESOURCE, + CAL_COMPONENT_CUTYPE_ROOM, + CAL_COMPONENT_CUTYPE_UNKNOWN +} CalComponentCUType; + + +CalComponentRole +typedef enum { + CAL_COMPONENT_ROLE_CHAIR, + CAL_COMPONENT_ROLE_REQUIRED, + CAL_COMPONENT_ROLE_OPTIONAL, + CAL_COMPONENT_ROLE_NON, + CAL_COMPONENT_ROLE_UNKNOWN +} CalComponentRole; + + +CalComponentPartStat +typedef enum { + CAL_COMPONENT_PARTSTAT_NEEDSACTION, + CAL_COMPONENT_PARTSTAT_ACCEPTED, + CAL_COMPONENT_PARTSTAT_DECLINED, + CAL_COMPONENT_PARTSTAT_TENTATIVE, + CAL_COMPONENT_PARTSTAT_DELEGATED, + CAL_COMPONENT_PARTSTAT_COMPLETED, + CAL_COMPONENT_PARTSTAT_INPROCESS, + CAL_COMPONENT_PARTSTAT_UNKNOWN +} CalComponentPartStat; + + +CalComponentAttendee +typedef struct { + const char *value; + + const char *member; + CalComponentCUType cutype; + CalComponentRole role; + CalComponentPartStat status; + gboolean rsvp; + + const char *delto; + const char *delfrom; + const char *sentby; + const char *cn; + const char *language; +} CalComponentAttendee; + + +CalComponentOrganizer +typedef struct { + const char *value; + const char *sentby; + const char *cn; + const char *language; +} CalComponentOrganizer; + CalComponent @@ -363,6 +440,16 @@ CalComponent *comp, struct icaltimetype **t CalComponent *comp, struct icaltimetype *t
+cal_component_get_organizer +void +CalComponent *comp, CalComponentOrganizer *organizer + + +cal_component_set_organizer +void +CalComponent *comp, CalComponentOrganizer *organizer + + cal_component_get_percent void CalComponent *comp, int **percent @@ -383,6 +470,16 @@ CalComponent *comp, int **priority CalComponent *comp, int *priority +cal_component_get_recurid +void +CalComponent *comp, CalComponentRange **recur_id + + +cal_component_set_recurid +void +CalComponent *comp, CalComponentRange *recur_id + + cal_component_get_rdate_list void CalComponent *comp, GSList **period_list @@ -473,6 +570,16 @@ CalComponent *comp, const char **url CalComponent *comp, const char *url +cal_component_get_attendee_list +void +CalComponent *comp, GSList **attendee_list + + +cal_component_set_attendee_list +void +CalComponent *comp, GSList *attendee_list + + cal_component_event_dates_match gboolean CalComponent *comp1, CalComponent *comp2 @@ -532,6 +639,11 @@ int *sequence void GSList *text_list + +cal_component_free_attendee_list +void +GSList *attendee_list + CalComponentAlarm @@ -615,11 +727,6 @@ CalComponent *comp CalComponent *comp, const char *auid -cal_component_free_alarm_uids -void -GList *alarm_uids - - cal_component_alarms_free void CalComponentAlarms *alarms @@ -630,6 +737,11 @@ CalComponentAlarms *alarms void +cal_component_alarm_clone +CalComponentAlarm * +CalComponentAlarm *alarm + + cal_component_alarm_get_uid const char * CalComponentAlarm *alarm @@ -767,12 +879,12 @@ time_t t time_week_begin time_t -time_t t +time_t t, int week_start_day time_week_end time_t -time_t t +time_t t, int week_start_day time_day_begin diff --git a/help/devel/calendar/cal-util/tmpl/cal-component.sgml b/help/devel/calendar/cal-util/tmpl/cal-component.sgml index 004e48674e..0bd957e9c2 100644 --- a/help/devel/calendar/cal-util/tmpl/cal-component.sgml +++ b/help/devel/calendar/cal-util/tmpl/cal-component.sgml @@ -115,6 +115,7 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_FIELD_OVERDUE: @CAL_COMPONENT_FIELD_COLOR: @CAL_COMPONENT_FIELD_STATUS: +@CAL_COMPONENT_FIELD_COMPONENT: @CAL_COMPONENT_FIELD_NUM_FIELDS: diff --git a/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml b/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml index 93625da7df..98c3ac55dd 100644 --- a/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml +++ b/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml @@ -10,46 +10,45 @@ @CAL_COMPONENT_ALARM_PROCEDURE: @CAL_COMPONENT_ALARM_UNKNOWN: - + -@str: -@Returns: - + -@comp: -@pilot_status: +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: - + -@ir: -@Returns: +@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: +@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: - + -@t: -@Returns: - + -@start: -@duration: -@Returns: +@year: +@month: +@day: +@hour: +@minute: +@second: @@ -64,165 +63,166 @@ @CAL_RECUR_MINUTELY: @CAL_RECUR_SECONDLY: - + -@str: -@Returns: - + -@comp: -@pilot_id: +@list: - + -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: +@trigger: - + -@str: +@comp: @Returns: - + -@r: +@comp: +@Returns: - + -@itt: -@Returns: +@comp: +@pilot_id: - + -@t: -@hour: -@Returns: +@comp: +@pilot_status: - + @comp: -@Returns: +@pilot_id: - + +@comp: +@pilot_status: - + -@secs: -@Returns: +@r: - + -@trigger: +@ir: +@Returns: - + +@hour: +@use_am_pm: +@Returns: - + -@list: +@t: +@Returns: - + -@comp: -@pilot_status: +@secs: +@Returns: - + -@comp: -@pilot_id: +@str: +@Returns: - + -@year: -@month: -@day: -@hour: -@minute: -@second: +@str: +@Returns: - + +@t: @hour: -@use_am_pm: @Returns: - + -@comp: +@itt: @Returns: - + -@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: -@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: +@str: +@Returns: - + +@start: +@duration: +@Returns: diff --git a/help/devel/calendar/cal-util/tmpl/timeutil.sgml b/help/devel/calendar/cal-util/tmpl/timeutil.sgml index 2b197ad685..2e7e15988d 100644 --- a/help/devel/calendar/cal-util/tmpl/timeutil.sgml +++ b/help/devel/calendar/cal-util/tmpl/timeutil.sgml @@ -136,6 +136,7 @@ timeutil @t: +@week_start_day: @Returns: @@ -145,6 +146,7 @@ timeutil @t: +@week_start_day: @Returns: diff --git a/help/devel/evolution-devel-guide.sgml b/help/devel/evolution-devel-guide.sgml index 10c779ce0c..c089c5b885 100644 --- a/help/devel/evolution-devel-guide.sgml +++ b/help/devel/evolution-devel-guide.sgml @@ -13,12 +13,6 @@ - + + + + + + &Evolution; Developer's Guide -- cgit v1.2.3