From e38c9ea0ed0f14ce563d355a0cea24460df26363 Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Mon, 17 Jul 2000 21:08:41 +0000 Subject: New toplevel for the Evolution Developer's Guide. 2000-07-17 Federico Mena Quintero * evolution-devel-guide.sgml: New toplevel for the Evolution Developer's Guide. * calendar/evolution-calendar.sgml: New for the calendar developer's documentation. * calendar/architecture.sgml: New for the calendar architecture. * calendar/reference.sgml: New for the calendar API reference. svn path=/trunk/; revision=4191 --- doc/devel/.cvsignore | 4 + doc/devel/ChangeLog | 13 ++ doc/devel/Makefile.am | 64 +++++++ doc/devel/calendar/.cvsignore | 2 + doc/devel/calendar/Makefile.am | 6 + doc/devel/calendar/architecture.sgml | 17 ++ doc/devel/calendar/cal-client/.cvsignore | 3 + doc/devel/calendar/cal-client/Makefile.am | 76 ++++++++ .../cal-client/evolution-cal-client-decl.txt | 127 +++++++++++++ .../cal-client/evolution-cal-client-sections.txt | 36 ++++ .../calendar/cal-client/evolution-cal-client.args | 0 .../cal-client/evolution-cal-client.hierarchy | 2 + .../cal-client/evolution-cal-client.signals | 21 +++ .../calendar/cal-client/evolution-cal-client.types | 4 + doc/devel/calendar/cal-client/tmpl/cal-client.sgml | 205 +++++++++++++++++++++ .../tmpl/evolution-cal-client-unused.sgml | 0 doc/devel/calendar/evolution-calendar.sgml | 51 +++++ doc/devel/calendar/public-reference.sgml | 20 ++ doc/devel/calendar/reference.sgml | 20 ++ doc/devel/evolution-devel-guide.sgml | 44 +++++ 20 files changed, 715 insertions(+) create mode 100644 doc/devel/.cvsignore create mode 100644 doc/devel/ChangeLog create mode 100644 doc/devel/Makefile.am create mode 100644 doc/devel/calendar/.cvsignore create mode 100644 doc/devel/calendar/Makefile.am create mode 100644 doc/devel/calendar/architecture.sgml create mode 100644 doc/devel/calendar/cal-client/.cvsignore create mode 100644 doc/devel/calendar/cal-client/Makefile.am create mode 100644 doc/devel/calendar/cal-client/evolution-cal-client-decl.txt create mode 100644 doc/devel/calendar/cal-client/evolution-cal-client-sections.txt create mode 100644 doc/devel/calendar/cal-client/evolution-cal-client.args create mode 100644 doc/devel/calendar/cal-client/evolution-cal-client.hierarchy create mode 100644 doc/devel/calendar/cal-client/evolution-cal-client.signals create mode 100644 doc/devel/calendar/cal-client/evolution-cal-client.types create mode 100644 doc/devel/calendar/cal-client/tmpl/cal-client.sgml create mode 100644 doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml create mode 100644 doc/devel/calendar/evolution-calendar.sgml create mode 100644 doc/devel/calendar/public-reference.sgml create mode 100644 doc/devel/calendar/reference.sgml create mode 100644 doc/devel/evolution-devel-guide.sgml (limited to 'doc/devel') diff --git a/doc/devel/.cvsignore b/doc/devel/.cvsignore new file mode 100644 index 0000000000..c24a54fbcc --- /dev/null +++ b/doc/devel/.cvsignore @@ -0,0 +1,4 @@ +Makefile +Makefile.in +html +evolution-devel-guide.html diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog new file mode 100644 index 0000000000..b273c5c657 --- /dev/null +++ b/doc/devel/ChangeLog @@ -0,0 +1,13 @@ +2000-07-17 Federico Mena Quintero + + * evolution-devel-guide.sgml: New toplevel for the + Evolution Developer's Guide. + + * calendar/evolution-calendar.sgml: New for the calendar + developer's documentation. + + * calendar/architecture.sgml: New for the calendar + architecture. + + * calendar/reference.sgml: New for the calendar API + reference. diff --git a/doc/devel/Makefile.am b/doc/devel/Makefile.am new file mode 100644 index 0000000000..63f190c190 --- /dev/null +++ b/doc/devel/Makefile.am @@ -0,0 +1,64 @@ +SUBDIRS = calendar + +# The name of the module. +DOC_MODULE=evolution-devel-guide + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=evolution-devel-guide.sgml + +HTML_DIR=$(datadir)/gnome/html + +TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) + +evolution_devel_guidedir = $(HTML_DIR) +evolution_devel_guide_DATA = \ + evolution-devel-guide.html + +content_files = \ + evolution-devel-guide.sgml + +EXTRA_DIST = \ + $(evolution_devel_guide_DATA) \ + $(content_files) + +if ENABLE_GTK_DOC +evolution-devel-guide.html: html/book1.html + -cd $(srcdir) && cp html/book1.html evolution-devel-guide.html +else +evolution-devel-guide.html: +endif + +html/book1.html: $(content-files) + $(MAKE) html + +html: + test -d $(srcdir)/html || mkdir $(srcdir)/html + -cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + +clean-local: + rm -f *~ *.bak *.signals *-unused.txt + +maintainer-clean-local: clean + cd $(srcdir) && rm -rf html + +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); \ + echo '-- Fixing Crossreferences' ; \ + gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \ + fi) + +dist-hook: + mkdir $(distdir)/html + -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html + +.PHONY: html diff --git a/doc/devel/calendar/.cvsignore b/doc/devel/calendar/.cvsignore new file mode 100644 index 0000000000..282522db03 --- /dev/null +++ b/doc/devel/calendar/.cvsignore @@ -0,0 +1,2 @@ +Makefile +Makefile.in diff --git a/doc/devel/calendar/Makefile.am b/doc/devel/calendar/Makefile.am new file mode 100644 index 0000000000..7efde02896 --- /dev/null +++ b/doc/devel/calendar/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = cal-client + +EXTRA_DIST = \ + architecture.sgml \ + evolution-calendar.sgml \ + reference.sgml diff --git a/doc/devel/calendar/architecture.sgml b/doc/devel/calendar/architecture.sgml new file mode 100644 index 0000000000..b174965fc3 --- /dev/null +++ b/doc/devel/calendar/architecture.sgml @@ -0,0 +1,17 @@ + + Overview of the Calendar + + + This chapter gives an overview of the Evolution Calendar + architecture. It describes the model/view split of the calendar + into a personal calendar server (PCS) and the GUI clients that + appear inside the Evolution shell. + + + + diff --git a/doc/devel/calendar/cal-client/.cvsignore b/doc/devel/calendar/cal-client/.cvsignore new file mode 100644 index 0000000000..0842a93f7a --- /dev/null +++ b/doc/devel/calendar/cal-client/.cvsignore @@ -0,0 +1,3 @@ +sgml +Makefile +Makefile.in diff --git a/doc/devel/calendar/cal-client/Makefile.am b/doc/devel/calendar/cal-client/Makefile.am new file mode 100644 index 0000000000..44d43639a8 --- /dev/null +++ b/doc/devel/calendar/cal-client/Makefile.am @@ -0,0 +1,76 @@ +## 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 new file mode 100644 index 0000000000..9fffd4c201 --- /dev/null +++ b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt @@ -0,0 +1,127 @@ + +CAL_CLIENT_TYPE +#define CAL_CLIENT_TYPE (cal_client_get_type ()) + + +CAL_CLIENT +#define CAL_CLIENT(obj) (GTK_CHECK_CAST ((obj), CAL_CLIENT_TYPE, CalClient)) + + +CAL_CLIENT_CLASS +#define CAL_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_CLIENT_TYPE, CalClientClass)) + + +IS_CAL_CLIENT +#define IS_CAL_CLIENT(obj) (GTK_CHECK_TYPE ((obj), CAL_CLIENT_TYPE)) + + +IS_CAL_CLIENT_CLASS +#define IS_CAL_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_CLIENT_TYPE)) + + +CalClient + + +CalClientClass + + +CalClientLoadStatus +typedef enum { + CAL_CLIENT_LOAD_SUCCESS, + CAL_CLIENT_LOAD_ERROR, + CAL_CLIENT_LOAD_IN_USE, + CAL_CLIENT_LOAD_METHOD_NOT_SUPPORTED +} CalClientLoadStatus; + + +CalClientGetStatus +typedef enum { + CAL_CLIENT_GET_SUCCESS, + CAL_CLIENT_GET_NOT_FOUND, + CAL_CLIENT_GET_SYNTAX_ERROR +} CalClientGetStatus; + + +CalClient +struct CalClient { + GtkObject object; + + /* Private data */ + gpointer priv; +}; + + +cal_client_get_type +GtkType +void + + +cal_client_construct +CalClient * +CalClient *client + + +cal_client_new +CalClient * +void + + +cal_client_load_calendar +gboolean +CalClient *client, const char *str_uri + + +cal_client_create_calendar +gboolean +CalClient *client, const char *str_uri + + +cal_client_get_n_objects +int +CalClient *client, CalObjType type + + +cal_client_get_object +CalClientGetStatus +CalClient *client,const char *uid,iCalObject **ico + + +cal_client_get_uid_by_pilot_id +CalClientGetStatus +CalClient *client,unsigned long pilot_id,char **uid + + +cal_client_update_pilot_id +void +CalClient *client, char *uid,unsigned long pilot_id,unsigned long pilot_status + + +cal_client_get_uids +GList * +CalClient *client, CalObjType type + + +cal_client_get_events_in_range +GList * +CalClient *client, time_t start, time_t end + + +cal_client_get_alarms_in_range +GList * +CalClient *client, time_t start, time_t end + + +cal_client_get_alarms_for_object +gboolean +CalClient *client, const char *uid,time_t start, time_t end,GList **alarms + + +cal_client_update_object +gboolean +CalClient *client, iCalObject *ico + + +cal_client_remove_object +gboolean +CalClient *client, const char *uid + diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt new file mode 100644 index 0000000000..5496f2f0f2 --- /dev/null +++ b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt @@ -0,0 +1,36 @@ +cal-client/cal-client.h + +
+cal-client +CAL_CLIENT +CalClient + +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_uid_by_pilot_id +cal_client_update_pilot_id +cal_client_get_uids +cal_client_get_events_in_range +cal_client_get_alarms_in_range +cal_client_get_alarms_for_object +cal_client_update_object +cal_client_remove_object + + + +CAL_CLIENT_TYPE +IS_CAL_CLIENT +CAL_CLIENT_CLASS +IS_CAL_CLIENT_CLASS +cal_client_get_type +cal_client_construct + + +CalClient + +
diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.args b/doc/devel/calendar/cal-client/evolution-cal-client.args new file mode 100644 index 0000000000..e69de29bb2 diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy b/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy new file mode 100644 index 0000000000..88efa3e673 --- /dev/null +++ b/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy @@ -0,0 +1,2 @@ +GtkObject + CalClient diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.signals b/doc/devel/calendar/cal-client/evolution-cal-client.signals new file mode 100644 index 0000000000..97e360b6a2 --- /dev/null +++ b/doc/devel/calendar/cal-client/evolution-cal-client.signals @@ -0,0 +1,21 @@ + +CalClient::cal-loaded +void +CalClient *calclient +GtkEnum arg1 + + + +CalClient::obj-updated +void +CalClient *calclient +GtkString arg1 + + + +CalClient::obj-removed +void +CalClient *calclient +GtkString arg1 + + diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.types b/doc/devel/calendar/cal-client/evolution-cal-client.types new file mode 100644 index 0000000000..84d65a6637 --- /dev/null +++ b/doc/devel/calendar/cal-client/evolution-cal-client.types @@ -0,0 +1,4 @@ +#include +#include + +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 new file mode 100644 index 0000000000..7fdc69bfdc --- /dev/null +++ b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml @@ -0,0 +1,205 @@ + +CalClient + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@CAL_CLIENT_LOAD_SUCCESS: +@CAL_CLIENT_LOAD_ERROR: +@CAL_CLIENT_LOAD_IN_USE: +@CAL_CLIENT_LOAD_METHOD_NOT_SUPPORTED: + + + + + + +@CAL_CLIENT_GET_SUCCESS: +@CAL_CLIENT_GET_NOT_FOUND: +@CAL_CLIENT_GET_SYNTAX_ERROR: + + + + + + +@Returns: + + + + + + + +@client: +@str_uri: +@Returns: + + + + + + + +@client: +@str_uri: +@Returns: + + + + + + + +@client: +@type: +@Returns: + + + + + + + +@client: +@uid: +@ico: +@Returns: + + + + + + + +@client: +@pilot_id: +@uid: +@Returns: + + + + + + + +@client: +@uid: +@pilot_id: +@pilot_status: + + + + + + + +@client: +@type: +@Returns: + + + + + + + +@client: +@start: +@end: +@Returns: + + + + + + + +@client: +@start: +@end: +@Returns: + + + + + + + +@client: +@uid: +@start: +@end: +@alarms: +@Returns: + + + + + + + +@client: +@ico: +@Returns: + + + + + + + +@client: +@uid: +@Returns: + + + + + + + +@calclient: the object which received the signal. +@arg1: + + + + + + +@calclient: the object which received the signal. +@arg1: + + + + + + +@calclient: the object which received the signal. +@arg1: + 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 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/doc/devel/calendar/evolution-calendar.sgml b/doc/devel/calendar/evolution-calendar.sgml new file mode 100644 index 0000000000..f3936d9bbc --- /dev/null +++ b/doc/devel/calendar/evolution-calendar.sgml @@ -0,0 +1,51 @@ + + + + + Federico + Mena Quintero + +
+ federico@helixcode.com +
+ + + + + + Developing Applications for the Evolution Calendar + + + + This part of the Evolution Developer's Guide describes how to + write applications for the Evolution Calendar by using its + public interfaces. The Evolution Calendar exports its + functionality through a number of interfaces, including CORBA, + GTK+ wrappers for Bonobo objects, and other utility libraries. + + + + You should read this part of the Evolution Developer's guide + if you intend to write client applications that use the + functionality of the Evolution Calendar. + + + + This part does not describe the internal interfaces of the + Evolution Calendar; for that you should read the Evolution + Internals Guide. You should only need to read that guide if + you are interested in the way the calendar works internally or + if you want to make changes directly to the Evolution Calendar + code. + + + + &calendar-architecture; + + + diff --git a/doc/devel/calendar/public-reference.sgml b/doc/devel/calendar/public-reference.sgml new file mode 100644 index 0000000000..afe3b85628 --- /dev/null +++ b/doc/devel/calendar/public-reference.sgml @@ -0,0 +1,20 @@ + + Calendar Public API Reference + + + + This part presents the class and function reference for the + public APIs of the different components of the Evolution + Calendar. + + + + &CalClient; + + + diff --git a/doc/devel/calendar/reference.sgml b/doc/devel/calendar/reference.sgml new file mode 100644 index 0000000000..afe3b85628 --- /dev/null +++ b/doc/devel/calendar/reference.sgml @@ -0,0 +1,20 @@ + + Calendar Public API Reference + + + + This part presents the class and function reference for the + public APIs of the different components of the Evolution + Calendar. + + + + &CalClient; + + + diff --git a/doc/devel/evolution-devel-guide.sgml b/doc/devel/evolution-devel-guide.sgml new file mode 100644 index 0000000000..e1637cde3c --- /dev/null +++ b/doc/devel/evolution-devel-guide.sgml @@ -0,0 +1,44 @@ + + + + +]> + + + + Evolution Developer's Guide + + + + Helix Code, Inc. + + + + + 2000 + Helix Code, Inc. + + + + + + &evolution-calendar; + + + + + Evolution Public API Reference + + + + This part presents the class and function reference for the + different libraries and interfaces that Evolution provides. + Classes are described together with their methods; individual + functions are grouped by functional group. + + + + &calendar-reference; + + -- cgit