diff options
author | Federico Mena Quintero <federico@src.gnome.org> | 2001-06-25 07:54:24 +0800 |
---|---|---|
committer | Federico Mena Quintero <federico@src.gnome.org> | 2001-06-25 07:54:24 +0800 |
commit | f08f4c88be0ffdf26639a5100e8ffb31bbb6668b (patch) | |
tree | de3f65f67889edb76706a1bce705dc6c99d9a163 /doc/devel/calendar/cal-client | |
parent | f0df1441553d79218d1c7de679003109090cc203 (diff) | |
download | gsoc2013-evolution-f08f4c88be0ffdf26639a5100e8ffb31bbb6668b.tar.gz gsoc2013-evolution-f08f4c88be0ffdf26639a5100e8ffb31bbb6668b.tar.zst gsoc2013-evolution-f08f4c88be0ffdf26639a5100e8ffb31bbb6668b.zip |
Sync - Federico
svn path=/trunk/; revision=10455
Diffstat (limited to 'doc/devel/calendar/cal-client')
4 files changed, 146 insertions, 83 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 d2f3663315..b6aeb89512 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt @@ -74,6 +74,14 @@ struct CalClient { CalClientPrivate *priv; }; </STRUCT> +<USER_FUNCTION> +<NAME>CalClientAuthFunc</NAME> +<RETURNS>gchar *</RETURNS> +CalClient *client, + const gchar *prompt, + const gchar *key, + gpointer user_data +</USER_FUNCTION> <FUNCTION> <NAME>cal_client_get_type</NAME> <RETURNS>GtkType </RETURNS> @@ -90,6 +98,11 @@ CalClient *client void </FUNCTION> <FUNCTION> +<NAME>cal_client_set_auth_func</NAME> +<RETURNS>void </RETURNS> +CalClient *client, CalClientAuthFunc func, gpointer data +</FUNCTION> +<FUNCTION> <NAME>cal_client_open_calendar</NAME> <RETURNS>gboolean </RETURNS> 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 </FUNCTION> <FUNCTION> +<NAME>cal_client_get_free_busy</NAME> +<RETURNS>CalClientGetStatus </RETURNS> +CalClient *client, time_t start, time_t end,CalComponent **comp +</FUNCTION> +<FUNCTION> <NAME>cal_client_generate_instances</NAME> <RETURNS>void </RETURNS> CalClient *client, CalObjType type,time_t start, time_t end,CalRecurInstanceFn cb, gpointer cb_data 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 0ce8d9427d..8e33be4933 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ b/doc/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 <SUBSECTION Standard> @@ -42,3 +43,27 @@ CalClient CalClientPrivate </SECTION> + + +<SECTION> +<FILE>cal-query</FILE> +CAL_QUERY +<TITLE>CalQuery</TITLE> + +CalQueryDoneStatus +cal_query_new + +<SUBSECTION Standard> + +CAL_QUERY_TYPE +IS_CAL_QUERY +CAL_QUERY_CLASS +IS_CAL_QUERY_CLASS +cal_query_get_type +cal_query_construct + +<SUBSECTION Private> +CalQuery +CalQueryPrivate + +</SECTION> diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml index e29fd8811f..27b0c28f98 100644 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml @@ -255,3 +255,67 @@ GTK+ object for communication with personal calendar server. @Returns: +<!-- ##### FUNCTION cal_client_get_query ##### --> +<para> + +</para> + +@client: +@sexp: +@Returns: + + +<!-- ##### SIGNAL CalClient::cal-opened ##### --> +<para> + +</para> + +@calclient: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL CalClient::obj-updated ##### --> + <para> + 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. + </para> + +@calclient: the object which received the signal. +@arg1: +<!-- # Unused Parameters # --> +@client: Calendar client which received the notification. +@uid: Unique identifier of the calendar component that changed in the + personal calendar server's storage. + +<!-- ##### SIGNAL CalClient::obj-removed ##### --> + <para> + 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. + </para> + +@calclient: the object which received the signal. +@arg1: +<!-- # Unused Parameters # --> +@client: Calendar client which received the notification. +@uid: Unique identifier of the calendar component that was removed + from the personal calendar server's storage. + +<!-- +Local variables: +mode: sgml +sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "") +End: +--> + +<!-- ##### SIGNAL CalClient::forget-password ##### --> +<para> + +</para> + +@calclient: the object which received the signal. +@arg1: + 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 3d050e171b..3e8ce25ee6 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,11 +1,30 @@ -<!-- ##### FUNCTION cal_client_load_calendar ##### --> -<para> +<!-- ##### 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> -</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. + +<!-- ##### 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> -@client: -@str_uri: -@Returns: <!-- ##### FUNCTION cal_client_create_calendar ##### --> <para> @@ -16,14 +35,6 @@ @str_uri: @Returns: -<!-- ##### SIGNAL CalClient::cal-opened ##### --> -<para> - -</para> - -@calclient: the object which received the signal. -@arg1: - <!-- ##### FUNCTION cal_client_get_events_in_range ##### --> <para> @@ -34,20 +45,15 @@ @end: @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> +<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### --> +<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. +</para> + +@client: +@pilot_id: +@uid: +@Returns: <!-- ##### FUNCTION cal_client_is_loaded ##### --> <para> @@ -57,72 +63,22 @@ @client: @Returns: -<!-- ##### SIGNAL CalClient::obj-updated ##### --> - <para> - 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. - </para> - -@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. - -<!-- ##### FUNCTION cal_client_update_pilot_id ##### --> +<!-- ##### FUNCTION cal_client_load_calendar ##### --> <para> </para> @client: -@uid: -@pilot_id: -@pilot_status: - -<!-- ##### 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> - +@str_uri: +@Returns: -<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### --> +<!-- ##### FUNCTION cal_client_update_pilot_id ##### --> <para> </para> @client: -@pilot_id: @uid: -@Returns: - -<!-- ##### SIGNAL CalClient::obj-removed ##### --> - <para> - 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. - </para> - -@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. - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "") -End: ---> +@pilot_id: +@pilot_status: |