diff options
Diffstat (limited to 'doc/devel/calendar/cal-client')
-rw-r--r-- | doc/devel/calendar/cal-client/evolution-cal-client-decl.txt | 145 | ||||
-rw-r--r-- | doc/devel/calendar/cal-client/tmpl/cal-client.sgml | 9 |
2 files changed, 152 insertions, 2 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 5511d9fb74..bf42dee8d2 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt @@ -1,3 +1,116 @@ +<MACRO> +<NAME>CAL_CLIENT_MULTI_TYPE</NAME> +#define CAL_CLIENT_MULTI_TYPE (cal_client_multi_get_type ()) +</MACRO> +<MACRO> +<NAME>CAL_CLIENT_MULTI</NAME> +#define CAL_CLIENT_MULTI(obj) (GTK_CHECK_CAST ((obj), CAL_CLIENT_MULTI_TYPE, CalClientMulti)) +</MACRO> +<MACRO> +<NAME>CAL_CLIENT_MULTI_CLASS</NAME> +#define CAL_CLIENT_MULTI_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_CLIENT_MULTI_TYPE, CalClientMultiClass)) +</MACRO> +<MACRO> +<NAME>IS_CAL_CLIENT_MULTI</NAME> +#define IS_CAL_CLIENT_MULTI(obj) (GTK_CHECK_TYPE ((obj), CAL_CLIENT_MULTI_TYPE)) +</MACRO> +<MACRO> +<NAME>IS_CAL_CLIENT_MULTI_CLASS</NAME> +#define IS_CAL_CLIENT_MULTI_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_CLIENT_MULTI_TYPE)) +</MACRO> +<STRUCT> +<NAME>CalClientMulti</NAME> +</STRUCT> +<STRUCT> +<NAME>CalClientMultiClass</NAME> +</STRUCT> +<STRUCT> +<NAME>CalClientMultiPrivate</NAME> +</STRUCT> +<STRUCT> +<NAME>CalClientMulti</NAME> +struct CalClientMulti { + GtkObject object; + + /* Private data */ + CalClientMultiPrivate *priv; +}; +</STRUCT> +<FUNCTION> +<NAME>cal_client_multi_get_type</NAME> +<RETURNS>GtkType </RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_new</NAME> +<RETURNS>CalClientMulti *</RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_add_client</NAME> +<RETURNS>void </RETURNS> +CalClientMulti *multi, CalClient *client +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_set_auth_func</NAME> +<RETURNS>void </RETURNS> +CalClientMulti *multi,CalClientAuthFunc func,gpointer user_data +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_open_calendar</NAME> +<RETURNS>CalClient *</RETURNS> +CalClientMulti *multi,const char *str_uri,gboolean only_if_exists +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_get_client_for_uri</NAME> +<RETURNS>CalClient *</RETURNS> +CalClientMulti *multi,const char *uri +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_get_n_objects</NAME> +<RETURNS>int </RETURNS> +CalClientMulti *multi, CalObjType type +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_get_object</NAME> +<RETURNS>CalClientGetStatus </RETURNS> +CalClientMulti *multi,const char *uid,CalComponent **comp +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_get_timezone</NAME> +<RETURNS>CalClientGetStatus </RETURNS> +CalClientMulti *multi,const char *tzid,icaltimezone **zone +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_get_uids</NAME> +<RETURNS>GList *</RETURNS> +CalClientMulti *multi, CalObjType type +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_get_changes</NAME> +<RETURNS>GList *</RETURNS> +CalClientMulti *multi,CalObjType type,const char *change_id +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_get_objects_in_range</NAME> +<RETURNS>GList *</RETURNS> +CalClientMulti *multi,CalObjType type,time_t start,time_t end +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_get_free_busy</NAME> +<RETURNS>GList *</RETURNS> +CalClientMulti *multi,GList *users,time_t start,time_t end +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_generate_instances</NAME> +<RETURNS>void </RETURNS> +CalClientMulti *multi,CalObjType type,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data +</FUNCTION> +<FUNCTION> +<NAME>cal_client_multi_get_alarms_in_range</NAME> +<RETURNS>GSList *</RETURNS> +CalClientMulti *multi,time_t start, time_t end +</FUNCTION> <ENUM> <NAME>CalClientChangeType</NAME> typedef enum { @@ -50,6 +163,14 @@ typedef enum { } CalClientOpenStatus; </ENUM> <ENUM> +<NAME>CalClientSetModeStatus</NAME> +typedef enum { + CAL_CLIENT_SET_MODE_SUCCESS, + CAL_CLIENT_SET_MODE_ERROR, + CAL_CLIENT_SET_MODE_NOT_SUPPORTED +} CalClientSetModeStatus; +</ENUM> +<ENUM> <NAME>CalClientGetStatus</NAME> typedef enum { CAL_CLIENT_GET_SUCCESS, @@ -103,11 +224,21 @@ void CalClient *client, CalClientAuthFunc func, gpointer data </FUNCTION> <FUNCTION> +<NAME>cal_client_set_default_timezone</NAME> +<RETURNS>gboolean </RETURNS> +CalClient *client, icaltimezone *zone +</FUNCTION> +<FUNCTION> <NAME>cal_client_open_calendar</NAME> <RETURNS>gboolean </RETURNS> CalClient *client, const char *str_uri, gboolean only_if_exists </FUNCTION> <FUNCTION> +<NAME>cal_client_uri_list</NAME> +<RETURNS>GList *</RETURNS> +CalClient *client, CalMode mode +</FUNCTION> +<FUNCTION> <NAME>cal_client_get_load_state</NAME> <RETURNS>CalClientLoadState </RETURNS> CalClient *client @@ -118,6 +249,11 @@ CalClient *client CalClient *client </FUNCTION> <FUNCTION> +<NAME>cal_client_set_mode</NAME> +<RETURNS>gboolean </RETURNS> +CalClient *client, CalMode mode +</FUNCTION> +<FUNCTION> <NAME>cal_client_get_n_objects</NAME> <RETURNS>int </RETURNS> CalClient *client, CalObjType type @@ -149,8 +285,8 @@ 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 +<RETURNS>GList *</RETURNS> +CalClient *client, GList *users,time_t start, time_t end </FUNCTION> <FUNCTION> <NAME>cal_client_generate_instances</NAME> @@ -197,6 +333,11 @@ CalClient *client, const char *sexp <RETURNS>icaltimezone *</RETURNS> const char *tzid, gpointer data </FUNCTION> +<FUNCTION> +<NAME>cal_client_get_component_as_string</NAME> +<RETURNS>char *</RETURNS> +CalClient *client,CalComponent *comp +</FUNCTION> <MACRO> <NAME>CAL_QUERY_TYPE</NAME> #define CAL_QUERY_TYPE (cal_query_get_type ()) diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml index dac080cca1..4426d6c478 100644 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml @@ -273,6 +273,15 @@ GTK+ object for communication with personal calendar server. @calclient: the object which received the signal. @arg1: +<!-- ##### SIGNAL CalClient::cal-set-mode ##### --> +<para> + +</para> + +@calclient: the object which received the signal. +@arg1: +@arg2: + <!-- ##### SIGNAL CalClient::obj-updated ##### --> <para> This signal is emitted when the calendar clients receives |