diff options
Diffstat (limited to 'help/devel/calendar/cal-client')
9 files changed, 0 insertions, 945 deletions
diff --git a/help/devel/calendar/cal-client/.cvsignore b/help/devel/calendar/cal-client/.cvsignore deleted file mode 100644 index 99dfc74bb8..0000000000 --- a/help/devel/calendar/cal-client/.cvsignore +++ /dev/null @@ -1,11 +0,0 @@ -sgml -Makefile -Makefile.in -*-decl.txt -*-decl-list.txt -*-unused.txt -*-undocumented.txt -*.hierarchy -*.signals -*.stamp -*-scan.c diff --git a/help/devel/calendar/cal-client/Makefile.am b/help/devel/calendar/cal-client/Makefile.am deleted file mode 100644 index bd01ad3b03..0000000000 --- a/help/devel/calendar/cal-client/Makefile.am +++ /dev/null @@ -1,198 +0,0 @@ -# The name of the module. -DOC_MODULE=evolution-cal-client - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-client - -# Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS= - -# Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS= - -# Used for dependencies. -HFILE_GLOB= \ - $(top_srcdir)/calendar/cal-client/cal-client.c \ - $(top_srcdir)/calendar/cal-client/cal-client-types.c - -CFILE_GLOB= \ - $(top_srcdir)/calendar/cal-client/cal-client.h \ - $(top_srcdir)/calendar/cal-client/cal-client-types.h - -# Header files to ignore when scanning. -IGNORE_HFILES= \ - cal-listener.h \ - evolution-calendar.h - -# Images to copy into HTML directory. -HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = - -# Other files to distribute. -extra_files = - -# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib -# contains GtkObjects/GObjects and you want to document signals and properties. -GTKDOC_CFLAGS= \ - -I$(top_srcdir)/calendar \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - -I$(top_builddir)/libical/src/libical \ - -I$(top_srcdir)/libical/src/libical \ - $(BONOBO_VFS_GNOME_CFLAGS) - -GTKDOC_LIBS= \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/calendar/cal-client/.libs/libcal-client-static.al\ - $(top_builddir)/calendar/cal-util/.libs/libcal-util-static.al \ - $(top_builddir)/libical/src/libical/.libs/libical-static.al \ - $(top_builddir)/libversit/.libs/libversit.al \ - $(top_builddir)/libwombat/libwombat.la - -GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in this file -# and uncomment this line. -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt -DOC_OVERRIDES = - -#DOC_DIR=$(datadir)/gnome/html - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_MODULE)-sections.txt \ - $(DOC_OVERRIDES) - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals - -if ENABLE_GTK_DOC -#all-local: html-build.stamp -all-local: sgml-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building SGML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -install-data-local: - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo $(srcdir)/html/*.html`; \ - if test "$$installfiles" = '$(srcdir)/html/*.html'; \ - then echo '-- Nothing to install' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/sgml - mkdir $(distdir)/html - -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml - -cp $(srcdir)/html/index.sgml $(distdir)/html - -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html - - images=$(HTML_IMAGES) ; \ - for i in $$images ; do \ - cp $(srcdir)/$$i $(distdir)/html ; \ - done - -.PHONY : dist-hook-local diff --git a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt b/help/devel/calendar/cal-client/evolution-cal-client-decl.txt deleted file mode 100644 index d2f3663315..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ /dev/null @@ -1,301 +0,0 @@ -<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 ()) -</MACRO> -<MACRO> -<NAME>CAL_CLIENT</NAME> -#define CAL_CLIENT(obj) (GTK_CHECK_CAST ((obj), CAL_CLIENT_TYPE, CalClient)) -</MACRO> -<MACRO> -<NAME>CAL_CLIENT_CLASS</NAME> -#define CAL_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_CLIENT_TYPE, CalClientClass)) -</MACRO> -<MACRO> -<NAME>IS_CAL_CLIENT</NAME> -#define IS_CAL_CLIENT(obj) (GTK_CHECK_TYPE ((obj), CAL_CLIENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_CAL_CLIENT_CLASS</NAME> -#define IS_CAL_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_CLIENT_TYPE)) -</MACRO> -<STRUCT> -<NAME>CalClient</NAME> -</STRUCT> -<STRUCT> -<NAME>CalClientClass</NAME> -</STRUCT> -<STRUCT> -<NAME>CalClientPrivate</NAME> -</STRUCT> -<ENUM> -<NAME>CalClientOpenStatus</NAME> -typedef enum { - 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> -typedef enum { - CAL_CLIENT_GET_SUCCESS, - CAL_CLIENT_GET_NOT_FOUND, - 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 { - GtkObject object; - - /* Private data */ - CalClientPrivate *priv; -}; -</STRUCT> -<FUNCTION> -<NAME>cal_client_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_client_construct</NAME> -<RETURNS>CalClient *</RETURNS> -CalClient *client -</FUNCTION> -<FUNCTION> -<NAME>cal_client_new</NAME> -<RETURNS>CalClient *</RETURNS> -void -</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_get_load_state</NAME> -<RETURNS>CalClientLoadState </RETURNS> -CalClient *client -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_uri</NAME> -<RETURNS>const char *</RETURNS> -CalClient *client -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_n_objects</NAME> -<RETURNS>int </RETURNS> -CalClient *client, CalObjType type -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_object</NAME> -<RETURNS>CalClientGetStatus </RETURNS> -CalClient *client,const char *uid,CalComponent **comp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_uids</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, CalObjType type -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_changes</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, CalObjType type, const char *change_id -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_objects_in_range</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, CalObjType type,time_t start, time_t end -</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 -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_alarms_in_range</NAME> -<RETURNS>GSList *</RETURNS> -CalClient *client, time_t start, time_t end -</FUNCTION> -<FUNCTION> -<NAME>cal_client_free_alarms</NAME> -<RETURNS>void </RETURNS> -GSList *comp_alarms -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_alarms_for_object</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *uid,time_t start, time_t end,CalComponentAlarms **alarms -</FUNCTION> -<FUNCTION> -<NAME>cal_client_update_object</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_remove_object</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *uid -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_query</NAME> -<RETURNS>CalQuery *</RETURNS> -CalClient *client, const char *sexp -</FUNCTION> -<MACRO> -<NAME>CAL_QUERY_TYPE</NAME> -#define CAL_QUERY_TYPE (cal_query_get_type ()) -</MACRO> -<MACRO> -<NAME>CAL_QUERY</NAME> -#define CAL_QUERY(obj) (GTK_CHECK_CAST ((obj), CAL_QUERY_TYPE, CalQuery)) -</MACRO> -<MACRO> -<NAME>CAL_QUERY_CLASS</NAME> -#define CAL_QUERY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_QUERY_TYPE, CalQueryClass)) -</MACRO> -<MACRO> -<NAME>IS_CAL_QUERY</NAME> -#define IS_CAL_QUERY(obj) (GTK_CHECK_TYPE ((obj), CAL_QUERY_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_CAL_QUERY_CLASS</NAME> -#define IS_CAL_QUERY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_QUERY_TYPE)) -</MACRO> -<ENUM> -<NAME>CalQueryDoneStatus</NAME> -typedef enum { - CAL_QUERY_DONE_SUCCESS, - CAL_QUERY_DONE_PARSE_ERROR -} CalQueryDoneStatus; -</ENUM> -<STRUCT> -<NAME>CalQueryPrivate</NAME> -</STRUCT> -<TYPEDEF> -<NAME>CalQuery</NAME> -typedef struct { - GtkObject object; - - /* Private data */ - CalQueryPrivate *priv; -} CalQuery; -</TYPEDEF> -<FUNCTION> -<NAME>cal_query_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_query_construct</NAME> -<RETURNS>CalQuery *</RETURNS> -CalQuery *query,GNOME_Evolution_Calendar_Cal cal,const char *sexp -</FUNCTION> -<FUNCTION> -<NAME>cal_query_new</NAME> -<RETURNS>CalQuery *</RETURNS> -GNOME_Evolution_Calendar_Cal cal,const char *sexp -</FUNCTION> -<MACRO> -<NAME>QUERY_LISTENER_TYPE</NAME> -#define QUERY_LISTENER_TYPE (query_listener_get_type ()) -</MACRO> -<MACRO> -<NAME>QUERY_LISTENER</NAME> -#define QUERY_LISTENER(obj) (GTK_CHECK_CAST ((obj), QUERY_LISTENER_TYPE, QueryListener)) -</MACRO> -<MACRO> -<NAME>QUERY_LISTENER_CLASS</NAME> -#define QUERY_LISTENER_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), QUERY_LISTENER_TYPE, \ - QueryListenerClass)) -</MACRO> -<MACRO> -<NAME>IS_QUERY_LISTENER</NAME> -#define IS_QUERY_LISTENER(obj) (GTK_CHECK_TYPE ((obj), QUERY_LISTENER_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_QUERY_LISTENER_CLASS</NAME> -#define IS_QUERY_LISTENER_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), QUERY_LISTENER_TYPE)) -</MACRO> -<STRUCT> -<NAME>QueryListenerPrivate</NAME> -</STRUCT> -<TYPEDEF> -<NAME>QueryListener</NAME> -typedef struct { - BonoboXObject xobject; - - /* Private data */ - QueryListenerPrivate *priv; -} QueryListener; -</TYPEDEF> -<USER_FUNCTION> -<NAME>QueryListenerObjUpdatedFn</NAME> -<RETURNS>void </RETURNS> -QueryListener *ql, - const GNOME_Evolution_Calendar_CalObjUID uid, - CORBA_boolean query_in_progress, - CORBA_long n_scanned, - CORBA_long total, - gpointer data -</USER_FUNCTION> -<USER_FUNCTION> -<NAME>QueryListenerObjRemovedFn</NAME> -<RETURNS>void </RETURNS> -QueryListener *ql, - const GNOME_Evolution_Calendar_CalObjUID uid, - gpointer data -</USER_FUNCTION> -<USER_FUNCTION> -<NAME>QueryListenerQueryDoneFn</NAME> -<RETURNS>void </RETURNS> - - QueryListener *ql, - GNOME_Evolution_Calendar_QueryListener_QueryDoneStatus status, - const CORBA_char *error_str, - gpointer data -</USER_FUNCTION> -<USER_FUNCTION> -<NAME>QueryListenerEvalErrorFn</NAME> -<RETURNS>void </RETURNS> -QueryListener *ql, - const CORBA_char *error_str, - gpointer data -</USER_FUNCTION> -<FUNCTION> -<NAME>query_listener_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>query_listener_construct</NAME> -<RETURNS>QueryListener *</RETURNS> -QueryListener *ql,QueryListenerObjUpdatedFn obj_updated_fn,QueryListenerObjRemovedFn obj_removed_fn,QueryListenerQueryDoneFn query_done_fn,QueryListenerEvalErrorFn eval_error_fn,gpointer fn_data -</FUNCTION> -<FUNCTION> -<NAME>query_listener_new</NAME> -<RETURNS>QueryListener *</RETURNS> -QueryListenerObjUpdatedFn obj_updated_fn,QueryListenerObjRemovedFn obj_removed_fn,QueryListenerQueryDoneFn query_done_fn,QueryListenerEvalErrorFn eval_error_fn,gpointer fn_data -</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 deleted file mode 100644 index 0ce8d9427d..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ /dev/null @@ -1,44 +0,0 @@ -<INCLUDE>cal-client/cal-client.h</INCLUDE> - -<SECTION> -<FILE>cal-client</FILE> -CAL_CLIENT -<TITLE>CalClient</TITLE> - -CalClientOpenStatus -CalClientGetStatus -CalClientLoadState - -CalClientChangeType - -cal_client_new -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 -cal_client_get_changes -cal_client_change_list_free -cal_client_get_objects_in_range -cal_client_generate_instances -cal_client_get_alarms_in_range -cal_client_free_alarms -cal_client_get_alarms_for_object -cal_client_update_object -cal_client_remove_object - -<SUBSECTION Standard> - -CAL_CLIENT_TYPE -IS_CAL_CLIENT -CAL_CLIENT_CLASS -IS_CAL_CLIENT_CLASS -cal_client_get_type -cal_client_construct - -<SUBSECTION Private> -CalClient -CalClientPrivate - -</SECTION> diff --git a/help/devel/calendar/cal-client/evolution-cal-client.args b/help/devel/calendar/cal-client/evolution-cal-client.args deleted file mode 100644 index e69de29bb2..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client.args +++ /dev/null diff --git a/help/devel/calendar/cal-client/evolution-cal-client.hierarchy b/help/devel/calendar/cal-client/evolution-cal-client.hierarchy deleted file mode 100644 index 88efa3e673..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client.hierarchy +++ /dev/null @@ -1,2 +0,0 @@ -GtkObject - CalClient diff --git a/help/devel/calendar/cal-client/evolution-cal-client.types b/help/devel/calendar/cal-client/evolution-cal-client.types deleted file mode 100644 index 84d65a6637..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client.types +++ /dev/null @@ -1,4 +0,0 @@ -#include <gnome.h> -#include <cal-client/cal-client.h> - -cal_client_get_type diff --git a/help/devel/calendar/cal-client/tmpl/cal-client.sgml b/help/devel/calendar/cal-client/tmpl/cal-client.sgml deleted file mode 100644 index e29fd8811f..0000000000 --- a/help/devel/calendar/cal-client/tmpl/cal-client.sgml +++ /dev/null @@ -1,257 +0,0 @@ -<!-- ##### SECTION Title ##### --> -CalClient - -<!-- ##### SECTION Short_Description ##### --> -GTK+ object for communication with personal calendar server. - -<!-- ##### SECTION Long_Description ##### --> - <para> - The #CalClient object provides a nice GTK+ wrapper for the CORBA - interfaces that are used to communicate between calendar clients - and the personal calendar server in the user's Wombat daemon. The - CORBA interfaces transfer calendar components in RFC 2445 text - format; the #CalClient object automatically converts these into - #CalComponent structures that are easier to handle. - </para> - - <para> - After a #CalClient object is created with cal_client_new(), it - should be asked to send a request to the personal calendar server - to load or create a calendar based on its URI. The server will - asynchronously notify the client about completion of the request, - and will return an appropriate result code; this should be noted - by the client with the <link - linkend="CalClient--cal-loaded">cal_loaded</link> signal. - </para> - - <para> - When a client asks the server to update or delete a calendar - component from the storage, the server will do so and then notify - all the clients about the update or removal. This is the core of - the model/view split between calendar clients and the storage in - the personal calendar server. Clients should watch the <link - linkend="calclient-obj-updated">obj_updated</link> and <link - linkend="calclient-obj-removed">obj_removed</link> signals on the - CalClient objects they create so that they can be notified about - changes in the storage. - </para> - -<!-- ##### SECTION See_Also ##### --> - <para> - #CalComponent - </para> - -<!-- ##### MACRO CAL_CLIENT ##### --> - <para> - Casts a #GtkObject to a #CalClient. - </para> - -@obj: A GTK+ object. - - -<!-- ##### 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> - These values describe the result of the cal_client_get_object() - 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> - -</para> - -@Returns: - - -<!-- ##### FUNCTION cal_client_open_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@only_if_exists: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_load_state ##### --> -<para> - -</para> - -@client: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_uri ##### --> -<para> - -</para> - -@client: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_n_objects ##### --> -<para> - -</para> - -@client: -@type: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_uids ##### --> -<para> - -</para> - -@client: -@type: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_object ##### --> -<para> - -</para> - -@client: -@uid: -@comp: -@Returns: -<!-- # Unused Parameters # --> -@ico: - - -<!-- ##### FUNCTION cal_client_get_changes ##### --> -<para> - -</para> - -@client: -@type: -@change_id: -@Returns: - - -<!-- ##### FUNCTION cal_client_change_list_free ##### --> -<para> - -</para> - -@list: - - -<!-- ##### FUNCTION cal_client_get_objects_in_range ##### --> -<para> - -</para> - -@client: -@type: -@start: -@end: -@Returns: - - -<!-- ##### FUNCTION cal_client_generate_instances ##### --> -<para> - -</para> - -@client: -@type: -@start: -@end: -@cb: -@cb_data: - - -<!-- ##### FUNCTION cal_client_get_alarms_in_range ##### --> -<para> - -</para> - -@client: -@start: -@end: -@Returns: - - -<!-- ##### FUNCTION cal_client_free_alarms ##### --> -<para> - -</para> - -@comp_alarms: - - -<!-- ##### FUNCTION cal_client_get_alarms_for_object ##### --> -<para> - -</para> - -@client: -@uid: -@start: -@end: -@alarms: -@Returns: - - -<!-- ##### FUNCTION cal_client_update_object ##### --> -<para> - -</para> - -@client: -@comp: -@Returns: -<!-- # Unused Parameters # --> -@ico: - - -<!-- ##### FUNCTION cal_client_remove_object ##### --> -<para> - -</para> - -@client: -@uid: -@Returns: - - 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 deleted file mode 100644 index 3d050e171b..0000000000 --- a/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ /dev/null @@ -1,128 +0,0 @@ -<!-- ##### FUNCTION cal_client_load_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@Returns: - -<!-- ##### FUNCTION cal_client_create_calendar ##### --> -<para> - -</para> - -@client: -@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> - -</para> - -@client: -@start: -@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> - -@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: - -<!-- ##### 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 ##### --> -<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> - - -<!-- ##### FUNCTION cal_client_get_uid_by_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: ---> - |