diff options
Diffstat (limited to 'help/devel/calendar/cal-client')
10 files changed, 0 insertions, 753 deletions
diff --git a/help/devel/calendar/cal-client/.cvsignore b/help/devel/calendar/cal-client/.cvsignore deleted file mode 100644 index 0842a93f7a..0000000000 --- a/help/devel/calendar/cal-client/.cvsignore +++ /dev/null @@ -1,3 +0,0 @@ -sgml -Makefile -Makefile.in diff --git a/help/devel/calendar/cal-client/Makefile.am b/help/devel/calendar/cal-client/Makefile.am deleted file mode 100644 index f3a2b39ec6..0000000000 --- a/help/devel/calendar/cal-client/Makefile.am +++ /dev/null @@ -1,131 +0,0 @@ -# The name of the module. -DOC_MODULE=evolution-cal-client - -# The directory containing the source code (if it contains documentation). -DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-client - -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) \ - " - -LDFLAGS=" \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/calendar/cal-client/.libs/libcal-client.a \ - $(top_builddir)/calendar/cal-util/.libs/libcal-util.a \ - $(top_builddir)/libical/src/libical/.libs/libical.a \ - $(top_builddir)/libversit/.libs/libversit.al \ - " - -DOC_DIR=$(datadir)/gnome/html - -DOC_DIR_INSTALL_FILES = \ - evolution-cal-client.args \ - evolution-cal-client.hierarchy \ - evolution-cal-client.signals \ - evolution-cal-client.types \ - evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt - -SOURCE_FILES = \ - $(top_srcdir)/calendar/cal-client/cal-client.c \ - $(top_srcdir)/calendar/cal-client/cal-client.h \ - $(top_srcdir)/calendar/cal-client/cal-client-types.c \ - $(top_srcdir)/calendar/cal-client/cal-client-types.h - -IGNORED_HEADER_FILES = \ - cal-listener.h \ - evolution-calendar.h - -scan_generated = \ - evolution-cal-client-decl.txt \ - evolution-cal-client.args \ - evolution-cal-client.hierarchy \ - evolution-cal-client.signals \ - evolution-cal-client.types - -tmpl_dependencies = \ - evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt \ - evolution-cal-client.args \ - evolution-cal-client.hierarchy \ - evolution-cal-client.signals - -tmpl_sources = \ - tmpl/cal-client.sgml \ - tmpl/evolution-cal-client-unused.sgml - -tmpl_generated = \ - evolution-cal-client-unused.txt - -sgml_dependencies = \ - evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt \ - evolution-cal-client.args \ - evolution-cal-client.hierarchy \ - evolution-cal-client.signals \ - tmpl/cal-client.sgml - -sgml_generated = \ - sgml/cal-client.sgml \ - sgml/evolution-cal-client-doc.bottom \ - sgml/evolution-cal-client-doc.top \ - sgml/object_index.sgml \ - sgml/tree_index.sgml - -EXTRA_DIST = \ - evolution-cal-client.args \ - evolution-cal-client.hierarchy \ - evolution-cal-client.signals \ - evolution-cal-client.types \ - evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt - -all: $(sgml_generated) - -if ENABLE_GTK_DOC -scan $(scan_generated): $(SOURCE_FILES) - -(cd $(srcdir) \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \ - --ignore-headers="$(IGNORED_HEADER_FILES)" ) - -templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - -sgml $(sgml_generated): $(sgml_dependencies) - cd $(srcdir) \ - && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) -else -scan $(scan_generated): $(SOURCE_FILES) - -templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) - -sgml $(sgml_generated): $(sgml_dependencies) -endif - -clean-local: - rm -f *~ *.bak *.signals *-unused.txt - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -install-data-local: - $(mkinstalldirs) $(DOC_DIR) - for i in $(DOC_DIR_INSTALL_FILES); do \ - $(INSTALL_DATA) $$i $(DOC_DIR); \ - done - -dist-hook: - mkdir $(distdir)/sgml - mkdir $(distdir)/tmpl - -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml - -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml - -.PHONY: scan templates sgml 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 0bc30e6462..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ /dev/null @@ -1,161 +0,0 @@ -<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> -<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 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.signals b/help/devel/calendar/cal-client/evolution-cal-client.signals deleted file mode 100644 index 65d142777a..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client.signals +++ /dev/null @@ -1,21 +0,0 @@ -<SIGNAL> -<NAME>CalClient::cal-opened</NAME> -<RETURNS>void</RETURNS> -CalClient *calclient -gint arg1 -</SIGNAL> - -<SIGNAL> -<NAME>CalClient::obj-updated</NAME> -<RETURNS>void</RETURNS> -CalClient *calclient -gchar *arg1 -</SIGNAL> - -<SIGNAL> -<NAME>CalClient::obj-removed</NAME> -<RETURNS>void</RETURNS> -CalClient *calclient -gchar *arg1 -</SIGNAL> - 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 06195ca454..0000000000 --- a/help/devel/calendar/cal-client/tmpl/cal-client.sgml +++ /dev/null @@ -1,303 +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: - - -<!-- ##### 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: ---> - 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 56bcf3aff5..0000000000 --- a/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ /dev/null @@ -1,84 +0,0 @@ -<!-- ##### FUNCTION cal_client_update_pilot_id ##### --> -<para> - -</para> - -@client: -@uid: -@pilot_id: -@pilot_status: - -<!-- ##### FUNCTION cal_client_load_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@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_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: - -<!-- ##### FUNCTION cal_client_create_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@Returns: - -<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### --> -<para> - -</para> - -@client: -@pilot_id: -@uid: -@Returns: - |