From 4cf1f4c583263a33234708e5973388c688c7f96d Mon Sep 17 00:00:00 2001 From: Aaron Weber Date: Thu, 16 Aug 2001 17:48:38 +0000 Subject: Removing these files which belong in the doc dir, not the help dir. svn path=/trunk/; revision=12102 --- help/devel/ChangeLog | 251 ------ help/devel/Makefile.am | 178 ---- help/devel/calendar/Makefile.am | 7 - help/devel/calendar/alarm-generation.sgml | 139 --- help/devel/calendar/architecture.sgml | 162 ---- help/devel/calendar/cal-client/Makefile.am | 195 ---- .../cal-client/evolution-cal-client-decl.txt | 339 ------- .../cal-client/evolution-cal-client-docs.sgml | 15 - .../cal-client/evolution-cal-client-sections.txt | 69 -- .../calendar/cal-client/evolution-cal-client.args | 0 .../cal-client/evolution-cal-client.hierarchy | 2 - .../calendar/cal-client/evolution-cal-client.types | 4 - .../devel/calendar/cal-client/tmpl/cal-client.sgml | 329 ------- .../tmpl/evolution-cal-client-unused.sgml | 84 -- help/devel/calendar/cal-util/Makefile.am | 196 ---- .../calendar/cal-util/evolution-cal-util-decl.txt | 985 -------------------- .../calendar/cal-util/evolution-cal-util-docs.sgml | 19 - .../cal-util/evolution-cal-util-sections.txt | 161 ---- .../calendar/cal-util/evolution-cal-util.args | 0 .../calendar/cal-util/evolution-cal-util.hierarchy | 2 - .../calendar/cal-util/evolution-cal-util.signals | 0 .../calendar/cal-util/evolution-cal-util.types | 4 - .../calendar/cal-util/tmpl/cal-component.sgml | 993 --------------------- help/devel/calendar/cal-util/tmpl/cal-recur.sgml | 44 - help/devel/calendar/cal-util/tmpl/cal-util.sgml | 48 - .../cal-util/tmpl/evolution-cal-util-unused.sgml | 288 ------ help/devel/calendar/cal-util/tmpl/timeutil.sgml | 111 --- help/devel/calendar/evolution-calendar.sgml | 52 -- help/devel/calendar/public-reference.sgml | 24 - help/devel/evolution-devel-guide.sgml | 98 -- help/devel/fdl.sgml | 671 -------------- help/devel/preface.sgml | 113 --- help/devel/reference.sgml | 49 - 33 files changed, 5632 deletions(-) delete mode 100644 help/devel/ChangeLog delete mode 100644 help/devel/Makefile.am delete mode 100644 help/devel/calendar/Makefile.am delete mode 100644 help/devel/calendar/alarm-generation.sgml delete mode 100644 help/devel/calendar/architecture.sgml delete mode 100644 help/devel/calendar/cal-client/Makefile.am delete mode 100644 help/devel/calendar/cal-client/evolution-cal-client-decl.txt delete mode 100644 help/devel/calendar/cal-client/evolution-cal-client-docs.sgml delete mode 100644 help/devel/calendar/cal-client/evolution-cal-client-sections.txt delete mode 100644 help/devel/calendar/cal-client/evolution-cal-client.args delete mode 100644 help/devel/calendar/cal-client/evolution-cal-client.hierarchy delete mode 100644 help/devel/calendar/cal-client/evolution-cal-client.types delete mode 100644 help/devel/calendar/cal-client/tmpl/cal-client.sgml delete mode 100644 help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml delete mode 100644 help/devel/calendar/cal-util/Makefile.am delete mode 100644 help/devel/calendar/cal-util/evolution-cal-util-decl.txt delete mode 100644 help/devel/calendar/cal-util/evolution-cal-util-docs.sgml delete mode 100644 help/devel/calendar/cal-util/evolution-cal-util-sections.txt delete mode 100644 help/devel/calendar/cal-util/evolution-cal-util.args delete mode 100644 help/devel/calendar/cal-util/evolution-cal-util.hierarchy delete mode 100644 help/devel/calendar/cal-util/evolution-cal-util.signals delete mode 100644 help/devel/calendar/cal-util/evolution-cal-util.types delete mode 100644 help/devel/calendar/cal-util/tmpl/cal-component.sgml delete mode 100644 help/devel/calendar/cal-util/tmpl/cal-recur.sgml delete mode 100644 help/devel/calendar/cal-util/tmpl/cal-util.sgml delete mode 100644 help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml delete mode 100644 help/devel/calendar/cal-util/tmpl/timeutil.sgml delete mode 100644 help/devel/calendar/evolution-calendar.sgml delete mode 100644 help/devel/calendar/public-reference.sgml delete mode 100644 help/devel/evolution-devel-guide.sgml delete mode 100644 help/devel/fdl.sgml delete mode 100644 help/devel/preface.sgml delete mode 100644 help/devel/reference.sgml (limited to 'help/devel') diff --git a/help/devel/ChangeLog b/help/devel/ChangeLog deleted file mode 100644 index 265dac5ce7..0000000000 --- a/help/devel/ChangeLog +++ /dev/null @@ -1,251 +0,0 @@ -2001-07-31 Ettore Perazzoli - - * 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 - - * Makefile.am: ... and comment out more exec summary stuff. - - * reference.sgml: Here too. - -2001-06-25 Peter Williams - - * calendar/cal-util/Makefile.am, - calendar/cal-client/Makefile.am: Fix make dist. - - * Makefile.am: clean up a bit. - -2001-06-21 JP Rosevear - - * Makefile.am: disable executive summary build because it is no - longer built - -2001-06-21 JP Rosevear - - * calendar/cal-client/Makefile.am: add new lib - -2001-06-21 Peter Williams - - * 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 - - * executive-summary/.cvsignore: - * calendar/cal-util/.cvsignore: - * calendar/cal-client/.cvsignore: added *-undocumented.txt - -2001-05-24 Federico Mena Quintero - - * evolution-devel-guide.sgml: s/Helix Code/Ximian - -2001-05-15 Jeffrey Stedfast - - * 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 - - * Removed generated files from CVS, updated .cvsignore files - to include generated files. - -2001-04-23 Ettore Perazzoli - - * 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 - - * evolution-devel-guide.sgml: Disable the importer references here - too. - - * Makefile.am: Remove the importer stuff for now. - -2001-04-20 Damon Chaplin - - * 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 - - * 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 - - * importer/Makefile.am: Change (nonexistant) importer.sgml - references to evolution-importer.sgml to fix dependency problem. - -2001-01-17 Iain Holmes - - * 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 - - * 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 - - * 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 - - 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 - - * 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 - - * calendar/Makefile.am (EXTRA_DIST): make it public-reference.sgml - not referenc.sgml here. - -2000-11-29 Federico Mena Quintero - - * calendar/architecture.sgml: Finished the calendar architecture - chapter. - -2000-11-29 Federico Mena Quintero - - * evolution-devel-guide.sgml: Added an id for the API reference . - Added the FDL . - 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 . - - * calendar/public-reference.sgml: Added an id for the . - 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 - - * evolution-devel-guide.sgml: Made the toplevel id be - "index". - -2000-08-14 Federico Mena Quintero - - * 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 - - * Makefile.am (maintainer-clean-local): Don't depend - on 'clean'; this messes up maintainer-clean. - -2000-07-17 Federico Mena Quintero - - * calendar/cal-client/tmpl/cal-client.sgml: Populated. - - * evolution-devel-guide.sgml: New toplevel for the - Evolution Developer's Guide. - - * calendar/evolution-calendar.sgml: New for the calendar - developer's documentation. - - * calendar/architecture.sgml: New for the calendar - architecture. - - * calendar/reference.sgml: New for the calendar API - reference. diff --git a/help/devel/Makefile.am b/help/devel/Makefile.am deleted file mode 100644 index f8597eccf1..0000000000 --- a/help/devel/Makefile.am +++ /dev/null @@ -1,178 +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 - -########################################################################### -# 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) - -# $(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/help/devel/calendar/Makefile.am b/help/devel/calendar/Makefile.am deleted file mode 100644 index 028622bd82..0000000000 --- a/help/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/help/devel/calendar/alarm-generation.sgml b/help/devel/calendar/alarm-generation.sgml deleted file mode 100644 index 77d35258da..0000000000 --- a/help/devel/calendar/alarm-generation.sgml +++ /dev/null @@ -1,139 +0,0 @@ - - How the Wombat generates alarm instances - - - 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. - - - - What makes up an alarm trigger - - - 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. - - - - 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. - - - - - Generating trigger instances - - - 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. - - - - 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. - - - - 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. - - - - 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. - - - - 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 - end 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 - start of the time range in an analogous - way, by subtracting the time offset from it. - - - - 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. - - - - - Alarm trigger generation code - - - The main function to generate alarm trigger instances is - generate_alarms_for_comp() in - evolution/calendar/pcs/cal-backend-file.c. - This function calls compute_alarm_range() - 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 - add_alarm_occurrences_cb() callback, - which is used by - cal_recur_generate_instances() 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 CalAlarmInstance structures - to the final list of trigger instances. Finally, - generate_alarms_for_comp() calls - generate_absolute_triggers(), 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. - - - - - diff --git a/help/devel/calendar/architecture.sgml b/help/devel/calendar/architecture.sgml deleted file mode 100644 index d261f0a7f4..0000000000 --- a/help/devel/calendar/architecture.sgml +++ /dev/null @@ -1,162 +0,0 @@ - - Architecture of the Calendar - - - This chapter gives an overview of the &Evolution; Calendar - architecture. It describes the model/view split of the calendar - into a personal calendar server, or &PCS;, and the GUI clients - that appear inside the &Evolution; Shell. - - - - - - Model/View Separation - - - 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 gnome-pilot 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. - - - - &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. - - - - - - - Personal Calendar Server - - - 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: - - - - Storage - - - 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. - - - - - Basic Queries - - - 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. - - - - - Recurrence and Alarm Queries - - - 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. - - - - - Modification Log - - - 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. - - - - - - - - Data Views - - - &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. - - - - 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. - - - - - - - Non-graphical Clients - - - 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 gpilotd daemon - from the gnome-pilot package - detects that the HotSync button has been pressed on a Palm - Pilot device. - - - - 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. - - - - - diff --git a/help/devel/calendar/cal-client/Makefile.am b/help/devel/calendar/cal-client/Makefile.am deleted file mode 100644 index 7452ba35b5..0000000000 --- a/help/devel/calendar/cal-client/Makefile.am +++ /dev/null @@ -1,195 +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 \ - $(BONOBO_VFS_GNOME_CFLAGS) - -GTKDOC_LIBS= \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/calendar/cal-client/.libs/libcal-client-static.al\ - $(top_builddir)/calendar/cal-util/.libs/libcal-util-static.al \ - $(top_builddir)/libical/src/libical/.libs/libical-static.al \ - $(top_builddir)/libversit/.libs/libversit.al \ - $(top_builddir)/libwombat/libwombat.la - -GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in this file -# and uncomment this line. -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt -DOC_OVERRIDES = - -#DOC_DIR=$(datadir)/gnome/html - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_MODULE)-sections.txt \ - $(DOC_OVERRIDES) - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals - -if ENABLE_GTK_DOC -#all-local: html-build.stamp -all-local: sgml-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building SGML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -install-data-local: - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo $(srcdir)/html/*.html`; \ - if test "$$installfiles" = '$(srcdir)/html/*.html'; \ - then echo '-- Nothing to install' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/sgml - 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/help/devel/calendar/cal-client/evolution-cal-client-decl.txt b/help/devel/calendar/cal-client/evolution-cal-client-decl.txt deleted file mode 100644 index 5511d9fb74..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ /dev/null @@ -1,339 +0,0 @@ - -CalClientChangeType -typedef enum { - CAL_CLIENT_CHANGE_ADDED = 1 << 0, - CAL_CLIENT_CHANGE_MODIFIED = 1 << 1, - CAL_CLIENT_CHANGE_DELETED = 1 << 2 -} CalClientChangeType; - - -cal_client_change_list_free -void -GList *list - - -CAL_CLIENT_TYPE -#define CAL_CLIENT_TYPE (cal_client_get_type ()) - - -CAL_CLIENT -#define CAL_CLIENT(obj) (GTK_CHECK_CAST ((obj), CAL_CLIENT_TYPE, CalClient)) - - -CAL_CLIENT_CLASS -#define CAL_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_CLIENT_TYPE, CalClientClass)) - - -IS_CAL_CLIENT -#define IS_CAL_CLIENT(obj) (GTK_CHECK_TYPE ((obj), CAL_CLIENT_TYPE)) - - -IS_CAL_CLIENT_CLASS -#define IS_CAL_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_CLIENT_TYPE)) - - -CalClient - - -CalClientClass - - -CalClientPrivate - - -CalClientOpenStatus -typedef enum { - CAL_CLIENT_OPEN_SUCCESS, - CAL_CLIENT_OPEN_ERROR, - CAL_CLIENT_OPEN_NOT_FOUND, - CAL_CLIENT_OPEN_METHOD_NOT_SUPPORTED -} CalClientOpenStatus; - - -CalClientGetStatus -typedef enum { - CAL_CLIENT_GET_SUCCESS, - CAL_CLIENT_GET_NOT_FOUND, - CAL_CLIENT_GET_SYNTAX_ERROR -} CalClientGetStatus; - - -CalClientLoadState -typedef enum { - CAL_CLIENT_LOAD_NOT_LOADED, - CAL_CLIENT_LOAD_LOADING, - CAL_CLIENT_LOAD_LOADED -} CalClientLoadState; - - -CalClient -struct CalClient { - GtkObject object; - - /* Private data */ - CalClientPrivate *priv; -}; - - -CalClientAuthFunc -gchar * -CalClient *client, - const gchar *prompt, - const gchar *key, - gpointer user_data - - -cal_client_get_type -GtkType -void - - -cal_client_construct -CalClient * -CalClient *client - - -cal_client_new -CalClient * -void - - -cal_client_set_auth_func -void -CalClient *client, CalClientAuthFunc func, gpointer data - - -cal_client_open_calendar -gboolean -CalClient *client, const char *str_uri, gboolean only_if_exists - - -cal_client_get_load_state -CalClientLoadState -CalClient *client - - -cal_client_get_uri -const char * -CalClient *client - - -cal_client_get_n_objects -int -CalClient *client, CalObjType type - - -cal_client_get_object -CalClientGetStatus -CalClient *client,const char *uid,CalComponent **comp - - -cal_client_get_timezone -CalClientGetStatus -CalClient *client,const char *tzid,icaltimezone **zone - - -cal_client_get_uids -GList * -CalClient *client, CalObjType type - - -cal_client_get_changes -GList * -CalClient *client, CalObjType type, const char *change_id - - -cal_client_get_objects_in_range -GList * -CalClient *client, CalObjType type,time_t start, time_t end - - -cal_client_get_free_busy -CalClientGetStatus -CalClient *client, time_t start, time_t end,CalComponent **comp - - -cal_client_generate_instances -void -CalClient *client, CalObjType type,time_t start, time_t end,CalRecurInstanceFn cb, gpointer cb_data - - -cal_client_get_alarms_in_range -GSList * -CalClient *client, time_t start, time_t end - - -cal_client_free_alarms -void -GSList *comp_alarms - - -cal_client_get_alarms_for_object -gboolean -CalClient *client, const char *uid,time_t start, time_t end,CalComponentAlarms **alarms - - -cal_client_update_object -gboolean -CalClient *client, CalComponent *comp - - -cal_client_update_objects -gboolean -CalClient *client, icalcomponent *icalcomp - - -cal_client_remove_object -gboolean -CalClient *client, const char *uid - - -cal_client_get_query -CalQuery * -CalClient *client, const char *sexp - - -cal_client_resolve_tzid_cb -icaltimezone * -const char *tzid, gpointer data - - -CAL_QUERY_TYPE -#define CAL_QUERY_TYPE (cal_query_get_type ()) - - -CAL_QUERY -#define CAL_QUERY(obj) (GTK_CHECK_CAST ((obj), CAL_QUERY_TYPE, CalQuery)) - - -CAL_QUERY_CLASS -#define CAL_QUERY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_QUERY_TYPE, CalQueryClass)) - - -IS_CAL_QUERY -#define IS_CAL_QUERY(obj) (GTK_CHECK_TYPE ((obj), CAL_QUERY_TYPE)) - - -IS_CAL_QUERY_CLASS -#define IS_CAL_QUERY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_QUERY_TYPE)) - - -CalQueryDoneStatus -typedef enum { - CAL_QUERY_DONE_SUCCESS, - CAL_QUERY_DONE_PARSE_ERROR -} CalQueryDoneStatus; - - -CalQueryPrivate - - -CalQuery -typedef struct { - GtkObject object; - - /* Private data */ - CalQueryPrivate *priv; -} CalQuery; - - -cal_query_get_type -GtkType -void - - -cal_query_construct -CalQuery * -CalQuery *query,GNOME_Evolution_Calendar_Cal cal,const char *sexp - - -cal_query_new -CalQuery * -GNOME_Evolution_Calendar_Cal cal,const char *sexp - - -QUERY_LISTENER_TYPE -#define QUERY_LISTENER_TYPE (query_listener_get_type ()) - - -QUERY_LISTENER -#define QUERY_LISTENER(obj) (GTK_CHECK_CAST ((obj), QUERY_LISTENER_TYPE, QueryListener)) - - -QUERY_LISTENER_CLASS -#define QUERY_LISTENER_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), QUERY_LISTENER_TYPE, \ - QueryListenerClass)) - - -IS_QUERY_LISTENER -#define IS_QUERY_LISTENER(obj) (GTK_CHECK_TYPE ((obj), QUERY_LISTENER_TYPE)) - - -IS_QUERY_LISTENER_CLASS -#define IS_QUERY_LISTENER_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), QUERY_LISTENER_TYPE)) - - -QueryListenerPrivate - - -QueryListener -typedef struct { - BonoboXObject xobject; - - /* Private data */ - QueryListenerPrivate *priv; -} QueryListener; - - -QueryListenerObjUpdatedFn -void -QueryListener *ql, - const GNOME_Evolution_Calendar_CalObjUID uid, - CORBA_boolean query_in_progress, - CORBA_long n_scanned, - CORBA_long total, - gpointer data - - -QueryListenerObjRemovedFn -void -QueryListener *ql, - const GNOME_Evolution_Calendar_CalObjUID uid, - gpointer data - - -QueryListenerQueryDoneFn -void - - QueryListener *ql, - GNOME_Evolution_Calendar_QueryListener_QueryDoneStatus status, - const CORBA_char *error_str, - gpointer data - - -QueryListenerEvalErrorFn -void -QueryListener *ql, - const CORBA_char *error_str, - gpointer data - - -query_listener_get_type -GtkType -void - - -query_listener_construct -QueryListener * -QueryListener *ql,QueryListenerObjUpdatedFn obj_updated_fn,QueryListenerObjRemovedFn obj_removed_fn,QueryListenerQueryDoneFn query_done_fn,QueryListenerEvalErrorFn eval_error_fn,gpointer fn_data - - -query_listener_new -QueryListener * -QueryListenerObjUpdatedFn obj_updated_fn,QueryListenerObjRemovedFn obj_removed_fn,QueryListenerQueryDoneFn query_done_fn,QueryListenerEvalErrorFn eval_error_fn,gpointer fn_data - - -query_listener_stop_notification -void -QueryListener *ql - diff --git a/help/devel/calendar/cal-client/evolution-cal-client-docs.sgml b/help/devel/calendar/cal-client/evolution-cal-client-docs.sgml deleted file mode 100644 index 136cf77e5c..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client-docs.sgml +++ /dev/null @@ -1,15 +0,0 @@ - - -]> - - - [Insert name here] Reference Manual - - - - [Insert title here] - &CalClient; - &evolution-cal-client-CalQuery; - - diff --git a/help/devel/calendar/cal-client/evolution-cal-client-sections.txt b/help/devel/calendar/cal-client/evolution-cal-client-sections.txt deleted file mode 100644 index 8e33be4933..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ /dev/null @@ -1,69 +0,0 @@ -cal-client/cal-client.h - -
-cal-client -CAL_CLIENT -CalClient - -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 - - - -CAL_CLIENT_TYPE -IS_CAL_CLIENT -CAL_CLIENT_CLASS -IS_CAL_CLIENT_CLASS -cal_client_get_type -cal_client_construct - - -CalClient -CalClientPrivate - -
- - -
-cal-query -CAL_QUERY -CalQuery - -CalQueryDoneStatus -cal_query_new - - - -CAL_QUERY_TYPE -IS_CAL_QUERY -CAL_QUERY_CLASS -IS_CAL_QUERY_CLASS -cal_query_get_type -cal_query_construct - - -CalQuery -CalQueryPrivate - -
diff --git a/help/devel/calendar/cal-client/evolution-cal-client.args b/help/devel/calendar/cal-client/evolution-cal-client.args deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/help/devel/calendar/cal-client/evolution-cal-client.hierarchy b/help/devel/calendar/cal-client/evolution-cal-client.hierarchy deleted file mode 100644 index 88efa3e673..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client.hierarchy +++ /dev/null @@ -1,2 +0,0 @@ -GtkObject - CalClient diff --git a/help/devel/calendar/cal-client/evolution-cal-client.types b/help/devel/calendar/cal-client/evolution-cal-client.types deleted file mode 100644 index 84d65a6637..0000000000 --- a/help/devel/calendar/cal-client/evolution-cal-client.types +++ /dev/null @@ -1,4 +0,0 @@ -#include -#include - -cal_client_get_type diff --git a/help/devel/calendar/cal-client/tmpl/cal-client.sgml b/help/devel/calendar/cal-client/tmpl/cal-client.sgml deleted file mode 100644 index dac080cca1..0000000000 --- a/help/devel/calendar/cal-client/tmpl/cal-client.sgml +++ /dev/null @@ -1,329 +0,0 @@ - -CalClient - - -GTK+ object for communication with personal calendar server. - - - - 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. - - - - 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 cal_loaded signal. - - - - 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 obj_updated and obj_removed signals on the - CalClient objects they create so that they can be notified about - changes in the storage. - - - - - #CalComponent - - - - - Casts a #GtkObject to a #CalClient. - - -@obj: A GTK+ object. - - - - - - - -@CAL_CLIENT_OPEN_SUCCESS: -@CAL_CLIENT_OPEN_ERROR: -@CAL_CLIENT_OPEN_NOT_FOUND: -@CAL_CLIENT_OPEN_METHOD_NOT_SUPPORTED: - - - - These values describe the result of the cal_client_get_object() - function. - - -@CAL_CLIENT_GET_SUCCESS: -@CAL_CLIENT_GET_NOT_FOUND: -@CAL_CLIENT_GET_SYNTAX_ERROR: - - - - - - -@CAL_CLIENT_LOAD_NOT_LOADED: -@CAL_CLIENT_LOAD_LOADING: -@CAL_CLIENT_LOAD_LOADED: - - - - - - -@CAL_CLIENT_CHANGE_ADDED: -@CAL_CLIENT_CHANGE_MODIFIED: -@CAL_CLIENT_CHANGE_DELETED: - - - - - - -@Returns: - - - - - - - -@client: -@str_uri: -@only_if_exists: -@Returns: - - - - - - - -@client: -@Returns: - - - - - - - -@client: -@Returns: - - - - - - - -@client: -@type: -@Returns: - - - - - - - -@client: -@type: -@Returns: - - - - - - - -@client: -@uid: -@comp: -@Returns: - -@ico: - - - - - - - -@client: -@type: -@change_id: -@Returns: - - - - - - - -@list: - - - - - - - -@client: -@type: -@start: -@end: -@Returns: - - - - - - - -@client: -@type: -@start: -@end: -@cb: -@cb_data: - - - - - - - -@client: -@start: -@end: -@Returns: - - - - - - - -@comp_alarms: - - - - - - - -@client: -@uid: -@start: -@end: -@alarms: -@Returns: - - - - - - - -@client: -@comp: -@Returns: - -@ico: - - - - - - - -@client: -@uid: -@Returns: - - - - - - - -@client: -@sexp: -@Returns: - - - - - - - -@calclient: the object which received the signal. -@arg1: - - - - 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. - - -@calclient: the object which received the signal. -@arg1: - -@client: Calendar client which received the notification. -@uid: Unique identifier of the calendar component that changed in the - personal calendar server's storage. - - - - 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. - - -@calclient: the object which received the signal. -@arg1: - -@client: Calendar client which received the notification. -@uid: Unique identifier of the calendar component that was removed - from the personal calendar server's storage. - - - - - - - - -@calclient: the object which received the signal. -@arg1: - - - - - - -@calclient: the object which received the signal. -@arg1: - diff --git a/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml deleted file mode 100644 index 3e8ce25ee6..0000000000 --- a/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ /dev/null @@ -1,84 +0,0 @@ - - - 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. - - -@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. - - - - 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. - - - - - - - - -@client: -@str_uri: -@Returns: - - - - - - -@client: -@start: -@end: -@Returns: - - - - - - -@client: -@pilot_id: -@uid: -@Returns: - - - - - - -@client: -@Returns: - - - - - - -@client: -@str_uri: -@Returns: - - - - - - -@client: -@uid: -@pilot_id: -@pilot_status: - diff --git a/help/devel/calendar/cal-util/Makefile.am b/help/devel/calendar/cal-util/Makefile.am deleted file mode 100644 index fa5effcb31..0000000000 --- a/help/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 \ - $(BONOBO_VFS_GNOME_CFLAGS) - -GTKDOC_LIBS = \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/calendar/cal-util/.libs/libcal-util-static.al \ - $(top_builddir)/libical/src/libical/.libs/libical-static.al \ - $(top_builddir)/libversit/.libs/libversit.al - -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 \ No newline at end of file diff --git a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt deleted file mode 100644 index 34164aba0e..0000000000 --- a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ /dev/null @@ -1,985 +0,0 @@ - -CAL_COMPONENT_TYPE -#define CAL_COMPONENT_TYPE (cal_component_get_type ()) - - -CAL_COMPONENT -#define CAL_COMPONENT(obj) (GTK_CHECK_CAST ((obj), CAL_COMPONENT_TYPE, CalComponent)) - - -CAL_COMPONENT_CLASS -#define CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_COMPONENT_TYPE, \ - CalComponentClass)) - - -IS_CAL_COMPONENT -#define IS_CAL_COMPONENT(obj) (GTK_CHECK_TYPE ((obj), CAL_COMPONENT_TYPE)) - - -IS_CAL_COMPONENT_CLASS -#define IS_CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_COMPONENT_TYPE)) - - -CalComponentVType -typedef enum { - CAL_COMPONENT_NO_TYPE, - CAL_COMPONENT_EVENT, - CAL_COMPONENT_TODO, - CAL_COMPONENT_JOURNAL, - CAL_COMPONENT_FREEBUSY, - CAL_COMPONENT_TIMEZONE -} CalComponentVType; - - -CalComponentField -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 */ - CAL_COMPONENT_FIELD_NUM_FIELDS -} CalComponentField; - - -CalComponentClassification -typedef enum { - CAL_COMPONENT_CLASS_NONE, - CAL_COMPONENT_CLASS_PUBLIC, - CAL_COMPONENT_CLASS_PRIVATE, - CAL_COMPONENT_CLASS_CONFIDENTIAL, - CAL_COMPONENT_CLASS_UNKNOWN -} CalComponentClassification; - - -CalComponentDateTime -typedef struct { - /* Actual date/time value */ - struct icaltimetype *value; - - /* Timezone ID */ - const char *tzid; -} CalComponentDateTime; - - -CalComponentPeriodType -typedef enum { - CAL_COMPONENT_PERIOD_DATETIME, - CAL_COMPONENT_PERIOD_DURATION -} CalComponentPeriodType; - - -CalComponentPeriod -typedef struct { - CalComponentPeriodType type; - - struct icaltimetype start; - - union { - struct icaltimetype end; - struct icaldurationtype duration; - } u; -} CalComponentPeriod; - - -CalComponentRangeType -typedef enum { - CAL_COMPONENT_RANGE_SINGLE, - CAL_COMPONENT_RANGE_THISPRIOR, - CAL_COMPONENT_RANGE_THISFUTURE, -} CalComponentRangeType; - - -CalComponentRange -typedef struct { - CalComponentRangeType type; - - CalComponentDateTime *datetime; -} CalComponentRange; - - -CalComponentText -typedef struct { - /* Description string */ - const char *value; - - /* Alternate representation URI */ - const char *altrep; -} CalComponentText; - - -CalComponentTransparency -typedef enum { - CAL_COMPONENT_TRANSP_NONE, - CAL_COMPONENT_TRANSP_TRANSPARENT, - CAL_COMPONENT_TRANSP_OPAQUE, - CAL_COMPONENT_TRANSP_UNKNOWN -} CalComponentTransparency; - - -CalComponentCUType -typedef enum { - CAL_COMPONENT_CUTYPE_INDIVIDUAL, - CAL_COMPONENT_CUTYPE_GROUP, - CAL_COMPONENT_CUTYPE_RESOURCE, - CAL_COMPONENT_CUTYPE_ROOM, - CAL_COMPONENT_CUTYPE_UNKNOWN -} CalComponentCUType; - - -CalComponentRole -typedef enum { - CAL_COMPONENT_ROLE_CHAIR, - CAL_COMPONENT_ROLE_REQUIRED, - CAL_COMPONENT_ROLE_OPTIONAL, - CAL_COMPONENT_ROLE_NON, - CAL_COMPONENT_ROLE_UNKNOWN -} CalComponentRole; - - -CalComponentPartStat -typedef enum { - CAL_COMPONENT_PARTSTAT_NEEDSACTION, - CAL_COMPONENT_PARTSTAT_ACCEPTED, - CAL_COMPONENT_PARTSTAT_DECLINED, - CAL_COMPONENT_PARTSTAT_TENTATIVE, - CAL_COMPONENT_PARTSTAT_DELEGATED, - CAL_COMPONENT_PARTSTAT_COMPLETED, - CAL_COMPONENT_PARTSTAT_INPROCESS, - CAL_COMPONENT_PARTSTAT_UNKNOWN -} CalComponentPartStat; - - -CalComponentAttendee -typedef struct { - const char *value; - - const char *member; - CalComponentCUType cutype; - CalComponentRole role; - CalComponentPartStat status; - gboolean rsvp; - - const char *delto; - const char *delfrom; - const char *sentby; - const char *cn; - const char *language; -} CalComponentAttendee; - - -CalComponentOrganizer -typedef struct { - const char *value; - const char *sentby; - const char *cn; - const char *language; -} CalComponentOrganizer; - - -CalComponent - - -CalComponentClass - - -CalComponentPrivate - - -CalComponent -struct CalComponent { - GtkObject object; - - /* Private data */ - CalComponentPrivate *priv; -}; - - -cal_component_get_type -GtkType -void - - -cal_component_gen_uid -char * -void - - -cal_component_new -CalComponent * -void - - -cal_component_clone -CalComponent * -CalComponent *comp - - -cal_component_set_new_vtype -void -CalComponent *comp, CalComponentVType type - - -cal_component_set_icalcomponent -gboolean -CalComponent *comp, icalcomponent *icalcomp - - -cal_component_get_icalcomponent -icalcomponent * -CalComponent *comp - - -cal_component_get_vtype -CalComponentVType -CalComponent *comp - - -cal_component_get_as_string -char * -CalComponent *comp - - -cal_component_commit_sequence -void -CalComponent *comp - - -cal_component_get_uid -void -CalComponent *comp, const char **uid - - -cal_component_set_uid -void -CalComponent *comp, const char *uid - - -cal_component_get_categories -void -CalComponent *comp, const char **categories - - -cal_component_set_categories -void -CalComponent *comp, const char *categories - - -cal_component_get_categories_list -void -CalComponent *comp, GSList **categ_list - - -cal_component_set_categories_list -void -CalComponent *comp, GSList *categ_list - - -cal_component_get_classification -void -CalComponent *comp, CalComponentClassification *classif - - -cal_component_set_classification -void -CalComponent *comp, CalComponentClassification classif - - -cal_component_get_comment_list -void -CalComponent *comp, GSList **text_list - - -cal_component_set_comment_list -void -CalComponent *comp, GSList *text_list - - -cal_component_get_completed -void -CalComponent *comp, struct icaltimetype **t - - -cal_component_set_completed -void -CalComponent *comp, struct icaltimetype *t - - -cal_component_get_created -void -CalComponent *comp, struct icaltimetype **t - - -cal_component_set_created -void -CalComponent *comp, struct icaltimetype *t - - -cal_component_get_description_list -void -CalComponent *comp, GSList **text_list - - -cal_component_set_description_list -void -CalComponent *comp, GSList *text_list - - -cal_component_get_dtend -void -CalComponent *comp, CalComponentDateTime *dt - - -cal_component_set_dtend -void -CalComponent *comp, CalComponentDateTime *dt - - -cal_component_get_dtstamp -void -CalComponent *comp, struct icaltimetype *t - - -cal_component_set_dtstamp -void -CalComponent *comp, struct icaltimetype *t - - -cal_component_get_dtstart -void -CalComponent *comp, CalComponentDateTime *dt - - -cal_component_set_dtstart -void -CalComponent *comp, CalComponentDateTime *dt - - -cal_component_get_due -void -CalComponent *comp, CalComponentDateTime *dt - - -cal_component_set_due -void -CalComponent *comp, CalComponentDateTime *dt - - -cal_component_get_exdate_list -void -CalComponent *comp, GSList **exdate_list - - -cal_component_set_exdate_list -void -CalComponent *comp, GSList *exdate_list - - -cal_component_has_exdates -gboolean -CalComponent *comp - - -cal_component_get_exrule_list -void -CalComponent *comp, GSList **recur_list - - -cal_component_get_exrule_property_list -void -CalComponent *comp, GSList **recur_list - - -cal_component_set_exrule_list -void -CalComponent *comp, GSList *recur_list - - -cal_component_has_exrules -gboolean -CalComponent *comp - - -cal_component_has_exceptions -gboolean -CalComponent *comp - - -cal_component_get_geo -void -CalComponent *comp, struct icalgeotype **geo - - -cal_component_set_geo -void -CalComponent *comp, struct icalgeotype *geo - - -cal_component_get_last_modified -void -CalComponent *comp, struct icaltimetype **t - - -cal_component_set_last_modified -void -CalComponent *comp, struct icaltimetype *t - - -cal_component_get_organizer -void -CalComponent *comp, CalComponentOrganizer *organizer - - -cal_component_set_organizer -void -CalComponent *comp, CalComponentOrganizer *organizer - - -cal_component_get_percent -void -CalComponent *comp, int **percent - - -cal_component_set_percent -void -CalComponent *comp, int *percent - - -cal_component_get_priority -void -CalComponent *comp, int **priority - - -cal_component_set_priority -void -CalComponent *comp, int *priority - - -cal_component_get_recurid -void -CalComponent *comp, CalComponentRange **recur_id - - -cal_component_set_recurid -void -CalComponent *comp, CalComponentRange *recur_id - - -cal_component_get_rdate_list -void -CalComponent *comp, GSList **period_list - - -cal_component_set_rdate_list -void -CalComponent *comp, GSList *period_list - - -cal_component_has_rdates -gboolean -CalComponent *comp - - -cal_component_get_rrule_list -void -CalComponent *comp, GSList **recur_list - - -cal_component_get_rrule_property_list -void -CalComponent *comp, GSList **recur_list - - -cal_component_set_rrule_list -void -CalComponent *comp, GSList *recur_list - - -cal_component_has_rrules -gboolean -CalComponent *comp - - -cal_component_has_recurrences -gboolean -CalComponent *comp - - -cal_component_get_sequence -void -CalComponent *comp, int **sequence - - -cal_component_set_sequence -void -CalComponent *comp, int *sequence - - -cal_component_get_status -void -CalComponent *comp, icalproperty_status *status - - -cal_component_set_status -void -CalComponent *comp, icalproperty_status status - - -cal_component_get_summary -void -CalComponent *comp, CalComponentText *summary - - -cal_component_set_summary -void -CalComponent *comp, CalComponentText *summary - - -cal_component_get_transparency -void -CalComponent *comp, CalComponentTransparency *transp - - -cal_component_set_transparency -void -CalComponent *comp, CalComponentTransparency transp - - -cal_component_get_url -void -CalComponent *comp, const char **url - - -cal_component_set_url -void -CalComponent *comp, const char *url - - -cal_component_get_attendee_list -void -CalComponent *comp, GSList **attendee_list - - -cal_component_set_attendee_list -void -CalComponent *comp, GSList *attendee_list - - -cal_component_event_dates_match -gboolean -CalComponent *comp1, CalComponent *comp2 - - -cal_component_free_categories_list -void -GSList *categ_list - - -cal_component_free_datetime -void -CalComponentDateTime *dt - - -cal_component_free_exdate_list -void -GSList *exdate_list - - -cal_component_free_geo -void -struct icalgeotype *geo - - -cal_component_free_icaltimetype -void -struct icaltimetype *t - - -cal_component_free_percent -void -int *percent - - -cal_component_free_priority -void -int *priority - - -cal_component_free_period_list -void -GSList *period_list - - -cal_component_free_recur_list -void -GSList *recur_list - - -cal_component_free_sequence -void -int *sequence - - -cal_component_free_text_list -void -GSList *text_list - - -cal_component_free_attendee_list -void -GSList *attendee_list - - -CalComponentAlarm - - -CalAlarmInstance -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; - - -CalComponentAlarms -typedef struct { - /* The actual component */ - CalComponent *comp; - - /* List of CalAlarmInstance structures */ - GSList *alarms; -} CalComponentAlarms; - - -CalAlarmAction -typedef enum { - CAL_ALARM_NONE, - CAL_ALARM_AUDIO, - CAL_ALARM_DISPLAY, - CAL_ALARM_EMAIL, - CAL_ALARM_PROCEDURE, - CAL_ALARM_UNKNOWN -} CalAlarmAction; - - -CalAlarmTriggerType -typedef enum { - CAL_ALARM_TRIGGER_NONE, - CAL_ALARM_TRIGGER_RELATIVE_START, - CAL_ALARM_TRIGGER_RELATIVE_END, - CAL_ALARM_TRIGGER_ABSOLUTE -} CalAlarmTriggerType; - - -CalAlarmTrigger -typedef struct { - CalAlarmTriggerType type; - - union { - struct icaldurationtype rel_duration; - struct icaltimetype abs_time; - } u; -} CalAlarmTrigger; - - -CalAlarmRepeat -typedef struct { - /* Number of extra repetitions, zero for none */ - int repetitions; - - /* Interval between repetitions */ - struct icaldurationtype duration; -} CalAlarmRepeat; - - -cal_component_has_alarms -gboolean -CalComponent *comp - - -cal_component_add_alarm -void -CalComponent *comp, CalComponentAlarm *alarm - - -cal_component_remove_alarm -void -CalComponent *comp, const char *auid - - -cal_component_get_alarm_uids -GList * -CalComponent *comp - - -cal_component_get_alarm -CalComponentAlarm * -CalComponent *comp, const char *auid - - -cal_component_alarms_free -void -CalComponentAlarms *alarms - - -cal_component_alarm_new -CalComponentAlarm * -void - - -cal_component_alarm_clone -CalComponentAlarm * -CalComponentAlarm *alarm - - -cal_component_alarm_free -void -CalComponentAlarm *alarm - - -cal_component_alarm_get_uid -const char * -CalComponentAlarm *alarm - - -cal_component_alarm_get_action -void -CalComponentAlarm *alarm, CalAlarmAction *action - - -cal_component_alarm_set_action -void -CalComponentAlarm *alarm, CalAlarmAction action - - -cal_component_alarm_get_attach -void -CalComponentAlarm *alarm, struct icalattachtype **attach - - -cal_component_alarm_set_attach -void -CalComponentAlarm *alarm, struct icalattachtype *attach - - -cal_component_alarm_get_description -void -CalComponentAlarm *alarm, CalComponentText *description - - -cal_component_alarm_set_description -void -CalComponentAlarm *alarm, CalComponentText *description - - -cal_component_alarm_get_repeat -void -CalComponentAlarm *alarm, CalAlarmRepeat *repeat - - -cal_component_alarm_set_repeat -void -CalComponentAlarm *alarm, CalAlarmRepeat repeat - - -cal_component_alarm_get_trigger -void -CalComponentAlarm *alarm, CalAlarmTrigger *trigger - - -cal_component_alarm_set_trigger -void -CalComponentAlarm *alarm, CalAlarmTrigger trigger - - -CalRecurInstanceFn -gboolean -CalComponent *comp, - time_t instance_start, - time_t instance_end, - gpointer data - - -CalRecurResolveTimezoneFn -icaltimezone * -const char *tzid, - gpointer data - - -cal_recur_generate_instances -void -CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data,CalRecurResolveTimezoneFn tz_cb,gpointer tz_cb_data - - -CalObjInstance -typedef struct { - char *uid; /* UID of the object */ - time_t start; /* Start time of instance */ - time_t end; /* End time of instance */ -} CalObjInstance; - - -cal_obj_instance_list_free -void -GList *list - - -CalObjType -typedef enum { - CALOBJ_TYPE_EVENT = 1 << 0, - CALOBJ_TYPE_TODO = 1 << 1, - CALOBJ_TYPE_JOURNAL = 1 << 2, - CALOBJ_TYPE_ANY = 0x07 -} CalObjType; - - -cal_obj_uid_list_free -void -GList *list - - -cal_util_new_top_level -icalcomponent * -void - - -time_days_in_month -int -int year, int month - - -time_day_of_year -int -int day, int month, int year - - -time_day_of_week -int -int day, int month, int year - - -time_is_leap_year -gboolean -int year - - -time_leap_years_up_to -int -int year - - -isodate_from_time_t -char * -time_t t - - -time_from_isodate -time_t -const char *str - - -time_add_day -time_t -time_t time, int days - - -time_add_week -time_t -time_t time, int weeks - - -time_add_month -time_t -time_t time, int months - - -time_year_begin -time_t -time_t t - - -time_month_begin -time_t -time_t t - - -time_week_begin -time_t -time_t t, int week_start_day - - -time_day_begin -time_t -time_t t - - -time_day_end -time_t -time_t t - - -time_add_day_with_zone -time_t -time_t time, int days, icaltimezone *zone - - -time_add_week_with_zone -time_t -time_t time, int weeks, icaltimezone *zone - - -time_add_month_with_zone -time_t -time_t time, int months, icaltimezone *zone - - -time_year_begin_with_zone -time_t -time_t time, icaltimezone *zone - - -time_month_begin_with_zone -time_t -time_t time, icaltimezone *zone - - -time_week_begin_with_zone -time_t -time_t time, int week_start_day,icaltimezone *zone - - -time_day_begin_with_zone -time_t -time_t time, icaltimezone *zone - - -time_day_end_with_zone -time_t -time_t time, icaltimezone *zone - - -time_to_gdate_with_zone -void -GDate *date, time_t time, icaltimezone *zone - diff --git a/help/devel/calendar/cal-util/evolution-cal-util-docs.sgml b/help/devel/calendar/cal-util/evolution-cal-util-docs.sgml deleted file mode 100644 index bab3cac78e..0000000000 --- a/help/devel/calendar/cal-util/evolution-cal-util-docs.sgml +++ /dev/null @@ -1,19 +0,0 @@ - - - - -]> - - - [Insert name here] Reference Manual - - - - [Insert title here] - &CalComponent; - &evolution-cal-util-cal-recur; - &evolution-cal-util-cal-util; - &evolution-cal-util-timeutil; - - diff --git a/help/devel/calendar/cal-util/evolution-cal-util-sections.txt b/help/devel/calendar/cal-util/evolution-cal-util-sections.txt deleted file mode 100644 index 1a03226591..0000000000 --- a/help/devel/calendar/cal-util/evolution-cal-util-sections.txt +++ /dev/null @@ -1,161 +0,0 @@ -
-cal-component -CAL_COMPONENT -CalComponent - -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 - - -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 - - -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 - - -CAL_COMPONENT_TYPE -CAL_COMPONENT_CLASS -IS_CAL_COMPONENT -IS_CAL_COMPONENT_CLASS -cal_component_get_type - - -CalComponent -CalComponentPrivate - -
- -
-cal-recur -CalRecurInstanceFn -cal_recur_generate_instances -
- -
-cal-util -CalObjInstance -cal_obj_instance_list_free -CalObjType -cal_obj_uid_list_free -
- -
-timeutil -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 -
diff --git a/help/devel/calendar/cal-util/evolution-cal-util.args b/help/devel/calendar/cal-util/evolution-cal-util.args deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/help/devel/calendar/cal-util/evolution-cal-util.hierarchy b/help/devel/calendar/cal-util/evolution-cal-util.hierarchy deleted file mode 100644 index cc235653f2..0000000000 --- a/help/devel/calendar/cal-util/evolution-cal-util.hierarchy +++ /dev/null @@ -1,2 +0,0 @@ -GtkObject - CalComponent diff --git a/help/devel/calendar/cal-util/evolution-cal-util.signals b/help/devel/calendar/cal-util/evolution-cal-util.signals deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/help/devel/calendar/cal-util/evolution-cal-util.types b/help/devel/calendar/cal-util/evolution-cal-util.types deleted file mode 100644 index 52b2d9bf90..0000000000 --- a/help/devel/calendar/cal-util/evolution-cal-util.types +++ /dev/null @@ -1,4 +0,0 @@ -#include -#include - -cal_component_get_type diff --git a/help/devel/calendar/cal-util/tmpl/cal-component.sgml b/help/devel/calendar/cal-util/tmpl/cal-component.sgml deleted file mode 100644 index 0bd957e9c2..0000000000 --- a/help/devel/calendar/cal-util/tmpl/cal-component.sgml +++ /dev/null @@ -1,993 +0,0 @@ - -CalComponent - - -RFC 2445 iCalendar component object. - - - - 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. - - - - 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 - icalcomponent 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. - - - - A #CalComponent object starts out empty. It must be initialized - from an existing icalcomponent 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. - - - - #CalComponent will create an internal map of the properties in the - icalcomponent 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 - icalcomponent and will let the parent - application modify them at any time without having to do any - iteration. - - - - 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 - - - “Interoperable.” Heavens, I love that word. - - - string to other programs that deal with iCalendar. - - - - - - - - - - Casts a #GtkObject to a #CalComponent. - - -@obj: A GTK+ object. - - - - - 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. - - -@CAL_COMPONENT_NO_TYPE: -@CAL_COMPONENT_EVENT: -@CAL_COMPONENT_TODO: -@CAL_COMPONENT_JOURNAL: -@CAL_COMPONENT_FREEBUSY: -@CAL_COMPONENT_TIMEZONE: - - - - These values are used as identifiers for #ETable columns. These - are used by the calendar GUI code in &Evolution;. - - -@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: -@CAL_COMPONENT_FIELD_NUM_FIELDS: - - - - Values for the access classification property of a calendar - component. - - -@CAL_COMPONENT_CLASS_NONE: -@CAL_COMPONENT_CLASS_PUBLIC: -@CAL_COMPONENT_CLASS_PRIVATE: -@CAL_COMPONENT_CLASS_CONFIDENTIAL: -@CAL_COMPONENT_CLASS_UNKNOWN: - - - - This structure defines a date and time value. - - - - - - Defines how a period of time is specified. - - -@CAL_COMPONENT_PERIOD_DATETIME: -@CAL_COMPONENT_PERIOD_DURATION: - - - - This structure defines a period of time. - - - - - - This structure defines the value of a text property that may have - an alternate representation parameter. - - - - - - - - -@CAL_COMPONENT_TRANSP_NONE: -@CAL_COMPONENT_TRANSP_TRANSPARENT: -@CAL_COMPONENT_TRANSP_OPAQUE: -@CAL_COMPONENT_TRANSP_UNKNOWN: - - - - - - -@Returns: - - - - - - - -@Returns: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@type: - - - - - - - -@comp: -@icalcomp: -@Returns: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: - - - - - - - -@comp: -@uid: - - - - - - - -@comp: -@uid: - - - - - - - -@comp: -@categories: - - - - - - - -@comp: -@categories: - - - - - - - -@comp: -@categ_list: - - - - - - - -@comp: -@categ_list: - - - - - - - -@comp: -@classif: - - - - - - - -@comp: -@classif: - - - - - - - -@comp: -@text_list: - - - - - - - -@comp: -@text_list: - - - - - - - -@comp: -@t: - - - - - - - -@comp: -@t: - - - - - - - -@comp: -@t: - - - - - - - -@comp: -@t: - - - - - - - -@comp: -@text_list: - - - - - - - -@comp: -@text_list: - - - - - - - -@comp: -@dt: - - - - - - - -@comp: -@dt: - - - - - - - -@comp: -@t: - - - - - - - -@comp: -@t: - - - - - - - -@comp: -@dt: - - - - - - - -@comp: -@dt: - - - - - - - -@comp: -@dt: - - - - - - - -@comp: -@dt: - - - - - - - -@comp: -@exdate_list: - - - - - - - -@comp: -@exdate_list: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@recur_list: - - - - - - - -@comp: -@recur_list: - - - - - - - -@comp: -@recur_list: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@geo: - - - - - - - -@comp: -@geo: - - - - - - - -@comp: -@t: - - - - - - - -@comp: -@t: - - - - - - - -@comp: -@percent: - - - - - - - -@comp: -@percent: - - - - - - - -@comp: -@priority: - - - - - - - -@comp: -@priority: - - - - - - - -@comp: -@period_list: - - - - - - - -@comp: -@period_list: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@recur_list: - - - - - - - -@comp: -@recur_list: - - - - - - - -@comp: -@recur_list: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@sequence: - - - - - - - -@comp: -@sequence: - - - - - - - -@comp: -@status: - - - - - - - -@comp: -@status: - - - - - - - -@comp: -@summary: - - - - - - - -@comp: -@summary: - - - - - - - -@comp: -@transp: - - - - - - - -@comp: -@transp: - - - - - - - -@comp: -@url: - - - - - - - -@comp: -@url: - - - - - - - -@categ_list: - - - - - - - -@dt: - - - - - - - -@exdate_list: - - - - - - - -@geo: - - - - - - - -@t: - - - - - - - -@percent: - - - - - - - -@priority: - - - - - - - -@period_list: - - - - - - - -@recur_list: - - - - - - - -@sequence: - - - - - - - -@text_list: - - - - - - - - - - - - - - - - - - - - - - - - - -@CAL_ALARM_NONE: -@CAL_ALARM_AUDIO: -@CAL_ALARM_DISPLAY: -@CAL_ALARM_EMAIL: -@CAL_ALARM_PROCEDURE: -@CAL_ALARM_UNKNOWN: - - - - - - -@CAL_ALARM_TRIGGER_NONE: -@CAL_ALARM_TRIGGER_RELATIVE_START: -@CAL_ALARM_TRIGGER_RELATIVE_END: -@CAL_ALARM_TRIGGER_ABSOLUTE: - - - - - - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@Returns: - - - - - - - -@comp: -@auid: -@Returns: - - - - - - - -@alarm: - - - - - - - -@alarms: - - - - - - - -@alarm: -@Returns: - - - - - - - -@alarm: -@action: - - - - - - - -@alarm: -@action: - - - - - - - -@alarm: -@trigger: - - - - - - - -@alarm: -@trigger: - - diff --git a/help/devel/calendar/cal-util/tmpl/cal-recur.sgml b/help/devel/calendar/cal-util/tmpl/cal-recur.sgml deleted file mode 100644 index a8e7cf1620..0000000000 --- a/help/devel/calendar/cal-util/tmpl/cal-recur.sgml +++ /dev/null @@ -1,44 +0,0 @@ - -cal-recur - - - - - - - - - - - - - - - - - - - -@comp: -@instance_start: -@instance_end: -@data: -@Returns: - -@instace_end: - - - - - - - -@comp: -@start: -@end: -@cb: -@cb_data: -@tz_cb: -@tz_cb_data: - - diff --git a/help/devel/calendar/cal-util/tmpl/cal-util.sgml b/help/devel/calendar/cal-util/tmpl/cal-util.sgml deleted file mode 100644 index ccd35fac2e..0000000000 --- a/help/devel/calendar/cal-util/tmpl/cal-util.sgml +++ /dev/null @@ -1,48 +0,0 @@ - -Miscellaneous utilities - - - - - - - - - - - - - - - - - - - - - - - - - -@list: - - - - - - - -@CALOBJ_TYPE_EVENT: -@CALOBJ_TYPE_TODO: -@CALOBJ_TYPE_JOURNAL: -@CALOBJ_TYPE_ANY: - - - - - - -@list: - - diff --git a/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml b/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml deleted file mode 100644 index 878273b0aa..0000000000 --- a/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml +++ /dev/null @@ -1,288 +0,0 @@ - - - - - -@CAL_COMPONENT_ALARM_NONE: -@CAL_COMPONENT_ALARM_AUDIO: -@CAL_COMPONENT_ALARM_DISPLAY: -@CAL_COMPONENT_ALARM_EMAIL: -@CAL_COMPONENT_ALARM_PROCEDURE: -@CAL_COMPONENT_ALARM_UNKNOWN: - - - - - - - - - - - - -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: - - - - - - -@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: -@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: - - - - - - - - - - - - -@year: -@month: -@day: -@hour: -@minute: -@second: - - - - - - -@CAL_RECUR_YEARLY: -@CAL_RECUR_MONTHLY: -@CAL_RECUR_WEEKLY: -@CAL_RECUR_DAILY: -@CAL_RECUR_HOURLY: -@CAL_RECUR_MINUTELY: -@CAL_RECUR_SECONDLY: - - - - - - - - - - - - -@list: - - - - - - -@trigger: - - - - - - -@comp: -@Returns: - - - - - - -@comp: -@Returns: - - - - - - -@comp: -@pilot_id: - - - - - - -@comp: -@pilot_status: - - - - - - -@comp: -@pilot_id: - - - - - - -@comp: -@pilot_status: - - - - - - -@r: - - - - - - -@ir: -@Returns: - - - - - - -@hour: -@use_am_pm: -@Returns: - - - - - - -@t: -@Returns: - - - - - - -@secs: -@Returns: - - - - - - -@str: -@Returns: - - - - - - -@str: -@Returns: - - - - - - -@t: - - - - - - -@time: -@minutes: -@Returns: - - - - - - -@time: -@years: -@Returns: - - - - - - -@t: -@hour: -@Returns: - - - - - - -@year: -@month: -@day: -@Returns: - - - - - - -@itt: -@Returns: - - - - - - -@str: -@Returns: - - - - - - -@start: -@duration: -@Returns: - - - - - - -@t: -@Returns: - - - - - - -@t: -@week_start_day: -@Returns: - - - - - - -@t: -@Returns: - diff --git a/help/devel/calendar/cal-util/tmpl/timeutil.sgml b/help/devel/calendar/cal-util/tmpl/timeutil.sgml deleted file mode 100644 index e2dba5224f..0000000000 --- a/help/devel/calendar/cal-util/tmpl/timeutil.sgml +++ /dev/null @@ -1,111 +0,0 @@ - -timeutil - - - - - - - - - - - - - - - - - - - -@t: -@Returns: - - - - - - - -@time: -@days: -@Returns: - - - - - - - -@time: -@weeks: -@Returns: - - - - - - - -@time: -@months: -@Returns: - - - - - - - -@year: -@month: -@Returns: - - - - - - - -@t: -@Returns: - - - - - - - -@t: -@Returns: - - - - - - - -@t: -@week_start_day: -@Returns: - - - - - - - -@t: -@Returns: - - - - - - - -@t: -@Returns: - - diff --git a/help/devel/calendar/evolution-calendar.sgml b/help/devel/calendar/evolution-calendar.sgml deleted file mode 100644 index ea0d8c7127..0000000000 --- a/help/devel/calendar/evolution-calendar.sgml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - Federico - Mena Quintero - -
- federico@ximian.com -
- - - - - - Developing Applications with the &Evolution; Calendar - - - - This part of the &Evolution; Developer's Guide describes how - to write applications for the &Evolution; Calendar by using - its public interfaces. The &Evolution; Calendar exports its - functionality through a number of interfaces, including CORBA, - GTK+ wrappers for Bonobo objects, and other utility libraries. - 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. - - - - 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. - - - - &calendar-architecture; - &calendar-alarm-generation; - - - diff --git a/help/devel/calendar/public-reference.sgml b/help/devel/calendar/public-reference.sgml deleted file mode 100644 index b880bd2972..0000000000 --- a/help/devel/calendar/public-reference.sgml +++ /dev/null @@ -1,24 +0,0 @@ - - Calendar Public API Reference - - - - This part presents the class and function reference for the - public APIs of the different components of the &Evolution; - Calendar. - - - - &CalClient; - &CalComponent; - &cal-util; - &cal-recur; - &timeutil; - - - diff --git a/help/devel/evolution-devel-guide.sgml b/help/devel/evolution-devel-guide.sgml deleted file mode 100644 index c089c5b885..0000000000 --- a/help/devel/evolution-devel-guide.sgml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - -Evolution"> -Wombat"> -Camel"> -PCS"> -libical"> -Executive Summary"> -]> - - - - - - - - - - - &Evolution; Developer's Guide - - - - Ximian, Inc. - - - - - 2001 - Ximian, Inc. - - - - 2001 - Ximian, Inc. - - - - - 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 no Invariant - Sections, no Front-Cover Texts, and no Back-Cover Texts. You - may obtain a copy of the GNU Free Documentation - License from the Free Software Foundation by - visiting their Web - site or by writing to: Free Software Foundation, Inc., - 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - - - - 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. - - - - - - - &preface; - - - - &evolution-calendar; - - - - &evolution-reference; - - - - &FDL; - diff --git a/help/devel/fdl.sgml b/help/devel/fdl.sgml deleted file mode 100644 index 817adbdbb7..0000000000 --- a/help/devel/fdl.sgml +++ /dev/null @@ -1,671 +0,0 @@ - - - - - - Version 1.1, March 2000 - - - 2000Free Software Foundation, Inc. - - - -
Free Software Foundation, Inc. 59 Temple Place, - Suite 330, Boston, MA - 02111-1307 USA
- Everyone is permitted to copy and distribute verbatim copies of this - license document, but changing it is not allowed. - - - - GNU Free Documentation License - - - 0. PREAMBLE - - The purpose of this License is to make a manual, textbook, or - other written document free 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. - - - - This License is a kind of copyleft, 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. - - - - 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. - - - - 1. APPLICABILITY AND DEFINITIONS - - 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 - Document, below, refers to any such manual or - work. Any member of the public is a licensee, and is addressed - as you. - - - - A Modified Version 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. - - - - A Secondary Section is a named appendix or a - front-matter section of the Document 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. - - - - The Invariant Sections are certain Secondary Sections whose titles - are designated, as being those of Invariant Sections, in the - notice that says that the Document is released under this - License. - - - - The Cover Texts are certain short passages of - text that are listed, as Front-Cover Texts or Back-Cover Texts, - in the notice that says that the Document is released under this - License. - - - - A Transparent copy of the Document 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 Transparent is called - Opaque. - - - - 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. - - - - The Title Page 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, Title Page means the text near the - most prominent appearance of the work's title, preceding the - beginning of the body of the text. - - - - - 2. VERBATIM COPYING - - You may copy and distribute the Document 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 section 3. - - - - You may also lend copies, under the same conditions stated - above, and you may publicly display copies. - - - - - 3. COPYING IN QUANTITY - - If you publish printed copies of the Document numbering more than 100, - and the Document's license notice requires Cover Texts, 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 - Document and satisfy these - conditions, can be treated as verbatim copying in other - respects. - - - - 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. - - - - If you publish or distribute Opaque copies of the Document numbering more than 100, - you must either include a machine-readable Transparent 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. - - - - It is requested, but not required, that you contact the authors - of the Document well before - redistributing any large number of copies, to give them a chance - to provide you with an updated version of the Document. - - - - - 4. MODIFICATIONS - - You may copy and distribute a Modified Version of the Document under the conditions of - sections 2 and 3 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: - - - - - - A - - Use in the Title - Page (and on the covers, if any) a title distinct - from that of the Document, 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. - - - - - - - B - - List on the Title - Page, as authors, one or more persons or entities - responsible for authorship of the modifications in the - Modified Version, - together with at least five of the principal authors of - the Document (all of - its principal authors, if it has less than five). - - - - - - - C - - State on the Title - Page the name of the publisher of the Modified Version, as the - publisher. - - - - - - - D - - Preserve all the copyright notices of the Document. - - - - - - - E - - Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. - - - - - - - F - - Include, immediately after the copyright notices, a - license notice giving the public permission to use the - Modified Version under - the terms of this License, in the form shown in the - Addendum below. - - - - - - - G - - Preserve in that license notice the full lists of Invariant Sections and - required Cover - Texts given in the Document's license notice. - - - - - - - H - - Include an unaltered copy of this License. - - - - - - - I - - Preserve the section entitled History, and - its title, and add to it an item stating at least the - title, year, new authors, and publisher of the Modified Version as given on - the Title Page. If - there is no section entitled History in the - Document, 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. - - - - - - - J - - Preserve the network location, if any, given in the Document for public access - to a Transparent - 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 History - 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. - - - - - - - K - - In any section entitled Acknowledgements or - Dedications, 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. - - - - - - - L - - Preserve all the Invariant - Sections of the Document, unaltered in their - text and in their titles. Section numbers or the - equivalent are not considered part of the section titles. - - - - - - - M - - Delete any section entitled - Endorsements. Such a section may not be - included in the Modified - Version. - - - - - - - N - - Do not retitle any existing section as - Endorsements or to conflict in title with - any Invariant - Section. - - - - - - - If the Modified Version - includes new front-matter sections or appendices that qualify as - Secondary Sections 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 Invariant Sections in the - Modified Version's license notice. These titles must be - distinct from any other section titles. - - - - You may add a section entitled Endorsements, - provided it contains nothing but endorsements of your Modified Version 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. - - - - You may add a passage of up to five words as a Front-Cover Text, and a passage - of up to 25 words as a Back-Cover Text, to the end of - the list of Cover Texts - in the Modified Version. - 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 Document - 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. - - - - The author(s) and publisher(s) of the Document do not by this License - give permission to use their names for publicity for or to - assert or imply endorsement of any Modified Version . - - - - - 5. COMBINING DOCUMENTS - - You may combine the Document - with other documents released under this License, under the - terms defined in section 4 - above for modified versions, provided that you include in the - combination all of the Invariant - Sections of all of the original documents, unmodified, - and list them all as Invariant Sections of your combined work in - its license notice. - - - - The combined work need only contain one copy of this License, - and multiple identical Invariant - Sections 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. - - - - In the combination, you must combine any sections entitled - History in the various original documents, - forming one section entitled History; likewise - combine any sections entitled Acknowledgements, - and any sections entitled Dedications. You must - delete all sections entitled Endorsements. - - - - - 6. COLLECTIONS OF DOCUMENTS - - You may make a collection consisting of the Document 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. - - - - 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. - - - - - 7. AGGREGATION WITH INDEPENDENT WORKS - - A compilation of the Document 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 Modified Version - of the Document, provided no compilation copyright is claimed - for the compilation. Such a compilation is called an - aggregate, 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 Cover Text requirement of section 3 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. - - - - - 8. TRANSLATION - - Translation is considered a kind of modification, so you may - distribute translations of the Document under the terms of section 4. Replacing Invariant Sections 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. - - - - - 9. TERMINATION - - You may not copy, modify, sublicense, or distribute the Document 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. - - - - - 10. FUTURE REVISIONS OF THIS LICENSE - - The Free Software - Foundation 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 http://www.gnu.org/copyleft/. - - - - Each version of the License is given a distinguishing version - number. If the Document - specifies that a particular numbered version of this License - or any later version 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. - - - - - Addendum - - 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: - - -
- - Copyright © YEAR YOUR NAME. - - - 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 Invariant Sections being LIST - THEIR TITLES, with the Front-Cover Texts being LIST, - and with the Back-Cover - Texts being LIST. A copy of the license is included in - the section entitled GNU Free Documentation - License. - -
- - - If you have no Invariant - Sections, write with no Invariant Sections - instead of saying which ones are invariant. If you have no - Front-Cover Texts, write - no Front-Cover Texts instead of - Front-Cover Texts being LIST; likewise for Back-Cover Texts. - - - - 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 GNU General Public - License, to permit their use in free software. - - - - - - - - - diff --git a/help/devel/preface.sgml b/help/devel/preface.sgml deleted file mode 100644 index fdaa824a8b..0000000000 --- a/help/devel/preface.sgml +++ /dev/null @@ -1,113 +0,0 @@ - - Introduction - - - 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. - - - - If you are an end-user of &Evolution; you do not need to read - this guide; please read the &Evolution; User's Guide instead. - - - - This guide contains the information you need to know to do the - following: - - - - - Write applications that use &Evolution;'s data - repositories via the &Wombat; personal information server. - Examples of this would be a GNOME - Panel applet that displays today's - appointments, or a telephone dialer application that uses - the contents of the &Evolution; Addressbook. - - - - - - Write applications that use the &Camel; mail library. - This includes extending &Evolution;'s own mail component - to perform additional functions. - - - - - - 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. - - - - - - 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. - - - - - - Modify the core &Evolution; code to add new features or - change its architecture. - - - - - - - Organization of this Guide - - - 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. - - - - 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. - - - - &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. - - - - - diff --git a/help/devel/reference.sgml b/help/devel/reference.sgml deleted file mode 100644 index 4381ad29b7..0000000000 --- a/help/devel/reference.sgml +++ /dev/null @@ -1,49 +0,0 @@ - - &Evolution; API Reference - - - - This part presents the class and function reference for the - different libraries and interfaces that &Evolution; provides. - Classes are described together with their methods; individual - functions are grouped by functional group. - - - - &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. - - - - 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. - - - - &calendar-public-reference; - - - - - - - -- cgit v1.2.3