diff options
| author | nobody <nobody@localhost> | 2003-12-09 09:57:09 +0800 |
|---|---|---|
| committer | nobody <nobody@localhost> | 2003-12-09 09:57:09 +0800 |
| commit | 56f2d7b21f78ef90bd59bc2b88e312a8480a5b4c (patch) | |
| tree | 75bb0caf9afd4b94842023406d6a7938c5d8b2b7 /doc/devel | |
| parent | 0031a7166cd0f3fc0cec0b60c468ca22a8c45b0b (diff) | |
| download | gsoc2013-evolution-GEDIT_2_5_92.tar.gz gsoc2013-evolution-GEDIT_2_5_92.tar.zst gsoc2013-evolution-GEDIT_2_5_92.zip | |
This commit was manufactured by cvs2svn to create tag 'GEDIT_2_5_92'.GEDIT_2_5_92
svn path=/tags/GEDIT_2_5_92/; revision=23726
Diffstat (limited to 'doc/devel')
63 files changed, 0 insertions, 7629 deletions
diff --git a/doc/devel/.cvsignore b/doc/devel/.cvsignore deleted file mode 100644 index 81268d18cf..0000000000 --- a/doc/devel/.cvsignore +++ /dev/null @@ -1,5 +0,0 @@ -Makefile -Makefile.in -html -evolution-devel-guide.html -*.stamp diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog deleted file mode 100644 index a2080cb953..0000000000 --- a/doc/devel/ChangeLog +++ /dev/null @@ -1,6 +0,0 @@ -2003-09-11 Dan Winship <danw@ximian.com> - - * calendar/cal-client/Makefile.am (GTKDOC_LIBS): Use non-static - libraries. - - * calendar/cal-util/Makefile.am (GTKDOC_LIBS): Likewise diff --git a/doc/devel/ChangeLog.pre-1-4 b/doc/devel/ChangeLog.pre-1-4 deleted file mode 100644 index 4d90e1e515..0000000000 --- a/doc/devel/ChangeLog.pre-1-4 +++ /dev/null @@ -1,286 +0,0 @@ -2003-01-22 Ettore Perazzoli <ettore@ximian.com> - - * Makefile.am (HTML_DIR): Version using $(BASE_VERSION). - -2002-07-17 Peter Williams <peterw@ximian.com> - - * calendar/cal-util/Makefile.am (GTKDOC_LIBS): Because we're - using libtool as our LD, we can reference .la's and libtool - will DTRT for us. - - * calendar/cal-client/Makefile.am (GTKDOC_LIBS): Same here. - -2002-03-19 Dan Winship <danw@ximian.com> - - * calendar/cal-util/Makefile.am (GTKDOC_LIBS): Update for - libversit change. - - * calendar/cal-client/Makefile.am (GTKDOC_LIBS): Likewise - -2002-01-24 Ettore Perazzoli <ettore@ximian.com> - - * calendar/cal-client/Makefile.am: Use EVOLUTION_CALENDAR_CFLAGS - and EVOLUTION_CALENDAR_LIBS. - * calendar/cal-util/Makefile.am: Likewise. - -2001-12-18 JP Rosevear <jpr@ximian.com> - - * calendar/cal-client/Makefile.am: cal-client needs bonobo-conf - now - -2001-10-29 Federico Mena Quintero <federico@ximian.com> - - * calendar/alarm-generation.sgml: Updated docs for repeating - alarms. - -2001-07-31 Ettore Perazzoli <ettore@ximian.com> - - * Makefile.am (dist-hook): Remove the copying of the - index.sgml file which doesn't seem to be generated - anywhere anyway. - -2001-06-25 Peter Williams <peterw@ximian.com> - - * Makefile.am: ... and comment out more exec summary stuff. - - * reference.sgml: Here too. - -2001-06-25 Peter Williams <peterw@ximian.com> - - * calendar/cal-util/Makefile.am, - calendar/cal-client/Makefile.am: Fix make dist. - - * Makefile.am: clean up a bit. - -2001-06-21 JP Rosevear <jpr@ximian.com> - - * Makefile.am: disable executive summary build because it is no - longer built - -2001-06-21 JP Rosevear <jpr@ximian.com> - - * calendar/cal-client/Makefile.am: add new lib - -2001-06-21 Peter Williams <peterw@ximian.com> - - * Makefile.am: - calendar/cal-client/Makefile.am: - calendar/cal-util/Makefile.am: - importer/Makefile.am: - executive-summary/Makefile.am: Changed to used gtk-doc's - canonical Makefile.am (plus some tweaks because not every - dir builds html). - -2001-06-14 Damon Chaplin <damon@ximian.com> - - * executive-summary/.cvsignore: - * calendar/cal-util/.cvsignore: - * calendar/cal-client/.cvsignore: added *-undocumented.txt - -2001-05-24 Federico Mena Quintero <federico@ximian.com> - - * evolution-devel-guide.sgml: s/Helix Code/Ximian - -2001-05-15 Jeffrey Stedfast <fejj@ximian.com> - - * Removed some evolution-*-decl.txt files since these are - autogenerated by gtk-doc and don't belong in cvs anyway. - Should the tmpl/ dirs also be removed?? - - Updated: Readded them and updated the .cvsignore files - I guess - we do need them after all ;-) - -2001-04-25 Jon Trowbridge <trow@ximian.com> - - * Removed generated files from CVS, updated .cvsignore files - to include generated files. - -2001-04-23 Ettore Perazzoli <ettore@ximian.com> - - * executive-summary/Makefile.am (scan) [ENABLE_GTK_DOC]: Kludge - builddir != srcdir behavior by symlinking the $(DOC_MODULE).types - file into the builddir. - * calendar/cal-client/Makefile.am (scan) [ENABLE_GTK_DOC]: - Likewise. - * calendar/cal-util/Makefile.am (scan) [ENABLE_GTK_DOC]: Likewise. - -2001-04-23 Ettore Perazzoli <ettore@ximian.com> - - * evolution-devel-guide.sgml: Disable the importer references here - too. - - * Makefile.am: Remove the importer stuff for now. - -2001-04-20 Damon Chaplin <damon@ximian.com> - - * importer/evolution-shell-importer.types: changed path to the - importer header files, since we've had reports that they aren't being - found (though it worked OK for me). - -2001-04-17 Ettore Perazzoli <ettore@ximian.com> - - * calendar/cal-client/Makefile.am (install-data-local): Install - the $(DOC_DIR_INSTALL_FILES) from the srcdir. - * calendar/cal-util/Makefile.am (install-data-local): Likewise. - * importer/Makefile.am (install-data-local): Likewise. - * executive-summary/Makefile.am (install-data-local): Likewise. - -2001-01-26 John R. Sheets <dusk@ravendusk.org> - - * importer/Makefile.am: Change (nonexistant) importer.sgml - references to evolution-importer.sgml to fix dependency problem. - -2001-01-17 Iain Holmes <iain@ximian.com> - - * Makefile.am (local_entities): Added the importer stuff. - - * evolution-devel-guide.sgml: Added entities for the importer documents. - - * reference.sgml: Added the public and private APIs for the importer. - - * importer/*: New directory containing all the documenation for the - importer. - -2001-01-17 Federico Mena Quintero <federico@ximian.com> - - * evolution-devel-guide.sgml: Ximianified. - - * calendar/evolution-calendar.sgml: Ditto. - - * calendar/cal-util/evolution-cal-util-sections.txt: Updated. - - * calendar/cal-client/evolution-cal-client-sections.txt: Updated. - -2001-01-10 Federico Mena Quintero <federico@helixcode.com> - - * Makefile.am: Make it work when gtk-doc is not installed. - - * calendar/cal-client/Makefile.am: Likewise. - - * calendar/cal-util/Makefile.am: Likewise. - -2000-12-19 Federico Mena Quintero <federico@helixcode.com> - - Added proper dependency lists to the gtk-doc mess. - - * calendar/cal-client/Makefile.am (TARGET_DIR): Removed unused - variable. - (SOURCE_FILES): New variable with the list of source files we - depend on. - (IGNORED_SOURCE_HEADERS): New variable with the headers we ignore - for the gtkdoc-scan phase. - (scan_generated): - (tmpl_dependencies): - (tmpl_sources): - (tmpl_generated); - (sgml_dependencies): - (sgml_generated): Lists of stuff that is generated and that other - stuff depends on. - (all): Added the $(sgml_generated) as the final target. - (install-data-local): Added an installation hook; gtk-doc seems to - want some of its generated files to be installed. - - * calendar/cal-client/evolution-cal-client-sections.txt: Updated. - - * calendar/cal-util/Makefile.am: Made the same changes as for - calendar/cal-client/Makefile.am. - - * calendar/cal-util/evolution-cal-util-sections.txt: Updated. - - * Makefile.am (local_entities): Added alarm-generation.sgml. - (all): Made the main target be the html/index.html. - -2000-12-18 Federico Mena Quintero <federico@helixcode.com> - - * calendar/alarm-generation.sgml: New file with a description of - the algorithm used to generate alarm instances. - - * evolution-devel-guide.sgml: Added an entity for the above - chapter. - - * calendar/evolution-calendar.sgml: Reference the entity here. - - * calendar/Makefile.am (EXTRA_DIST): Added alarm-generation.sgml. - -2000-12-13 Larry Ewing <lewing@helixcode.com> - - * calendar/Makefile.am (EXTRA_DIST): make it public-reference.sgml - not referenc.sgml here. - -2000-11-29 Federico Mena Quintero <federico@helixcode.com> - - * calendar/architecture.sgml: Finished the calendar architecture - chapter. - -2000-11-29 Federico Mena Quintero <federico@helixcode.com> - - * evolution-devel-guide.sgml: Added an id for the API reference <part>. - Added the FDL <legalnotice>. - Added the preface and toplevel reference entities. - Added entities for Evolution, Wombat, and Camel. - Added an appendix for the GNU FDL. - - * preface.sgml: New file with the introduction to the Evolution - Developer's Guide. - - * reference.sgml: Split the toplevel reference part into its own - file. - - * fdl.sgml: Added the GNU Free Documentation License. - - * calendar/evolution-calendar.sgml: Added an id for the <part>. - - * calendar/public-reference.sgml: Added an id for the <reference>. - Moved this file over from calendar/reference.sgml. - - * Makefile.am (local_entities): Added a list of the SGML files - that define entities for inclusion in the toplevel document. This - way we can track documentation file dependencies down to all - levels. - (html/index.html): Made the toplevel document depend on - $(local_entities). Also, removed the "html" target and put its - contents directly here; this way we avoid having .PHONY targets. - (EXTRA_DIST): Removed the evolution_devel_guideDATA; it made no - sense. - (content_files): Added preface.sgml and reference.sgml. - -2000-09-15 Federico Mena Quintero <federico@helixcode.com> - - * evolution-devel-guide.sgml: Made the toplevel <book> id be - "index". - -2000-08-14 Federico Mena Quintero <federico@helixcode.com> - - * calendar/cal-util/*: Integrated the cal-util library into the - documentation framework. - - * calendar/Makefile.am (SUBDIRS): Added the cal-util directory. - - * evolution-devel-guide.sgml: Added entities for the cal-util stuff. - Added entity for libical. - - * calendar/reference.sgml: Added the cal-util reference entries. - - * calendar/cal-client/evolution-cal-client-sections.txt: Updated - for new API. - -2000-08-09 Peter Williams <peterw@helixcode.com> - - * Makefile.am (maintainer-clean-local): Don't depend - on 'clean'; this messes up maintainer-clean. - -2000-07-17 Federico Mena Quintero <federico@helixcode.com> - - * calendar/cal-client/tmpl/cal-client.sgml: Populated. - - * evolution-devel-guide.sgml: New <book> toplevel for the - Evolution Developer's Guide. - - * calendar/evolution-calendar.sgml: New <part> for the calendar - developer's documentation. - - * calendar/architecture.sgml: New <chapter> for the calendar - architecture. - - * calendar/reference.sgml: New <reference> for the calendar API - reference. diff --git a/doc/devel/Makefile.am b/doc/devel/Makefile.am deleted file mode 100644 index 7940af73f5..0000000000 --- a/doc/devel/Makefile.am +++ /dev/null @@ -1,179 +0,0 @@ -## Process this file with automake to produce Makefile.in - -SUBDIRS = calendar - -# The name of the module, e.g. 'glib'. -DOC_MODULE=evolution-devel-guide - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE=evolution-devel-guide.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= - -# 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= -#CFILE_GLOB= - -# Header files to ignore when scanning. -#IGNORE_HFILES= - -# Images to copy into HTML directory. -HTML_IMAGES = - - -# Add your module's hand-written and auto-generated files here; these -# are used for dependency tracking. - -local_entities = \ - calendar/alarm-generation.sgml \ - calendar/architecture.sgml \ - calendar/evolution-calendar.sgml \ - calendar/public-reference.sgml \ - \ - calendar/cal-client/sgml/cal-client.sgml \ - \ - calendar/cal-util/sgml/cal-component.sgml \ - calendar/cal-util/sgml/cal-recur.sgml \ - calendar/cal-util/sgml/cal-util.sgml \ - calendar/cal-util/sgml/timeutil.sgml - -# executive-summary/sgml/executive-summary-component.sgml \ -# executive-summary/sgml/executive-summary-component-factory.sgml \ -# executive-summary/sgml/executive-summary-component-factory-client.sgml \ -# executive-summary/sgml/executive-summary-html-view.sgml - -# importer/sgml/evolution-importer.sgml \ -# importer/sgml/evolution-importer-client.sgml - -installed_content_files = \ - fdl.sgml \ - preface.sgml \ - reference.sgml - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = \ - $(installed_content_files) \ - $(local_entities) - -# 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 = -#GTKDOC_LIBS = -# -#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 - -HTML_DIR = $(datadir)/gnome/html/evolution-$(BASE_VERSION) - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(extra_files) \ - $(installed_content_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - ChangeLog.pre-1-4 - -# $(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 - -#### html #### - -html-build.stamp: $(DOC_MAIN_SGML_FILE) $(content_files) #sgml.stamp - @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 *-unused.txt $(DOC_STAMPS) # $(SCANOBJ_FILES) - -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; \ - fi) - -# echo '-- Installing $(srcdir)/html/index.sgml' ; \ -# $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - -# -# 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)/html - files=`echo $(srcdir)/html/*.html` ; \ - test '$(srcdir)/html/*.html' = "$$files" \ - || cp $$files $(distdir)/html - files=`echo $(srcdir)/html/*.css` ; \ - test '$(srcdir)/html/*.css' = "$$files" \ - || cp $$files $(distdir)/html - images=$(HTML_IMAGES) ; \ - for i in $$images ; do \ - cp $(srcdir)/$$i $(distdir)/html ; \ - done - -# mkdir $(distdir)/tmpl -# mkdir $(distdir)/sgml -# -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml -# -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -.PHONY : dist-hook-local diff --git a/doc/devel/calendar/.cvsignore b/doc/devel/calendar/.cvsignore deleted file mode 100644 index 282522db03..0000000000 --- a/doc/devel/calendar/.cvsignore +++ /dev/null @@ -1,2 +0,0 @@ -Makefile -Makefile.in diff --git a/doc/devel/calendar/Makefile.am b/doc/devel/calendar/Makefile.am deleted file mode 100644 index 028622bd82..0000000000 --- a/doc/devel/calendar/Makefile.am +++ /dev/null @@ -1,7 +0,0 @@ -SUBDIRS = cal-util cal-client - -EXTRA_DIST = \ - alarm-generation.sgml \ - architecture.sgml \ - evolution-calendar.sgml \ - public-reference.sgml diff --git a/doc/devel/calendar/alarm-generation.sgml b/doc/devel/calendar/alarm-generation.sgml deleted file mode 100644 index 46f7e4bff1..0000000000 --- a/doc/devel/calendar/alarm-generation.sgml +++ /dev/null @@ -1,155 +0,0 @@ - <chapter id="calendar-alarm-generation"> - <title>How the Wombat generates alarm instances</title> - - <para> - This chapter describes the algorithm that the &Wombat; uses - internally to generate instances of a calendar component's - alarms. You do not need to read this chapter if you are simply - using the client-side functions. - </para> - - <sect1 id="what-makes-up-an-alarm-trigger"> - <title>What makes up an alarm trigger</title> - - <para> - VTODO and VEVENT calendar components can have any number of - alarms defined for them. Each alarm has a trigger - specification, an alarm type (display, audio, email, or - procedure), and data corresponding to the alarm type. The - Wombat side of things is interested only in the trigger - specification, since this is all that the Wombat needs to - produce alarm instances. - </para> - - <para> - An alarm trigger can be relative or absolute. Relative - triggers occur a certain time before or after the start or end - of a calendar component's occurrence. For example, you could - configure a trigger to notify you 15 minutes before an - appointment starts, so that you can get to its location on - time; or another one to notify you 5 minutes after another - person's meeting has ended, so that you can call that person - on the phone after the meeting and not disturb him while - there. Absolute triggers occur at a specific point in time; - you can configure an alarm to trigger exactly at a particular - date and time that has no relation to the component's - occurrences at all. - </para> - </sect1> - - <sect1 id="generating-trigger-instances"> - <title>Generating trigger instances</title> - - <para> - Generating absolute triggers is trivial; you just use the date - and time they specify. However, relative triggers are - associated to recurrence instances, so in order to generate - trigger instances we must generate the corresponding - recurrence instances and compute the trigger times based on - those. - </para> - - <para> - Since relative triggers are specified as occurring a certain - amount of time before or after each of a calendar component's - recurrence instances, we can compute a trigger time by adding - or subtracting that amount of time to the corresponding - recurrence instance's time. - </para> - - <para> - Recurrence instances are generated by specifying a range of - time and asking the Wombat to generate the instances that - occur within that range. We shall see that the range of time - in which instances occur is not necessarily the same range of - time in which those instances' alarm triggers occur. - </para> - - <para> - Consider an alarm that is set to trigger 10 minutes before the - start time of an event's occurrence, that is, the trigger has - an offset of -10 minutes. Say this event recurs every hour at - 5 minutes past the hour: it would occur at 1:05, 2:05, 3:05, - etc.; the corresponding triggers would occur at 12:55, 1:55, - 2:55, etc. If we wish to compute the alarm triggers that - occur between 4:00 and 6:00 (which would be at 4:55 and 5:55), - then we cannot just generate recurrence instances between 4:00 - and 6:00 because we will miss the 6:05 occurrence which - corresponds to the 5:55 trigger. - </para> - - <para> - The solution is to expand the range of time on both sides to - fit the relative triggers that have the largest time periods. - If a trigger's offset is negative, like the -10 minutes in the - example above, then we must expand the - <emphasis>end</emphasis> of the time range: in the case above, - the range's ending time of 6:00 must be grown by 10 minutes to - 6:10 so that the last recurrence instance will be that of - 6:05; computing the trigger's offset we will get the 5:55 - trigger, which is what we wanted. For triggers with positive - offsets, like if an alarm were to trigger 20 minutes after an - event's occurrence, we must expand the - <emphasis>start</emphasis> of the time range in an analogous - way, by subtracting the time offset from it. - </para> - - <para> - Again, absolute triggers need no special computation. We can - just see if the trigger time is within the requested range of - time, and if so, we take that trigger occurrence into account - for the final result. - </para> - - <para> - In addition, alarms may specify a number of repetitions and a - duration time. For example, an alarm may be configured to - repeat 3 extra times after the original occurrence with 5 - minutes between each repetition. Again, for absolute triggers - this does not present a problem, as we can just generate the - repetitions starting from the absolute trigger time. For - relative triggers, we expand the range as described above and - also add the total offset for the repetitions to the start of - the range, i.e. 15 extra minutes for the case of 3 repetitions - with 5 minutes between each. We do not need to modify the end - of the range because alarm repetitions always have positive - offsets, so they are equivalent to relative alarm triggers - with positive offsets. - </para> - </sect1> - - <sect1 id="alarm-trigger-generation-code"> - <title>Alarm trigger generation code</title> - - <para> - The main function to generate alarm trigger instances is - <function>generate_alarms_for_comp()</function> in - <filename>evolution/calendar/pcs/cal-backend-file.c</filename>. - This function calls <function>compute_alarm_range()</function> - to expand the specified range of time in the way described in - the previous section. It then generates the instances for - relative alarm triggers inside the - <function>add_alarm_occurrences_cb()</function> callback, - which is used by - <function>cal_recur_generate_instances()</function> with the - expanded range of time. The callback goes through all of the - calendar component's relative alarm triggers and adds the - trigger offsets to the occurrence's time; the results are - added as <structname>CalAlarmInstance</structname> structures - to the final list of trigger instances. Finally, - <function>generate_alarms_for_comp()</function> calls - <function>generate_absolute_triggers()</function>, which - simply adds the instances for absolute alarm triggers; these - are the absolute times that are within the time range that was - requested originally. In the very end, the list of instances - is sorted to produce nicer results. - </para> - </sect1> - </chapter> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/calendar/architecture.sgml b/doc/devel/calendar/architecture.sgml deleted file mode 100644 index d261f0a7f4..0000000000 --- a/doc/devel/calendar/architecture.sgml +++ /dev/null @@ -1,162 +0,0 @@ - <chapter id="calendar-architecture"> - <title>Architecture of the Calendar</title> - - <para> - This chapter gives an overview of the &Evolution; Calendar - architecture. It describes the model/view split of the calendar - into a personal calendar server, or &PCS;, and the GUI clients - that appear inside the &Evolution; Shell. - </para> - - <!-- Model/View Separation --> - - <sect1 id="calendar-model-view"> - <title>Model/View Separation</title> - - <para> - Like other base components in &Evolution;, the calendar - separates the data model from the views or clients. This is - done so that multiple clients can access the same calendar - data in an orderly fashion and without clashes. For example, - the user may be running a graphical calendar client. If he - then wants to synchronize his calendar with a handheld device, - then the corresponding synchronization program (e.g. a conduit - for the <application>gnome-pilot</application> package) will - also need to access the calendar storage. It is important - that both the GUI client and the synchronization program keep - a consistent view of the calendar at all times, otherwise one - of them will be left in an inconsistent state if the - calendar's data changes unexpectedly. - </para> - - <para> - &Evolution; puts the calendar storage in a daemon called the - &Wombat; and completely separates it from clients who wants to - access calendar data. This part of the &Wombat; is called the - personal calendar server, or &PCS;. Clients must contact the - &PCS; and ask it to open an existing calendar or create a new - one. When a calendar component object (e.g. an appointment or - to-do item) changes in the &PCS; it will notify all the - clients that are using the component's parent calendar. - </para> - </sect1> - - <!-- Personal Calendar Server --> - - <sect1> - <title>Personal Calendar Server</title> - - <para> - The personal calendar server, or &PCS;, provides centralized - management and storage of a user's personal calendar. - Multiple clients can connect to the &PCS; simultaneously to - query and modify the user's calendar in a synchronized - fashion. The main features of the &PCS; are as follows: - </para> - - <formalpara> - <title>Storage</title> - - <para> - The &PCS; is responsible for loading and saving calendars. - Centralizing the loading and saving functionality allows - multiple clients to use the same calendar at the same time - without having to worry about each other. - </para> - </formalpara> - - <formalpara> - <title>Basic Queries</title> - - <para> - The &PCS; provides functions to do basic queries on a - calendar, for example, a client can ask the server for a - list of all the appointments in the calendar, or for all the - data for a specific appointment. - </para> - </formalpara> - - <formalpara> - <title>Recurrence and Alarm Queries</title> - - <para> - Looking for the events that recur or have alarm triggers in - a specific period of time involves scanning all the - appointments in a calendar. To keep clients from having to - load whole calendars at once, the &PCS; can do these - computations and send the results to clients. - </para> - </formalpara> - - <formalpara> - <title>Modification Log</title> - - <para> - To allow multiple handheld devices to be synchronized - against a calendar, the &PCS; keeps a log of all the - modifications that are done to the calendar. When an - appointment is updated or removed, the &PCS; logs this - action in the modification log. Synchronization conduit - programs can then use this information to do their work. - </para> - </formalpara> - </sect1> - - <!-- Data Views --> - - <sect1> - <title>Data Views</title> - - <para> - &Evolution; provides a graphical calendar client inside the - shell that is just a view onto the data stored in the personal - calendar server. You can launch as many views of a calendar - as you like and they will all receive notification from the - &PCS; when changes occur. The views are then responsible for - updating their respective displays. - </para> - - <para> - Even within a single calendar view in the &Evolution; shell - there can be multiple clients of a single calendar. For - example, in the day view of the &Evolution; calendar there are - three widgets that act as three different clients of the - &PCS;: the multi-day view, the busy days calendar, and the - task list. - </para> - </sect1> - - <!-- Non-graphical Clients --> - - <sect1> - <title>Non-graphical Clients</title> - - <para> - Clients of the personal calendar server can be non-graphical, - that is, they do not have to provide views of the data to the - user. Examples of such clients are the synchronization - conduit programs for handheld devices. These usually run with - no user interface as a result of being invoked by a daemon - that watches the connection to a handheld device. For - example, the calendar synchronization conduit in &Evolution; - gets run when the <application>gpilotd</application> daemon - from the <application>gnome-pilot</application> package - detects that the HotSync button has been pressed on a Palm - Pilot device. - </para> - - <para> - Such clients simply take advantage of the centralized storage - in the &PCS; without presenting any graphical display of the - data; they just act as middlemen between the &PCS; and other - applications. - </para> - </sect1> - </chapter> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/calendar/cal-client/.cvsignore b/doc/devel/calendar/cal-client/.cvsignore deleted file mode 100644 index 79be6b0149..0000000000 --- a/doc/devel/calendar/cal-client/.cvsignore +++ /dev/null @@ -1,13 +0,0 @@ -sgml -Makefile -Makefile.in -*-decl.txt -*-decl-list.txt -*-unused.txt -*-undocumented.txt -*-symbols.txt -*.hierarchy -*.signals -*.stamp -*-scan.c -.libs diff --git a/doc/devel/calendar/cal-client/Makefile.am b/doc/devel/calendar/cal-client/Makefile.am deleted file mode 100644 index a441e6cbd0..0000000000 --- a/doc/devel/calendar/cal-client/Makefile.am +++ /dev/null @@ -1,196 +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_builddir)/calendar/cal-client \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - -I$(top_builddir)/libical/src/libical \ - -I$(top_srcdir)/libical/src/libical \ - $(EVOLUTION_CALENDAR_CFLAGS) - -GTKDOC_LIBS= \ - $(EVOLUTION_CALENDAR_LIBS) \ - $(top_builddir)/e-util/libeutil.la \ - $(top_builddir)/calendar/cal-client/libcal-client.la \ - $(top_builddir)/calendar/cal-util/libcal-util.la \ - $(top_builddir)/libical/src/libical/libical.la \ - $(top_builddir)/libversit/libversit.a \ - $(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 - files=`echo $(srcdir)/tmpl/*.sgml` ; \ - test '$(srcdir)/tmpl/*.sgml' = "$$files" \ - || cp $$files $(distdir)/tmpl - files=`echo $(srcdir)/sgml/*.sgml` ; \ - test '$(srcdir)/sgml/*.sgml' = "$$files" \ - || cp $$files $(distdir)/sgml - -.PHONY : dist-hook-local 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 68bfef1c1a..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ /dev/null @@ -1,526 +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_PERMISSION_DENIED, - CAL_CLIENT_OPEN_METHOD_NOT_SUPPORTED -} 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, - CAL_CLIENT_GET_NOT_FOUND, - CAL_CLIENT_GET_SYNTAX_ERROR -} CalClientGetStatus; -</ENUM> -<ENUM> -<NAME>CalClientResult</NAME> -typedef enum { - CAL_CLIENT_RESULT_SUCCESS, - CAL_CLIENT_RESULT_CORBA_ERROR, - CAL_CLIENT_RESULT_INVALID_OBJECT, - CAL_CLIENT_RESULT_NOT_FOUND, - CAL_CLIENT_RESULT_PERMISSION_DENIED -} CalClientResult; -</ENUM> -<ENUM> -<NAME>CalClientSendResult</NAME> -typedef enum { - CAL_CLIENT_SEND_SUCCESS, - CAL_CLIENT_SEND_CORBA_ERROR, - CAL_CLIENT_SEND_INVALID_OBJECT, - CAL_CLIENT_SEND_BUSY, - CAL_CLIENT_SEND_PERMISSION_DENIED -} CalClientSendResult; -</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> -<USER_FUNCTION> -<NAME>CalClientAuthFunc</NAME> -<RETURNS>gchar *</RETURNS> -CalClient *client, - const gchar *prompt, - const gchar *key, - gpointer user_data -</USER_FUNCTION> -<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_set_auth_func</NAME> -<RETURNS>void </RETURNS> -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_open_default_calendar</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, gboolean only_if_exists -</FUNCTION> -<FUNCTION> -<NAME>cal_client_open_default_tasks</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, 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 -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_uri</NAME> -<RETURNS>const char *</RETURNS> -CalClient *client -</FUNCTION> -<FUNCTION> -<NAME>cal_client_is_read_only</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_email_address</NAME> -<RETURNS>const char *</RETURNS> -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 -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_object</NAME> -<RETURNS>CalClientGetStatus </RETURNS> -CalClient *client,const char *uid,CalComponent **comp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_timezone</NAME> -<RETURNS>CalClientGetStatus </RETURNS> -CalClient *client,const char *tzid,icaltimezone **zone -</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_get_free_busy</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, GList *users,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>CalClientResult </RETURNS> -CalClient *client, CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_update_objects</NAME> -<RETURNS>CalClientResult </RETURNS> -CalClient *client, icalcomponent *icalcomp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_remove_object</NAME> -<RETURNS>CalClientResult </RETURNS> -CalClient *client, const char *uid -</FUNCTION> -<FUNCTION> -<NAME>cal_client_send_object</NAME> -<RETURNS>CalClientSendResult </RETURNS> -CalClient *client, icalcomponent *icalcomp,icalcomponent **new_icalcomp, GList **users,char error_msg[256] -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_query</NAME> -<RETURNS>CalQuery *</RETURNS> -CalClient *client, const char *sexp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_resolve_tzid_cb</NAME> -<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 ()) -</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_CalObjUIDSeq *uids, - 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> -<FUNCTION> -<NAME>query_listener_stop_notification</NAME> -<RETURNS>void </RETURNS> -QueryListener *ql -</FUNCTION> -<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> diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-docs.sgml b/doc/devel/calendar/cal-client/evolution-cal-client-docs.sgml deleted file mode 100644 index 136cf77e5c..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-docs.sgml +++ /dev/null @@ -1,15 +0,0 @@ -<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ -<!ENTITY CalClient SYSTEM "sgml/cal-client.sgml"> -<!ENTITY evolution-cal-client-CalQuery SYSTEM "sgml/cal-query.sgml"> -]> -<book id="index"> - <bookinfo> - <title>[Insert name here] Reference Manual</title> - </bookinfo> - - <chapter> - <title>[Insert title here]</title> - &CalClient; - &evolution-cal-client-CalQuery; - </chapter> -</book> 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 8e33be4933..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ /dev/null @@ -1,69 +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 -cal_client_get_query - -<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> - - -<SECTION> -<FILE>cal-query</FILE> -CAL_QUERY -<TITLE>CalQuery</TITLE> - -CalQueryDoneStatus -cal_query_new - -<SUBSECTION Standard> - -CAL_QUERY_TYPE -IS_CAL_QUERY -CAL_QUERY_CLASS -IS_CAL_QUERY_CLASS -cal_query_get_type -cal_query_construct - -<SUBSECTION Private> -CalQuery -CalQueryPrivate - -</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.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 b558b7979f..0000000000 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ /dev/null @@ -1,354 +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_PERMISSION_DENIED: -@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: - - -<!-- ##### FUNCTION cal_client_get_query ##### --> -<para> - -</para> - -@client: -@sexp: -@Returns: - - -<!-- ##### SIGNAL CalClient::cal-opened ##### --> -<para> - -</para> - -@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 - 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: ---> - -<!-- ##### SIGNAL CalClient::backend-error ##### --> -<para> - -</para> - -@calclient: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL CalClient::categories-changed ##### --> -<para> - -</para> - -@calclient: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL CalClient::forget-password ##### --> -<para> - -</para> - -@calclient: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL CalClient::backend-died ##### --> -<para> - -</para> - -@calclient: the object which received the signal. - 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 3e8ce25ee6..0000000000 --- a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ /dev/null @@ -1,84 +0,0 @@ -<!-- ##### 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. - -<!-- ##### 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_create_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@Returns: - -<!-- ##### FUNCTION cal_client_get_events_in_range ##### --> -<para> - -</para> - -@client: -@start: -@end: -@Returns: - -<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### --> -<para> - -</para> - -@client: -@pilot_id: -@uid: -@Returns: - -<!-- ##### FUNCTION cal_client_is_loaded ##### --> -<para> - -</para> - -@client: -@Returns: - -<!-- ##### FUNCTION cal_client_load_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@Returns: - -<!-- ##### FUNCTION cal_client_update_pilot_id ##### --> -<para> - -</para> - -@client: -@uid: -@pilot_id: -@pilot_status: - diff --git a/doc/devel/calendar/cal-util/.cvsignore b/doc/devel/calendar/cal-util/.cvsignore deleted file mode 100644 index 724c33a4c6..0000000000 --- a/doc/devel/calendar/cal-util/.cvsignore +++ /dev/null @@ -1,13 +0,0 @@ -sgml -Makefile -Makefile.in -*-decl.txt -*-decl-list.txt -*-unused.txt -*-undocumented.txt -*-symbols.txt -*.signals -*.hierarchy -*.stamp -*-scan.c -.libs diff --git a/doc/devel/calendar/cal-util/Makefile.am b/doc/devel/calendar/cal-util/Makefile.am deleted file mode 100644 index 5367c4a605..0000000000 --- a/doc/devel/calendar/cal-util/Makefile.am +++ /dev/null @@ -1,196 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# The name of the module, e.g. 'glib'. -DOC_MODULE=evolution-cal-util - -# 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-util - -# 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-util/cal-component.h \ - $(top_srcdir)/calendar/cal-util/cal-recur.h \ - $(top_srcdir)/calendar/cal-util/cal-util.h \ - $(top_srcdir)/calendar/cal-util/timeutil.h - -CFILE_GLOB= \ - $(top_srcdir)/calendar/cal-util/cal-component.c \ - $(top_srcdir)/calendar/cal-util/cal-recur.c \ - $(top_srcdir)/calendar/cal-util/cal-util.c \ - $(top_srcdir)/calendar/cal-util/timeutil.c - - -# Header files to ignore when scanning. -IGNORE_HFILES= \ - calobj.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 \ - $(EVOLUTION_CALENDAR_CFLAGS) - -GTKDOC_LIBS = \ - $(EVOLUTION_CALENDAR_LIBS) \ - $(top_builddir)/calendar/cal-util/libcal-util.la \ - $(top_builddir)/libical/src/libical/libical.la \ - $(top_builddir)/libversit/libversit.a - -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 = - -########################################################################### -# 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: sgml-build.stamp -#all-local: html-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 - files=`echo $(srcdir)/tmpl/*.sgml` ; \ - test '$(srcdir)/tmpl/*.sgml' = "$$files" \ - || cp $$files $(distdir)/tmpl - files=`echo $(srcdir)/sgml/*.sgml` ; \ - test '$(srcdir)/sgml/*.sgml' = "$$files" \ - || cp $$files $(distdir)/sgml - -.PHONY : dist-hook-local diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt deleted file mode 100644 index af91e3f9cb..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ /dev/null @@ -1,1039 +0,0 @@ -<MACRO> -<NAME>CAL_COMPONENT_TYPE</NAME> -#define CAL_COMPONENT_TYPE (cal_component_get_type ()) -</MACRO> -<MACRO> -<NAME>CAL_COMPONENT</NAME> -#define CAL_COMPONENT(obj) (GTK_CHECK_CAST ((obj), CAL_COMPONENT_TYPE, CalComponent)) -</MACRO> -<MACRO> -<NAME>CAL_COMPONENT_CLASS</NAME> -#define CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_COMPONENT_TYPE, \ - CalComponentClass)) -</MACRO> -<MACRO> -<NAME>IS_CAL_COMPONENT</NAME> -#define IS_CAL_COMPONENT(obj) (GTK_CHECK_TYPE ((obj), CAL_COMPONENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_CAL_COMPONENT_CLASS</NAME> -#define IS_CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_COMPONENT_TYPE)) -</MACRO> -<ENUM> -<NAME>CalComponentVType</NAME> -typedef enum { - CAL_COMPONENT_NO_TYPE, - CAL_COMPONENT_EVENT, - CAL_COMPONENT_TODO, - CAL_COMPONENT_JOURNAL, - CAL_COMPONENT_FREEBUSY, - CAL_COMPONENT_TIMEZONE -} CalComponentVType; -</ENUM> -<ENUM> -<NAME>CalComponentField</NAME> -typedef enum { - CAL_COMPONENT_FIELD_CATEGORIES, /* concatenation of the categories list */ - CAL_COMPONENT_FIELD_CLASSIFICATION, - CAL_COMPONENT_FIELD_COMPLETED, - CAL_COMPONENT_FIELD_DTEND, - CAL_COMPONENT_FIELD_DTSTART, - CAL_COMPONENT_FIELD_DUE, - CAL_COMPONENT_FIELD_GEO, - CAL_COMPONENT_FIELD_PERCENT, - CAL_COMPONENT_FIELD_PRIORITY, - CAL_COMPONENT_FIELD_SUMMARY, - CAL_COMPONENT_FIELD_TRANSPARENCY, - CAL_COMPONENT_FIELD_URL, - CAL_COMPONENT_FIELD_HAS_ALARMS, /* not a real field */ - CAL_COMPONENT_FIELD_ICON, /* not a real field */ - CAL_COMPONENT_FIELD_COMPLETE, /* not a real field */ - CAL_COMPONENT_FIELD_RECURRING, /* not a real field */ - CAL_COMPONENT_FIELD_OVERDUE, /* not a real field */ - CAL_COMPONENT_FIELD_COLOR, /* not a real field */ - CAL_COMPONENT_FIELD_STATUS, - CAL_COMPONENT_FIELD_COMPONENT, /* not a real field */ -#if 0 - CAL_COMPONENT_FIELD_LOCATION, -#endif - CAL_COMPONENT_FIELD_NUM_FIELDS -} CalComponentField; -</ENUM> -<ENUM> -<NAME>CalComponentClassification</NAME> -typedef enum { - CAL_COMPONENT_CLASS_NONE, - CAL_COMPONENT_CLASS_PUBLIC, - CAL_COMPONENT_CLASS_PRIVATE, - CAL_COMPONENT_CLASS_CONFIDENTIAL, - CAL_COMPONENT_CLASS_UNKNOWN -} CalComponentClassification; -</ENUM> -<TYPEDEF> -<NAME>CalComponentDateTime</NAME> -typedef struct { - /* Actual date/time value */ - struct icaltimetype *value; - - /* Timezone ID */ - const char *tzid; -} CalComponentDateTime; -</TYPEDEF> -<ENUM> -<NAME>CalComponentPeriodType</NAME> -typedef enum { - CAL_COMPONENT_PERIOD_DATETIME, - CAL_COMPONENT_PERIOD_DURATION -} CalComponentPeriodType; -</ENUM> -<TYPEDEF> -<NAME>CalComponentPeriod</NAME> -typedef struct { - CalComponentPeriodType type; - - struct icaltimetype start; - - union { - struct icaltimetype end; - struct icaldurationtype duration; - } u; -} CalComponentPeriod; -</TYPEDEF> -<ENUM> -<NAME>CalComponentRangeType</NAME> -typedef enum { - CAL_COMPONENT_RANGE_SINGLE, - CAL_COMPONENT_RANGE_THISPRIOR, - CAL_COMPONENT_RANGE_THISFUTURE, -} CalComponentRangeType; -</ENUM> -<TYPEDEF> -<NAME>CalComponentRange</NAME> -typedef struct { - CalComponentRangeType type; - - CalComponentDateTime datetime; -} CalComponentRange; -</TYPEDEF> -<TYPEDEF> -<NAME>CalComponentText</NAME> -typedef struct { - /* Description string */ - const char *value; - - /* Alternate representation URI */ - const char *altrep; -} CalComponentText; -</TYPEDEF> -<ENUM> -<NAME>CalComponentTransparency</NAME> -typedef enum { - CAL_COMPONENT_TRANSP_NONE, - CAL_COMPONENT_TRANSP_TRANSPARENT, - CAL_COMPONENT_TRANSP_OPAQUE, - CAL_COMPONENT_TRANSP_UNKNOWN -} CalComponentTransparency; -</ENUM> -<TYPEDEF> -<NAME>CalComponentAttendee</NAME> -typedef struct { - const char *value; - - const char *member; - icalparameter_cutype cutype; - icalparameter_role role; - icalparameter_partstat status; - gboolean rsvp; - - const char *delto; - const char *delfrom; - const char *sentby; - const char *cn; - const char *language; -} CalComponentAttendee; -</TYPEDEF> -<TYPEDEF> -<NAME>CalComponentOrganizer</NAME> -typedef struct { - const char *value; - const char *sentby; - const char *cn; - const char *language; -} CalComponentOrganizer; -</TYPEDEF> -<STRUCT> -<NAME>CalComponent</NAME> -</STRUCT> -<STRUCT> -<NAME>CalComponentClass</NAME> -</STRUCT> -<STRUCT> -<NAME>CalComponentPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>CalComponent</NAME> -struct CalComponent { - GtkObject object; - - /* Private data */ - CalComponentPrivate *priv; -}; -</STRUCT> -<FUNCTION> -<NAME>cal_component_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_component_gen_uid</NAME> -<RETURNS>char *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_component_new</NAME> -<RETURNS>CalComponent *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_component_clone</NAME> -<RETURNS>CalComponent *</RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_new_vtype</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentVType type -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_icalcomponent</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp, icalcomponent *icalcomp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_icalcomponent</NAME> -<RETURNS>icalcomponent *</RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_rescan</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_strip_errors</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_vtype</NAME> -<RETURNS>CalComponentVType </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_as_string</NAME> -<RETURNS>char *</RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_commit_sequence</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_abort_sequence</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_uid</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char **uid -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_uid</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char *uid -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_categories</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char **categories -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_categories</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char *categories -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_categories_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **categ_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_categories_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *categ_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_classification</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentClassification *classif -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_classification</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentClassification classif -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_comment_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_comment_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_completed</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype **t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_completed</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_contact_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_contact_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_created</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype **t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_created</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_description_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_description_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_dtend</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_dtend</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_dtstamp</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_dtstamp</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_dtstart</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_dtstart</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_due</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_due</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_exdate_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **exdate_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_exdate_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *exdate_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_exdates</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_exrule_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_exrule_property_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_exrule_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_exrules</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_exceptions</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_geo</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icalgeotype **geo -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_geo</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icalgeotype *geo -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_last_modified</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype **t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_last_modified</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_organizer</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentOrganizer *organizer -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_organizer</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentOrganizer *organizer -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_organizer</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_percent</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int **percent -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_percent</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int *percent -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_priority</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int **priority -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_priority</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int *priority -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_recurid</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentRange *recur_id -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_recurid</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentRange *recur_id -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_rdate_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **period_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_rdate_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *period_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_rdates</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_rrule_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_rrule_property_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_rrule_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_rrules</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_recurrences</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_simple_recurrence</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_sequence</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int **sequence -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_sequence</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int *sequence -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_status</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, icalproperty_status *status -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_status</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, icalproperty_status status -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_summary</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentText *summary -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_summary</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentText *summary -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_transparency</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentTransparency *transp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_transparency</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentTransparency transp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_url</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char **url -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_url</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char *url -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_attendee_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **attendee_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_attendee_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *attendee_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_attendees</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_location</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char **location -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_location</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char *location -</FUNCTION> -<FUNCTION> -<NAME>cal_component_event_dates_match</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp1, CalComponent *comp2 -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_categories_list</NAME> -<RETURNS>void </RETURNS> -GSList *categ_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_datetime</NAME> -<RETURNS>void </RETURNS> -CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_exdate_list</NAME> -<RETURNS>void </RETURNS> -GSList *exdate_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_geo</NAME> -<RETURNS>void </RETURNS> -struct icalgeotype *geo -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_icaltimetype</NAME> -<RETURNS>void </RETURNS> -struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_percent</NAME> -<RETURNS>void </RETURNS> -int *percent -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_priority</NAME> -<RETURNS>void </RETURNS> -int *priority -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_period_list</NAME> -<RETURNS>void </RETURNS> -GSList *period_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_recur_list</NAME> -<RETURNS>void </RETURNS> -GSList *recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_sequence</NAME> -<RETURNS>void </RETURNS> -int *sequence -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_text_list</NAME> -<RETURNS>void </RETURNS> -GSList *text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_attendee_list</NAME> -<RETURNS>void </RETURNS> -GSList *attendee_list -</FUNCTION> -<STRUCT> -<NAME>CalComponentAlarm</NAME> -</STRUCT> -<TYPEDEF> -<NAME>CalAlarmInstance</NAME> -typedef struct { - /* UID of the alarm that triggered */ - const char *auid; - - /* Trigger time, i.e. "5 minutes before the appointment" */ - time_t trigger; - - /* Actual event occurrence to which this trigger corresponds */ - time_t occur_start; - time_t occur_end; -} CalAlarmInstance; -</TYPEDEF> -<TYPEDEF> -<NAME>CalComponentAlarms</NAME> -typedef struct { - /* The actual component */ - CalComponent *comp; - - /* List of CalAlarmInstance structures */ - GSList *alarms; -} CalComponentAlarms; -</TYPEDEF> -<ENUM> -<NAME>CalAlarmAction</NAME> -typedef enum { - CAL_ALARM_NONE, - CAL_ALARM_AUDIO, - CAL_ALARM_DISPLAY, - CAL_ALARM_EMAIL, - CAL_ALARM_PROCEDURE, - CAL_ALARM_UNKNOWN -} CalAlarmAction; -</ENUM> -<ENUM> -<NAME>CalAlarmTriggerType</NAME> -typedef enum { - CAL_ALARM_TRIGGER_NONE, - CAL_ALARM_TRIGGER_RELATIVE_START, - CAL_ALARM_TRIGGER_RELATIVE_END, - CAL_ALARM_TRIGGER_ABSOLUTE -} CalAlarmTriggerType; -</ENUM> -<TYPEDEF> -<NAME>CalAlarmTrigger</NAME> -typedef struct { - CalAlarmTriggerType type; - - union { - struct icaldurationtype rel_duration; - struct icaltimetype abs_time; - } u; -} CalAlarmTrigger; -</TYPEDEF> -<TYPEDEF> -<NAME>CalAlarmRepeat</NAME> -typedef struct { - /* Number of extra repetitions, zero for none */ - int repetitions; - - /* Interval between repetitions */ - struct icaldurationtype duration; -} CalAlarmRepeat; -</TYPEDEF> -<FUNCTION> -<NAME>cal_component_has_alarms</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_add_alarm</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentAlarm *alarm -</FUNCTION> -<FUNCTION> -<NAME>cal_component_remove_alarm</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char *auid -</FUNCTION> -<FUNCTION> -<NAME>cal_component_remove_all_alarms</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_alarm_uids</NAME> -<RETURNS>GList *</RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_alarm</NAME> -<RETURNS>CalComponentAlarm *</RETURNS> -CalComponent *comp, const char *auid -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarms_free</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarms *alarms -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_new</NAME> -<RETURNS>CalComponentAlarm *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_clone</NAME> -<RETURNS>CalComponentAlarm *</RETURNS> -CalComponentAlarm *alarm -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_free</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_uid</NAME> -<RETURNS>const char *</RETURNS> -CalComponentAlarm *alarm -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_action</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmAction *action -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_action</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmAction action -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_attach</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, icalattach **attach -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_attach</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, icalattach *attach -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_description</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentText *description -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_description</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentText *description -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_repeat</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmRepeat *repeat -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_repeat</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmRepeat repeat -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_trigger</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmTrigger *trigger -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_trigger</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmTrigger trigger -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_icalcomponent</NAME> -<RETURNS>icalcomponent *</RETURNS> -CalComponentAlarm *alarm -</FUNCTION> -<USER_FUNCTION> -<NAME>CalRecurInstanceFn</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp, - time_t instance_start, - time_t instance_end, - gpointer data -</USER_FUNCTION> -<USER_FUNCTION> -<NAME>CalRecurResolveTimezoneFn</NAME> -<RETURNS>icaltimezone *</RETURNS> -const char *tzid, - gpointer data -</USER_FUNCTION> -<FUNCTION> -<NAME>cal_recur_generate_instances</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data,CalRecurResolveTimezoneFn tz_cb,gpointer tz_cb_data,icaltimezone *default_timezone -</FUNCTION> -<TYPEDEF> -<NAME>CalObjInstance</NAME> -typedef struct { - char *uid; /* UID of the object */ - time_t start; /* Start time of instance */ - time_t end; /* End time of instance */ -} CalObjInstance; -</TYPEDEF> -<FUNCTION> -<NAME>cal_obj_instance_list_free</NAME> -<RETURNS>void </RETURNS> -GList *list -</FUNCTION> -<ENUM> -<NAME>CalObjType</NAME> -typedef enum { - CALOBJ_TYPE_EVENT = 1 << 0, - CALOBJ_TYPE_TODO = 1 << 1, - CALOBJ_TYPE_JOURNAL = 1 << 2, - CALOBJ_TYPE_ANY = 0x07 -} CalObjType; -</ENUM> -<ENUM> -<NAME>CalMode</NAME> -typedef enum { - CAL_MODE_INVALID = -1, - CAL_MODE_LOCAL = 1 << 0, - CAL_MODE_REMOTE = 1 << 1, - CAL_MODE_ANY = 0x07 -} CalMode; -</ENUM> -<FUNCTION> -<NAME>cal_obj_uid_list_free</NAME> -<RETURNS>void </RETURNS> -GList *list -</FUNCTION> -<FUNCTION> -<NAME>cal_util_new_top_level</NAME> -<RETURNS>icalcomponent *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_util_generate_alarms_for_comp</NAME> -<RETURNS>CalComponentAlarms *</RETURNS> -CalComponent *comp,time_t start,time_t end,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data,icaltimezone *default_timezone -</FUNCTION> -<FUNCTION> -<NAME>cal_util_generate_alarms_for_list</NAME> -<RETURNS>int </RETURNS> -GList *comps,time_t start,time_t end,GSList **comp_alarms,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data,icaltimezone *default_timezone -</FUNCTION> -<FUNCTION> -<NAME>cal_util_resolve_tzid</NAME> -<RETURNS>icaltimezone *</RETURNS> -const char *tzid, gpointer data -</FUNCTION> -<FUNCTION> -<NAME>cal_util_priority_to_string</NAME> -<RETURNS>char *</RETURNS> -int priority -</FUNCTION> -<FUNCTION> -<NAME>cal_util_priority_from_string</NAME> -<RETURNS>int </RETURNS> -const char *string -</FUNCTION> -<FUNCTION> -<NAME>cal_util_expand_uri</NAME> -<RETURNS>char *</RETURNS> -char *uri, gboolean tasks -</FUNCTION> -<FUNCTION> -<NAME>cal_util_add_timezones_from_component</NAME> -<RETURNS>void </RETURNS> -icalcomponent *vcal_comp,CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>time_days_in_month</NAME> -<RETURNS>int </RETURNS> -int year, int month -</FUNCTION> -<FUNCTION> -<NAME>time_day_of_year</NAME> -<RETURNS>int </RETURNS> -int day, int month, int year -</FUNCTION> -<FUNCTION> -<NAME>time_day_of_week</NAME> -<RETURNS>int </RETURNS> -int day, int month, int year -</FUNCTION> -<FUNCTION> -<NAME>time_is_leap_year</NAME> -<RETURNS>gboolean </RETURNS> -int year -</FUNCTION> -<FUNCTION> -<NAME>time_leap_years_up_to</NAME> -<RETURNS>int </RETURNS> -int year -</FUNCTION> -<FUNCTION> -<NAME>isodate_from_time_t</NAME> -<RETURNS>char *</RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_from_isodate</NAME> -<RETURNS>time_t </RETURNS> -const char *str -</FUNCTION> -<FUNCTION> -<NAME>time_add_day</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int days -</FUNCTION> -<FUNCTION> -<NAME>time_add_week</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int weeks -</FUNCTION> -<FUNCTION> -<NAME>time_day_begin</NAME> -<RETURNS>time_t </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_day_end</NAME> -<RETURNS>time_t </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_add_day_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int days, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_add_week_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int weeks, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_add_month_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int months, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_year_begin_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_month_begin_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_week_begin_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int week_start_day,icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_day_begin_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_day_end_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_to_gdate_with_zone</NAME> -<RETURNS>void </RETURNS> -GDate *date, time_t time, icaltimezone *zone -</FUNCTION> diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-docs.sgml b/doc/devel/calendar/cal-util/evolution-cal-util-docs.sgml deleted file mode 100644 index bab3cac78e..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-docs.sgml +++ /dev/null @@ -1,19 +0,0 @@ -<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ -<!ENTITY CalComponent SYSTEM "sgml/cal-component.sgml"> -<!ENTITY evolution-cal-util-cal-recur SYSTEM "sgml/cal-recur.sgml"> -<!ENTITY evolution-cal-util-cal-util SYSTEM "sgml/cal-util.sgml"> -<!ENTITY evolution-cal-util-timeutil SYSTEM "sgml/timeutil.sgml"> -]> -<book id="index"> - <bookinfo> - <title>[Insert name here] Reference Manual</title> - </bookinfo> - - <chapter> - <title>[Insert title here]</title> - &CalComponent; - &evolution-cal-util-cal-recur; - &evolution-cal-util-cal-util; - &evolution-cal-util-timeutil; - </chapter> -</book> diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt deleted file mode 100644 index 1a03226591..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt +++ /dev/null @@ -1,161 +0,0 @@ -<SECTION> -<FILE>cal-component</FILE> -CAL_COMPONENT -<TITLE>CalComponent</TITLE> - -CalComponentVType -CalComponentField -CalComponentClassification -CalComponentDateTime -CalComponentPeriodType -CalComponentPeriod -CalComponentText -CalComponentTransparency - -cal_component_gen_uid -cal_component_new -cal_component_clone -cal_component_set_new_vtype -cal_component_set_icalcomponent -cal_component_get_icalcomponent -cal_component_get_vtype -cal_component_get_as_string -cal_component_commit_sequence -cal_component_get_uid -cal_component_set_uid -cal_component_get_categories -cal_component_set_categories -cal_component_get_categories_list -cal_component_set_categories_list -cal_component_get_classification -cal_component_set_classification -cal_component_get_comment_list -cal_component_set_comment_list -cal_component_get_completed -cal_component_set_completed -cal_component_get_created -cal_component_set_created -cal_component_get_description_list -cal_component_set_description_list -cal_component_get_dtend -cal_component_set_dtend -cal_component_get_dtstamp -cal_component_set_dtstamp -cal_component_get_dtstart -cal_component_set_dtstart -cal_component_get_due -cal_component_set_due -cal_component_get_exdate_list -cal_component_set_exdate_list -cal_component_has_exdates -cal_component_get_exrule_list -cal_component_get_exrule_property_list -cal_component_set_exrule_list -cal_component_has_exrules -cal_component_has_exceptions -cal_component_get_geo -cal_component_set_geo -cal_component_get_last_modified -cal_component_set_last_modified -cal_component_get_percent -cal_component_set_percent -cal_component_get_priority -cal_component_set_priority -cal_component_get_rdate_list -cal_component_set_rdate_list -cal_component_has_rdates -cal_component_get_rrule_list -cal_component_get_rrule_property_list -cal_component_set_rrule_list -cal_component_has_rrules -cal_component_has_recurrences -cal_component_get_sequence -cal_component_set_sequence -cal_component_get_status -cal_component_set_status -cal_component_get_summary -cal_component_set_summary -cal_component_get_transparency -cal_component_set_transparency -cal_component_get_url -cal_component_set_url - -<SUBSECTION Functions to free returned values> -cal_component_free_categories_list -cal_component_free_datetime -cal_component_free_exdate_list -cal_component_free_geo -cal_component_free_icaltimetype -cal_component_free_percent -cal_component_free_priority -cal_component_free_period_list -cal_component_free_recur_list -cal_component_free_sequence -cal_component_free_text_list - -<SUBSECTION Alarms> -CalComponentAlarm -CalAlarmInstance -CalComponentAlarms -CalAlarmAction -CalAlarmTriggerType -CalAlarmTrigger - -cal_component_has_alarms -cal_component_get_alarm_uids -cal_component_get_alarm -cal_component_alarm_free -cal_component_alarms_free -cal_component_alarm_get_uid -cal_component_alarm_get_action -cal_component_alarm_set_action -cal_component_alarm_get_trigger -cal_component_alarm_set_trigger - -<SUBSECTION Standard> -CAL_COMPONENT_TYPE -CAL_COMPONENT_CLASS -IS_CAL_COMPONENT -IS_CAL_COMPONENT_CLASS -cal_component_get_type - -<SUBSECTION Private> -CalComponent -CalComponentPrivate - -</SECTION> - -<SECTION> -<FILE>cal-recur</FILE> -CalRecurInstanceFn -cal_recur_generate_instances -</SECTION> - -<SECTION> -<FILE>cal-util</FILE> -CalObjInstance -cal_obj_instance_list_free -CalObjType -cal_obj_uid_list_free -</SECTION> - -<SECTION> -<FILE>timeutil</FILE> -isodate_from_time_t -time_add_minutes -time_add_day -time_add_week -time_add_month -time_add_year -time_days_in_month -time_from_day -time_year_begin -time_year_end -time_month_begin -time_month_end -time_week_begin -time_week_end -time_day_begin -time_day_end -print_time_t -</SECTION> diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.args b/doc/devel/calendar/cal-util/evolution-cal-util.args deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util.args +++ /dev/null diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy b/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy deleted file mode 100644 index cc235653f2..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy +++ /dev/null @@ -1,2 +0,0 @@ -GtkObject - CalComponent diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.signals b/doc/devel/calendar/cal-util/evolution-cal-util.signals deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util.signals +++ /dev/null diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.types b/doc/devel/calendar/cal-util/evolution-cal-util.types deleted file mode 100644 index 52b2d9bf90..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util.types +++ /dev/null @@ -1,4 +0,0 @@ -#include <gnome.h> -#include <cal-util/cal-component.h> - -cal_component_get_type diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml deleted file mode 100644 index 8a8cfa8907..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml +++ /dev/null @@ -1,992 +0,0 @@ -<!-- ##### SECTION Title ##### --> -CalComponent - -<!-- ##### SECTION Short_Description ##### --> -RFC 2445 iCalendar component object. - -<!-- ##### SECTION Long_Description ##### --> - <para> - The #CalComponent object provides a wrapper over the &libical; - functions for manipulating calendar components. #CalComponent - presents a GTK+-like interface to calendar components according to - RFC 2445. - </para> - - <para> - While &libical; supports almost all of the features of the - iCalendar RFCs, applications are normally not interested in all - the mindless gunk that is there. Still, applications should do - their best not to drop extension fields from calendar components - or any other extra information they do not support (including - standard fields they are not interested in). The #CalComponent - object provides a wrapper over - <structname>icalcomponent</structname> structures from &libical; - so that no information in them will be lost even if the - application is not designed to handle it. Also, #CalComponent - provides a higher-level API to many of the &libical; operations so - as to make it less painful to deal with iCalendar components. - </para> - - <para> - A #CalComponent object starts out empty. It must be initialized - from an existing <structname>icalcomponent</structname> structure - by using the cal_component_set_icalcomponent() function, or from a - completely new data by specifying the desired component type to - the cal_component_set_new_vtype() function. - </para> - - <para> - #CalComponent will create an internal map of the properties in the - <structname>icalcomponent</structname> structure and then allow - random access to them via the #CalComponent API functions; - normally the &libical; API would have to be used by creating many - iterators and other unpleasant constructs. #CalComponent keeps - handles to the properties it scanned from the - <structname>icalcomponent</structname> and will let the parent - application modify them at any time without having to do any - iteration. - </para> - - <para> - Eventually a #CalComponent may be turned into the RFC 2445 string - representation of an iCalendar component by using the - cal_component_get_as_string() function. Applications can then - transfer this interoperable - <footnote> - <para> - “Interoperable.” Heavens, I love that word. - </para> - </footnote> - string to other programs that deal with iCalendar. - </para> - -<!-- ##### SECTION See_Also ##### --> - <para> - - </para> - -<!-- ##### MACRO CAL_COMPONENT ##### --> - <para> - Casts a #GtkObject to a #CalComponent. - </para> - -@obj: A GTK+ object. - - -<!-- ##### ENUM CalComponentVType ##### --> - <para> - Calendar component types as defined by RFC 2445. These values can - be used to create a new calendar component by passing them to the - cal_component_set_new_vtype() function. They are also the return - value of the cal_component_get_vtype() function. The only time - the @CAL_COMPONENT_NO_TYPE value is used is when querying the - vtype of an uninitialized #CalComponent. - </para> - -@CAL_COMPONENT_NO_TYPE: -@CAL_COMPONENT_EVENT: -@CAL_COMPONENT_TODO: -@CAL_COMPONENT_JOURNAL: -@CAL_COMPONENT_FREEBUSY: -@CAL_COMPONENT_TIMEZONE: - -<!-- ##### ENUM CalComponentField ##### --> - <para> - These values are used as identifiers for #ETable columns. These - are used by the calendar GUI code in &Evolution;. - </para> - -@CAL_COMPONENT_FIELD_CATEGORIES: -@CAL_COMPONENT_FIELD_CLASSIFICATION: -@CAL_COMPONENT_FIELD_COMPLETED: -@CAL_COMPONENT_FIELD_DTEND: -@CAL_COMPONENT_FIELD_DTSTART: -@CAL_COMPONENT_FIELD_DUE: -@CAL_COMPONENT_FIELD_GEO: -@CAL_COMPONENT_FIELD_PERCENT: -@CAL_COMPONENT_FIELD_PRIORITY: -@CAL_COMPONENT_FIELD_SUMMARY: -@CAL_COMPONENT_FIELD_TRANSPARENCY: -@CAL_COMPONENT_FIELD_URL: -@CAL_COMPONENT_FIELD_HAS_ALARMS: -@CAL_COMPONENT_FIELD_ICON: -@CAL_COMPONENT_FIELD_COMPLETE: -@CAL_COMPONENT_FIELD_RECURRING: -@CAL_COMPONENT_FIELD_OVERDUE: -@CAL_COMPONENT_FIELD_COLOR: -@CAL_COMPONENT_FIELD_STATUS: -@CAL_COMPONENT_FIELD_COMPONENT: - -<!-- ##### ENUM CalComponentClassification ##### --> - <para> - Values for the access classification property of a calendar - component. - </para> - -@CAL_COMPONENT_CLASS_NONE: -@CAL_COMPONENT_CLASS_PUBLIC: -@CAL_COMPONENT_CLASS_PRIVATE: -@CAL_COMPONENT_CLASS_CONFIDENTIAL: -@CAL_COMPONENT_CLASS_UNKNOWN: - -<!-- ##### TYPEDEF CalComponentDateTime ##### --> - <para> - This structure defines a date and time value. - </para> - - -<!-- ##### ENUM CalComponentPeriodType ##### --> - <para> - Defines how a period of time is specified. - </para> - -@CAL_COMPONENT_PERIOD_DATETIME: -@CAL_COMPONENT_PERIOD_DURATION: - -<!-- ##### TYPEDEF CalComponentPeriod ##### --> - <para> - This structure defines a period of time. - </para> - - -<!-- ##### TYPEDEF CalComponentText ##### --> - <para> - This structure defines the value of a text property that may have - an alternate representation parameter. - </para> - - -<!-- ##### ENUM CalComponentTransparency ##### --> -<para> - -</para> - -@CAL_COMPONENT_TRANSP_NONE: -@CAL_COMPONENT_TRANSP_TRANSPARENT: -@CAL_COMPONENT_TRANSP_OPAQUE: -@CAL_COMPONENT_TRANSP_UNKNOWN: - -<!-- ##### FUNCTION cal_component_gen_uid ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION cal_component_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION cal_component_clone ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_set_new_vtype ##### --> -<para> - -</para> - -@comp: -@type: - - -<!-- ##### FUNCTION cal_component_set_icalcomponent ##### --> -<para> - -</para> - -@comp: -@icalcomp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_icalcomponent ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_vtype ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_as_string ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_commit_sequence ##### --> -<para> - -</para> - -@comp: - - -<!-- ##### FUNCTION cal_component_get_uid ##### --> -<para> - -</para> - -@comp: -@uid: - - -<!-- ##### FUNCTION cal_component_set_uid ##### --> -<para> - -</para> - -@comp: -@uid: - - -<!-- ##### FUNCTION cal_component_get_categories ##### --> -<para> - -</para> - -@comp: -@categories: - - -<!-- ##### FUNCTION cal_component_set_categories ##### --> -<para> - -</para> - -@comp: -@categories: - - -<!-- ##### FUNCTION cal_component_get_categories_list ##### --> -<para> - -</para> - -@comp: -@categ_list: - - -<!-- ##### FUNCTION cal_component_set_categories_list ##### --> -<para> - -</para> - -@comp: -@categ_list: - - -<!-- ##### FUNCTION cal_component_get_classification ##### --> -<para> - -</para> - -@comp: -@classif: - - -<!-- ##### FUNCTION cal_component_set_classification ##### --> -<para> - -</para> - -@comp: -@classif: - - -<!-- ##### FUNCTION cal_component_get_comment_list ##### --> -<para> - -</para> - -@comp: -@text_list: - - -<!-- ##### FUNCTION cal_component_set_comment_list ##### --> -<para> - -</para> - -@comp: -@text_list: - - -<!-- ##### FUNCTION cal_component_get_completed ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_set_completed ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_get_created ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_set_created ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_get_description_list ##### --> -<para> - -</para> - -@comp: -@text_list: - - -<!-- ##### FUNCTION cal_component_set_description_list ##### --> -<para> - -</para> - -@comp: -@text_list: - - -<!-- ##### FUNCTION cal_component_get_dtend ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_set_dtend ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_get_dtstamp ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_set_dtstamp ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_get_dtstart ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_set_dtstart ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_get_due ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_set_due ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_get_exdate_list ##### --> -<para> - -</para> - -@comp: -@exdate_list: - - -<!-- ##### FUNCTION cal_component_set_exdate_list ##### --> -<para> - -</para> - -@comp: -@exdate_list: - - -<!-- ##### FUNCTION cal_component_has_exdates ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_exrule_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_get_exrule_property_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_set_exrule_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_has_exrules ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_has_exceptions ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_geo ##### --> -<para> - -</para> - -@comp: -@geo: - - -<!-- ##### FUNCTION cal_component_set_geo ##### --> -<para> - -</para> - -@comp: -@geo: - - -<!-- ##### FUNCTION cal_component_get_last_modified ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_set_last_modified ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_get_percent ##### --> -<para> - -</para> - -@comp: -@percent: - - -<!-- ##### FUNCTION cal_component_set_percent ##### --> -<para> - -</para> - -@comp: -@percent: - - -<!-- ##### FUNCTION cal_component_get_priority ##### --> -<para> - -</para> - -@comp: -@priority: - - -<!-- ##### FUNCTION cal_component_set_priority ##### --> -<para> - -</para> - -@comp: -@priority: - - -<!-- ##### FUNCTION cal_component_get_rdate_list ##### --> -<para> - -</para> - -@comp: -@period_list: - - -<!-- ##### FUNCTION cal_component_set_rdate_list ##### --> -<para> - -</para> - -@comp: -@period_list: - - -<!-- ##### FUNCTION cal_component_has_rdates ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_rrule_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_get_rrule_property_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_set_rrule_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_has_rrules ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_has_recurrences ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_sequence ##### --> -<para> - -</para> - -@comp: -@sequence: - - -<!-- ##### FUNCTION cal_component_set_sequence ##### --> -<para> - -</para> - -@comp: -@sequence: - - -<!-- ##### FUNCTION cal_component_get_status ##### --> -<para> - -</para> - -@comp: -@status: - - -<!-- ##### FUNCTION cal_component_set_status ##### --> -<para> - -</para> - -@comp: -@status: - - -<!-- ##### FUNCTION cal_component_get_summary ##### --> -<para> - -</para> - -@comp: -@summary: - - -<!-- ##### FUNCTION cal_component_set_summary ##### --> -<para> - -</para> - -@comp: -@summary: - - -<!-- ##### FUNCTION cal_component_get_transparency ##### --> -<para> - -</para> - -@comp: -@transp: - - -<!-- ##### FUNCTION cal_component_set_transparency ##### --> -<para> - -</para> - -@comp: -@transp: - - -<!-- ##### FUNCTION cal_component_get_url ##### --> -<para> - -</para> - -@comp: -@url: - - -<!-- ##### FUNCTION cal_component_set_url ##### --> -<para> - -</para> - -@comp: -@url: - - -<!-- ##### FUNCTION cal_component_free_categories_list ##### --> -<para> - -</para> - -@categ_list: - - -<!-- ##### FUNCTION cal_component_free_datetime ##### --> -<para> - -</para> - -@dt: - - -<!-- ##### FUNCTION cal_component_free_exdate_list ##### --> -<para> - -</para> - -@exdate_list: - - -<!-- ##### FUNCTION cal_component_free_geo ##### --> -<para> - -</para> - -@geo: - - -<!-- ##### FUNCTION cal_component_free_icaltimetype ##### --> -<para> - -</para> - -@t: - - -<!-- ##### FUNCTION cal_component_free_percent ##### --> -<para> - -</para> - -@percent: - - -<!-- ##### FUNCTION cal_component_free_priority ##### --> -<para> - -</para> - -@priority: - - -<!-- ##### FUNCTION cal_component_free_period_list ##### --> -<para> - -</para> - -@period_list: - - -<!-- ##### FUNCTION cal_component_free_recur_list ##### --> -<para> - -</para> - -@recur_list: - - -<!-- ##### FUNCTION cal_component_free_sequence ##### --> -<para> - -</para> - -@sequence: - - -<!-- ##### FUNCTION cal_component_free_text_list ##### --> -<para> - -</para> - -@text_list: - - -<!-- ##### STRUCT CalComponentAlarm ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CalAlarmInstance ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CalComponentAlarms ##### --> -<para> - -</para> - - -<!-- ##### ENUM CalAlarmAction ##### --> -<para> - -</para> - -@CAL_ALARM_NONE: -@CAL_ALARM_AUDIO: -@CAL_ALARM_DISPLAY: -@CAL_ALARM_EMAIL: -@CAL_ALARM_PROCEDURE: -@CAL_ALARM_UNKNOWN: - -<!-- ##### ENUM CalAlarmTriggerType ##### --> -<para> - -</para> - -@CAL_ALARM_TRIGGER_NONE: -@CAL_ALARM_TRIGGER_RELATIVE_START: -@CAL_ALARM_TRIGGER_RELATIVE_END: -@CAL_ALARM_TRIGGER_ABSOLUTE: - -<!-- ##### TYPEDEF CalAlarmTrigger ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION cal_component_has_alarms ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_alarm_uids ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_alarm ##### --> -<para> - -</para> - -@comp: -@auid: -@Returns: - - -<!-- ##### FUNCTION cal_component_alarm_free ##### --> -<para> - -</para> - -@alarm: - - -<!-- ##### FUNCTION cal_component_alarms_free ##### --> -<para> - -</para> - -@alarms: - - -<!-- ##### FUNCTION cal_component_alarm_get_uid ##### --> -<para> - -</para> - -@alarm: -@Returns: - - -<!-- ##### FUNCTION cal_component_alarm_get_action ##### --> -<para> - -</para> - -@alarm: -@action: - - -<!-- ##### FUNCTION cal_component_alarm_set_action ##### --> -<para> - -</para> - -@alarm: -@action: - - -<!-- ##### FUNCTION cal_component_alarm_get_trigger ##### --> -<para> - -</para> - -@alarm: -@trigger: - - -<!-- ##### FUNCTION cal_component_alarm_set_trigger ##### --> -<para> - -</para> - -@alarm: -@trigger: - - diff --git a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml deleted file mode 100644 index 214b24cbf7..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml +++ /dev/null @@ -1,45 +0,0 @@ -<!-- ##### SECTION Title ##### --> -cal-recur - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### USER_FUNCTION CalRecurInstanceFn ##### --> -<para> - -</para> - -@comp: -@instance_start: -@instance_end: -@data: -@Returns: -<!-- # Unused Parameters # --> -@instace_end: - - -<!-- ##### FUNCTION cal_recur_generate_instances ##### --> -<para> - -</para> - -@comp: -@start: -@end: -@cb: -@cb_data: -@tz_cb: -@tz_cb_data: -@default_timezone: - - diff --git a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml deleted file mode 100644 index ccd35fac2e..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml +++ /dev/null @@ -1,48 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Miscellaneous utilities - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### TYPEDEF CalObjInstance ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION cal_obj_instance_list_free ##### --> -<para> - -</para> - -@list: - - -<!-- ##### ENUM CalObjType ##### --> -<para> - -</para> - -@CALOBJ_TYPE_EVENT: -@CALOBJ_TYPE_TODO: -@CALOBJ_TYPE_JOURNAL: -@CALOBJ_TYPE_ANY: - -<!-- ##### FUNCTION cal_obj_uid_list_free ##### --> -<para> - -</para> - -@list: - - diff --git a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml deleted file mode 100644 index 757b46b170..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml +++ /dev/null @@ -1,322 +0,0 @@ -<!-- ##### ENUM CalComponentAlarmAction ##### --> -<para> - -</para> - -@CAL_COMPONENT_ALARM_NONE: -@CAL_COMPONENT_ALARM_AUDIO: -@CAL_COMPONENT_ALARM_DISPLAY: -@CAL_COMPONENT_ALARM_EMAIL: -@CAL_COMPONENT_ALARM_PROCEDURE: -@CAL_COMPONENT_ALARM_UNKNOWN: - -<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### --> -<para> - -</para> - - -<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### --> -<para> - -</para> - -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: - -<!-- ##### ENUM CalComponentAlarmTriggerType ##### --> -<para> - -</para> - -@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: -@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: - -<!-- ##### STRUCT CalComponentPrivate ##### --> -<para> - -</para> - - -<!-- ##### STRUCT CalObjTime ##### --> -<para> - -</para> - -@year: -@month: -@day: -@hour: -@minute: -@second: - -<!-- ##### ENUM CalRecurType ##### --> -<para> - -</para> - -@CAL_RECUR_YEARLY: -@CAL_RECUR_MONTHLY: -@CAL_RECUR_WEEKLY: -@CAL_RECUR_DAILY: -@CAL_RECUR_HOURLY: -@CAL_RECUR_MINUTELY: -@CAL_RECUR_SECONDLY: - -<!-- ##### TYPEDEF CalRecurrence ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION cal_alarm_instance_list_free ##### --> -<para> - -</para> - -@list: - -<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### --> -<para> - -</para> - -@trigger: <!-- -Local variables: -mode: sgml -sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "") -End: ---> - -<!-- ##### FUNCTION cal_component_get_first_alarm ##### --> -<para> - -</para> - -@comp: -@Returns: - -<!-- ##### FUNCTION cal_component_get_next_alarm ##### --> -<para> - -</para> - -@comp: -@Returns: - -<!-- ##### FUNCTION cal_component_get_pilot_id ##### --> -<para> - -</para> - -@comp: -@pilot_id: - -<!-- ##### FUNCTION cal_component_get_pilot_status ##### --> -<para> - -</para> - -@comp: -@pilot_status: - -<!-- ##### FUNCTION cal_component_set_pilot_id ##### --> -<para> - -</para> - -@comp: -@pilot_id: - -<!-- ##### FUNCTION cal_component_set_pilot_status ##### --> -<para> - -</para> - -@comp: -@pilot_status: - -<!-- ##### FUNCTION cal_recur_free ##### --> -<para> - -</para> - -@r: - -<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### --> -<para> - -</para> - -@ir: -@Returns: - -<!-- ##### FUNCTION format_simple_hour ##### --> -<para> - -</para> - -@hour: -@use_am_pm: -@Returns: - -<!-- ##### FUNCTION get_time_t_hour ##### --> -<para> - -</para> - -@t: -@Returns: - -<!-- ##### FUNCTION isodiff_from_secs ##### --> -<para> - -</para> - -@secs: -@Returns: - -<!-- ##### FUNCTION isodiff_to_secs ##### --> -<para> - -</para> - -@str: -@Returns: - -<!-- ##### FUNCTION parse_date ##### --> -<para> - -</para> - -@str: -@Returns: - -<!-- ##### FUNCTION print_time_t ##### --> -<para> - -</para> - -@t: - -<!-- ##### FUNCTION time_add_minutes ##### --> -<para> - -</para> - -@time: -@minutes: -@Returns: - -<!-- ##### FUNCTION time_add_month ##### --> -<para> - -</para> - -@time: -@months: -@Returns: - -<!-- ##### FUNCTION time_add_year ##### --> -<para> - -</para> - -@time: -@years: -@Returns: - -<!-- ##### FUNCTION time_day_hour ##### --> -<para> - -</para> - -@t: -@hour: -@Returns: - -<!-- ##### FUNCTION time_from_day ##### --> -<para> - -</para> - -@year: -@month: -@day: -@Returns: - -<!-- ##### FUNCTION time_from_icaltimetype ##### --> -<para> - -</para> - -@itt: -@Returns: - -<!-- ##### FUNCTION time_from_isodate ##### --> -<para> - -</para> - -@str: -@Returns: - -<!-- ##### FUNCTION time_from_start_duration ##### --> -<para> - -</para> - -@start: -@duration: -@Returns: - -<!-- ##### FUNCTION time_month_begin ##### --> -<para> - -</para> - -@t: -@Returns: - -<!-- ##### FUNCTION time_month_end ##### --> -<para> - -</para> - -@t: -@Returns: - -<!-- ##### FUNCTION time_week_begin ##### --> -<para> - -</para> - -@t: -@week_start_day: -@Returns: - -<!-- ##### FUNCTION time_week_end ##### --> -<para> - -</para> - -@t: -@week_start_day: -@Returns: - -<!-- ##### FUNCTION time_year_begin ##### --> -<para> - -</para> - -@t: -@Returns: - -<!-- ##### FUNCTION time_year_end ##### --> -<para> - -</para> - -@t: -@Returns: - diff --git a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml deleted file mode 100644 index e118c438eb..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml +++ /dev/null @@ -1,73 +0,0 @@ -<!-- ##### SECTION Title ##### --> -timeutil - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### FUNCTION isodate_from_time_t ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_add_day ##### --> -<para> - -</para> - -@time: -@days: -@Returns: - - -<!-- ##### FUNCTION time_add_week ##### --> -<para> - -</para> - -@time: -@weeks: -@Returns: - - -<!-- ##### FUNCTION time_days_in_month ##### --> -<para> - -</para> - -@year: -@month: -@Returns: - - -<!-- ##### FUNCTION time_day_begin ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_day_end ##### --> -<para> - -</para> - -@t: -@Returns: - - diff --git a/doc/devel/calendar/evolution-calendar.sgml b/doc/devel/calendar/evolution-calendar.sgml deleted file mode 100644 index ea0d8c7127..0000000000 --- a/doc/devel/calendar/evolution-calendar.sgml +++ /dev/null @@ -1,52 +0,0 @@ - <part id="evolution-calendar"> - <docinfo> - <authorgroup> - <author> - <firstname>Federico</firstname> - <surname>Mena Quintero</surname> - <affiliation> - <address> - <email>federico@ximian.com</email> - </address> - </affiliation> - </author> - </authorgroup> - </docinfo> - - <title>Developing Applications with the &Evolution; Calendar</title> - - <partintro> - <para> - 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. - This part also describes the internals of the calendar so that - it will be easy for you to make changes to &Evolution;'s core - code. - </para> - - <para> - 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, such as its storage - interfaces and generic recurrence engine. If you intend to - make changes to the calendar's core code, it will be useful to - read the sections on the calendar internals as well. Even if - you do not intend to modify the core code of the calendar, it - may be useful to know a few things about the way it works so - that you can make better use of the public interfaces. - </para> - </partintro> - - &calendar-architecture; - &calendar-alarm-generation; - </part> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../evolution-devel-guide.sgml" "book" "book" "") -End: ---> diff --git a/doc/devel/calendar/public-reference.sgml b/doc/devel/calendar/public-reference.sgml deleted file mode 100644 index b880bd2972..0000000000 --- a/doc/devel/calendar/public-reference.sgml +++ /dev/null @@ -1,24 +0,0 @@ - <reference id="calendar-public-reference"> - <title>Calendar Public API Reference</title> - - <partintro> - <para> - This part presents the class and function reference for the - public APIs of the different components of the &Evolution; - Calendar. - </para> - </partintro> - - &CalClient; - &CalComponent; - &cal-util; - &cal-recur; - &timeutil; - </reference> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/evolution-devel-guide.sgml b/doc/devel/evolution-devel-guide.sgml deleted file mode 100644 index c089c5b885..0000000000 --- a/doc/devel/evolution-devel-guide.sgml +++ /dev/null @@ -1,98 +0,0 @@ -<!DOCTYPE book PUBLIC "-//Davenport//DTD DocBook V3.0//EN"[ -<!ENTITY preface SYSTEM "preface.sgml"> -<!ENTITY evolution-reference SYSTEM "reference.sgml"> -<!ENTITY FDL SYSTEM "fdl.sgml"> - -<!ENTITY evolution-calendar SYSTEM "calendar/evolution-calendar.sgml"> -<!ENTITY calendar-architecture SYSTEM "calendar/architecture.sgml"> -<!ENTITY calendar-alarm-generation SYSTEM "calendar/alarm-generation.sgml"> -<!ENTITY calendar-public-reference SYSTEM "calendar/public-reference.sgml"> -<!ENTITY CalClient SYSTEM "calendar/cal-client/sgml/cal-client.sgml"> -<!ENTITY CalComponent SYSTEM "calendar/cal-util/sgml/cal-component.sgml"> -<!ENTITY cal-recur SYSTEM "calendar/cal-util/sgml/cal-recur.sgml"> -<!ENTITY cal-util SYSTEM "calendar/cal-util/sgml/cal-util.sgml"> -<!ENTITY timeutil SYSTEM "calendar/cal-util/sgml/timeutil.sgml"> - -<!ENTITY evolution-services-public-reference SYSTEM "executive-summary/public-reference.sgml"> -<!ENTITY evolution-services-private-reference SYSTEM "executive-summary/private-reference.sgml"> -<!ENTITY ExecutiveSummaryComponent SYSTEM "executive-summary/sgml/executive-summary-component.sgml"> -<!ENTITY ExecutiveSummaryComponentFactory SYSTEM "executive-summary/sgml/executive-summary-component-factory.sgml"> -<!ENTITY ExecutiveSummaryComponentFactoryClient SYSTEM "executive-summary/sgml/executive-summary-component-factory-client.sgml"> -<!ENTITY ExecutiveSummaryHtmlView SYSTEM "executive-summary/sgml/executive-summary-html-view.sgml"> - -<!ENTITY Evolution "<application>Evolution</application>"> -<!ENTITY Wombat "<application>Wombat</application>"> -<!ENTITY Camel "<application>Camel</application>"> -<!ENTITY PCS "<acronym>PCS</acronym>"> -<!ENTITY libical "<application>libical</application>"> -<!ENTITY Executive-Summary "<application>Executive Summary</application>"> -]> - -<!-- ENTITY importer-public-reference SYSTEM "importer/public-reference.sgml" --> -<!-- ENTITY importer-private-reference SYSTEM "importer/private-reference.sgml" --> -<!-- ENTITY EvolutionImporter SYSTEM "importer/sgml/evolution-importer.sgml" --> -<!-- ENTITY EvolutionImporterClient SYSTEM "importer/sgml/evolution-importer-client.sgml" --> -<!-- ENTITY EvolutionImporterListener SYSTEM "importer/sgml/evolution-importer-listener.sgml" --> - - -<book id="index"> - <bookinfo> - <title>&Evolution; Developer's Guide</title> - - <authorgroup> - <corpauthor> - Ximian, Inc. - </corpauthor> - </authorgroup> - - <copyright> - <year>2001</year> - <holder>Ximian, Inc.</holder> - </copyright> - - <copyright> - <year>2001</year> - <holder>Ximian, Inc.</holder> - </copyright> - - <legalnotice id="legalnotice"> - <para> - Permission is granted to copy, distribute and/or modify this - document under the terms of the <ulink type="help" - url="gnome-help:fdl"><citetitle>GNU Free Documentation - License</citetitle></ulink>, Version 1.1 or any later version - published by the Free Software Foundation with no Invariant - Sections, no Front-Cover Texts, and no Back-Cover Texts. You - may obtain a copy of the <citetitle>GNU Free Documentation - License</citetitle> from the Free Software Foundation by - visiting <ulink type="http" url="http://www.fsf.org">their Web - site</ulink> or by writing to: Free Software Foundation, Inc., - 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - </para> - - <para> - Many of the names used by companies to distinguish their - products and services are claimed as trademarks. Where those - names appear in any GNOME documentation, and those trademarks - are made aware to the members of the GNOME Documentation - Project, the names have been printed in caps or initial caps. - </para> - </legalnotice> - </bookinfo> - - <!-- Introduction --> - - &preface; - - <!-- DocBook parts for each individual component --> - - &evolution-calendar; - - <!-- API Reference part --> - - &evolution-reference; - - <!-- Appendices --> - - &FDL; -</book> diff --git a/doc/devel/executive-summary/.cvsignore b/doc/devel/executive-summary/.cvsignore deleted file mode 100644 index 489a3d04fd..0000000000 --- a/doc/devel/executive-summary/.cvsignore +++ /dev/null @@ -1,12 +0,0 @@ -Makefile -Makefile.in -*-decl.txt -*.signals -*.hierarchy -*.stamp -*-scan.c -*-unused.txt -*-undocumented.txt -*-decl-list.txt -sgml - diff --git a/doc/devel/executive-summary/Makefile.am b/doc/devel/executive-summary/Makefile.am deleted file mode 100644 index 9e0901bd9f..0000000000 --- a/doc/devel/executive-summary/Makefile.am +++ /dev/null @@ -1,191 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# The name of the module, e.g. 'glib'. -DOC_MODULE=evolution-services - -# 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)/executive-summary/evolution-services - -# 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= -CFILE_GLOB= \ - $(top_srcdir)/executive-summary/evolution-services/executive-summary-component.c \ - $(top_srcdir)/executive-summary/evolution-services/executive-summary-component-factory-client.c \ - $(top_srcdir)/executive-summary/evolution-services/executive-summary-html-view.c - - -# Header files to ignore when scanning. -IGNORE_HFILES=Executive-Summary.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)/executive-summary/evolution-services \ - -I$(top_srcdir)/executive-summary \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - $(BONOBO_VFS_GNOME_CFLAGS) - -GTKDOC_LIBS = \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/executive-summary/evolution-services/.libs/libevolution-services.so - -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 = - - -########################################################################### -# 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/doc/devel/executive-summary/evolution-services-decl.txt b/doc/devel/executive-summary/evolution-services-decl.txt deleted file mode 100644 index caaabb2ee7..0000000000 --- a/doc/devel/executive-summary/evolution-services-decl.txt +++ /dev/null @@ -1,536 +0,0 @@ -<MACRO> -<NAME>EXECUTIVE_SUMMARY_CLIENT_TYPE</NAME> -#define EXECUTIVE_SUMMARY_CLIENT_TYPE (executive_summary_client_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_CLIENT</NAME> -#define EXECUTIVE_SUMMARY_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE, ExecutiveSummaryClient)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_CLIENT_CLASS</NAME> -#define EXECUTIVE_SUMMARY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_CLIENT_TYPE, ExecutiveSummaryClientClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_CLIENT</NAME> -#define IS_EXECUTIVE_SUMMARY_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_CLIENT_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryClientPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryClient</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryClientClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryClient</NAME> -struct ExecutiveSummaryClient { - BonoboObjectClient parent; - - ExecutiveSummaryClientPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_client_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_client_construct</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryClient *client,CORBA_Object object -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_client_set_title</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryClient *client,int id,const char *title -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_client_set_icon</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryClient *client,int id,const char *icon -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_client_flash</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryClient *client,int id -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_client_update</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryClient *client,int id,const char *html -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE (executive_summary_component_client_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLIENT</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE, ExecutiveSummaryComponentClient)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE, ExecutiveSummaryComponentClientClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryComponentClientPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentClient</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentClientClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentClient</NAME> -struct ExecutiveSummaryComponentClient { - BonoboObjectClient parent; - - ExecutiveSummaryComponentClientPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_component_client_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_new</NAME> -<RETURNS>ExecutiveSummaryComponentClient *</RETURNS> -const char *id -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_set_owner</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentClient *client,ExecutiveSummary *summary -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_unset_owner</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentClient *client -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_supports</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentClient *client,gboolean *bonobo,gboolean *html -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_configure</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentClient *client,ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_destroy_view</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentClient *client,ExecutiveSummaryComponentView *view -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE (executive_summary_component_factory_client_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE, ExecutiveSummaryComponentFactoryClient)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE, ExecutiveSummaryComponentFactoryClientClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryClientPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryClient</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryClientClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryClient</NAME> -struct ExecutiveSummaryComponentFactoryClient { - BonoboObjectClient parent; - - ExecutiveSummaryComponentFactoryClientPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_component_factory_client_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_factory_client_construct</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentFactoryClient *client,CORBA_Object corba_object -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_factory_client_new</NAME> -<RETURNS>ExecutiveSummaryComponentFactoryClient *</RETURNS> -const char *id -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_factory_client_create_view</NAME> -<RETURNS>CORBA_Object </RETURNS> -ExecutiveSummaryComponentFactoryClient *client -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE (executive_summary_component_view_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_VIEW</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_VIEW(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE, ExecutiveSummaryComponentView)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE, ExecutiveSummaryComponentClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryComponentViewPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentView</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentViewClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentView</NAME> -struct ExecutiveSummaryComponentView { - GtkObject object; - - ExecutiveSummaryComponentViewPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_component_view_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_construct</NAME> -<RETURNS>void</RETURNS> -ExecutiveSummaryComponentView *view,ExecutiveSummaryComponent *component,BonoboControl *control,const char *html,const char *title,const char *icon -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_new</NAME> -<RETURNS>ExecutiveSummaryComponentView *</RETURNS> -ExecutiveSummaryComponent *component,BonoboControl *control,const char *html,const char *title,const char *icon -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_set_title</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view,const char *title -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_title</NAME> -<RETURNS>const char *</RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_set_icon</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view,const char *icon -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_icon</NAME> -<RETURNS>const char *</RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_flash</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_set_html</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view,const char *html -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_html</NAME> -<RETURNS>const char *</RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_control</NAME> -<RETURNS>BonoboObject *</RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_id</NAME> -<RETURNS>int </RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_set_id</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view,int id -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_configure</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_set_objref</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view,Bonobo_Control objref -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_widget</NAME> -<RETURNS>GtkWidget *</RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_TYPE</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_TYPE (executive_summary_component_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE, ExecutiveSummaryComponent)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLASS</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_TYPE, ExecutiveSummaryComponentClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryComponentPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponent</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponent</NAME> -struct ExecutiveSummaryComponent { - BonoboObject parent; - - ExecutiveSummaryComponentPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_component_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_new</NAME> -<RETURNS>BonoboObject *</RETURNS> -void -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE (executive_summary_component_factory_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE, ExecutiveSummaryComponentFactory)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE, ExecutiveSummaryComponentFactoryClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactory</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryClass</NAME> -</STRUCT> -<USER_FUNCTION> -<NAME>EvolutionServicesCreateViewFn</NAME> -<RETURNS>BonoboObject *</RETURNS> -ExecutiveSummaryComponentFactory *factory, - void *closure -</USER_FUNCTION> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactory</NAME> -struct ExecutiveSummaryComponentFactory { - BonoboObject parent; - - ExecutiveSummaryComponentFactoryPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_component_factory_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_factory_new</NAME> -<RETURNS>BonoboObject *</RETURNS> -EvolutionServicesCreateViewFn create_view,void *closure -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED</NAME> -#define EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED "GNOME:Evolution:Summary:HTMLView:html_changed" -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_HTML_VIEW_TYPE</NAME> -#define EXECUTIVE_SUMMARY_HTML_VIEW_TYPE (executive_summary_html_view_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_HTML_VIEW</NAME> -#define EXECUTIVE_SUMMARY_HTML_VIEW(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE, ExecutiveSummaryHtmlView)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_HTML_VIEW_CLASS</NAME> -#define EXECUTIVE_SUMMARY_HTML_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE, ExecutiveSummaryHtmlViewClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_HTML_VIEW</NAME> -#define IS_EXECUTIVE_SUMMARY_HTML_VIEW(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryHtmlViewPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryHtmlView</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryHtmlViewClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryHtmlView</NAME> -struct ExecutiveSummaryHtmlView { - BonoboObject parent; - - ExecutiveSummaryHtmlViewPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_html_view_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_html_view_new_full</NAME> -<RETURNS>BonoboObject *</RETURNS> -BonoboEventSource *event_source -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_html_view_new</NAME> -<RETURNS>BonoboObject *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_html_view_set_html</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryHtmlView *view,const char *html -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_html_view_get_html</NAME> -<RETURNS>const char *</RETURNS> -ExecutiveSummaryHtmlView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_html_view_get_event_source</NAME> -<RETURNS>BonoboEventSource *</RETURNS> -ExecutiveSummaryHtmlView *view -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_TYPE</NAME> -#define EXECUTIVE_SUMMARY_TYPE (executive_summary_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY</NAME> -#define EXECUTIVE_SUMMARY(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_TYPE, ExecutiveSummary)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_CLASS</NAME> -#define EXECUTIVE_SUMMARY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_TYPE, ExecutiveSummaryClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY</NAME> -#define IS_EXECUTIVE_SUMMARY(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummary</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummary</NAME> -struct ExecutiveSummary { - BonoboObject parent; - - ExecutiveSummaryPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_construct</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummary *es,GNOME_Evolution_Summary_ViewFrame corba_object -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_new</NAME> -<RETURNS>BonoboObject *</RETURNS> -void -</FUNCTION> diff --git a/doc/devel/executive-summary/evolution-services-sections.txt b/doc/devel/executive-summary/evolution-services-sections.txt deleted file mode 100644 index 8ba2b42317..0000000000 --- a/doc/devel/executive-summary/evolution-services-sections.txt +++ /dev/null @@ -1,95 +0,0 @@ -<INCLUDE>executive-summary-component.h</INCLUDE> -<SECTION> -<FILE>executive-summary-component</FILE> -EXECUTIVE_SUMMARY_COMPONENT -<TITLE>ExecutiveSummaryComponent</TITLE> - -executive_summary_component_new - -<SUBSECTION Standard> -EXECUTIVE_SUMMARY_COMPONENT_TYPE -EXECUTIVE_SUMMARY_COMPONENT -EXECUTIVE_SUMMARY_COMPONENT_CLASS -IS_EXECUTIVE_SUMMARY_COMPONENT -IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS -executive_summary_component_get_type - -<SUBSECTION Private> -ExecutiveSummaryComponent -ExecutiveSummaryComponentPrivate - -</SECTION> - -<SECTION> -<FILE>executive-summary-component-factory</FILE> -EXECUTIVE_SUMMARY_COMPONENT_FACTORY -<TITLE>ExecutiveSummaryComponentFactory</TITLE> - -EvolutionServicesCreateViewFn - -executive_summary_component_factory_new - -<SUBSECTION Standard> -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE -EXECUTIVE_SUMMARY_COMPONENT_FACTORY -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS -IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY -IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS -executive_summary_component_factory_get_type - -<SUBSECTION Private> -ExecutiveSummaryComponentFactory -ExecutiveSummaryComponentFactoryPrivate - -</SECTION> - -<INCLUDE>executive-summary-component-factory-client.h</INCLUDE> -<SECTION> -<FILE>executive-summary-component-factory-client</FILE> -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT -<TITLE>ExecutiveSummaryComponentFactoryClient</TITLE> - -executive_summary_component_factory_client_construct -executive_summary_component_factory_client_new -executive_summary_component_factory_client_create_view - -<SUBSECTION Standard> -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS -IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT -IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS -executive_summary_component_factory_client_get_type - -<SUBSECTION Private> -ExecutiveSummaryComponentFactoryClient -ExecutiveSummaryComponentFactoryClientPrivate - -</SECTION> - -<INCLUDE>executive-summary-html-view.h</INCLUDE> -<SECTION> -<FILE>executive-summary-html-view</FILE> -EXECUTIVE_SUMMARY_HTML_VIEW -<TITLE>ExecutiveSummaryHtmlView</TITLE> - -EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED - -executive_summary_html_view_new_full -executive_summary_html_view_new -executive_summary_html_view_set_html -executive_summary_html_view_get_html -executive_summary_html_view_get_event_source - -<SUBSECTION Standard> -EXECUTIVE_SUMMARY_HTML_VIEW_TYPE -EXECUTIVE_SUMMARY_HTML_VIEW -IS_EXECUTIVE_SUMMARY_HTML_VIEW -EXECUTIVE_SUMMARY_HTML_VIEW_CLASS -IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS -executive_summary_html_view_get_type - -<SUBSECTION Private> -ExecutiveSummaryHtmlView -ExecutiveSummaryHtmlViewPrivate -</SECTION> diff --git a/doc/devel/executive-summary/evolution-services.args b/doc/devel/executive-summary/evolution-services.args deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/executive-summary/evolution-services.args +++ /dev/null diff --git a/doc/devel/executive-summary/evolution-services.hierarchy b/doc/devel/executive-summary/evolution-services.hierarchy deleted file mode 100644 index 37559d819d..0000000000 --- a/doc/devel/executive-summary/evolution-services.hierarchy +++ /dev/null @@ -1,7 +0,0 @@ -GtkObject - BonoboObject - ExecutiveSummaryComponent - ExecutiveSummaryComponentFactory - Handle to remote Bonobo::Unknown - ExecutiveSummaryComponentFactoryClient - ExecutiveSummaryHtmlView diff --git a/doc/devel/executive-summary/evolution-services.types b/doc/devel/executive-summary/evolution-services.types deleted file mode 100644 index b7ac05b89c..0000000000 --- a/doc/devel/executive-summary/evolution-services.types +++ /dev/null @@ -1,10 +0,0 @@ -#include <gnome.h> -#include <bonobo.h> -#include <evolution-services/executive-summary-component.h> -#include <evolution-services/executive-summary-component-factory-client.h> -#include <evolution-services/executive-summary-html-view.h> - -executive_summary_component_get_type -executive_summary_component_factory_get_type -executive_summary_component_factory_client_get_type -executive_summary_html_view_get_type diff --git a/doc/devel/executive-summary/private-reference.sgml b/doc/devel/executive-summary/private-reference.sgml deleted file mode 100644 index e06d7c1690..0000000000 --- a/doc/devel/executive-summary/private-reference.sgml +++ /dev/null @@ -1,20 +0,0 @@ - <reference id="evolution-services-private-reference"> - <title>Evolution Services Private API Reference</title> - - <partintro> - <para> - This part presents the class and function reference for the - private APIs of the different components of the &Evolution; - Executive Summary Services Framework. - </para> - </partintro> - - &ExecutiveSummaryComponentFactoryClient; - </reference> - -<!-- -Local variables: -mode: sgml -sml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/executive-summary/public-reference.sgml b/doc/devel/executive-summary/public-reference.sgml deleted file mode 100644 index 7758a9a5c8..0000000000 --- a/doc/devel/executive-summary/public-reference.sgml +++ /dev/null @@ -1,22 +0,0 @@ - <reference id="evolution-services-public-reference"> - <title>Evolution Services Public API Reference</title> - - <partintro> - <para> - This part presents the class and function reference for the - public APIs of the different components of the &Evolution; - Executive Summary Services Framework. - </para> - </partintro> - - &ExecutiveSummaryComponent; - &ExecutiveSummaryComponentFactory; - &ExecutiveSummaryHtmlView; - </reference> - -<!-- -Local variables: -mode: sgml -sml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/executive-summary/tmpl/evolution-services-unused.sgml b/doc/devel/executive-summary/tmpl/evolution-services-unused.sgml deleted file mode 100644 index 9f8096db6a..0000000000 --- a/doc/devel/executive-summary/tmpl/evolution-services-unused.sgml +++ /dev/null @@ -1,8 +0,0 @@ -<!-- ##### SIGNAL ExecutiveSummaryHtmlView::handle-uri ##### --> -<para> - -</para> - -@executivesummaryhtmlview: the object which received the signal. -@arg1: - diff --git a/doc/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml b/doc/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml deleted file mode 100644 index ee8ef25689..0000000000 --- a/doc/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml +++ /dev/null @@ -1,53 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ExecutiveSummaryComponentFactoryClient - -<!-- ##### SECTION Short_Description ##### --> -GtkObject client to simplfy use of GNOME_Evolution_Summary_ComponentFactory - -<!-- ##### SECTION Long_Description ##### --> -<para> -This object provides an easy wrapper around the CORBA object that represents the - GNOME_Evolution_Summary_ComponentFactory interface. It handles conversion from -normal types to CORBA types and has error checking. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT ##### --> -<para> -Casts a #GtkObject into an #ExecutiveSummaryComponentFactoryClient -</para> - -@obj: - - -<!-- ##### FUNCTION executive_summary_component_factory_client_construct ##### --> -<para> - -</para> - -@client: -@corba_object: - - -<!-- ##### FUNCTION executive_summary_component_factory_client_new ##### --> -<para> - -</para> - -@id: -@Returns: - - -<!-- ##### FUNCTION executive_summary_component_factory_client_create_view ##### --> -<para> - -</para> - -@client: -@Returns: - - diff --git a/doc/devel/executive-summary/tmpl/executive-summary-component-factory.sgml b/doc/devel/executive-summary/tmpl/executive-summary-component-factory.sgml deleted file mode 100644 index 7069eea9d0..0000000000 --- a/doc/devel/executive-summary/tmpl/executive-summary-component-factory.sgml +++ /dev/null @@ -1,46 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ExecutiveSummaryComponentFactory - -<!-- ##### SECTION Short_Description ##### --> -GtkObject wrapper for GNOME/Evolution/Summary/ComponentFactory. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An ExecutiveSummaryComponentFactory simplifies the creation of a -GNOME_Evolution_Summary_ComponentFactory object. It also allows error checking -and all the standard #GtkObject signals. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO EXECUTIVE_SUMMARY_COMPONENT_FACTORY ##### --> -<para> -Casts a #GtkObject to an #ExecutiveSummaryComponentFactory. -</para> - -@obj: A #GtkObject. - - -<!-- ##### USER_FUNCTION EvolutionServicesCreateViewFn ##### --> -<para> -The type of function that is called when the factory has to create a new view. -</para> - -@factory: The #ExecutiveSummaryComponent that is creating the view. -@closure: The data that was passed into executive_summary_factory_new (). -@Returns: An #ExecutiveSummaryComponent. - - -<!-- ##### FUNCTION executive_summary_component_factory_new ##### --> -<para> - -</para> - -@create_view: -@closure: -@Returns: - - diff --git a/doc/devel/executive-summary/tmpl/executive-summary-component.sgml b/doc/devel/executive-summary/tmpl/executive-summary-component.sgml deleted file mode 100644 index 04768b1b1c..0000000000 --- a/doc/devel/executive-summary/tmpl/executive-summary-component.sgml +++ /dev/null @@ -1,37 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ExecutiveSummaryComponent - -<!-- ##### SECTION Short_Description ##### --> -The base #BonoboObject that implements GNOME/Evolution/Summary/Component. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This #GtkObject wrapper around the GNOME/Evolution/Summary/Component, is the -base object that has all the other interfaces aggregated onto it. These -interfaces are: GNOME/Evolution/HTMLView, Bonobo/Control, Bonobo/EventSource, -Bonobo/PropertyBag, Bonobo/PropertyControl and Bonobo/PersistStream. Each of -the aggregated interfaces performs a specific job in the creation of the service. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#ExecutiveSummaryHtmlView, #BonoboControl, #BonoboEventSource, #BonoboPropertyBag, -#BonoboPropertyControl, #BonoboPersistStream. -</para> - -<!-- ##### MACRO EXECUTIVE_SUMMARY_COMPONENT ##### --> -<para> -Casts a #GtkObject to an #ExecutiveSummaryComponent. -</para> - -@obj: A #GtkObject. - - -<!-- ##### FUNCTION executive_summary_component_new ##### --> -<para> - -</para> - -@Returns: - - diff --git a/doc/devel/executive-summary/tmpl/executive-summary-html-view.sgml b/doc/devel/executive-summary/tmpl/executive-summary-html-view.sgml deleted file mode 100644 index 2fb66a2035..0000000000 --- a/doc/devel/executive-summary/tmpl/executive-summary-html-view.sgml +++ /dev/null @@ -1,75 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ExecutiveSummaryHtmlView - -<!-- ##### SECTION Short_Description ##### --> -A Bonobo component used to implement HTML based services. - -<!-- ##### SECTION Long_Description ##### --> -<para> -When writing HTML services, this component is aggregated onto an #ExecutiveSummaryComponent, to allow the Executive Summary to be able to find the HTML. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#ExecutiveSummaryComponent, #BonoboEventSource -</para> - -<!-- ##### MACRO EXECUTIVE_SUMMARY_HTML_VIEW ##### --> -<para> - Casts a #GtkObject into an #ExecutiveSummaryHtmlView -</para> - -@obj: A #GtkObject - - -<!-- ##### MACRO EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED ##### --> -<para> -This is the event that is emitted on the BonoboEventSource when the HTML is changed. -</para> - - - -<!-- ##### FUNCTION executive_summary_html_view_new_full ##### --> -<para> - -</para> - -@event_source: -@Returns: - - -<!-- ##### FUNCTION executive_summary_html_view_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION executive_summary_html_view_set_html ##### --> -<para> - -</para> - -@view: -@html: - - -<!-- ##### FUNCTION executive_summary_html_view_get_html ##### --> -<para> - -</para> - -@view: -@Returns: - - -<!-- ##### FUNCTION executive_summary_html_view_get_event_source ##### --> -<para> - -</para> - -@view: -@Returns: - - diff --git a/doc/devel/fdl.sgml b/doc/devel/fdl.sgml deleted file mode 100644 index 817adbdbb7..0000000000 --- a/doc/devel/fdl.sgml +++ /dev/null @@ -1,671 +0,0 @@ -<!-- - The GNU Free Documentation License 1.1 in DocBook - Markup by Eric Baudais <baudais@okstate.edu> - Maintained by the GNOME Documentation Project - http://developer.gnome.org/projects/gdp - Version: 1.0.1 - Last Modified: Nov 16, 2000 ---> - -<appendix id="fdl"> - <docinfo> - <releaseinfo> - Version 1.1, March 2000 - </releaseinfo> - <copyright> - <year>2000</year><holder>Free Software Foundation, Inc.</holder> - </copyright> - <legalnotice id="fdl-legalnotice"> - <para> - <address>Free Software Foundation, Inc. <street>59 Temple Place, - Suite 330</street>, <city>Boston</city>, <state>MA</state> - <postcode>02111-1307</postcode> <country>USA</country></address> - Everyone is permitted to copy and distribute verbatim copies of this - license document, but changing it is not allowed. - </para> - </legalnotice> - </docinfo> - <title>GNU Free Documentation License</title> - - <sect1 id="fdl-preamble"> - <title>0. PREAMBLE</title> - <para> - The purpose of this License is to make a manual, textbook, or - other written document <quote>free</quote> in the sense of - freedom: to assure everyone the effective freedom to copy and - redistribute it, with or without modifying it, either - commercially or noncommercially. Secondarily, this License - preserves for the author and publisher a way to get credit for - their work, while not being considered responsible for - modifications made by others. - </para> - - <para> - This License is a kind of <quote>copyleft</quote>, which means - that derivative works of the document must themselves be free in - the same sense. It complements the GNU General Public License, - which is a copyleft license designed for free software. - </para> - - <para> - We have designed this License in order to use it for manuals for - free software, because free software needs free documentation: a - free program should come with manuals providing the same - freedoms that the software does. But this License is not limited - to software manuals; it can be used for any textual work, - regardless of subject matter or whether it is published as a - printed book. We recommend this License principally for works - whose purpose is instruction or reference. - </para> - </sect1> - <sect1 id="fdl-section1"> - <title>1. APPLICABILITY AND DEFINITIONS</title> - <para id="fdl-document"> - This License applies to any manual or other work that contains a - notice placed by the copyright holder saying it can be - distributed under the terms of this License. The - <quote>Document</quote>, below, refers to any such manual or - work. Any member of the public is a licensee, and is addressed - as <quote>you</quote>. - </para> - - <para id="fdl-modified"> - A <quote>Modified Version</quote> of the Document means any work - containing the Document or a portion of it, either copied - verbatim, or with modifications and/or translated into another - language. - </para> - - <para id="fdl-secondary"> - A <quote>Secondary Section</quote> is a named appendix or a - front-matter section of the <link - linkend="fdl-document">Document</link> that deals exclusively - with the relationship of the publishers or authors of the - Document to the Document's overall subject (or to related - matters) and contains nothing that could fall directly within - that overall subject. (For example, if the Document is in part a - textbook of mathematics, a Secondary Section may not explain any - mathematics.) The relationship could be a matter of historical - connection with the subject or with related matters, or of - legal, commercial, philosophical, ethical or political position - regarding them. - </para> - - <para id="fdl-invariant"> - The <quote>Invariant Sections</quote> are certain <link - linkend="fdl-secondary"> Secondary Sections</link> whose titles - are designated, as being those of Invariant Sections, in the - notice that says that the <link - linkend="fdl-document">Document</link> is released under this - License. - </para> - - <para id="fdl-cover-texts"> - The <quote>Cover Texts</quote> are certain short passages of - text that are listed, as Front-Cover Texts or Back-Cover Texts, - in the notice that says that the <link - linkend="fdl-document">Document</link> is released under this - License. - </para> - - <para id="fdl-transparent"> - A <quote>Transparent</quote> copy of the <link - linkend="fdl-document"> Document</link> means a machine-readable - copy, represented in a format whose specification is available - to the general public, whose contents can be viewed and edited - directly and straightforwardly with generic text editors or (for - images composed of pixels) generic paint programs or (for - drawings) some widely available drawing editor, and that is - suitable for input to text formatters or for automatic - translation to a variety of formats suitable for input to text - formatters. A copy made in an otherwise Transparent file format - whose markup has been designed to thwart or discourage - subsequent modification by readers is not Transparent. A copy - that is not <quote>Transparent</quote> is called - <quote>Opaque</quote>. - </para> - - <para> - Examples of suitable formats for Transparent copies include - plain ASCII without markup, Texinfo input format, LaTeX input - format, SGML or XML using a publicly available DTD, and - standard-conforming simple HTML designed for human - modification. Opaque formats include PostScript, PDF, - proprietary formats that can be read and edited only by - proprietary word processors, SGML or XML for which the DTD - and/or processing tools are not generally available, and the - machine-generated HTML produced by some word processors for - output purposes only. - </para> - - <para id="fdl-title-page"> - The <quote>Title Page</quote> means, for a printed book, the - title page itself, plus such following pages as are needed to - hold, legibly, the material this License requires to appear in - the title page. For works in formats which do not have any title - page as such, <quote>Title Page</quote> means the text near the - most prominent appearance of the work's title, preceding the - beginning of the body of the text. - </para> - </sect1> - - <sect1 id="fdl-section2"> - <title>2. VERBATIM COPYING</title> - <para> - You may copy and distribute the <link - linkend="fdl-document">Document</link> in any medium, either - commercially or noncommercially, provided that this License, the - copyright notices, and the license notice saying this License - applies to the Document are reproduced in all copies, and that - you add no other conditions whatsoever to those of this - License. You may not use technical measures to obstruct or - control the reading or further copying of the copies you make or - distribute. However, you may accept compensation in exchange for - copies. If you distribute a large enough number of copies you - must also follow the conditions in <link - linkend="fdl-section3">section 3</link>. - </para> - - <para> - You may also lend copies, under the same conditions stated - above, and you may publicly display copies. - </para> - </sect1> - - <sect1 id="fdl-section3"> - <title>3. COPYING IN QUANTITY</title> - <para> - If you publish printed copies of the <link - linkend="fdl-document">Document</link> numbering more than 100, - and the Document's license notice requires <link - linkend="fdl-cover-texts">Cover Texts</link>, you must enclose - the copies in covers that carry, clearly and legibly, all these - Cover Texts: Front-Cover Texts on the front cover, and - Back-Cover Texts on the back cover. Both covers must also - clearly and legibly identify you as the publisher of these - copies. The front cover must present the full title with all - words of the title equally prominent and visible. You may add - other material on the covers in addition. Copying with changes - limited to the covers, as long as they preserve the title of the - <link linkend="fdl-document">Document</link> and satisfy these - conditions, can be treated as verbatim copying in other - respects. - </para> - - <para> - If the required texts for either cover are too voluminous to fit - legibly, you should put the first ones listed (as many as fit - reasonably) on the actual cover, and continue the rest onto - adjacent pages. - </para> - - <para> - If you publish or distribute <link - linkend="fdl-transparent">Opaque</link> copies of the <link - linkend="fdl-document">Document</link> numbering more than 100, - you must either include a machine-readable <link - linkend="fdl-transparent">Transparent</link> copy along with - each Opaque copy, or state in or with each Opaque copy a - publicly-accessible computer-network location containing a - complete Transparent copy of the Document, free of added - material, which the general network-using public has access to - download anonymously at no charge using public-standard network - protocols. If you use the latter option, you must take - reasonably prudent steps, when you begin distribution of Opaque - copies in quantity, to ensure that this Transparent copy will - remain thus accessible at the stated location until at least one - year after the last time you distribute an Opaque copy (directly - or through your agents or retailers) of that edition to the - public. - </para> - - <para> - It is requested, but not required, that you contact the authors - of the <link linkend="fdl-document">Document</link> well before - redistributing any large number of copies, to give them a chance - to provide you with an updated version of the Document. - </para> - </sect1> - - <sect1 id="fdl-section4"> - <title>4. MODIFICATIONS</title> - <para> - You may copy and distribute a <link - linkend="fdl-modified">Modified Version</link> of the <link - linkend="fdl-document">Document</link> under the conditions of - sections <link linkend="fdl-section2">2</link> and <link - linkend="fdl-section3">3</link> above, provided that you release - the Modified Version under precisely this License, with the - Modified Version filling the role of the Document, thus - licensing distribution and modification of the Modified Version - to whoever possesses a copy of it. In addition, you must do - these things in the Modified Version: - </para> - - <itemizedlist mark="opencircle"> - <listitem> - <formalpara> - <title>A</title> - <para> - Use in the <link linkend="fdl-title-page">Title - Page</link> (and on the covers, if any) a title distinct - from that of the <link - linkend="fdl-document">Document</link>, and from those of - previous versions (which should, if there were any, be - listed in the History section of the Document). You may - use the same title as a previous version if the original - publisher of that version gives permission. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>B</title> - <para> - List on the <link linkend="fdl-title-page">Title - Page</link>, as authors, one or more persons or entities - responsible for authorship of the modifications in the - <link linkend="fdl-modified">Modified Version</link>, - together with at least five of the principal authors of - the <link linkend="fdl-document">Document</link> (all of - its principal authors, if it has less than five). - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>C</title> - <para> - State on the <link linkend="fdl-title-page">Title - Page</link> the name of the publisher of the <link - linkend="fdl-modified">Modified Version</link>, as the - publisher. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>D</title> - <para> - Preserve all the copyright notices of the <link - linkend="fdl-document">Document</link>. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>E</title> - <para> - Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>F</title> - <para> - Include, immediately after the copyright notices, a - license notice giving the public permission to use the - <link linkend="fdl-modified">Modified Version</link> under - the terms of this License, in the form shown in the - Addendum below. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>G</title> - <para> - Preserve in that license notice the full lists of <link - linkend="fdl-invariant"> Invariant Sections</link> and - required <link linkend="fdl-cover-texts">Cover - Texts</link> given in the <link - linkend="fdl-document">Document's</link> license notice. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>H</title> - <para> - Include an unaltered copy of this License. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>I</title> - <para> - Preserve the section entitled <quote>History</quote>, and - its title, and add to it an item stating at least the - title, year, new authors, and publisher of the <link - linkend="fdl-modified">Modified Version </link>as given on - the <link linkend="fdl-title-page">Title Page</link>. If - there is no section entitled <quote>History</quote> in the - <link linkend="fdl-document">Document</link>, create one - stating the title, year, authors, and publisher of the - Document as given on its Title Page, then add an item - describing the Modified Version as stated in the previous - sentence. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>J</title> - <para> - Preserve the network location, if any, given in the <link - linkend="fdl-document">Document</link> for public access - to a <link linkend="fdl-transparent">Transparent</link> - copy of the Document, and likewise the network locations - given in the Document for previous versions it was based - on. These may be placed in the <quote>History</quote> - section. You may omit a network location for a work that - was published at least four years before the Document - itself, or if the original publisher of the version it - refers to gives permission. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>K</title> - <para> - In any section entitled <quote>Acknowledgements</quote> or - <quote>Dedications</quote>, preserve the section's title, - and preserve in the section all the substance and tone of - each of the contributor acknowledgements and/or - dedications given therein. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>L</title> - <para> - Preserve all the <link linkend="fdl-invariant">Invariant - Sections</link> of the <link - linkend="fdl-document">Document</link>, unaltered in their - text and in their titles. Section numbers or the - equivalent are not considered part of the section titles. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>M</title> - <para> - Delete any section entitled - <quote>Endorsements</quote>. Such a section may not be - included in the <link linkend="fdl-modified">Modified - Version</link>. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>N</title> - <para> - Do not retitle any existing section as - <quote>Endorsements</quote> or to conflict in title with - any <link linkend="fdl-invariant">Invariant - Section</link>. - </para> - </formalpara> - </listitem> - </itemizedlist> - - <para> - If the <link linkend="fdl-modified">Modified Version</link> - includes new front-matter sections or appendices that qualify as - <link linkend="fdl-secondary">Secondary Sections</link> and - contain no material copied from the Document, you may at your - option designate some or all of these sections as invariant. To - do this, add their titles to the list of <link - linkend="fdl-invariant">Invariant Sections</link> in the - Modified Version's license notice. These titles must be - distinct from any other section titles. - </para> - - <para> - You may add a section entitled <quote>Endorsements</quote>, - provided it contains nothing but endorsements of your <link - linkend="fdl-modified">Modified Version</link> by various - parties--for example, statements of peer review or that the text - has been approved by an organization as the authoritative - definition of a standard. - </para> - - <para> - You may add a passage of up to five words as a <link - linkend="fdl-cover-texts">Front-Cover Text</link>, and a passage - of up to 25 words as a <link - linkend="fdl-cover-texts">Back-Cover Text</link>, to the end of - the list of <link linkend="fdl-cover-texts">Cover Texts</link> - in the <link linkend="fdl-modified">Modified Version</link>. - Only one passage of Front-Cover Text and one of Back-Cover Text - may be added by (or through arrangements made by) any one - entity. If the <link linkend="fdl-document">Document</link> - already includes a cover text for the same cover, previously - added by you or by arrangement made by the same entity you are - acting on behalf of, you may not add another; but you may - replace the old one, on explicit permission from the previous - publisher that added the old one. - </para> - - <para> - The author(s) and publisher(s) of the <link - linkend="fdl-document">Document</link> do not by this License - give permission to use their names for publicity for or to - assert or imply endorsement of any <link - linkend="fdl-modified">Modified Version </link>. - </para> - </sect1> - - <sect1 id="fdl-section5"> - <title>5. COMBINING DOCUMENTS</title> - <para> - You may combine the <link linkend="fdl-document">Document</link> - with other documents released under this License, under the - terms defined in <link linkend="fdl-section4">section 4</link> - above for modified versions, provided that you include in the - combination all of the <link linkend="fdl-invariant">Invariant - Sections</link> of all of the original documents, unmodified, - and list them all as Invariant Sections of your combined work in - its license notice. - </para> - - <para> - The combined work need only contain one copy of this License, - and multiple identical <link linkend="fdl-invariant">Invariant - Sections</link> may be replaced with a single copy. If there are - multiple Invariant Sections with the same name but different - contents, make the title of each such section unique by adding - at the end of it, in parentheses, the name of the original - author or publisher of that section if known, or else a unique - number. Make the same adjustment to the section titles in the - list of Invariant Sections in the license notice of the combined - work. - </para> - - <para> - In the combination, you must combine any sections entitled - <quote>History</quote> in the various original documents, - forming one section entitled <quote>History</quote>; likewise - combine any sections entitled <quote>Acknowledgements</quote>, - and any sections entitled <quote>Dedications</quote>. You must - delete all sections entitled <quote>Endorsements.</quote> - </para> - </sect1> - - <sect1 id="fdl-section6"> - <title>6. COLLECTIONS OF DOCUMENTS</title> - <para> - You may make a collection consisting of the <link - linkend="fdl-document">Document</link> and other documents - released under this License, and replace the individual copies - of this License in the various documents with a single copy that - is included in the collection, provided that you follow the - rules of this License for verbatim copying of each of the - documents in all other respects. - </para> - - <para> - You may extract a single document from such a collection, and - dispbibute it individually under this License, provided you - insert a copy of this License into the extracted document, and - follow this License in all other respects regarding verbatim - copying of that document. - </para> - </sect1> - - <sect1 id="fdl-section7"> - <title>7. AGGREGATION WITH INDEPENDENT WORKS</title> - <para> - A compilation of the <link - linkend="fdl-document">Document</link> or its derivatives with - other separate and independent documents or works, in or on a - volume of a storage or distribution medium, does not as a whole - count as a <link linkend="fdl-modified">Modified Version</link> - of the Document, provided no compilation copyright is claimed - for the compilation. Such a compilation is called an - <quote>aggregate</quote>, and this License does not apply to the - other self-contained works thus compiled with the Document , on - account of their being thus compiled, if they are not themselves - derivative works of the Document. If the <link - linkend="fdl-cover-texts">Cover Text</link> requirement of <link - linkend="fdl-section3">section 3</link> is applicable to these - copies of the Document, then if the Document is less than one - quarter of the entire aggregate, the Document's Cover Texts may - be placed on covers that surround only the Document within the - aggregate. Otherwise they must appear on covers around the whole - aggregate. - </para> - </sect1> - - <sect1 id="fdl-section8"> - <title>8. TRANSLATION</title> - <para> - Translation is considered a kind of modification, so you may - distribute translations of the <link - linkend="fdl-document">Document</link> under the terms of <link - linkend="fdl-section4">section 4</link>. Replacing <link - linkend="fdl-invariant"> Invariant Sections</link> with - translations requires special permission from their copyright - holders, but you may include translations of some or all - Invariant Sections in addition to the original versions of these - Invariant Sections. You may include a translation of this - License provided that you also include the original English - version of this License. In case of a disagreement between the - translation and the original English version of this License, - the original English version will prevail. - </para> - </sect1> - - <sect1 id="fdl-section9"> - <title>9. TERMINATION</title> - <para> - You may not copy, modify, sublicense, or distribute the <link - linkend="fdl-document">Document</link> except as expressly - provided for under this License. Any other attempt to copy, - modify, sublicense or distribute the Document is void, and will - automatically terminate your rights under this License. However, - parties who have received copies, or rights, from you under this - License will not have their licenses terminated so long as such - parties remain in full compliance. - </para> - </sect1> - - <sect1 id="fdl-section10"> - <title>10. FUTURE REVISIONS OF THIS LICENSE</title> - <para> - The <ulink type="http" - url="http://www.gnu.org/fsf/fsf.html">Free Software - Foundation</ulink> may publish new, revised versions of the GNU - Free Documentation License from time to time. Such new versions - will be similar in spirit to the present version, but may differ - in detail to address new problems or concerns. See <ulink - type="http" - url="http://www.gnu.org/copyleft">http://www.gnu.org/copyleft/</ulink>. - </para> - - <para> - Each version of the License is given a distinguishing version - number. If the <link linkend="fdl-document">Document</link> - specifies that a particular numbered version of this License - <quote>or any later version</quote> applies to it, you have the - option of following the terms and conditions either of that - specified version or of any later version that has been - published (not as a draft) by the Free Software Foundation. If - the Document does not specify a version number of this License, - you may choose any version ever published (not as a draft) by - the Free Software Foundation. - </para> - </sect1> - - <sect1 id="fdl-using"> - <title>Addendum</title> - <para> - To use this License in a document you have written, include a copy of - the License in the document and put the following copyright and - license notices just after the title page: - </para> - - <blockquote> - <para> - Copyright © YEAR YOUR NAME. - </para> - <para> - Permission is granted to copy, distribute and/or modify this - document under the terms of the GNU Free Documentation - License, Version 1.1 or any later version published by the - Free Software Foundation; with the <link - linkend="fdl-invariant">Invariant Sections</link> being LIST - THEIR TITLES, with the <link - linkend="fdl-cover-texts">Front-Cover Texts</link> being LIST, - and with the <link linkend="fdl-cover-texts">Back-Cover - Texts</link> being LIST. A copy of the license is included in - the section entitled <quote>GNU Free Documentation - License</quote>. - </para> - </blockquote> - - <para> - If you have no <link linkend="fdl-invariant">Invariant - Sections</link>, write <quote>with no Invariant Sections</quote> - instead of saying which ones are invariant. If you have no - <link linkend="fdl-cover-texts">Front-Cover Texts</link>, write - <quote>no Front-Cover Texts</quote> instead of - <quote>Front-Cover Texts being LIST</quote>; likewise for <link - linkend="fdl-cover-texts">Back-Cover Texts</link>. - </para> - - <para> - If your document contains nontrivial examples of program code, - we recommend releasing these examples in parallel under your - choice of free software license, such as the <ulink type="http" - url="http://www.gnu.org/copyleft/gpl.html"> GNU General Public - License</ulink>, to permit their use in free software. - </para> - </sect1> -</appendix> - - - - - - diff --git a/doc/devel/importer/.cvsignore b/doc/devel/importer/.cvsignore deleted file mode 100644 index 439d6641ff..0000000000 --- a/doc/devel/importer/.cvsignore +++ /dev/null @@ -1,10 +0,0 @@ -sgml -Makefile -Makefile.in -*-decl.txt -*-decl-list.txt -*-unused.txt -*.hierarchy -*.signals -*.stamp -*-scan.c diff --git a/doc/devel/importer/Makefile.am b/doc/devel/importer/Makefile.am deleted file mode 100644 index 8b5343677a..0000000000 --- a/doc/devel/importer/Makefile.am +++ /dev/null @@ -1,195 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# The name of the module, e.g. 'glib'. -DOC_MODULE=evolution-shell-importer - -# 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)/shell/importer - -# 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)/shell/importer/evolution-importer.h \ - $(top_srcdir)/shell/importer/evolution-importer-client.h - -CFILE_GLOB= \ - $(top_srcdir)/shell/importer/evolution-importer.c \ - $(top_srcdir)/shell/importer/evolution-importer-client.c - -# Header files to ignore when scanning. -IGNORE_HFILES= \ - GNOME_Evolution_Importer.h \ - importer.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)/shell/importer \ - -I$(top_srcdir)/shell \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - $(BONOBO_VFS_GNOME_CFLAGS) - -GTKDOC_LIBS = \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/shell/importer/.libs/libevolution-importer.so - -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 = - -########################################################################### -# 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/doc/devel/importer/evolution-shell-importer-sections.txt b/doc/devel/importer/evolution-shell-importer-sections.txt deleted file mode 100644 index e2474f6375..0000000000 --- a/doc/devel/importer/evolution-shell-importer-sections.txt +++ /dev/null @@ -1,79 +0,0 @@ -<INCLUDE>evolution-importer.h</INCLUDE> - -<SECTION> -<FILE>evolution-importer</FILE> -EVOLUTION_IMPORTER -<TITLE>EvolutionImporter</TITLE> - -EvolutionImporterSupportFormatFn -EvolutionImporterLoadFileFn -EvolutionImporterProcessItemFn -EvolutionImporterGetErrorFn - -EvolutionImporterResult - -evolution_importer_new - -<SUBSECTION Standard> -EVOLUTION_TYPE_IMPORTER -EVOLUTION_IMPORTER -EVOLUTION_IS_IMPORTER -EVOLUTION_IMPORTER_CLASS -EVOLUTION_IS_IMPORTER_CLASS -evolution_importer_get_type - -<SUBSECTION Private> -EvolutionImporter -EvolutionImporterPrivate - -</SECTION> - -<INCLUDE>evolution-importer-listener.h</INCLUDE> -<SECTION> -<FILE>evolution-importer-listener</FILE> -EVOLUTION_IMPORTER_LISTENER -<TITLE>EvolutionImporterListener</TITLE> - -EvolutionImporterListenerCallback - -evolution_importer_listener_new - -<SUBSECTION Standard> -EVOLUTION_TYPE_IMPORTER_LISTENER -EVOLUTION_IMPORTER_LISTENER -EVOLUTION_IMPORTER_LISTENER_CLASS -EVOLUTION_IS_IMPORTER_LISTENER -EVOLUTION_IS_IMPORTER_LISTENER_CLASS -evolution_importer_listener_get_type - -<SUBSECTION Private> -EvolutionImporterListener -EvolutionImporterListenerPrivate - -</SECTION> - -<INCLUDE>evolution-importer-client.h</INCLUDE> -<SECTION> -<FILE>evolution-importer-client</FILE> -EVOLUTION_IMPORTER_CLIENT -<TITLE>EvolutionImporterClient</TITLE> - -evolution_importer_client_new -evolution_importer_client_new_from_id -evolution_importer_client_support_format -evolution_importer_client_load_file -evolution_importer_client_process_item -evolution_importer_client_get_error - -<SUBSECTION Standard> -EVOLUTION_TYPE_IMPORTER_CLIENT -EVOLUTION_IMPORTER_CLIENT -EVOLUTION_IMPORTER_CLIENT_CLASS -EVOLUTION_IS_IMPORTER_CLIENT -EVOLUTION_IS_IMPORTER_CLIENT_CLASS -evolution_importer_client_get_type - -<SUBSECTION Private> -EvolutionImporterClient - -</SECTION> diff --git a/doc/devel/importer/evolution-shell-importer.args b/doc/devel/importer/evolution-shell-importer.args deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/importer/evolution-shell-importer.args +++ /dev/null diff --git a/doc/devel/importer/evolution-shell-importer.hierarchy b/doc/devel/importer/evolution-shell-importer.hierarchy deleted file mode 100644 index c46ebdf782..0000000000 --- a/doc/devel/importer/evolution-shell-importer.hierarchy +++ /dev/null @@ -1,7 +0,0 @@ -GtkObject - BonoboObject - BonoboXObject - EvolutionImporter - EvolutionImporterListener - Handle to remote Bonobo::Unknown - EvolutionImporterClient diff --git a/doc/devel/importer/evolution-shell-importer.types b/doc/devel/importer/evolution-shell-importer.types deleted file mode 100644 index e787818599..0000000000 --- a/doc/devel/importer/evolution-shell-importer.types +++ /dev/null @@ -1,9 +0,0 @@ -#include <gnome.h> -#include <bonobo.h> -#include <shell/importer/evolution-importer.h> -#include <shell/importer/evolution-importer-client.h> -#include <shell/importer/evolution-importer-listener.h> - -evolution_importer_get_type -evolution_importer_client_get_type -evolution_importer_listener_get_type diff --git a/doc/devel/importer/private-reference.sgml b/doc/devel/importer/private-reference.sgml deleted file mode 100644 index d28c7b8591..0000000000 --- a/doc/devel/importer/private-reference.sgml +++ /dev/null @@ -1,21 +0,0 @@ - <reference id="importer-private-reference"> - <title>Importer Private API Reference</title> - - <partintro> - <para> - This part presents the class and function reference for the - private APIs of the different components of the &Evolution; - Import Framework. - </para> - </partintro> - - &EvolutionImporterListener; - &EvolutionImporterClient; - </reference> - -<!-- -Local variables: -mode: sgml -sml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/importer/public-reference.sgml b/doc/devel/importer/public-reference.sgml deleted file mode 100644 index ba99c9b309..0000000000 --- a/doc/devel/importer/public-reference.sgml +++ /dev/null @@ -1,20 +0,0 @@ - <reference id="importer-public-reference"> - <title>Importer Public API Reference</title> - - <partintro> - <para> - This part presents the class and function reference for the - public APIs of the different components of the &Evolution; - Import Framework. - </para> - </partintro> - - &EvolutionImporter; - </reference> - -<!-- -Local variables: -mode: sgml -sml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/importer/tmpl/evolution-importer-client.sgml b/doc/devel/importer/tmpl/evolution-importer-client.sgml deleted file mode 100644 index 6cee37bef1..0000000000 --- a/doc/devel/importer/tmpl/evolution-importer-client.sgml +++ /dev/null @@ -1,84 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EvolutionImporterClient - -<!-- ##### SECTION Short_Description ##### --> -A #GtkObject based client to simplify use of a GNOME_Evolution_Importer object. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This #GtkObject provides a convience wrapper to the GNOME_Evolution_Importer object, providing error checking and hiding all the CORBA internals from the user. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO EVOLUTION_IMPORTER_CLIENT ##### --> -<para> -Casts a #GtkObject into an #EvolutionImporterClient -</para> - -@obj: A #GtkObject - - -<!-- ##### FUNCTION evolution_importer_client_new ##### --> -<para> - -</para> - -@objref: -@Returns: - - -<!-- ##### FUNCTION evolution_importer_client_new_from_id ##### --> -<para> - -</para> - -@id: -@Returns: - - -<!-- ##### FUNCTION evolution_importer_client_support_format ##### --> -<para> - -</para> - -@client: -@filename: -@Returns: - - -<!-- ##### FUNCTION evolution_importer_client_load_file ##### --> -<para> - -</para> - -@client: -@filename: -@folderpath: -@Returns: - - -<!-- ##### FUNCTION evolution_importer_client_process_item ##### --> -<para> - -</para> - -@client: -@listener: -<!-- # Unused Parameters # --> -@callback: -@closure: - - -<!-- ##### FUNCTION evolution_importer_client_get_error ##### --> -<para> - -</para> - -@client: -@Returns: - - diff --git a/doc/devel/importer/tmpl/evolution-importer.sgml b/doc/devel/importer/tmpl/evolution-importer.sgml deleted file mode 100644 index 1c7736a37f..0000000000 --- a/doc/devel/importer/tmpl/evolution-importer.sgml +++ /dev/null @@ -1,96 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EvolutionImporter - -<!-- ##### SECTION Short_Description ##### --> -A #BonoboObject that implements the GNOME/Evolution/Importer interface. - -<!-- ##### SECTION Long_Description ##### --> -<para> -A #BonoboObject wrapper around the GNOME/Evolution/Importer interface, providing error checking and reference counting, hiding the CORBA internals from the user and providing a simple way to create a GNOME_Evolution_Importer object. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO EVOLUTION_IMPORTER ##### --> -<para> -Casts a #GtkObject into an #EvolutionImporter. -</para> - -@obj: A #GtkObject. - - -<!-- ##### USER_FUNCTION EvolutionImporterSupportFormatFn ##### --> -<para> -The type of function that is called when the importer wishes to find out if the importing component can support the file given in @filename. -</para> - -@importer: The #EvolutionImporter. -@filename: The filename of the file to check. -@closure: The data passed into evolution_importer_new (). -@Returns: A #gboolean. TRUE if the importing component can import the file, FALSE otherwise. - - -<!-- ##### USER_FUNCTION EvolutionImporterLoadFileFn ##### --> -<para> -The type of function that is called when the importer wishes the importing component to load the file given in @filename, and initialise itself. -</para> - -@importer: The #EvolutionImporter. -@filename: The filename of the file to load. -@folderpath: -@closure: The data passed into evolution_importer_new (). -@Returns: A #gboolean. TRUE if the load and initialisation was successful, FALSE otherwise. - - -<!-- ##### USER_FUNCTION EvolutionImporterProcessItemFn ##### --> -<para> -The type of function that is called when the importer wants the importing component to process the next item (or items) in a file. -</para> - -@importer: The #EvolutionImporter -@listener: A GNOME_Evolution_Importer_Listener CORBA object. -@closure: The data passed into evolution_importer_new (). -@ev: A #CORBA_Environment for returning any CORBA exceptions. - - -<!-- ##### USER_FUNCTION EvolutionImporterGetErrorFn ##### --> -<para> -The type of function that is called when the importer wants to get a string version of an error. Not all importing components support this function. -</para> - -@importer: The #EvolutionImporter. -@closure: The data passed to evolution_importer_new (). -@Returns: A string representation of the error, or NULL if there was no error, or the importing component does not support the getError method. - - -<!-- ##### ENUM EvolutionImporterResult ##### --> -<para> - -</para> - -@EVOLUTION_IMPORTER_OK: -@EVOLUTION_IMPORTER_UNSUPPORTED_OPERATION: -@EVOLUTION_IMPORTER_INTERRUPTED: -@EVOLUTION_IMPORTER_BUSY: -@EVOLUTION_IMPORTER_NOT_READY: -@EVOLUTION_IMPORTER_UNKNOWN_DATA: -@EVOLUTION_IMPORTER_BAD_DATA: -@EVOLUTION_IMPORTER_BAD_FILE: -@EVOLUTION_IMPORTER_UNKNOWN_ERROR: - -<!-- ##### FUNCTION evolution_importer_new ##### --> -<para> - -</para> - -@support_format_fn: -@load_file_fn: -@process_item_fn: -@get_error_fn: -@closure: -@Returns: - - diff --git a/doc/devel/importer/tmpl/evolution-shell-importer-unused.sgml b/doc/devel/importer/tmpl/evolution-shell-importer-unused.sgml deleted file mode 100644 index 7a9a98034b..0000000000 --- a/doc/devel/importer/tmpl/evolution-shell-importer-unused.sgml +++ /dev/null @@ -1,10 +0,0 @@ -<!-- ##### USER_FUNCTION EvolutionImporterClientCallback ##### --> -<para> - -</para> - -@client: -@result: -@more_items: -@data: - diff --git a/doc/devel/preface.sgml b/doc/devel/preface.sgml deleted file mode 100644 index fdaa824a8b..0000000000 --- a/doc/devel/preface.sgml +++ /dev/null @@ -1,113 +0,0 @@ - <preface id="introduction"> - <title>Introduction</title> - - <para> - This is the &Evolution; Developer's Guide or programming guide - for the &Evolution; groupware suite. If you are a programmer - and you wish to use &Evolution;'s functionality from your own - applications or if you wish to modify the &Evolution; core code, - you should read this guide. - </para> - - <para> - If you are an end-user of &Evolution; you do not need to read - this guide; please read the &Evolution; User's Guide instead. - </para> - - <para> - This guide contains the information you need to know to do the - following: - - <itemizedlist> - <listitem> - <para> - Write applications that use &Evolution;'s data - repositories via the &Wombat; personal information server. - Examples of this would be a <application>GNOME - Panel</application> applet that displays today's - appointments, or a telephone dialer application that uses - the contents of the &Evolution; Addressbook. - </para> - </listitem> - - <listitem> - <para> - Write applications that use the &Camel; mail library. - This includes extending &Evolution;'s own mail component - to perform additional functions. - </para> - </listitem> - - <listitem> - <para> - Write new components for the &Evolution; Shell. Instead - of writing a stand-alone application, you can provide your - users with the benefit of having integrated views of their - data from within Evolution. - </para> - </listitem> - - <listitem> - <para> - Write new modules for the &Evolution; Executive Summary. - This allows you to present commonly-accessed information - in a convenient fashion directly in the &Evolution; Shell. - </para> - </listitem> - - <listitem> - <para> - Modify the core &Evolution; code to add new features or - change its architecture. - </para> - </listitem> - </itemizedlist> - </para> - - <sect1 id="organization"> - <title>Organization of this Guide</title> - - <para> - This guide is organized in two big sections. The first is a - programming guide, which consists of one part for each one of - &Evolution;'s components: there are separate parts for the - calendar, the addressbook, the mailer, the executive summary, - and the shell. Each part gives a description of the - architecture of its corresponding component, and also gives - information about the component's internal architecture and - some implementation details. - </para> - - <para> - The second section of this guide is a reference guide for - &Evolution;'s programming interfaces. We have separated these - into public and private interfaces. The public ones are those - that most people will need to use when writing extensions or - third-party components; the private interfaces are those used - internally in &Evolution;. Even if you do not intend to - modify the &Evolution; core code, it may be useful to know a - bit about the way it is organized internally. - </para> - - <para> - &Evolution; is free software, and we want you as a programmer - to make the most of it. We have provided many useful - interfaces that you can use in your own applications. Still, - we want you to view &Evolution; as a framework for building - groupware applications, and this may occasionally involve - making changes to its core code. We want you to learn from - &Evolution;'s design because we think it marks an important - milestone in the development of large-scale free software - applications. We want you to modify it as you see fit. Free - software gives you this freedom, and we want the whole world - to benefit from it. - </para> - </sect1> - </preface> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("evolution-devel-guide.sgml" "book" "book" "") -End: ---> diff --git a/doc/devel/reference.sgml b/doc/devel/reference.sgml deleted file mode 100644 index 4381ad29b7..0000000000 --- a/doc/devel/reference.sgml +++ /dev/null @@ -1,49 +0,0 @@ - <part id="evolution-api-reference"> - <title>&Evolution; API Reference</title> - - <partintro> - <para> - 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. - </para> - - <para> - &Evolution; provides two kinds of interfaces, public and - private. The public interfaces are those designed to be used - from third-party applications or components; if you wanted to - write an application that uses &Evolution;'s data repositories - to display data in a particular way, you would use the public - interfaces. The private interfaces are those used inside - &Evolution; itself; these are generally not interesting unless - you intend to make modifications to the &Evolution; code base. - </para> - - <para> - While the public and private interfaces are described in - separate reference sections, we have decided to put them - together in the same book, this guide, because we want to - encourage you to regard &Evolution; as something more than a - black box that stores and dispatches personal information. We - want you to make modifications to the &Evolution; core if - these would allow you to present or store your data in better - ways. &Evolution; is free software; we want you to learn from - its design and implementation details so that you can make it - even better for the whole world to use. - </para> - </partintro> - - &calendar-public-reference; - <!-- &importer-public-reference; --> - <!-- &evolution-services-public-reference; --> - <!-- &importer-private-reference; --> - <!-- &evolution-services-private-reference; --> - </part> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("evolution-devel-guide.sgml" "book" "book" "") -End: ---> |