diff options
Diffstat (limited to 'help/devel/calendar/cal-client')
6 files changed, 132 insertions, 81 deletions
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 54de988830..0bc30e6462 100644 --- a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ b/help/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/help/devel/calendar/cal-client/evolution-cal-client-sections.txt b/help/devel/calendar/cal-client/evolution-cal-client-sections.txt index 3e4eafbf48..0ce8d9427d 100644 --- a/help/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ b/help/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/help/devel/calendar/cal-client/evolution-cal-client.hierarchy b/help/devel/calendar/cal-client/evolution-cal-client.hierarchy index 21651b5e89..88efa3e673 100644 --- a/help/devel/calendar/cal-client/evolution-cal-client.hierarchy +++ b/help/devel/calendar/cal-client/evolution-cal-client.hierarchy @@ -1,5 +1,2 @@ GtkObject - GtkWidget - GtkRange - GtkContainer CalClient diff --git a/help/devel/calendar/cal-client/evolution-cal-client.signals b/help/devel/calendar/cal-client/evolution-cal-client.signals index 97e360b6a2..65d142777a 100644 --- a/help/devel/calendar/cal-client/evolution-cal-client.signals +++ b/help/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/help/devel/calendar/cal-client/tmpl/cal-client.sgml b/help/devel/calendar/cal-client/tmpl/cal-client.sgml index d3ef7c8113..06195ca454 100644 --- a/help/devel/calendar/cal-client/tmpl/cal-client.sgml +++ b/help/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/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml index 77eb4a2b15..ccfb33de4d 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,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> |