diff options
Diffstat (limited to 'doc/devel/calendar/cal-client')
10 files changed, 0 insertions, 576 deletions
diff --git a/doc/devel/calendar/cal-client/.cvsignore b/doc/devel/calendar/cal-client/.cvsignore deleted file mode 100644 index 0842a93f7a..0000000000 --- a/doc/devel/calendar/cal-client/.cvsignore +++ /dev/null @@ -1,3 +0,0 @@ -sgml -Makefile -Makefile.in diff --git a/doc/devel/calendar/cal-client/Makefile.am b/doc/devel/calendar/cal-client/Makefile.am deleted file mode 100644 index 44d43639a8..0000000000 --- a/doc/devel/calendar/cal-client/Makefile.am +++ /dev/null @@ -1,76 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# The name of the module. -DOC_MODULE=evolution-cal-client - -# The top-level SGML file. -DOC_MAIN_SGML_FILE=evolution-cal-client.sgml - -# 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/libical.a \ - $(top_builddir)/libversit/.libs/libversit.al \ - " - -HTML_DIR=$(datadir)/gnome/html - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -tmpl_sources = \ - tmpl/cal-client.sgml \ - tmpl/evolution-cal-client-unused.sgml - -evolution_cal_client_docdir = $(HTML_DIR) -evolution_cal_client_doc_DATA = \ - evolution-cal-client.hierarchy \ - evolution-cal-client.types \ - evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt - -EXTRA_DIST = \ - $(evolution_cal_client_doc_DATA) - -sgml/evolution-cal-client-doc.bottom: $(tmpl_sources) - $(MAKE) sgml - -scan: - -(cd $(srcdir) \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="cal-listener.h evolution-calendar.h" ) - -templates: scan - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - -sgml: - cd $(srcdir) \ - && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) - -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 - -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 : sgml templates scan diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt deleted file mode 100644 index 0574d70678..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ /dev/null @@ -1,132 +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> -<ENUM> -<NAME>CalClientLoadStatus</NAME> -typedef enum { - CAL_CLIENT_LOAD_SUCCESS, - CAL_CLIENT_LOAD_ERROR, - CAL_CLIENT_LOAD_IN_USE, - CAL_CLIENT_LOAD_METHOD_NOT_SUPPORTED -} CalClientLoadStatus; -</ENUM> -<ENUM> -<NAME>CalClientGetStatus</NAME> -typedef enum { - CAL_CLIENT_GET_SUCCESS, - CAL_CLIENT_GET_NOT_FOUND, - CAL_CLIENT_GET_SYNTAX_ERROR -} CalClientGetStatus; -</ENUM> -<STRUCT> -<NAME>CalClient</NAME> -struct CalClient { - GtkObject object; - - /* Private data */ - gpointer 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_load_calendar</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *str_uri -</FUNCTION> -<FUNCTION> -<NAME>cal_client_create_calendar</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *str_uri -</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_uid_by_pilot_id</NAME> -<RETURNS>CalClientGetStatus </RETURNS> -CalClient *client,unsigned long pilot_id,char **uid -</FUNCTION> -<FUNCTION> -<NAME>cal_client_update_pilot_id</NAME> -<RETURNS>void </RETURNS> -CalClient *client, char *uid,unsigned long pilot_id,unsigned long pilot_status -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_uids</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, CalObjType type -</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>GList *</RETURNS> -CalClient *client, time_t start, time_t end -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_alarms_for_object</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *uid,time_t start, time_t end,GList **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> diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt deleted file mode 100644 index c37b223247..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ /dev/null @@ -1,37 +0,0 @@ -<INCLUDE>cal-client/cal-client.h</INCLUDE> - -<SECTION> -<FILE>cal-client</FILE> -CAL_CLIENT -<TITLE>CalClient</TITLE> - -CalClientLoadStatus -CalClientGetStatus -cal_client_new -cal_client_load_calendar -cal_client_create_calendar -cal_client_get_n_objects -cal_client_get_object -cal_client_get_objects_in_range -cal_client_generate_instances -cal_client_get_uid_by_pilot_id -cal_client_update_pilot_id -cal_client_get_uids -cal_client_get_alarms_in_range -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 - -</SECTION> diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.args b/doc/devel/calendar/cal-client/evolution-cal-client.args deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client.args +++ /dev/null diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy b/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy deleted file mode 100644 index 88efa3e673..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy +++ /dev/null @@ -1,2 +0,0 @@ -GtkObject - CalClient diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.signals b/doc/devel/calendar/cal-client/evolution-cal-client.signals deleted file mode 100644 index 97e360b6a2..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client.signals +++ /dev/null @@ -1,21 +0,0 @@ -<SIGNAL> -<NAME>CalClient::cal-loaded</NAME> -<RETURNS>void</RETURNS> -CalClient *calclient -GtkEnum arg1 -</SIGNAL> - -<SIGNAL> -<NAME>CalClient::obj-updated</NAME> -<RETURNS>void</RETURNS> -CalClient *calclient -GtkString arg1 -</SIGNAL> - -<SIGNAL> -<NAME>CalClient::obj-removed</NAME> -<RETURNS>void</RETURNS> -CalClient *calclient -GtkString arg1 -</SIGNAL> - diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.types b/doc/devel/calendar/cal-client/evolution-cal-client.types deleted file mode 100644 index 84d65a6637..0000000000 --- a/doc/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/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml deleted file mode 100644 index a146709b8a..0000000000 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ /dev/null @@ -1,291 +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. - </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> - - </para> - -<!-- ##### MACRO CAL_CLIENT ##### --> - <para> - Casts a #GtkObject to a #CalClient. - </para> - -@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> - -@CAL_CLIENT_LOAD_SUCCESS: Indicates a successful load or create - operation; the corresponding calendar is ready for use. -@CAL_CLIENT_LOAD_ERROR: Indicates an error while loading or creating - the calendar. -@CAL_CLIENT_LOAD_IN_USE: Indicates that a create request failed - because the specified calendar was already being used by another - client. -@CAL_CLIENT_LOAD_METHOD_NOT_SUPPORTED: Indicates an error due to - trying to load a calendar for which a backend type is not present. - -<!-- ##### ENUM CalClientGetStatus ##### --> - <para> - These values describe the result of the cal_client_get_object() - function. - </para> - -@CAL_CLIENT_GET_SUCCESS: Indicates a successful get operation. -@CAL_CLIENT_GET_NOT_FOUND: Indicates that the requested object was - not found. -@CAL_CLIENT_GET_SYNTAX_ERROR: Indicates a syntax error when parsing - the requested object. This could indicate a bug in the calendar - client libraries or in the Wombat server. - -<!-- ##### FUNCTION cal_client_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION cal_client_load_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@Returns: - - -<!-- ##### FUNCTION cal_client_create_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_n_objects ##### --> -<para> - -</para> - -@client: -@type: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_object ##### --> -<para> - -</para> - -@client: -@uid: -@comp: -@Returns: -<!-- # Unused Parameters # --> -@ico: - - -<!-- ##### 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_uid_by_pilot_id ##### --> -<para> - -</para> - -@client: -@pilot_id: -@uid: -@Returns: - - -<!-- ##### FUNCTION cal_client_update_pilot_id ##### --> -<para> - -</para> - -@client: -@uid: -@pilot_id: -@pilot_status: - - -<!-- ##### FUNCTION cal_client_get_uids ##### --> -<para> - -</para> - -@client: -@type: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_alarms_in_range ##### --> -<para> - -</para> - -@client: -@start: -@end: -@Returns: - - -<!-- ##### 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-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: -<!-- # 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> - 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/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml deleted file mode 100644 index 5576dbd57f..0000000000 --- a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ /dev/null @@ -1,10 +0,0 @@ -<!-- ##### FUNCTION cal_client_get_events_in_range ##### --> -<para> - -</para> - -@client: -@start: -@end: -@Returns: - |