From 634ea84f65334eff1b4c7410ef6aebfecba519e5 Mon Sep 17 00:00:00 2001 From: JP Rosevear Date: Mon, 29 Dec 2003 20:03:47 +0000 Subject: Removing old, dead docs. svn path=/trunk/; revision=24016 --- doc/Makefile.am | 2 - doc/devel/ChangeLog | 4 + doc/devel/calendar/.cvsignore | 2 - doc/devel/calendar/Makefile.am | 7 - doc/devel/calendar/alarm-generation.sgml | 155 --- doc/devel/calendar/architecture.sgml | 162 --- doc/devel/calendar/cal-client/.cvsignore | 13 - doc/devel/calendar/cal-client/Makefile.am | 196 ---- .../cal-client/evolution-cal-client-decl.txt | 526 ---------- .../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 - doc/devel/calendar/cal-client/tmpl/cal-client.sgml | 354 ------- .../tmpl/evolution-cal-client-unused.sgml | 84 -- doc/devel/calendar/cal-util/.cvsignore | 13 - doc/devel/calendar/cal-util/Makefile.am | 196 ---- .../calendar/cal-util/evolution-cal-util-decl.txt | 1039 -------------------- .../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 | 992 ------------------- doc/devel/calendar/cal-util/tmpl/cal-recur.sgml | 45 - doc/devel/calendar/cal-util/tmpl/cal-util.sgml | 48 - .../cal-util/tmpl/evolution-cal-util-unused.sgml | 322 ------ doc/devel/calendar/cal-util/tmpl/timeutil.sgml | 73 -- doc/devel/calendar/evolution-calendar.sgml | 52 - doc/devel/calendar/public-reference.sgml | 24 - 32 files changed, 4 insertions(+), 4581 deletions(-) delete mode 100644 doc/devel/calendar/.cvsignore delete mode 100644 doc/devel/calendar/Makefile.am delete mode 100644 doc/devel/calendar/alarm-generation.sgml delete mode 100644 doc/devel/calendar/architecture.sgml delete mode 100644 doc/devel/calendar/cal-client/.cvsignore delete mode 100644 doc/devel/calendar/cal-client/Makefile.am delete mode 100644 doc/devel/calendar/cal-client/evolution-cal-client-decl.txt delete mode 100644 doc/devel/calendar/cal-client/evolution-cal-client-docs.sgml delete mode 100644 doc/devel/calendar/cal-client/evolution-cal-client-sections.txt delete mode 100644 doc/devel/calendar/cal-client/evolution-cal-client.args delete mode 100644 doc/devel/calendar/cal-client/evolution-cal-client.hierarchy delete mode 100644 doc/devel/calendar/cal-client/evolution-cal-client.types delete mode 100644 doc/devel/calendar/cal-client/tmpl/cal-client.sgml delete mode 100644 doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml delete mode 100644 doc/devel/calendar/cal-util/.cvsignore delete mode 100644 doc/devel/calendar/cal-util/Makefile.am delete mode 100644 doc/devel/calendar/cal-util/evolution-cal-util-decl.txt delete mode 100644 doc/devel/calendar/cal-util/evolution-cal-util-docs.sgml delete mode 100644 doc/devel/calendar/cal-util/evolution-cal-util-sections.txt delete mode 100644 doc/devel/calendar/cal-util/evolution-cal-util.args delete mode 100644 doc/devel/calendar/cal-util/evolution-cal-util.hierarchy delete mode 100644 doc/devel/calendar/cal-util/evolution-cal-util.signals delete mode 100644 doc/devel/calendar/cal-util/evolution-cal-util.types delete mode 100644 doc/devel/calendar/cal-util/tmpl/cal-component.sgml delete mode 100644 doc/devel/calendar/cal-util/tmpl/cal-recur.sgml delete mode 100644 doc/devel/calendar/cal-util/tmpl/cal-util.sgml delete mode 100644 doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml delete mode 100644 doc/devel/calendar/cal-util/tmpl/timeutil.sgml delete mode 100644 doc/devel/calendar/evolution-calendar.sgml delete mode 100644 doc/devel/calendar/public-reference.sgml diff --git a/doc/Makefile.am b/doc/Makefile.am index b940e42eb7..965492689a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,3 +1 @@ -SUBDIRS = devel - EXTRA_DIST = ChangeLog.pre-1-4 diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog index a2080cb953..0f6ba969e2 100644 --- a/doc/devel/ChangeLog +++ b/doc/devel/ChangeLog @@ -1,3 +1,7 @@ +2003-11-20 JP Rosevear + + * Remove dead doc files. + 2003-09-11 Dan Winship * calendar/cal-client/Makefile.am (GTKDOC_LIBS): Use non-static diff --git a/doc/devel/calendar/.cvsignore b/doc/devel/calendar/.cvsignore deleted file mode 100644 index 282522db03..0000000000 --- a/doc/devel/calendar/.cvsignore +++ /dev/null @@ -1,2 +0,0 @@ -Makefile -Makefile.in diff --git a/doc/devel/calendar/Makefile.am b/doc/devel/calendar/Makefile.am deleted file mode 100644 index 028622bd82..0000000000 --- a/doc/devel/calendar/Makefile.am +++ /dev/null @@ -1,7 +0,0 @@ -SUBDIRS = cal-util cal-client - -EXTRA_DIST = \ - alarm-generation.sgml \ - architecture.sgml \ - evolution-calendar.sgml \ - public-reference.sgml diff --git a/doc/devel/calendar/alarm-generation.sgml b/doc/devel/calendar/alarm-generation.sgml deleted file mode 100644 index 46f7e4bff1..0000000000 --- a/doc/devel/calendar/alarm-generation.sgml +++ /dev/null @@ -1,155 +0,0 @@ - - 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. - - - - In addition, alarms may specify a number of repetitions and a - duration time. For example, an alarm may be configured to - repeat 3 extra times after the original occurrence with 5 - minutes between each repetition. Again, for absolute triggers - this does not present a problem, as we can just generate the - repetitions starting from the absolute trigger time. For - relative triggers, we expand the range as described above and - also add the total offset for the repetitions to the start of - the range, i.e. 15 extra minutes for the case of 3 repetitions - with 5 minutes between each. We do not need to modify the end - of the range because alarm repetitions always have positive - offsets, so they are equivalent to relative alarm triggers - with positive offsets. - - - - - 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/doc/devel/calendar/architecture.sgml b/doc/devel/calendar/architecture.sgml deleted file mode 100644 index d261f0a7f4..0000000000 --- a/doc/devel/calendar/architecture.sgml +++ /dev/null @@ -1,162 +0,0 @@ - - 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/doc/devel/calendar/cal-client/.cvsignore b/doc/devel/calendar/cal-client/.cvsignore deleted file mode 100644 index 79be6b0149..0000000000 --- a/doc/devel/calendar/cal-client/.cvsignore +++ /dev/null @@ -1,13 +0,0 @@ -sgml -Makefile -Makefile.in -*-decl.txt -*-decl-list.txt -*-unused.txt -*-undocumented.txt -*-symbols.txt -*.hierarchy -*.signals -*.stamp -*-scan.c -.libs diff --git a/doc/devel/calendar/cal-client/Makefile.am b/doc/devel/calendar/cal-client/Makefile.am deleted file mode 100644 index a441e6cbd0..0000000000 --- a/doc/devel/calendar/cal-client/Makefile.am +++ /dev/null @@ -1,196 +0,0 @@ -# The name of the module. -DOC_MODULE=evolution-cal-client - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-client - -# Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS= - -# Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS= - -# Used for dependencies. -HFILE_GLOB= \ - $(top_srcdir)/calendar/cal-client/cal-client.c \ - $(top_srcdir)/calendar/cal-client/cal-client-types.c - -CFILE_GLOB= \ - $(top_srcdir)/calendar/cal-client/cal-client.h \ - $(top_srcdir)/calendar/cal-client/cal-client-types.h - -# Header files to ignore when scanning. -IGNORE_HFILES= \ - cal-listener.h \ - evolution-calendar.h - -# Images to copy into HTML directory. -HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = - -# Other files to distribute. -extra_files = - -# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib -# contains GtkObjects/GObjects and you want to document signals and properties. -GTKDOC_CFLAGS= \ - -I$(top_srcdir)/calendar \ - -I$(top_builddir)/calendar/cal-client \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - -I$(top_builddir)/libical/src/libical \ - -I$(top_srcdir)/libical/src/libical \ - $(EVOLUTION_CALENDAR_CFLAGS) - -GTKDOC_LIBS= \ - $(EVOLUTION_CALENDAR_LIBS) \ - $(top_builddir)/e-util/libeutil.la \ - $(top_builddir)/calendar/cal-client/libcal-client.la \ - $(top_builddir)/calendar/cal-util/libcal-util.la \ - $(top_builddir)/libical/src/libical/libical.la \ - $(top_builddir)/libversit/libversit.a \ - $(top_builddir)/libwombat/libwombat.la - -GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in this file -# and uncomment this line. -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt -DOC_OVERRIDES = - -#DOC_DIR=$(datadir)/gnome/html - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_MODULE)-sections.txt \ - $(DOC_OVERRIDES) - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals - -if ENABLE_GTK_DOC -#all-local: html-build.stamp -all-local: sgml-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building SGML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -install-data-local: - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo $(srcdir)/html/*.html`; \ - if test "$$installfiles" = '$(srcdir)/html/*.html'; \ - then echo '-- Nothing to install' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/sgml - files=`echo $(srcdir)/tmpl/*.sgml` ; \ - test '$(srcdir)/tmpl/*.sgml' = "$$files" \ - || cp $$files $(distdir)/tmpl - files=`echo $(srcdir)/sgml/*.sgml` ; \ - test '$(srcdir)/sgml/*.sgml' = "$$files" \ - || cp $$files $(distdir)/sgml - -.PHONY : dist-hook-local diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt deleted file mode 100644 index 68bfef1c1a..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ /dev/null @@ -1,526 +0,0 @@ - -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_PERMISSION_DENIED, - CAL_CLIENT_OPEN_METHOD_NOT_SUPPORTED -} CalClientOpenStatus; - - -CalClientSetModeStatus -typedef enum { - CAL_CLIENT_SET_MODE_SUCCESS, - CAL_CLIENT_SET_MODE_ERROR, - CAL_CLIENT_SET_MODE_NOT_SUPPORTED -} CalClientSetModeStatus; - - -CalClientGetStatus -typedef enum { - CAL_CLIENT_GET_SUCCESS, - CAL_CLIENT_GET_NOT_FOUND, - CAL_CLIENT_GET_SYNTAX_ERROR -} CalClientGetStatus; - - -CalClientResult -typedef enum { - CAL_CLIENT_RESULT_SUCCESS, - CAL_CLIENT_RESULT_CORBA_ERROR, - CAL_CLIENT_RESULT_INVALID_OBJECT, - CAL_CLIENT_RESULT_NOT_FOUND, - CAL_CLIENT_RESULT_PERMISSION_DENIED -} CalClientResult; - - -CalClientSendResult -typedef enum { - CAL_CLIENT_SEND_SUCCESS, - CAL_CLIENT_SEND_CORBA_ERROR, - CAL_CLIENT_SEND_INVALID_OBJECT, - CAL_CLIENT_SEND_BUSY, - CAL_CLIENT_SEND_PERMISSION_DENIED -} CalClientSendResult; - - -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_set_default_timezone -gboolean -CalClient *client, icaltimezone *zone - - -cal_client_open_calendar -gboolean -CalClient *client, const char *str_uri, gboolean only_if_exists - - -cal_client_open_default_calendar -gboolean -CalClient *client, gboolean only_if_exists - - -cal_client_open_default_tasks -gboolean -CalClient *client, gboolean only_if_exists - - -cal_client_uri_list -GList * -CalClient *client, CalMode mode - - -cal_client_get_load_state -CalClientLoadState -CalClient *client - - -cal_client_get_uri -const char * -CalClient *client - - -cal_client_is_read_only -gboolean -CalClient *client - - -cal_client_get_email_address -const char * -CalClient *client - - -cal_client_set_mode -gboolean -CalClient *client, CalMode mode - - -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 -GList * -CalClient *client, GList *users,time_t start, time_t end - - -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 -CalClientResult -CalClient *client, CalComponent *comp - - -cal_client_update_objects -CalClientResult -CalClient *client, icalcomponent *icalcomp - - -cal_client_remove_object -CalClientResult -CalClient *client, const char *uid - - -cal_client_send_object -CalClientSendResult -CalClient *client, icalcomponent *icalcomp,icalcomponent **new_icalcomp, GList **users,char error_msg[256] - - -cal_client_get_query -CalQuery * -CalClient *client, const char *sexp - - -cal_client_resolve_tzid_cb -icaltimezone * -const char *tzid, gpointer data - - -cal_client_get_component_as_string -char * -CalClient *client,CalComponent *comp - - -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_CalObjUIDSeq *uids, - 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 - - -CAL_CLIENT_MULTI_TYPE -#define CAL_CLIENT_MULTI_TYPE (cal_client_multi_get_type ()) - - -CAL_CLIENT_MULTI -#define CAL_CLIENT_MULTI(obj) (GTK_CHECK_CAST ((obj), CAL_CLIENT_MULTI_TYPE, CalClientMulti)) - - -CAL_CLIENT_MULTI_CLASS -#define CAL_CLIENT_MULTI_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_CLIENT_MULTI_TYPE, CalClientMultiClass)) - - -IS_CAL_CLIENT_MULTI -#define IS_CAL_CLIENT_MULTI(obj) (GTK_CHECK_TYPE ((obj), CAL_CLIENT_MULTI_TYPE)) - - -IS_CAL_CLIENT_MULTI_CLASS -#define IS_CAL_CLIENT_MULTI_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_CLIENT_MULTI_TYPE)) - - -CalClientMulti - - -CalClientMultiClass - - -CalClientMultiPrivate - - -CalClientMulti -struct CalClientMulti { - GtkObject object; - - /* Private data */ - CalClientMultiPrivate *priv; -}; - - -cal_client_multi_get_type -GtkType -void - - -cal_client_multi_new -CalClientMulti * -void - - -cal_client_multi_add_client -void -CalClientMulti *multi, CalClient *client - - -cal_client_multi_set_auth_func -void -CalClientMulti *multi,CalClientAuthFunc func,gpointer user_data - - -cal_client_multi_open_calendar -CalClient * -CalClientMulti *multi,const char *str_uri,gboolean only_if_exists - - -cal_client_multi_get_client_for_uri -CalClient * -CalClientMulti *multi,const char *uri - - -cal_client_multi_get_n_objects -int -CalClientMulti *multi, CalObjType type - - -cal_client_multi_get_object -CalClientGetStatus -CalClientMulti *multi,const char *uid,CalComponent **comp - - -cal_client_multi_get_timezone -CalClientGetStatus -CalClientMulti *multi,const char *tzid,icaltimezone **zone - - -cal_client_multi_get_uids -GList * -CalClientMulti *multi, CalObjType type - - -cal_client_multi_get_changes -GList * -CalClientMulti *multi,CalObjType type,const char *change_id - - -cal_client_multi_get_objects_in_range -GList * -CalClientMulti *multi,CalObjType type,time_t start,time_t end - - -cal_client_multi_get_free_busy -GList * -CalClientMulti *multi,GList *users,time_t start,time_t end - - -cal_client_multi_generate_instances -void -CalClientMulti *multi,CalObjType type,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data - - -cal_client_multi_get_alarms_in_range -GSList * -CalClientMulti *multi,time_t start, time_t end - diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-docs.sgml b/doc/devel/calendar/cal-client/evolution-cal-client-docs.sgml deleted file mode 100644 index 136cf77e5c..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-docs.sgml +++ /dev/null @@ -1,15 +0,0 @@ - - -]> - - - [Insert name here] Reference Manual - - - - [Insert title here] - &CalClient; - &evolution-cal-client-CalQuery; - - diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt deleted file mode 100644 index 8e33be4933..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ /dev/null @@ -1,69 +0,0 @@ -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/doc/devel/calendar/cal-client/evolution-cal-client.args b/doc/devel/calendar/cal-client/evolution-cal-client.args deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy b/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy deleted file mode 100644 index 88efa3e673..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy +++ /dev/null @@ -1,2 +0,0 @@ -GtkObject - CalClient diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.types b/doc/devel/calendar/cal-client/evolution-cal-client.types deleted file mode 100644 index 84d65a6637..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client.types +++ /dev/null @@ -1,4 +0,0 @@ -#include -#include - -cal_client_get_type diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml deleted file mode 100644 index b558b7979f..0000000000 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ /dev/null @@ -1,354 +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_PERMISSION_DENIED: -@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: - - - - - - -@calclient: the object which received the signal. -@arg1: -@arg2: - - - - 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: - - - - - - -@calclient: the object which received the signal. -@arg1: - - - - - - -@calclient: the object which received the signal. - diff --git a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml deleted file mode 100644 index 3e8ce25ee6..0000000000 --- a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ /dev/null @@ -1,84 +0,0 @@ - - - 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/doc/devel/calendar/cal-util/.cvsignore b/doc/devel/calendar/cal-util/.cvsignore deleted file mode 100644 index 724c33a4c6..0000000000 --- a/doc/devel/calendar/cal-util/.cvsignore +++ /dev/null @@ -1,13 +0,0 @@ -sgml -Makefile -Makefile.in -*-decl.txt -*-decl-list.txt -*-unused.txt -*-undocumented.txt -*-symbols.txt -*.signals -*.hierarchy -*.stamp -*-scan.c -.libs diff --git a/doc/devel/calendar/cal-util/Makefile.am b/doc/devel/calendar/cal-util/Makefile.am deleted file mode 100644 index 5367c4a605..0000000000 --- a/doc/devel/calendar/cal-util/Makefile.am +++ /dev/null @@ -1,196 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# The name of the module, e.g. 'glib'. -DOC_MODULE=evolution-cal-util - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-util - -# Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS= - -# Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS= - -# Used for dependencies. -HFILE_GLOB= \ - $(top_srcdir)/calendar/cal-util/cal-component.h \ - $(top_srcdir)/calendar/cal-util/cal-recur.h \ - $(top_srcdir)/calendar/cal-util/cal-util.h \ - $(top_srcdir)/calendar/cal-util/timeutil.h - -CFILE_GLOB= \ - $(top_srcdir)/calendar/cal-util/cal-component.c \ - $(top_srcdir)/calendar/cal-util/cal-recur.c \ - $(top_srcdir)/calendar/cal-util/cal-util.c \ - $(top_srcdir)/calendar/cal-util/timeutil.c - - -# Header files to ignore when scanning. -IGNORE_HFILES= \ - calobj.h - -# Images to copy into HTML directory. -HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = - -# Other files to distribute. -extra_files = - -# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib -# contains GtkObjects/GObjects and you want to document signals and properties. -GTKDOC_CFLAGS = \ - -I$(top_srcdir)/calendar \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - -I$(top_builddir)/libical/src/libical \ - -I$(top_srcdir)/libical/src/libical \ - $(EVOLUTION_CALENDAR_CFLAGS) - -GTKDOC_LIBS = \ - $(EVOLUTION_CALENDAR_LIBS) \ - $(top_builddir)/calendar/cal-util/libcal-util.la \ - $(top_builddir)/libical/src/libical/libical.la \ - $(top_builddir)/libversit/libversit.a - -GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in this file -# and uncomment this line. -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt -DOC_OVERRIDES = - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_MODULE)-sections.txt \ - $(DOC_OVERRIDES) - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals - -if ENABLE_GTK_DOC -all-local: sgml-build.stamp -#all-local: html-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building SGML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -install-data-local: - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo $(srcdir)/html/*.html`; \ - if test "$$installfiles" = '$(srcdir)/html/*.html'; \ - then echo '-- Nothing to install' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/sgml - files=`echo $(srcdir)/tmpl/*.sgml` ; \ - test '$(srcdir)/tmpl/*.sgml' = "$$files" \ - || cp $$files $(distdir)/tmpl - files=`echo $(srcdir)/sgml/*.sgml` ; \ - test '$(srcdir)/sgml/*.sgml' = "$$files" \ - || cp $$files $(distdir)/sgml - -.PHONY : dist-hook-local diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt deleted file mode 100644 index af91e3f9cb..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ /dev/null @@ -1,1039 +0,0 @@ - -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 */ -#if 0 - CAL_COMPONENT_FIELD_LOCATION, -#endif - 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; - - -CalComponentAttendee -typedef struct { - const char *value; - - const char *member; - icalparameter_cutype cutype; - icalparameter_role role; - icalparameter_partstat status; - gboolean rsvp; - - const char *delto; - const char *delfrom; - const char *sentby; - const char *cn; - const char *language; -} CalComponentAttendee; - - -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_rescan -void -CalComponent *comp - - -cal_component_strip_errors -void -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_abort_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_contact_list -void -CalComponent *comp, GSList **text_list - - -cal_component_set_contact_list -void -CalComponent *comp, GSList *text_list - - -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_has_organizer -gboolean -CalComponent *comp - - -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_has_simple_recurrence -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_has_attendees -gboolean -CalComponent *comp - - -cal_component_get_location -void -CalComponent *comp, const char **location - - -cal_component_set_location -void -CalComponent *comp, const char *location - - -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_remove_all_alarms -void -CalComponent *comp - - -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, icalattach **attach - - -cal_component_alarm_set_attach -void -CalComponentAlarm *alarm, icalattach *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 - - -cal_component_alarm_get_icalcomponent -icalcomponent * -CalComponentAlarm *alarm - - -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,icaltimezone *default_timezone - - -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; - - -CalMode -typedef enum { - CAL_MODE_INVALID = -1, - CAL_MODE_LOCAL = 1 << 0, - CAL_MODE_REMOTE = 1 << 1, - CAL_MODE_ANY = 0x07 -} CalMode; - - -cal_obj_uid_list_free -void -GList *list - - -cal_util_new_top_level -icalcomponent * -void - - -cal_util_generate_alarms_for_comp -CalComponentAlarms * -CalComponent *comp,time_t start,time_t end,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data,icaltimezone *default_timezone - - -cal_util_generate_alarms_for_list -int -GList *comps,time_t start,time_t end,GSList **comp_alarms,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data,icaltimezone *default_timezone - - -cal_util_resolve_tzid -icaltimezone * -const char *tzid, gpointer data - - -cal_util_priority_to_string -char * -int priority - - -cal_util_priority_from_string -int -const char *string - - -cal_util_expand_uri -char * -char *uri, gboolean tasks - - -cal_util_add_timezones_from_component -void -icalcomponent *vcal_comp,CalComponent *comp - - -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_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/doc/devel/calendar/cal-util/evolution-cal-util-docs.sgml b/doc/devel/calendar/cal-util/evolution-cal-util-docs.sgml deleted file mode 100644 index bab3cac78e..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-docs.sgml +++ /dev/null @@ -1,19 +0,0 @@ - - - - -]> - - - [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/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt deleted file mode 100644 index 1a03226591..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt +++ /dev/null @@ -1,161 +0,0 @@ -
-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/doc/devel/calendar/cal-util/evolution-cal-util.args b/doc/devel/calendar/cal-util/evolution-cal-util.args deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy b/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy deleted file mode 100644 index cc235653f2..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy +++ /dev/null @@ -1,2 +0,0 @@ -GtkObject - CalComponent diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.signals b/doc/devel/calendar/cal-util/evolution-cal-util.signals deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.types b/doc/devel/calendar/cal-util/evolution-cal-util.types deleted file mode 100644 index 52b2d9bf90..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util.types +++ /dev/null @@ -1,4 +0,0 @@ -#include -#include - -cal_component_get_type diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml deleted file mode 100644 index 8a8cfa8907..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml +++ /dev/null @@ -1,992 +0,0 @@ - -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: - - - - 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/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml deleted file mode 100644 index 214b24cbf7..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml +++ /dev/null @@ -1,45 +0,0 @@ - -cal-recur - - - - - - - - - - - - - - - - - - - -@comp: -@instance_start: -@instance_end: -@data: -@Returns: - -@instace_end: - - - - - - - -@comp: -@start: -@end: -@cb: -@cb_data: -@tz_cb: -@tz_cb_data: -@default_timezone: - - diff --git a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml deleted file mode 100644 index ccd35fac2e..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml +++ /dev/null @@ -1,48 +0,0 @@ - -Miscellaneous utilities - - - - - - - - - - - - - - - - - - - - - - - - - -@list: - - - - - - - -@CALOBJ_TYPE_EVENT: -@CALOBJ_TYPE_TODO: -@CALOBJ_TYPE_JOURNAL: -@CALOBJ_TYPE_ANY: - - - - - - -@list: - - diff --git a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml deleted file mode 100644 index 757b46b170..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml +++ /dev/null @@ -1,322 +0,0 @@ - - - - - -@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: -@months: -@Returns: - - - - - - -@time: -@years: -@Returns: - - - - - - -@t: -@hour: -@Returns: - - - - - - -@year: -@month: -@day: -@Returns: - - - - - - -@itt: -@Returns: - - - - - - -@str: -@Returns: - - - - - - -@start: -@duration: -@Returns: - - - - - - -@t: -@Returns: - - - - - - -@t: -@Returns: - - - - - - -@t: -@week_start_day: -@Returns: - - - - - - -@t: -@week_start_day: -@Returns: - - - - - - -@t: -@Returns: - - - - - - -@t: -@Returns: - diff --git a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml deleted file mode 100644 index e118c438eb..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml +++ /dev/null @@ -1,73 +0,0 @@ - -timeutil - - - - - - - - - - - - - - - - - - - -@t: -@Returns: - - - - - - - -@time: -@days: -@Returns: - - - - - - - -@time: -@weeks: -@Returns: - - - - - - - -@year: -@month: -@Returns: - - - - - - - -@t: -@Returns: - - - - - - - -@t: -@Returns: - - diff --git a/doc/devel/calendar/evolution-calendar.sgml b/doc/devel/calendar/evolution-calendar.sgml deleted file mode 100644 index ea0d8c7127..0000000000 --- a/doc/devel/calendar/evolution-calendar.sgml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - 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/doc/devel/calendar/public-reference.sgml b/doc/devel/calendar/public-reference.sgml deleted file mode 100644 index b880bd2972..0000000000 --- a/doc/devel/calendar/public-reference.sgml +++ /dev/null @@ -1,24 +0,0 @@ - - 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; - - - -- cgit v1.2.3