aboutsummaryrefslogtreecommitdiffstats
path: root/doc/devel
diff options
context:
space:
mode:
Diffstat (limited to 'doc/devel')
-rw-r--r--doc/devel/ChangeLog31
-rw-r--r--doc/devel/Makefile.am12
-rw-r--r--doc/devel/calendar/alarm-generation.sgml87
-rw-r--r--doc/devel/calendar/cal-client/Makefile.am101
-rw-r--r--doc/devel/calendar/cal-client/evolution-cal-client-decl.txt47
-rw-r--r--doc/devel/calendar/cal-client/evolution-cal-client-sections.txt12
-rw-r--r--doc/devel/calendar/cal-client/tmpl/cal-client.sgml71
-rw-r--r--doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml20
-rw-r--r--doc/devel/calendar/cal-util/Makefile.am115
-rw-r--r--doc/devel/calendar/cal-util/evolution-cal-util-decl.txt320
-rw-r--r--doc/devel/calendar/cal-util/evolution-cal-util-sections.txt51
-rw-r--r--doc/devel/calendar/cal-util/tmpl/cal-component.sgml189
-rw-r--r--doc/devel/calendar/cal-util/tmpl/cal-recur.sgml52
-rw-r--r--doc/devel/calendar/cal-util/tmpl/cal-util.sgml14
-rw-r--r--doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml231
-rw-r--r--doc/devel/calendar/cal-util/tmpl/timeutil.sgml84
16 files changed, 875 insertions, 562 deletions
diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog
index 85b7341bf0..fcad430d33 100644
--- a/doc/devel/ChangeLog
+++ b/doc/devel/ChangeLog
@@ -1,3 +1,34 @@
+2000-12-19 Federico Mena Quintero <federico@helixcode.com>
+
+ Added proper dependency lists to the gtk-doc mess.
+
+ * calendar/cal-client/Makefile.am (TARGET_DIR): Removed unused
+ variable.
+ (SOURCE_FILES): New variable with the list of source files we
+ depend on.
+ (IGNORED_SOURCE_HEADERS): New variable with the headers we ignore
+ for the gtkdoc-scan phase.
+ (scan_generated):
+ (tmpl_dependencies):
+ (tmpl_sources):
+ (tmpl_generated);
+ (sgml_dependencies):
+ (sgml_generated): Lists of stuff that is generated and that other
+ stuff depends on.
+ (all): Added the $(sgml_generated) as the final target.
+ (install-data-local): Added an installation hook; gtk-doc seems to
+ want some of its generated files to be installed.
+
+ * calendar/cal-client/evolution-cal-client-sections.txt: Updated.
+
+ * calendar/cal-util/Makefile.am: Made the same changes as for
+ calendar/cal-client/Makefile.am.
+
+ * calendar/cal-util/evolution-cal-util-sections.txt: Updated.
+
+ * Makefile.am (local_entities): Added alarm-generation.sgml.
+ (all): Made the main target be the html/index.html.
+
2000-12-18 Federico Mena Quintero <federico@helixcode.com>
* calendar/alarm-generation.sgml: New file with a description of
diff --git a/doc/devel/Makefile.am b/doc/devel/Makefile.am
index 0dd533057e..8e8ca1085c 100644
--- a/doc/devel/Makefile.am
+++ b/doc/devel/Makefile.am
@@ -22,6 +22,7 @@ content_files = \
# are used for dependency tracking.
local_entities = \
+ calendar/alarm-generation.sgml \
calendar/architecture.sgml \
calendar/evolution-calendar.sgml \
calendar/public-reference.sgml \
@@ -36,18 +37,15 @@ local_entities = \
EXTRA_DIST = \
$(content_files)
-all: evolution-devel-guide.html
+all: html/index.html
if ENABLE_GTK_DOC
-evolution-devel-guide.html: html/index.html
- -cd $(srcdir) && cp html/index.html evolution-devel-guide.html
-else
-evolution-devel-guide.html:
-endif
-
html/index.html: $(content_files) $(local_entities)
test -d $(srcdir)/html || mkdir $(srcdir)/html
-cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
+else
+html/index.html:
+endif
clean-local:
rm -f *~ *.bak *.signals *-unused.txt
diff --git a/doc/devel/calendar/alarm-generation.sgml b/doc/devel/calendar/alarm-generation.sgml
index 60bc78343e..77d35258da 100644
--- a/doc/devel/calendar/alarm-generation.sgml
+++ b/doc/devel/calendar/alarm-generation.sgml
@@ -41,7 +41,92 @@
<title>Generating trigger instances</title>
<para>
-
+ Generating absolute triggers is trivial; you just use the date
+ and time they specify. However, relative triggers are
+ associated to recurrence instances, so in order to generate
+ trigger instances we must generate the corresponding
+ recurrence instances and compute the trigger times based on
+ those.
+ </para>
+
+ <para>
+ Since relative triggers are specified as occurring a certain
+ amount of time before or after each of a calendar component's
+ recurrence instances, we can compute a trigger time by adding
+ or subtracting that amount of time to the corresponding
+ recurrence instance's time.
+ </para>
+
+ <para>
+ Recurrence instances are generated by specifying a range of
+ time and asking the Wombat to generate the instances that
+ occur within that range. We shall see that the range of time
+ in which instances occur is not necessarily the same range of
+ time in which those instances' alarm triggers occur.
+ </para>
+
+ <para>
+ Consider an alarm that is set to trigger 10 minutes before the
+ start time of an event's occurrence, that is, the trigger has
+ an offset of -10 minutes. Say this event recurs every hour at
+ 5 minutes past the hour: it would occur at 1:05, 2:05, 3:05,
+ etc.; the corresponding triggers would occur at 12:55, 1:55,
+ 2:55, etc. If we wish to compute the alarm triggers that
+ occur between 4:00 and 6:00 (which would be at 4:55 and 5:55),
+ then we cannot just generate recurrence instances between 4:00
+ and 6:00 because we will miss the 6:05 occurrence which
+ corresponds to the 5:55 trigger.
+ </para>
+
+ <para>
+ The solution is to expand the range of time on both sides to
+ fit the relative triggers that have the largest time periods.
+ If a trigger's offset is negative, like the -10 minutes in the
+ example above, then we must expand the
+ <emphasis>end</emphasis> of the time range: in the case above,
+ the range's ending time of 6:00 must be grown by 10 minutes to
+ 6:10 so that the last recurrence instance will be that of
+ 6:05; computing the trigger's offset we will get the 5:55
+ trigger, which is what we wanted. For triggers with positive
+ offsets, like if an alarm were to trigger 20 minutes after an
+ event's occurrence, we must expand the
+ <emphasis>start</emphasis> of the time range in an analogous
+ way, by subtracting the time offset from it.
+ </para>
+
+ <para>
+ Again, absolute triggers need no special computation. We can
+ just see if the trigger time is within the requested range of
+ time, and if so, we take that trigger occurrence into account
+ for the final result.
+ </para>
+ </sect1>
+
+ <sect1 id="alarm-trigger-generation-code">
+ <title>Alarm trigger generation code</title>
+
+ <para>
+ The main function to generate alarm trigger instances is
+ <function>generate_alarms_for_comp()</function> in
+ <filename>evolution/calendar/pcs/cal-backend-file.c</filename>.
+ This function calls <function>compute_alarm_range()</function>
+ to expand the specified range of time in the way described in
+ the previous section. It then generates the instances for
+ relative alarm triggers inside the
+ <function>add_alarm_occurrences_cb()</function> callback,
+ which is used by
+ <function>cal_recur_generate_instances()</function> with the
+ expanded range of time. The callback goes through all of the
+ calendar component's relative alarm triggers and adds the
+ trigger offsets to the occurrence's time; the results are
+ added as <structname>CalAlarmInstance</structname> structures
+ to the final list of trigger instances. Finally,
+ <function>generate_alarms_for_comp()</function> calls
+ <function>generate_absolute_triggers()</function>, which
+ simply adds the instances for absolute alarm triggers; these
+ are the absolute times that are within the time range that was
+ requested originally. In the very end, the list of instances
+ is sorted to produce nicer results.
</para>
</sect1>
</chapter>
diff --git a/doc/devel/calendar/cal-client/Makefile.am b/doc/devel/calendar/cal-client/Makefile.am
index 44d43639a8..363c15b326 100644
--- a/doc/devel/calendar/cal-client/Makefile.am
+++ b/doc/devel/calendar/cal-client/Makefile.am
@@ -1,11 +1,6 @@
-## Process this file with automake to produce Makefile.in
-
# The name of the module.
DOC_MODULE=evolution-cal-client
-# The top-level SGML file.
-DOC_MAIN_SGML_FILE=evolution-cal-client.sgml
-
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-client
@@ -22,41 +17,87 @@ LDFLAGS=" \
$(BONOBO_VFS_GNOME_LIBS) \
$(top_builddir)/calendar/cal-client/.libs/libcal-client.a \
$(top_builddir)/calendar/cal-util/.libs/libcal-util.a \
- $(top_builddir)/libical/src/libical/libical.a \
+ $(top_builddir)/libical/src/libical/.libs/libical.a \
$(top_builddir)/libversit/.libs/libversit.al \
"
-HTML_DIR=$(datadir)/gnome/html
+DOC_DIR=$(datadir)/gnome/html
-TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
+DOC_DIR_INSTALL_FILES = \
+ evolution-cal-client.args \
+ evolution-cal-client.hierarchy \
+ evolution-cal-client.signals \
+ evolution-cal-client.types \
+ evolution-cal-client-decl.txt \
+ evolution-cal-client-sections.txt
-tmpl_sources = \
- tmpl/cal-client.sgml \
- tmpl/evolution-cal-client-unused.sgml
+SOURCE_FILES = \
+ $(top_srcdir)/calendar/cal-client/cal-client.c \
+ $(top_srcdir)/calendar/cal-client/cal-client.h \
+ $(top_srcdir)/calendar/cal-client/cal-client-types.c \
+ $(top_srcdir)/calendar/cal-client/cal-client-types.h
-evolution_cal_client_docdir = $(HTML_DIR)
-evolution_cal_client_doc_DATA = \
+IGNORED_HEADER_FILES = \
+ cal-listener.h \
+ evolution-calendar.h
+
+scan_generated = \
+ evolution-cal-client-decl.txt \
+ evolution-cal-client.args \
evolution-cal-client.hierarchy \
- evolution-cal-client.types \
+ evolution-cal-client.signals \
+ evolution-cal-client.types
+
+tmpl_dependencies = \
evolution-cal-client-decl.txt \
- evolution-cal-client-sections.txt
+ evolution-cal-client-sections.txt \
+ evolution-cal-client.args \
+ evolution-cal-client.hierarchy \
+ evolution-cal-client.signals
-EXTRA_DIST = \
- $(evolution_cal_client_doc_DATA)
+tmpl_sources = \
+ tmpl/cal-client.sgml \
+ tmpl/evolution-cal-client-unused.sgml
-sgml/evolution-cal-client-doc.bottom: $(tmpl_sources)
- $(MAKE) sgml
+tmpl_generated = \
+ evolution-cal-client-unused.txt
-scan:
- -(cd $(srcdir) \
- && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \
- gtkdoc-scanobj --module=$(DOC_MODULE) \
- && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="cal-listener.h evolution-calendar.h" )
+sgml_dependencies = \
+ evolution-cal-client-decl.txt \
+ evolution-cal-client-sections.txt \
+ evolution-cal-client.args \
+ evolution-cal-client.hierarchy \
+ evolution-cal-client.signals \
+ tmpl/cal-client.sgml
+
+sgml_generated = \
+ sgml/cal-client.sgml \
+ sgml/evolution-cal-client-doc.bottom \
+ sgml/evolution-cal-client-doc.top \
+ sgml/object_index.sgml \
+ sgml/tree_index.sgml
-templates: scan
+EXTRA_DIST = \
+ evolution-cal-client.args \
+ evolution-cal-client.hierarchy \
+ evolution-cal-client.signals \
+ evolution-cal-client.types \
+ evolution-cal-client-decl.txt \
+ evolution-cal-client-sections.txt
+
+all: $(sgml_generated)
+
+scan $(scan_generated): $(SOURCE_FILES)
+ -(cd $(srcdir) \
+ && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \
+ gtkdoc-scanobj --module=$(DOC_MODULE) \
+ && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \
+ --ignore-headers="$(IGNORED_HEADER_FILES)" )
+
+templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies)
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
-sgml:
+sgml $(sgml_generated): $(sgml_dependencies)
cd $(srcdir) \
&& gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
@@ -66,6 +107,12 @@ clean-local:
maintainer-clean-local: clean
cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
+install-data-local:
+ $(mkinstalldirs) $(DOC_DIR)
+ for i in $(DOC_DIR_INSTALL_FILES); do \
+ $(INSTALL_DATA) $$i $(DOC_DIR); \
+ done
+
dist-hook:
mkdir $(distdir)/sgml
mkdir $(distdir)/tmpl
@@ -73,4 +120,4 @@ dist-hook:
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
-.PHONY : sgml templates scan
+.PHONY: scan templates sgml
diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt
index 0574d70678..498285a370 100644
--- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt
+++ b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt
@@ -24,6 +24,9 @@
<STRUCT>
<NAME>CalClientClass</NAME>
</STRUCT>
+<STRUCT>
+<NAME>CalClientPrivate</NAME>
+</STRUCT>
<ENUM>
<NAME>CalClientLoadStatus</NAME>
typedef enum {
@@ -47,7 +50,7 @@ struct CalClient {
GtkObject object;
/* Private data */
- gpointer priv;
+ CalClientPrivate *priv;
};
</STRUCT>
<FUNCTION>
@@ -76,6 +79,11 @@ CalClient *client, const char *str_uri
CalClient *client, const char *str_uri
</FUNCTION>
<FUNCTION>
+<NAME>cal_client_is_loaded</NAME>
+<RETURNS>gboolean </RETURNS>
+CalClient *client
+</FUNCTION>
+<FUNCTION>
<NAME>cal_client_get_n_objects</NAME>
<RETURNS>int </RETURNS>
CalClient *client, CalObjType type
@@ -86,21 +94,16 @@ CalClient *client, CalObjType type
CalClient *client,const char *uid,CalComponent **comp
</FUNCTION>
<FUNCTION>
-<NAME>cal_client_get_uid_by_pilot_id</NAME>
-<RETURNS>CalClientGetStatus </RETURNS>
-CalClient *client,unsigned long pilot_id,char **uid
-</FUNCTION>
-<FUNCTION>
-<NAME>cal_client_update_pilot_id</NAME>
-<RETURNS>void </RETURNS>
-CalClient *client, char *uid,unsigned long pilot_id,unsigned long pilot_status
-</FUNCTION>
-<FUNCTION>
<NAME>cal_client_get_uids</NAME>
<RETURNS>GList *</RETURNS>
CalClient *client, CalObjType type
</FUNCTION>
<FUNCTION>
+<NAME>cal_client_get_changes</NAME>
+<RETURNS>GList *</RETURNS>
+CalClient *client, CalObjType type, const char *change_id
+</FUNCTION>
+<FUNCTION>
<NAME>cal_client_get_objects_in_range</NAME>
<RETURNS>GList *</RETURNS>
CalClient *client, CalObjType type,time_t start, time_t end
@@ -112,13 +115,18 @@ CalClient *client, CalObjType type,time_t start, time_t end,CalRecurInstanceFn c
</FUNCTION>
<FUNCTION>
<NAME>cal_client_get_alarms_in_range</NAME>
-<RETURNS>GList *</RETURNS>
+<RETURNS>GSList *</RETURNS>
CalClient *client, time_t start, time_t end
</FUNCTION>
<FUNCTION>
+<NAME>cal_client_free_alarms</NAME>
+<RETURNS>void </RETURNS>
+GSList *comp_alarms
+</FUNCTION>
+<FUNCTION>
<NAME>cal_client_get_alarms_for_object</NAME>
<RETURNS>gboolean </RETURNS>
-CalClient *client, const char *uid,time_t start, time_t end,GList **alarms
+CalClient *client, const char *uid,time_t start, time_t end,CalComponentAlarms **alarms
</FUNCTION>
<FUNCTION>
<NAME>cal_client_update_object</NAME>
@@ -130,3 +138,16 @@ CalClient *client, CalComponent *comp
<RETURNS>gboolean </RETURNS>
CalClient *client, const char *uid
</FUNCTION>
+<ENUM>
+<NAME>CalClientChangeType</NAME>
+typedef enum {
+ CAL_CLIENT_CHANGE_ADDED = 1 << 0,
+ CAL_CLIENT_CHANGE_MODIFIED = 1 << 1,
+ CAL_CLIENT_CHANGE_DELETED = 1 << 2
+} CalClientChangeType;
+</ENUM>
+<FUNCTION>
+<NAME>cal_client_change_list_free</NAME>
+<RETURNS>void </RETURNS>
+GList *list
+</FUNCTION>
diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt
index c37b223247..3e4eafbf48 100644
--- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt
+++ b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt
@@ -7,17 +7,22 @@ CAL_CLIENT
CalClientLoadStatus
CalClientGetStatus
+
+CalClientChangeType
+
cal_client_new
cal_client_load_calendar
cal_client_create_calendar
+cal_client_is_loaded
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_uid_by_pilot_id
-cal_client_update_pilot_id
-cal_client_get_uids
cal_client_get_alarms_in_range
+cal_client_free_alarms
cal_client_get_alarms_for_object
cal_client_update_object
cal_client_remove_object
@@ -33,5 +38,6 @@ cal_client_construct
<SUBSECTION Private>
CalClient
+CalClientPrivate
</SECTION>
diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml
index 06469ff3ee..6de1ab8045 100644
--- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml
+++ b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml
@@ -84,6 +84,15 @@ GTK+ object for communication with personal calendar server.
the requested object. This could indicate a bug in the calendar
client libraries or in the Wombat server.
+<!-- ##### ENUM CalClientChangeType ##### -->
+<para>
+
+</para>
+
+@CAL_CLIENT_CHANGE_ADDED:
+@CAL_CLIENT_CHANGE_MODIFIED:
+@CAL_CLIENT_CHANGE_DELETED:
+
<!-- ##### FUNCTION cal_client_new ##### -->
<para>
@@ -112,6 +121,15 @@ GTK+ object for communication with personal calendar server.
@Returns:
+<!-- ##### FUNCTION cal_client_is_loaded ##### -->
+<para>
+
+</para>
+
+@client:
+@Returns:
+
+
<!-- ##### FUNCTION cal_client_get_n_objects ##### -->
<para>
@@ -122,6 +140,16 @@ GTK+ object for communication with personal calendar server.
@Returns:
+<!-- ##### FUNCTION cal_client_get_uids ##### -->
+<para>
+
+</para>
+
+@client:
+@type:
+@Returns:
+
+
<!-- ##### FUNCTION cal_client_get_object ##### -->
<para>
@@ -135,72 +163,67 @@ GTK+ object for communication with personal calendar server.
@ico:
-<!-- ##### FUNCTION cal_client_get_objects_in_range ##### -->
+<!-- ##### FUNCTION cal_client_get_changes ##### -->
<para>
</para>
@client:
@type:
-@start:
-@end:
+@change_id:
@Returns:
-<!-- ##### FUNCTION cal_client_generate_instances ##### -->
+<!-- ##### FUNCTION cal_client_change_list_free ##### -->
<para>
</para>
-@client:
-@type:
-@start:
-@end:
-@cb:
-@cb_data:
+@list:
-<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### -->
+<!-- ##### FUNCTION cal_client_get_objects_in_range ##### -->
<para>
</para>
@client:
-@pilot_id:
-@uid:
+@type:
+@start:
+@end:
@Returns:
-<!-- ##### FUNCTION cal_client_update_pilot_id ##### -->
+<!-- ##### FUNCTION cal_client_generate_instances ##### -->
<para>
</para>
@client:
-@uid:
-@pilot_id:
-@pilot_status:
+@type:
+@start:
+@end:
+@cb:
+@cb_data:
-<!-- ##### FUNCTION cal_client_get_uids ##### -->
+<!-- ##### FUNCTION cal_client_get_alarms_in_range ##### -->
<para>
</para>
@client:
-@type:
+@start:
+@end:
@Returns:
-<!-- ##### FUNCTION cal_client_get_alarms_in_range ##### -->
+<!-- ##### FUNCTION cal_client_free_alarms ##### -->
<para>
</para>
-@client:
-@start:
-@end:
-@Returns:
+@comp_alarms:
<!-- ##### FUNCTION cal_client_get_alarms_for_object ##### -->
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
index 5576dbd57f..a0c23894d9 100644
--- a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
+++ b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
@@ -1,3 +1,13 @@
+<!-- ##### FUNCTION cal_client_update_pilot_id ##### -->
+<para>
+
+</para>
+
+@client:
+@uid:
+@pilot_id:
+@pilot_status:
+
<!-- ##### FUNCTION cal_client_get_events_in_range ##### -->
<para>
@@ -8,3 +18,13 @@
@end:
@Returns:
+<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### -->
+<para>
+
+</para>
+
+@client:
+@pilot_id:
+@uid:
+@Returns:
+
diff --git a/doc/devel/calendar/cal-util/Makefile.am b/doc/devel/calendar/cal-util/Makefile.am
index 8861aa03cb..b7308800c8 100644
--- a/doc/devel/calendar/cal-util/Makefile.am
+++ b/doc/devel/calendar/cal-util/Makefile.am
@@ -1,11 +1,6 @@
-## Process this file with automake to produce Makefile.in
-
# The name of the module.
DOC_MODULE=evolution-cal-util
-# The top-level SGML file.
-DOC_MAIN_SGML_FILE=evolution-cal-util.sgml
-
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-util
@@ -21,41 +16,99 @@ CFLAGS =" \
LDFLAGS=" \
$(BONOBO_VFS_GNOME_LIBS) \
$(top_builddir)/calendar/cal-util/.libs/libcal-util.a \
- $(top_builddir)/libical/src/libical/libical.a \
+ $(top_builddir)/libical/src/libical/.libs/libical.a \
$(top_builddir)/libversit/.libs/libversit.al \
"
-HTML_DIR=$(datadir)/gnome/html
+DOC_DIR=$(datadir)/gnome/html
+
+DOC_DIR_INSTALL_FILES = \
+ evolution-cal-util.args \
+ evolution-cal-util.hierarchy \
+ evolution-cal-util.signals \
+ evolution-cal-util.types \
+ evolution-cal-util-decl.txt \
+ evolution-cal-util-sections.txt
+
+SOURCE_FILES = \
+ $(top_srcdir)/calendar/cal-util/cal-component.c \
+ $(top_srcdir)/calendar/cal-util/cal-component.h \
+ $(top_srcdir)/calendar/cal-util/cal-recur.c \
+ $(top_srcdir)/calendar/cal-util/cal-recur.h \
+ $(top_srcdir)/calendar/cal-util/cal-util.c \
+ $(top_srcdir)/calendar/cal-util/cal-util.h \
+ $(top_srcdir)/calendar/cal-util/timeutil.c \
+ $(top_srcdir)/calendar/cal-util/timeutil.h
+
+IGNORED_HEADER_FILES = \
+ calobj.h
+
+scan_generated = \
+ evolution-cal-util-decl.txt \
+ evolution-cal-util.args \
+ evolution-cal-util.hierarchy \
+ evolution-cal-util.signals \
+ evolution-cal-util.types
-TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
+tmpl_dependencies = \
+ evolution-cal-util-decl.txt \
+ evolution-cal-util-sections.txt \
+ evolution-cal-util.args \
+ evolution-cal-util.hierarchy \
+ evolution-cal-util.signals
tmpl_sources = \
+ tmpl/cal-component.sgml \
+ tmpl/cal-recur.sgml \
tmpl/cal-util.sgml \
- tmpl/evolution-cal-util-unused.sgml
+ tmpl/evolution-cal-util-unused.sgml \
+ tmpl/timeutil.sgml
-evolution_cal_util_docdir = $(HTML_DIR)
-evolution_cal_util_doc_DATA = \
- evolution-cal-util.hierarchy \
- evolution-cal-util.types \
+tmpl_generated = \
+ evolution-cal-util-unused.txt
+
+sgml_dependencies = \
evolution-cal-util-decl.txt \
- evolution-cal-util-sections.txt
+ evolution-cal-util-sections.txt \
+ evolution-cal-util.args \
+ evolution-cal-util.hierarchy \
+ evolution-cal-util.signals \
+ tmpl/cal-component.sgml \
+ tmpl/cal-recur.sgml \
+ tmpl/cal-util.sgml \
+ tmpl/timeutil.sgml
+
+sgml_generated = \
+ sgml/cal-component.sgml \
+ sgml/cal-recur.sgml \
+ sgml/cal-util.sgml \
+ sgml/evolution-cal-util-doc.bottom \
+ sgml/evolution-cal-util-doc.top \
+ sgml/object_index.sgml \
+ sgml/timeutil.sgml \
+ sgml/tree_index.sgml
EXTRA_DIST = \
- $(evolution_cal_util_doc_DATA)
-
-sgml/evolution-cal-util-doc.bottom: $(tmpl_sources)
- $(MAKE) sgml
-
-scan:
- -(cd $(srcdir) \
- && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \
- gtkdoc-scanobj --module=$(DOC_MODULE) \
- && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="calobj.h icalendar-save.h icalendar.h" )
-
-templates: scan
+ evolution-cal-util.args \
+ evolution-cal-util.hierarchy \
+ evolution-cal-util.signals \
+ evolution-cal-util.types \
+ evolution-cal-util-decl.txt \
+ evolution-cal-util-sections.txt
+
+all: $(sgml_generated)
+
+scan $(scan_generated): $(SOURCE_FILES)
+ -(cd $(srcdir) \
+ && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \
+ gtkdoc-scanobj --module=$(DOC_MODULE) \
+ && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \
+ --ignore-headers="$(IGNORED_HEADER_FILES)" )
+
+templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies)
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
-sgml:
+sgml $(sgml_generated): $(sgml_dependencies)
cd $(srcdir) \
&& gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
@@ -65,6 +118,12 @@ clean-local:
maintainer-clean-local: clean
cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
+install-data-local:
+ $(mkinstalldirs) $(DOC_DIR)
+ for i in $(DOC_DIR_INSTALL_FILES); do \
+ $(INSTALL_DATA) $$i $(DOC_DIR); \
+ done
+
dist-hook:
mkdir $(distdir)/sgml
mkdir $(distdir)/tmpl
@@ -72,4 +131,4 @@ dist-hook:
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
-.PHONY : sgml templates scan
+.PHONY: scan templates sgml
diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt
index eb108b868f..f190d325fc 100644
--- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt
+++ b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt
@@ -114,9 +114,6 @@ typedef enum {
} CalComponentTransparency;
</ENUM>
<STRUCT>
-<NAME>CalComponentAlarm</NAME>
-</STRUCT>
-<STRUCT>
<NAME>CalComponent</NAME>
</STRUCT>
<STRUCT>
@@ -305,16 +302,36 @@ CalComponent *comp, GSList **exdate_list
CalComponent *comp, GSList *exdate_list
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_has_exdates</NAME>
+<RETURNS>gboolean </RETURNS>
+CalComponent *comp
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_get_exrule_list</NAME>
<RETURNS>void </RETURNS>
CalComponent *comp, GSList **recur_list
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_get_exrule_property_list</NAME>
+<RETURNS>void </RETURNS>
+CalComponent *comp, GSList **recur_list
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_set_exrule_list</NAME>
<RETURNS>void </RETURNS>
CalComponent *comp, GSList *recur_list
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_has_exrules</NAME>
+<RETURNS>gboolean </RETURNS>
+CalComponent *comp
+</FUNCTION>
+<FUNCTION>
+<NAME>cal_component_has_exceptions</NAME>
+<RETURNS>gboolean </RETURNS>
+CalComponent *comp
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_get_geo</NAME>
<RETURNS>void </RETURNS>
CalComponent *comp, struct icalgeotype **geo
@@ -375,6 +392,11 @@ CalComponent *comp
CalComponent *comp, GSList **recur_list
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_get_rrule_property_list</NAME>
+<RETURNS>void </RETURNS>
+CalComponent *comp, GSList **recur_list
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_set_rrule_list</NAME>
<RETURNS>void </RETURNS>
CalComponent *comp, GSList *recur_list
@@ -385,6 +407,11 @@ CalComponent *comp, GSList *recur_list
CalComponent *comp
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_has_recurrences</NAME>
+<RETURNS>gboolean </RETURNS>
+CalComponent *comp
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_get_sequence</NAME>
<RETURNS>void </RETURNS>
CalComponent *comp, int **sequence
@@ -395,6 +422,16 @@ CalComponent *comp, int **sequence
CalComponent *comp, int *sequence
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_get_status</NAME>
+<RETURNS>void </RETURNS>
+CalComponent *comp, icalproperty_status *status
+</FUNCTION>
+<FUNCTION>
+<NAME>cal_component_set_status</NAME>
+<RETURNS>void </RETURNS>
+CalComponent *comp, icalproperty_status status
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_get_summary</NAME>
<RETURNS>void </RETURNS>
CalComponent *comp, CalComponentText *summary
@@ -425,26 +462,6 @@ CalComponent *comp, const char **url
CalComponent *comp, const char *url
</FUNCTION>
<FUNCTION>
-<NAME>cal_component_get_pilot_id</NAME>
-<RETURNS>void </RETURNS>
-CalComponent *comp, unsigned long *pilot_id
-</FUNCTION>
-<FUNCTION>
-<NAME>cal_component_set_pilot_id</NAME>
-<RETURNS>void </RETURNS>
-CalComponent *comp, unsigned long pilot_id
-</FUNCTION>
-<FUNCTION>
-<NAME>cal_component_get_pilot_status</NAME>
-<RETURNS>void </RETURNS>
-CalComponent *comp, unsigned long *pilot_status
-</FUNCTION>
-<FUNCTION>
-<NAME>cal_component_set_pilot_status</NAME>
-<RETURNS>void </RETURNS>
-CalComponent *comp, unsigned long pilot_status
-</FUNCTION>
-<FUNCTION>
<NAME>cal_component_free_categories_list</NAME>
<RETURNS>void </RETURNS>
GSList *categ_list
@@ -499,167 +516,119 @@ int *sequence
<RETURNS>void </RETURNS>
GSList *text_list
</FUNCTION>
+<STRUCT>
+<NAME>CalComponentAlarm</NAME>
+</STRUCT>
+<TYPEDEF>
+<NAME>CalAlarmInstance</NAME>
+typedef struct {
+ /* UID of the alarm that triggered */
+ const char *auid;
+
+ /* Trigger time, i.e. "5 minutes before the appointment" */
+ time_t trigger;
+
+ /* Actual event occurrence to which this trigger corresponds */
+ time_t occur;
+} CalAlarmInstance;
+</TYPEDEF>
+<TYPEDEF>
+<NAME>CalComponentAlarms</NAME>
+typedef struct {
+ /* The actual component */
+ CalComponent *comp;
+
+ /* List of CalAlarmInstance structures */
+ GSList *alarms;
+} CalComponentAlarms;
+</TYPEDEF>
<ENUM>
-<NAME>CalComponentAlarmAction</NAME>
-typedef enum {
- CAL_COMPONENT_ALARM_NONE,
- CAL_COMPONENT_ALARM_AUDIO,
- CAL_COMPONENT_ALARM_DISPLAY,
- CAL_COMPONENT_ALARM_EMAIL,
- CAL_COMPONENT_ALARM_PROCEDURE,
- CAL_COMPONENT_ALARM_UNKNOWN
-} CalComponentAlarmAction;
-</ENUM>
-<ENUM>
-<NAME>CalComponentAlarmTriggerType</NAME>
+<NAME>CalAlarmAction</NAME>
typedef enum {
- CAL_COMPONENT_ALARM_TRIGGER_RELATIVE,
- CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE
-} CalComponentAlarmTriggerType;
+ CAL_ALARM_NONE,
+ CAL_ALARM_AUDIO,
+ CAL_ALARM_DISPLAY,
+ CAL_ALARM_EMAIL,
+ CAL_ALARM_PROCEDURE,
+ CAL_ALARM_UNKNOWN
+} CalAlarmAction;
</ENUM>
<ENUM>
-<NAME>CalComponentAlarmTriggerRelated</NAME>
+<NAME>CalAlarmTriggerType</NAME>
typedef enum {
- CAL_COMPONENT_ALARM_TRIGGER_RELATED_START,
- CAL_COMPONENT_ALARM_TRIGGER_RELATED_END
-} CalComponentAlarmTriggerRelated;
+ CAL_ALARM_TRIGGER_NONE,
+ CAL_ALARM_TRIGGER_RELATIVE_START,
+ CAL_ALARM_TRIGGER_RELATIVE_END,
+ CAL_ALARM_TRIGGER_ABSOLUTE
+} CalAlarmTriggerType;
</ENUM>
<TYPEDEF>
-<NAME>CalComponentAlarmTrigger</NAME>
+<NAME>CalAlarmTrigger</NAME>
typedef struct {
- CalComponentAlarmTriggerType type;
+ CalAlarmTriggerType type;
union {
- struct {
- struct icaldurationtype duration;
- CalComponentAlarmTriggerRelated related;
- } relative;
-
- struct icaltimetype absolute;
+ struct icaldurationtype rel_duration;
+ struct icaltimetype abs_time;
} u;
-} CalComponentAlarmTrigger;
+} CalAlarmTrigger;
</TYPEDEF>
<FUNCTION>
-<NAME>cal_component_get_first_alarm</NAME>
-<RETURNS>CalComponentAlarm *</RETURNS>
+<NAME>cal_component_has_alarms</NAME>
+<RETURNS>gboolean </RETURNS>
CalComponent *comp
</FUNCTION>
<FUNCTION>
-<NAME>cal_component_get_next_alarm</NAME>
-<RETURNS>CalComponentAlarm *</RETURNS>
+<NAME>cal_component_get_alarm_uids</NAME>
+<RETURNS>GList *</RETURNS>
CalComponent *comp
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_get_alarm</NAME>
+<RETURNS>CalComponentAlarm *</RETURNS>
+CalComponent *comp, const char *auid
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_alarm_free</NAME>
<RETURNS>void </RETURNS>
CalComponentAlarm *alarm
</FUNCTION>
<FUNCTION>
+<NAME>cal_component_alarms_free</NAME>
+<RETURNS>void </RETURNS>
+CalComponentAlarms *alarms
+</FUNCTION>
+<FUNCTION>
+<NAME>cal_component_alarm_get_uid</NAME>
+<RETURNS>const char *</RETURNS>
+CalComponentAlarm *alarm
+</FUNCTION>
+<FUNCTION>
<NAME>cal_component_alarm_get_action</NAME>
<RETURNS>void </RETURNS>
-CalComponentAlarm *alarm, CalComponentAlarmAction *action
+CalComponentAlarm *alarm, CalAlarmAction *action
</FUNCTION>
<FUNCTION>
<NAME>cal_component_alarm_set_action</NAME>
<RETURNS>void </RETURNS>
-CalComponentAlarm *alarm, CalComponentAlarmAction action
+CalComponentAlarm *alarm, CalAlarmAction action
</FUNCTION>
<FUNCTION>
<NAME>cal_component_alarm_get_trigger</NAME>
<RETURNS>void </RETURNS>
-CalComponentAlarm *alarm, CalComponentAlarmTrigger **trigger
+CalComponentAlarm *alarm, CalAlarmTrigger *trigger
</FUNCTION>
<FUNCTION>
<NAME>cal_component_alarm_set_trigger</NAME>
<RETURNS>void </RETURNS>
-CalComponentAlarm *alarm, CalComponentAlarmTrigger *trigger
-</FUNCTION>
-<FUNCTION>
-<NAME>cal_component_alarm_free_trigger</NAME>
-<RETURNS>void </RETURNS>
-CalComponentAlarmTrigger *trigger
+CalComponentAlarm *alarm, CalAlarmTrigger trigger
</FUNCTION>
-<ENUM>
-<NAME>CalRecurType</NAME>
-typedef enum {
- CAL_RECUR_YEARLY,
- CAL_RECUR_MONTHLY,
- CAL_RECUR_WEEKLY,
- CAL_RECUR_DAILY,
- CAL_RECUR_HOURLY,
- CAL_RECUR_MINUTELY,
- CAL_RECUR_SECONDLY
-} CalRecurType;
-</ENUM>
-<TYPEDEF>
-<NAME>CalRecurrence</NAME>
-typedef struct {
- CalRecurType type;
-
- int interval;
-
- /* Specifies the end of the recurrence. No occurrences are generated
- after this date. If it is 0, the event recurs forever. */
- time_t enddate;
-
- /* WKST property - the week start day: 0 = Monday to 6 = Sunday. */
- gint week_start_day;
-
-
- /* NOTE: I've used GList's here, but it doesn't matter if we use
- other data structures like arrays. The code should be easy to
- change. So long as it is easy to see if the modifier is set. */
-
- /* For BYMONTH modifier. A list of GINT_TO_POINTERs, 0-11. */
- GList *bymonth;
-
- /* For BYWEEKNO modifier. A list of GINT_TO_POINTERs, [+-]1-53. */
- GList *byweekno;
-
- /* For BYYEARDAY modifier. A list of GINT_TO_POINTERs, [+-]1-366. */
- GList *byyearday;
-
- /* For BYMONTHDAY modifier. A list of GINT_TO_POINTERs, [+-]1-31. */
- GList *bymonthday;
-
- /* For BYDAY modifier. A list of GINT_TO_POINTERs, in pairs.
- The first of each pair is the weekday, 0 = Monday to 6 = Sunday.
- The second of each pair is the week number [+-]0-53. */
- GList *byday;
-
- /* For BYHOUR modifier. A list of GINT_TO_POINTERs, 0-23. */
- GList *byhour;
-
- /* For BYMINUTE modifier. A list of GINT_TO_POINTERs, 0-59. */
- GList *byminute;
-
- /* For BYSECOND modifier. A list of GINT_TO_POINTERs, 0-60. */
- GList *bysecond;
-
- /* For BYSETPOS modifier. A list of GINT_TO_POINTERs, +ve or -ve. */
- GList *bysetpos;
-} CalRecurrence;
-</TYPEDEF>
-<STRUCT>
-<NAME>CalObjTime</NAME>
-</STRUCT>
-<STRUCT>
-<NAME>CalObjTime</NAME>
-struct CalObjTime {
- guint16 year;
- guint8 month; /* 0 - 11 */
- guint8 day; /* 1 - 31 */
- guint8 hour; /* 0 - 23 */
- guint8 minute; /* 0 - 59 */
- guint8 second; /* 0 - 59 (maybe 60 for leap second) */
-};
-</STRUCT>
<USER_FUNCTION>
<NAME>CalRecurInstanceFn</NAME>
<RETURNS>gboolean </RETURNS>
CalComponent *comp,
time_t instance_start,
- time_t instace_end,
+ time_t instance_end,
gpointer data
</USER_FUNCTION>
<FUNCTION>
@@ -667,16 +636,6 @@ CalComponent *comp,
<RETURNS>void </RETURNS>
CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data
</FUNCTION>
-<FUNCTION>
-<NAME>cal_recur_from_icalrecurrencetype</NAME>
-<RETURNS>CalRecurrence *</RETURNS>
-struct icalrecurrencetype *ir
-</FUNCTION>
-<FUNCTION>
-<NAME>cal_recur_free</NAME>
-<RETURNS>void </RETURNS>
-CalRecurrence *r
-</FUNCTION>
<TYPEDEF>
<NAME>CalObjInstance</NAME>
typedef struct {
@@ -690,22 +649,6 @@ typedef struct {
<RETURNS>void </RETURNS>
GList *list
</FUNCTION>
-<TYPEDEF>
-<NAME>CalAlarmInstance</NAME>
-typedef struct {
- char *uid; /* UID of object */
-#if 0
- enum AlarmType type; /* Type of alarm */
-#endif
- time_t trigger; /* Alarm trigger time */
- time_t occur; /* Occurrence time */
-} CalAlarmInstance;
-</TYPEDEF>
-<FUNCTION>
-<NAME>cal_alarm_instance_list_free</NAME>
-<RETURNS>void </RETURNS>
-GList *list
-</FUNCTION>
<ENUM>
<NAME>CalObjType</NAME>
typedef enum {
@@ -721,41 +664,11 @@ typedef enum {
GList *list
</FUNCTION>
<FUNCTION>
-<NAME>time_from_icaltimetype</NAME>
-<RETURNS>time_t </RETURNS>
-struct icaltimetype itt
-</FUNCTION>
-<FUNCTION>
-<NAME>time_from_isodate</NAME>
-<RETURNS>time_t </RETURNS>
-char *str
-</FUNCTION>
-<FUNCTION>
-<NAME>time_from_start_duration</NAME>
-<RETURNS>time_t </RETURNS>
-time_t start, char *duration
-</FUNCTION>
-<FUNCTION>
<NAME>isodate_from_time_t</NAME>
<RETURNS>char *</RETURNS>
time_t t
</FUNCTION>
<FUNCTION>
-<NAME>get_time_t_hour</NAME>
-<RETURNS>int </RETURNS>
-time_t t
-</FUNCTION>
-<FUNCTION>
-<NAME>isodiff_to_secs</NAME>
-<RETURNS>int </RETURNS>
-char *str
-</FUNCTION>
-<FUNCTION>
-<NAME>isodiff_from_secs</NAME>
-<RETURNS>char *</RETURNS>
-int secs
-</FUNCTION>
-<FUNCTION>
<NAME>time_add_minutes</NAME>
<RETURNS>time_t </RETURNS>
time_t time, int minutes
@@ -781,11 +694,6 @@ time_t time, int months
time_t time, int years
</FUNCTION>
<FUNCTION>
-<NAME>format_simple_hour</NAME>
-<RETURNS>char *</RETURNS>
-int hour, int use_am_pm
-</FUNCTION>
-<FUNCTION>
<NAME>time_days_in_month</NAME>
<RETURNS>int </RETURNS>
int year, int month
@@ -796,11 +704,6 @@ int year, int month
int year, int month, int day
</FUNCTION>
<FUNCTION>
-<NAME>time_day_hour</NAME>
-<RETURNS>time_t </RETURNS>
-time_t t, int hour
-</FUNCTION>
-<FUNCTION>
<NAME>time_year_begin</NAME>
<RETURNS>time_t </RETURNS>
time_t t
@@ -841,11 +744,6 @@ time_t t
time_t t
</FUNCTION>
<FUNCTION>
-<NAME>parse_date</NAME>
-<RETURNS>time_t </RETURNS>
-char *str
-</FUNCTION>
-<FUNCTION>
<NAME>print_time_t</NAME>
<RETURNS>void </RETURNS>
time_t t
diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt
index cd928fc7e3..130209e71c 100644
--- a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt
+++ b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt
@@ -11,8 +11,6 @@ CalComponentPeriodType
CalComponentPeriod
CalComponentText
CalComponentTransparency
-CalComponentAlarm
-CalComponentPrivate
cal_component_gen_uid
cal_component_new
@@ -47,8 +45,12 @@ 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
@@ -61,21 +63,22 @@ 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_get_pilot_id
-cal_component_set_pilot_id
-cal_component_get_pilot_status
-cal_component_set_pilot_status
+<SUBSECTION Functions to free returned values>
cal_component_free_categories_list
cal_component_free_datetime
cal_component_free_exdate_list
@@ -88,19 +91,24 @@ cal_component_free_recur_list
cal_component_free_sequence
cal_component_free_text_list
-CalComponentAlarmAction
-CalComponentAlarmTriggerType
-CalComponentAlarmTriggerRelated
-CalComponentAlarmTrigger
+<SUBSECTION Alarms>
+CalComponentAlarm
+CalAlarmInstance
+CalComponentAlarms
+CalAlarmAction
+CalAlarmTriggerType
+CalAlarmTrigger
-cal_component_get_first_alarm
-cal_component_get_next_alarm
+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_alarm_free_trigger
<SUBSECTION Standard>
CAL_COMPONENT_TYPE
@@ -111,48 +119,34 @@ cal_component_get_type
<SUBSECTION Private>
CalComponent
+CalComponentPrivate
</SECTION>
<SECTION>
<FILE>cal-recur</FILE>
-CalRecurType
-CalRecurrence
-CalObjTime
CalRecurInstanceFn
cal_recur_generate_instances
-cal_recur_from_icalrecurrencetype
-cal_recur_free
</SECTION>
<SECTION>
<FILE>cal-util</FILE>
CalObjInstance
cal_obj_instance_list_free
-CalAlarmInstance
-cal_alarm_instance_list_free
CalObjType
cal_obj_uid_list_free
</SECTION>
<SECTION>
<FILE>timeutil</FILE>
-time_from_icaltimetype
-time_from_isodate
-time_from_start_duration
isodate_from_time_t
-get_time_t_hour
-isodiff_to_secs
-isodiff_from_secs
time_add_minutes
time_add_day
time_add_week
time_add_month
time_add_year
-format_simple_hour
time_days_in_month
time_from_day
-time_day_hour
time_year_begin
time_year_end
time_month_begin
@@ -161,6 +155,5 @@ time_week_begin
time_week_end
time_day_begin
time_day_end
-parse_date
print_time_t
</SECTION>
diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml
index 56a04b02a0..c429e22a9c 100644
--- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml
+++ b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml
@@ -85,7 +85,6 @@ RFC 2445 iCalendar component object.
@CAL_COMPONENT_NO_TYPE: Returned from cal_component_get_vtype() to
indicate an uninitialized #CalComponent object.
-
@CAL_COMPONENT_EVENT: Indicates a VEVENT component.
@CAL_COMPONENT_TODO: Indicates a VTODO component.
@CAL_COMPONENT_JOURNAL: Indicates a VJOURNAL component.
@@ -126,11 +125,9 @@ RFC 2445 iCalendar component object.
@CAL_COMPONENT_CLASS_NONE: Indicates that no access classification has
been set for the corresponding component.
-
@CAL_COMPONENT_CLASS_PUBLIC: Public access.
@CAL_COMPONENT_CLASS_PRIVATE: Private access.
@CAL_COMPONENT_CLASS_CONFIDENTIAL: Confidential access.
-
@CAL_COMPONENT_CLASS_UNKNOWN: Unknown access classification value,
used when &libical; returns something #CalComponent does not know
about.
@@ -148,7 +145,6 @@ RFC 2445 iCalendar component object.
@CAL_COMPONENT_PERIOD_DATETIME: Indicates that the period is specified
by starting and ending date/time values.
-
@CAL_COMPONENT_PERIOD_DURATION: Indicates that the period is specified
as a starding date/time and a duration value.
@@ -175,18 +171,6 @@ RFC 2445 iCalendar component object.
@CAL_COMPONENT_TRANSP_OPAQUE:
@CAL_COMPONENT_TRANSP_UNKNOWN:
-<!-- ##### STRUCT CalComponentAlarm ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT CalComponentPrivate ##### -->
-<para>
-
-</para>
-
-
<!-- ##### FUNCTION cal_component_gen_uid ##### -->
<para>
@@ -482,6 +466,15 @@ RFC 2445 iCalendar component object.
@exdate_list:
+<!-- ##### FUNCTION cal_component_has_exdates ##### -->
+<para>
+
+</para>
+
+@comp:
+@Returns:
+
+
<!-- ##### FUNCTION cal_component_get_exrule_list ##### -->
<para>
@@ -491,6 +484,15 @@ RFC 2445 iCalendar component object.
@recur_list:
+<!-- ##### FUNCTION cal_component_get_exrule_property_list ##### -->
+<para>
+
+</para>
+
+@comp:
+@recur_list:
+
+
<!-- ##### FUNCTION cal_component_set_exrule_list ##### -->
<para>
@@ -500,6 +502,24 @@ RFC 2445 iCalendar component object.
@recur_list:
+<!-- ##### FUNCTION cal_component_has_exrules ##### -->
+<para>
+
+</para>
+
+@comp:
+@Returns:
+
+
+<!-- ##### FUNCTION cal_component_has_exceptions ##### -->
+<para>
+
+</para>
+
+@comp:
+@Returns:
+
+
<!-- ##### FUNCTION cal_component_get_geo ##### -->
<para>
@@ -608,7 +628,7 @@ RFC 2445 iCalendar component object.
@recur_list:
-<!-- ##### FUNCTION cal_component_set_rrule_list ##### -->
+<!-- ##### FUNCTION cal_component_get_rrule_property_list ##### -->
<para>
</para>
@@ -617,121 +637,121 @@ RFC 2445 iCalendar component object.
@recur_list:
-<!-- ##### FUNCTION cal_component_has_rrules ##### -->
+<!-- ##### FUNCTION cal_component_set_rrule_list ##### -->
<para>
</para>
@comp:
-@Returns:
+@recur_list:
-<!-- ##### FUNCTION cal_component_get_sequence ##### -->
+<!-- ##### FUNCTION cal_component_has_rrules ##### -->
<para>
</para>
@comp:
-@sequence:
+@Returns:
-<!-- ##### FUNCTION cal_component_set_sequence ##### -->
+<!-- ##### FUNCTION cal_component_has_recurrences ##### -->
<para>
</para>
@comp:
-@sequence:
+@Returns:
-<!-- ##### FUNCTION cal_component_get_summary ##### -->
+<!-- ##### FUNCTION cal_component_get_sequence ##### -->
<para>
</para>
@comp:
-@summary:
+@sequence:
-<!-- ##### FUNCTION cal_component_set_summary ##### -->
+<!-- ##### FUNCTION cal_component_set_sequence ##### -->
<para>
</para>
@comp:
-@summary:
+@sequence:
-<!-- ##### FUNCTION cal_component_get_transparency ##### -->
+<!-- ##### FUNCTION cal_component_get_status ##### -->
<para>
</para>
@comp:
-@transp:
+@status:
-<!-- ##### FUNCTION cal_component_set_transparency ##### -->
+<!-- ##### FUNCTION cal_component_set_status ##### -->
<para>
</para>
@comp:
-@transp:
+@status:
-<!-- ##### FUNCTION cal_component_get_url ##### -->
+<!-- ##### FUNCTION cal_component_get_summary ##### -->
<para>
</para>
@comp:
-@url:
+@summary:
-<!-- ##### FUNCTION cal_component_set_url ##### -->
+<!-- ##### FUNCTION cal_component_set_summary ##### -->
<para>
</para>
@comp:
-@url:
+@summary:
-<!-- ##### FUNCTION cal_component_get_pilot_id ##### -->
+<!-- ##### FUNCTION cal_component_get_transparency ##### -->
<para>
</para>
@comp:
-@pilot_id:
+@transp:
-<!-- ##### FUNCTION cal_component_set_pilot_id ##### -->
+<!-- ##### FUNCTION cal_component_set_transparency ##### -->
<para>
</para>
@comp:
-@pilot_id:
+@transp:
-<!-- ##### FUNCTION cal_component_get_pilot_status ##### -->
+<!-- ##### FUNCTION cal_component_get_url ##### -->
<para>
</para>
@comp:
-@pilot_status:
+@url:
-<!-- ##### FUNCTION cal_component_set_pilot_status ##### -->
+<!-- ##### FUNCTION cal_component_set_url ##### -->
<para>
</para>
@comp:
-@pilot_status:
+@url:
<!-- ##### FUNCTION cal_component_free_categories_list ##### -->
@@ -822,41 +842,62 @@ RFC 2445 iCalendar component object.
@text_list:
-<!-- ##### ENUM CalComponentAlarmAction ##### -->
+<!-- ##### STRUCT CalComponentAlarm ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### TYPEDEF CalAlarmInstance ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### TYPEDEF CalComponentAlarms ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM CalAlarmAction ##### -->
<para>
</para>
-@CAL_COMPONENT_ALARM_NONE:
-@CAL_COMPONENT_ALARM_AUDIO:
-@CAL_COMPONENT_ALARM_DISPLAY:
-@CAL_COMPONENT_ALARM_EMAIL:
-@CAL_COMPONENT_ALARM_PROCEDURE:
-@CAL_COMPONENT_ALARM_UNKNOWN:
+@CAL_ALARM_NONE:
+@CAL_ALARM_AUDIO:
+@CAL_ALARM_DISPLAY:
+@CAL_ALARM_EMAIL:
+@CAL_ALARM_PROCEDURE:
+@CAL_ALARM_UNKNOWN:
-<!-- ##### ENUM CalComponentAlarmTriggerType ##### -->
+<!-- ##### ENUM CalAlarmTriggerType ##### -->
<para>
</para>
-@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE:
-@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE:
+@CAL_ALARM_TRIGGER_NONE:
+@CAL_ALARM_TRIGGER_RELATIVE_START:
+@CAL_ALARM_TRIGGER_RELATIVE_END:
+@CAL_ALARM_TRIGGER_ABSOLUTE:
-<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### -->
+<!-- ##### TYPEDEF CalAlarmTrigger ##### -->
<para>
</para>
-@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START:
-@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END:
-<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### -->
+<!-- ##### FUNCTION cal_component_has_alarms ##### -->
<para>
</para>
+@comp:
+@Returns:
+
-<!-- ##### FUNCTION cal_component_get_first_alarm ##### -->
+<!-- ##### FUNCTION cal_component_get_alarm_uids ##### -->
<para>
</para>
@@ -865,12 +906,13 @@ RFC 2445 iCalendar component object.
@Returns:
-<!-- ##### FUNCTION cal_component_get_next_alarm ##### -->
+<!-- ##### FUNCTION cal_component_get_alarm ##### -->
<para>
</para>
@comp:
+@auid:
@Returns:
@@ -882,16 +924,24 @@ RFC 2445 iCalendar component object.
@alarm:
-<!-- ##### FUNCTION cal_component_alarm_get_action ##### -->
+<!-- ##### FUNCTION cal_component_alarms_free ##### -->
+<para>
+
+</para>
+
+@alarms:
+
+
+<!-- ##### FUNCTION cal_component_alarm_get_uid ##### -->
<para>
</para>
@alarm:
-@action:
+@Returns:
-<!-- ##### FUNCTION cal_component_alarm_set_action ##### -->
+<!-- ##### FUNCTION cal_component_alarm_get_action ##### -->
<para>
</para>
@@ -900,16 +950,16 @@ RFC 2445 iCalendar component object.
@action:
-<!-- ##### FUNCTION cal_component_alarm_get_trigger ##### -->
+<!-- ##### FUNCTION cal_component_alarm_set_action ##### -->
<para>
</para>
@alarm:
-@trigger:
+@action:
-<!-- ##### FUNCTION cal_component_alarm_set_trigger ##### -->
+<!-- ##### FUNCTION cal_component_alarm_get_trigger ##### -->
<para>
</para>
@@ -918,17 +968,12 @@ RFC 2445 iCalendar component object.
@trigger:
-<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### -->
+<!-- ##### FUNCTION cal_component_alarm_set_trigger ##### -->
<para>
</para>
+@alarm:
@trigger:
-<!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "")
-End:
--->
diff --git a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml
index 703f8b2b85..092b547809 100644
--- a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml
+++ b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml
@@ -14,37 +14,6 @@ cal-recur
</para>
-<!-- ##### ENUM CalRecurType ##### -->
-<para>
-
-</para>
-
-@CAL_RECUR_YEARLY:
-@CAL_RECUR_MONTHLY:
-@CAL_RECUR_WEEKLY:
-@CAL_RECUR_DAILY:
-@CAL_RECUR_HOURLY:
-@CAL_RECUR_MINUTELY:
-@CAL_RECUR_SECONDLY:
-
-<!-- ##### TYPEDEF CalRecurrence ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT CalObjTime ##### -->
-<para>
-
-</para>
-
-@year:
-@month:
-@day:
-@hour:
-@minute:
-@second:
-
<!-- ##### USER_FUNCTION CalRecurInstanceFn ##### -->
<para>
@@ -52,9 +21,11 @@ cal-recur
@comp:
@instance_start:
-@instace_end:
+@instance_end:
@data:
@Returns:
+<!-- # Unused Parameters # -->
+@instace_end:
<!-- ##### FUNCTION cal_recur_generate_instances ##### -->
@@ -69,20 +40,3 @@ cal-recur
@cb_data:
-<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### -->
-<para>
-
-</para>
-
-@ir:
-@Returns:
-
-
-<!-- ##### FUNCTION cal_recur_free ##### -->
-<para>
-
-</para>
-
-@r:
-
-
diff --git a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml
index bc349a377f..ccd35fac2e 100644
--- a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml
+++ b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml
@@ -28,20 +28,6 @@ Miscellaneous utilities
@list:
-<!-- ##### TYPEDEF CalAlarmInstance ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION cal_alarm_instance_list_free ##### -->
-<para>
-
-</para>
-
-@list:
-
-
<!-- ##### ENUM CalObjType ##### -->
<para>
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
index e69de29bb2..f2c70d526d 100644
--- a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml
+++ b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml
@@ -0,0 +1,231 @@
+<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### -->
+<para>
+
+</para>
+
+@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START:
+@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END:
+
+<!-- ##### FUNCTION cal_recur_free ##### -->
+<para>
+
+</para>
+
+@r:
+
+<!-- ##### ENUM CalRecurType ##### -->
+<para>
+
+</para>
+
+@CAL_RECUR_YEARLY:
+@CAL_RECUR_MONTHLY:
+@CAL_RECUR_WEEKLY:
+@CAL_RECUR_DAILY:
+@CAL_RECUR_HOURLY:
+@CAL_RECUR_MINUTELY:
+@CAL_RECUR_SECONDLY:
+
+<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION cal_component_get_pilot_id ##### -->
+<para>
+
+</para>
+
+@comp:
+@pilot_id:
+
+<!-- ##### FUNCTION get_time_t_hour ##### -->
+<para>
+
+</para>
+
+@t:
+@Returns:
+
+<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### -->
+<para>
+
+</para>
+
+@trigger:
+
+
+<!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "")
+End:
+-->
+
+<!-- ##### FUNCTION time_day_hour ##### -->
+<para>
+
+</para>
+
+@t:
+@hour:
+@Returns:
+
+<!-- ##### FUNCTION time_from_isodate ##### -->
+<para>
+
+</para>
+
+@str:
+@Returns:
+
+<!-- ##### FUNCTION cal_component_get_pilot_status ##### -->
+<para>
+
+</para>
+
+@comp:
+@pilot_status:
+
+<!-- ##### STRUCT CalObjTime ##### -->
+<para>
+
+</para>
+
+@year:
+@month:
+@day:
+@hour:
+@minute:
+@second:
+
+<!-- ##### STRUCT CalComponentPrivate ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM CalComponentAlarmTriggerType ##### -->
+<para>
+
+</para>
+
+@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE:
+@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE:
+
+<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### -->
+<para>
+
+</para>
+
+@ir:
+@Returns:
+
+<!-- ##### FUNCTION cal_alarm_instance_list_free ##### -->
+<para>
+
+</para>
+
+@list:
+
+<!-- ##### FUNCTION isodiff_to_secs ##### -->
+<para>
+
+</para>
+
+@str:
+@Returns:
+
+<!-- ##### FUNCTION cal_component_get_first_alarm ##### -->
+<para>
+
+</para>
+
+@comp:
+@Returns:
+
+<!-- ##### TYPEDEF CalRecurrence ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION time_from_icaltimetype ##### -->
+<para>
+
+</para>
+
+@itt:
+@Returns:
+
+<!-- ##### FUNCTION cal_component_get_next_alarm ##### -->
+<para>
+
+</para>
+
+@comp:
+@Returns:
+
+<!-- ##### ENUM CalComponentAlarmAction ##### -->
+<para>
+
+</para>
+
+@CAL_COMPONENT_ALARM_NONE:
+@CAL_COMPONENT_ALARM_AUDIO:
+@CAL_COMPONENT_ALARM_DISPLAY:
+@CAL_COMPONENT_ALARM_EMAIL:
+@CAL_COMPONENT_ALARM_PROCEDURE:
+@CAL_COMPONENT_ALARM_UNKNOWN:
+
+<!-- ##### FUNCTION time_from_start_duration ##### -->
+<para>
+
+</para>
+
+@start:
+@duration:
+@Returns:
+
+<!-- ##### FUNCTION cal_component_set_pilot_id ##### -->
+<para>
+
+</para>
+
+@comp:
+@pilot_id:
+
+<!-- ##### FUNCTION isodiff_from_secs ##### -->
+<para>
+
+</para>
+
+@secs:
+@Returns:
+
+<!-- ##### FUNCTION format_simple_hour ##### -->
+<para>
+
+</para>
+
+@hour:
+@use_am_pm:
+@Returns:
+
+<!-- ##### FUNCTION cal_component_set_pilot_status ##### -->
+<para>
+
+</para>
+
+@comp:
+@pilot_status:
+
+<!-- ##### FUNCTION parse_date ##### -->
+<para>
+
+</para>
+
+@str:
+@Returns:
+
diff --git a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml
index 3b62fbba3f..2b197ad685 100644
--- a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml
+++ b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml
@@ -14,34 +14,6 @@ timeutil
</para>
-<!-- ##### FUNCTION time_from_icaltimetype ##### -->
-<para>
-
-</para>
-
-@itt:
-@Returns:
-
-
-<!-- ##### FUNCTION time_from_isodate ##### -->
-<para>
-
-</para>
-
-@str:
-@Returns:
-
-
-<!-- ##### FUNCTION time_from_start_duration ##### -->
-<para>
-
-</para>
-
-@start:
-@duration:
-@Returns:
-
-
<!-- ##### FUNCTION isodate_from_time_t ##### -->
<para>
@@ -51,33 +23,6 @@ timeutil
@Returns:
-<!-- ##### FUNCTION get_time_t_hour ##### -->
-<para>
-
-</para>
-
-@t:
-@Returns:
-
-
-<!-- ##### FUNCTION isodiff_to_secs ##### -->
-<para>
-
-</para>
-
-@str:
-@Returns:
-
-
-<!-- ##### FUNCTION isodiff_from_secs ##### -->
-<para>
-
-</para>
-
-@secs:
-@Returns:
-
-
<!-- ##### FUNCTION time_add_minutes ##### -->
<para>
@@ -128,16 +73,6 @@ timeutil
@Returns:
-<!-- ##### FUNCTION format_simple_hour ##### -->
-<para>
-
-</para>
-
-@hour:
-@use_am_pm:
-@Returns:
-
-
<!-- ##### FUNCTION time_days_in_month ##### -->
<para>
@@ -159,16 +94,6 @@ timeutil
@Returns:
-<!-- ##### FUNCTION time_day_hour ##### -->
-<para>
-
-</para>
-
-@t:
-@hour:
-@Returns:
-
-
<!-- ##### FUNCTION time_year_begin ##### -->
<para>
@@ -241,15 +166,6 @@ timeutil
@Returns:
-<!-- ##### FUNCTION parse_date ##### -->
-<para>
-
-</para>
-
-@str:
-@Returns:
-
-
<!-- ##### FUNCTION print_time_t ##### -->
<para>
generated by cgit v1.2.3 (git 2.25.1) at 2024-10-31 02:00:42 +0800