Updated docs for repeating alarms.
2001-10-29 Federico Mena Quintero <federico@ximian.com> * calendar/alarm-generation.sgml: Updated docs for repeating alarms. svn path=/trunk/; revision=14367
This commit is contained in:
committed by
Federico Mena Quintero
parent
bf2ea436f7
commit
8836050e99
@ -1,3 +1,8 @@
|
||||
2001-10-29 Federico Mena Quintero <federico@ximian.com>
|
||||
|
||||
* calendar/alarm-generation.sgml: Updated docs for repeating
|
||||
alarms.
|
||||
|
||||
2001-07-31 Ettore Perazzoli <ettore@ximian.com>
|
||||
|
||||
* Makefile.am (dist-hook): Remove the copying of the
|
||||
|
||||
@ -100,6 +100,22 @@
|
||||
time, and if so, we take that trigger occurrence into account
|
||||
for the final result.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
In addition, alarms may specify a number of repetitions and a
|
||||
duration time. For example, an alarm may be configured to
|
||||
repeat 3 extra times after the original occurrence with 5
|
||||
minutes between each repetition. Again, for absolute triggers
|
||||
this does not present a problem, as we can just generate the
|
||||
repetitions starting from the absolute trigger time. For
|
||||
relative triggers, we expand the range as described above and
|
||||
also add the total offset for the repetitions to the start of
|
||||
the range, i.e. 15 extra minutes for the case of 3 repetitions
|
||||
with 5 minutes between each. We do not need to modify the end
|
||||
of the range because alarm repetitions always have positive
|
||||
offsets, so they are equivalent to relative alarm triggers
|
||||
with positive offsets.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="alarm-trigger-generation-code">
|
||||
|
||||
@ -1,3 +1,116 @@
|
||||
<MACRO>
|
||||
<NAME>CAL_CLIENT_MULTI_TYPE</NAME>
|
||||
#define CAL_CLIENT_MULTI_TYPE (cal_client_multi_get_type ())
|
||||
</MACRO>
|
||||
<MACRO>
|
||||
<NAME>CAL_CLIENT_MULTI</NAME>
|
||||
#define CAL_CLIENT_MULTI(obj) (GTK_CHECK_CAST ((obj), CAL_CLIENT_MULTI_TYPE, CalClientMulti))
|
||||
</MACRO>
|
||||
<MACRO>
|
||||
<NAME>CAL_CLIENT_MULTI_CLASS</NAME>
|
||||
#define CAL_CLIENT_MULTI_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_CLIENT_MULTI_TYPE, CalClientMultiClass))
|
||||
</MACRO>
|
||||
<MACRO>
|
||||
<NAME>IS_CAL_CLIENT_MULTI</NAME>
|
||||
#define IS_CAL_CLIENT_MULTI(obj) (GTK_CHECK_TYPE ((obj), CAL_CLIENT_MULTI_TYPE))
|
||||
</MACRO>
|
||||
<MACRO>
|
||||
<NAME>IS_CAL_CLIENT_MULTI_CLASS</NAME>
|
||||
#define IS_CAL_CLIENT_MULTI_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_CLIENT_MULTI_TYPE))
|
||||
</MACRO>
|
||||
<STRUCT>
|
||||
<NAME>CalClientMulti</NAME>
|
||||
</STRUCT>
|
||||
<STRUCT>
|
||||
<NAME>CalClientMultiClass</NAME>
|
||||
</STRUCT>
|
||||
<STRUCT>
|
||||
<NAME>CalClientMultiPrivate</NAME>
|
||||
</STRUCT>
|
||||
<STRUCT>
|
||||
<NAME>CalClientMulti</NAME>
|
||||
struct CalClientMulti {
|
||||
GtkObject object;
|
||||
|
||||
/* Private data */
|
||||
CalClientMultiPrivate *priv;
|
||||
};
|
||||
</STRUCT>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_get_type</NAME>
|
||||
<RETURNS>GtkType </RETURNS>
|
||||
void
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_new</NAME>
|
||||
<RETURNS>CalClientMulti *</RETURNS>
|
||||
void
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_add_client</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
CalClientMulti *multi, CalClient *client
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_set_auth_func</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
CalClientMulti *multi,CalClientAuthFunc func,gpointer user_data
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_open_calendar</NAME>
|
||||
<RETURNS>CalClient *</RETURNS>
|
||||
CalClientMulti *multi,const char *str_uri,gboolean only_if_exists
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_get_client_for_uri</NAME>
|
||||
<RETURNS>CalClient *</RETURNS>
|
||||
CalClientMulti *multi,const char *uri
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_get_n_objects</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
CalClientMulti *multi, CalObjType type
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_get_object</NAME>
|
||||
<RETURNS>CalClientGetStatus </RETURNS>
|
||||
CalClientMulti *multi,const char *uid,CalComponent **comp
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_get_timezone</NAME>
|
||||
<RETURNS>CalClientGetStatus </RETURNS>
|
||||
CalClientMulti *multi,const char *tzid,icaltimezone **zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_get_uids</NAME>
|
||||
<RETURNS>GList *</RETURNS>
|
||||
CalClientMulti *multi, CalObjType type
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_get_changes</NAME>
|
||||
<RETURNS>GList *</RETURNS>
|
||||
CalClientMulti *multi,CalObjType type,const char *change_id
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_get_objects_in_range</NAME>
|
||||
<RETURNS>GList *</RETURNS>
|
||||
CalClientMulti *multi,CalObjType type,time_t start,time_t end
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_get_free_busy</NAME>
|
||||
<RETURNS>GList *</RETURNS>
|
||||
CalClientMulti *multi,GList *users,time_t start,time_t end
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_generate_instances</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
CalClientMulti *multi,CalObjType type,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_multi_get_alarms_in_range</NAME>
|
||||
<RETURNS>GSList *</RETURNS>
|
||||
CalClientMulti *multi,time_t start, time_t end
|
||||
</FUNCTION>
|
||||
<ENUM>
|
||||
<NAME>CalClientChangeType</NAME>
|
||||
typedef enum {
|
||||
@ -50,6 +163,14 @@ typedef enum {
|
||||
} CalClientOpenStatus;
|
||||
</ENUM>
|
||||
<ENUM>
|
||||
<NAME>CalClientSetModeStatus</NAME>
|
||||
typedef enum {
|
||||
CAL_CLIENT_SET_MODE_SUCCESS,
|
||||
CAL_CLIENT_SET_MODE_ERROR,
|
||||
CAL_CLIENT_SET_MODE_NOT_SUPPORTED
|
||||
} CalClientSetModeStatus;
|
||||
</ENUM>
|
||||
<ENUM>
|
||||
<NAME>CalClientGetStatus</NAME>
|
||||
typedef enum {
|
||||
CAL_CLIENT_GET_SUCCESS,
|
||||
@ -103,11 +224,21 @@ void
|
||||
CalClient *client, CalClientAuthFunc func, gpointer data
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_set_default_timezone</NAME>
|
||||
<RETURNS>gboolean </RETURNS>
|
||||
CalClient *client, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_open_calendar</NAME>
|
||||
<RETURNS>gboolean </RETURNS>
|
||||
CalClient *client, const char *str_uri, gboolean only_if_exists
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_uri_list</NAME>
|
||||
<RETURNS>GList *</RETURNS>
|
||||
CalClient *client, CalMode mode
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_get_load_state</NAME>
|
||||
<RETURNS>CalClientLoadState </RETURNS>
|
||||
CalClient *client
|
||||
@ -118,6 +249,11 @@ CalClient *client
|
||||
CalClient *client
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_set_mode</NAME>
|
||||
<RETURNS>gboolean </RETURNS>
|
||||
CalClient *client, CalMode mode
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_get_n_objects</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
CalClient *client, CalObjType type
|
||||
@ -149,8 +285,8 @@ CalClient *client, CalObjType type,time_t start, time_t end
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_get_free_busy</NAME>
|
||||
<RETURNS>CalClientGetStatus </RETURNS>
|
||||
CalClient *client, time_t start, time_t end,CalComponent **comp
|
||||
<RETURNS>GList *</RETURNS>
|
||||
CalClient *client, GList *users,time_t start, time_t end
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_generate_instances</NAME>
|
||||
@ -197,6 +333,11 @@ CalClient *client, const char *sexp
|
||||
<RETURNS>icaltimezone *</RETURNS>
|
||||
const char *tzid, gpointer data
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_client_get_component_as_string</NAME>
|
||||
<RETURNS>char *</RETURNS>
|
||||
CalClient *client,CalComponent *comp
|
||||
</FUNCTION>
|
||||
<MACRO>
|
||||
<NAME>CAL_QUERY_TYPE</NAME>
|
||||
#define CAL_QUERY_TYPE (cal_query_get_type ())
|
||||
|
||||
@ -273,6 +273,15 @@ GTK+ object for communication with personal calendar server.
|
||||
@calclient: the object which received the signal.
|
||||
@arg1:
|
||||
|
||||
<!-- ##### SIGNAL CalClient::cal-set-mode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calclient: the object which received the signal.
|
||||
@arg1:
|
||||
@arg2:
|
||||
|
||||
<!-- ##### SIGNAL CalClient::obj-updated ##### -->
|
||||
<para>
|
||||
This signal is emitted when the calendar clients receives
|
||||
|
||||
@ -1,3 +1,188 @@
|
||||
<USER_FUNCTION>
|
||||
<NAME>CalRecurInstanceFn</NAME>
|
||||
<RETURNS>gboolean </RETURNS>
|
||||
CalComponent *comp,
|
||||
time_t instance_start,
|
||||
time_t instance_end,
|
||||
gpointer data
|
||||
</USER_FUNCTION>
|
||||
<USER_FUNCTION>
|
||||
<NAME>CalRecurResolveTimezoneFn</NAME>
|
||||
<RETURNS>icaltimezone *</RETURNS>
|
||||
const char *tzid,
|
||||
gpointer data
|
||||
</USER_FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_recur_generate_instances</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data,CalRecurResolveTimezoneFn tz_cb,gpointer tz_cb_data,icaltimezone *default_timezone
|
||||
</FUNCTION>
|
||||
<TYPEDEF>
|
||||
<NAME>CalObjInstance</NAME>
|
||||
typedef struct {
|
||||
char *uid; /* UID of the object */
|
||||
time_t start; /* Start time of instance */
|
||||
time_t end; /* End time of instance */
|
||||
} CalObjInstance;
|
||||
</TYPEDEF>
|
||||
<FUNCTION>
|
||||
<NAME>cal_obj_instance_list_free</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
GList *list
|
||||
</FUNCTION>
|
||||
<ENUM>
|
||||
<NAME>CalObjType</NAME>
|
||||
typedef enum {
|
||||
CALOBJ_TYPE_EVENT = 1 << 0,
|
||||
CALOBJ_TYPE_TODO = 1 << 1,
|
||||
CALOBJ_TYPE_JOURNAL = 1 << 2,
|
||||
CALOBJ_TYPE_ANY = 0x07
|
||||
} CalObjType;
|
||||
</ENUM>
|
||||
<ENUM>
|
||||
<NAME>CalMode</NAME>
|
||||
typedef enum {
|
||||
CAL_MODE_INVALID = -1,
|
||||
CAL_MODE_LOCAL = 1 << 0,
|
||||
CAL_MODE_REMOTE = 1 << 1,
|
||||
CAL_MODE_ANY = 0x07
|
||||
} CalMode;
|
||||
</ENUM>
|
||||
<FUNCTION>
|
||||
<NAME>cal_obj_uid_list_free</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
GList *list
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_util_new_top_level</NAME>
|
||||
<RETURNS>icalcomponent *</RETURNS>
|
||||
void
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_util_generate_alarms_for_comp</NAME>
|
||||
<RETURNS>CalComponentAlarms *</RETURNS>
|
||||
CalComponent *comp,time_t start,time_t end,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data,icaltimezone *default_timezone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_util_generate_alarms_for_list</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
GList *comps,time_t start,time_t end,GSList **comp_alarms,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data,icaltimezone *default_timezone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_util_resolve_tzid</NAME>
|
||||
<RETURNS>icaltimezone *</RETURNS>
|
||||
const char *tzid, gpointer data
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_util_priority_to_string</NAME>
|
||||
<RETURNS>char *</RETURNS>
|
||||
int priority
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_util_priority_from_string</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
const char *string
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_days_in_month</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
int year, int month
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_of_year</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
int day, int month, int year
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_of_week</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
int day, int month, int year
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_is_leap_year</NAME>
|
||||
<RETURNS>gboolean </RETURNS>
|
||||
int year
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_leap_years_up_to</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
int year
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>isodate_from_time_t</NAME>
|
||||
<RETURNS>char *</RETURNS>
|
||||
time_t t
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_from_isodate</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
const char *str
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_day</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int days
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_week</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int weeks
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_begin</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t t
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_end</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t t
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_day_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int days, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_week_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int weeks, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_month_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int months, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_year_begin_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_month_begin_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_week_begin_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int week_start_day,icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_begin_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_end_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_to_gdate_with_zone</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
GDate *date, time_t time, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<MACRO>
|
||||
<NAME>CAL_COMPONENT_TYPE</NAME>
|
||||
#define CAL_COMPONENT_TYPE (cal_component_get_type ())
|
||||
@ -53,6 +238,7 @@ typedef enum {
|
||||
CAL_COMPONENT_FIELD_COLOR, /* not a real field */
|
||||
CAL_COMPONENT_FIELD_STATUS,
|
||||
CAL_COMPONENT_FIELD_COMPONENT, /* not a real field */
|
||||
CAL_COMPONENT_FIELD_LOCATION,
|
||||
CAL_COMPONENT_FIELD_NUM_FIELDS
|
||||
} CalComponentField;
|
||||
</ENUM>
|
||||
@ -212,6 +398,11 @@ CalComponent *comp, icalcomponent *icalcomp
|
||||
CalComponent *comp
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_component_rescan</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
CalComponent *comp
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_component_get_vtype</NAME>
|
||||
<RETURNS>CalComponentVType </RETURNS>
|
||||
CalComponent *comp
|
||||
@ -427,6 +618,11 @@ CalComponent *comp, CalComponentOrganizer *organizer
|
||||
CalComponent *comp, CalComponentOrganizer *organizer
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_component_has_organizer</NAME>
|
||||
<RETURNS>gboolean </RETURNS>
|
||||
CalComponent *comp
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_component_get_percent</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
CalComponent *comp, int **percent
|
||||
@ -557,6 +753,21 @@ CalComponent *comp, GSList **attendee_list
|
||||
CalComponent *comp, GSList *attendee_list
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_component_has_attendees</NAME>
|
||||
<RETURNS>gboolean </RETURNS>
|
||||
CalComponent *comp
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_component_get_location</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
CalComponent *comp, const char **location
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_component_set_location</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
CalComponent *comp, const char *location
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_component_event_dates_match</NAME>
|
||||
<RETURNS>gboolean </RETURNS>
|
||||
CalComponent *comp1, CalComponent *comp2
|
||||
@ -705,6 +916,11 @@ CalComponent *comp, CalComponentAlarm *alarm
|
||||
CalComponent *comp, const char *auid
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_component_remove_all_alarms</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
CalComponent *comp
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_component_get_alarm_uids</NAME>
|
||||
<RETURNS>GList *</RETURNS>
|
||||
CalComponent *comp
|
||||
@ -789,189 +1005,3 @@ CalComponentAlarm *alarm, CalAlarmTrigger *trigger
|
||||
<RETURNS>void </RETURNS>
|
||||
CalComponentAlarm *alarm, CalAlarmTrigger trigger
|
||||
</FUNCTION>
|
||||
<USER_FUNCTION>
|
||||
<NAME>CalRecurInstanceFn</NAME>
|
||||
<RETURNS>gboolean </RETURNS>
|
||||
CalComponent *comp,
|
||||
time_t instance_start,
|
||||
time_t instance_end,
|
||||
gpointer data
|
||||
</USER_FUNCTION>
|
||||
<USER_FUNCTION>
|
||||
<NAME>CalRecurResolveTimezoneFn</NAME>
|
||||
<RETURNS>icaltimezone *</RETURNS>
|
||||
const char *tzid,
|
||||
gpointer data
|
||||
</USER_FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_recur_generate_instances</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data,CalRecurResolveTimezoneFn tz_cb,gpointer tz_cb_data
|
||||
</FUNCTION>
|
||||
<TYPEDEF>
|
||||
<NAME>CalObjInstance</NAME>
|
||||
typedef struct {
|
||||
char *uid; /* UID of the object */
|
||||
time_t start; /* Start time of instance */
|
||||
time_t end; /* End time of instance */
|
||||
} CalObjInstance;
|
||||
</TYPEDEF>
|
||||
<FUNCTION>
|
||||
<NAME>cal_obj_instance_list_free</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
GList *list
|
||||
</FUNCTION>
|
||||
<ENUM>
|
||||
<NAME>CalObjType</NAME>
|
||||
typedef enum {
|
||||
CALOBJ_TYPE_EVENT = 1 << 0,
|
||||
CALOBJ_TYPE_TODO = 1 << 1,
|
||||
CALOBJ_TYPE_JOURNAL = 1 << 2,
|
||||
CALOBJ_TYPE_ANY = 0x07
|
||||
} CalObjType;
|
||||
</ENUM>
|
||||
<FUNCTION>
|
||||
<NAME>cal_obj_uid_list_free</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
GList *list
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_util_new_top_level</NAME>
|
||||
<RETURNS>icalcomponent *</RETURNS>
|
||||
void
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_util_generate_alarms_for_comp</NAME>
|
||||
<RETURNS>CalComponentAlarms *</RETURNS>
|
||||
CalComponent *comp,time_t start,time_t end,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_util_generate_alarms_for_list</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
GList *comps,time_t start,time_t end,GSList **comp_alarms,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>cal_util_resolve_tzid</NAME>
|
||||
<RETURNS>icaltimezone *</RETURNS>
|
||||
const char *tzid, gpointer data
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_days_in_month</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
int year, int month
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_of_year</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
int day, int month, int year
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_of_week</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
int day, int month, int year
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_is_leap_year</NAME>
|
||||
<RETURNS>gboolean </RETURNS>
|
||||
int year
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_leap_years_up_to</NAME>
|
||||
<RETURNS>int </RETURNS>
|
||||
int year
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>isodate_from_time_t</NAME>
|
||||
<RETURNS>char *</RETURNS>
|
||||
time_t t
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_from_isodate</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
const char *str
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_day</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int days
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_week</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int weeks
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_month</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int months
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_year_begin</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t t
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_month_begin</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t t
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_week_begin</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t t, int week_start_day
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_begin</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t t
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_end</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t t
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_day_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int days, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_week_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int weeks, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_add_month_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int months, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_year_begin_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_month_begin_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_week_begin_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, int week_start_day,icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_begin_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_day_end_with_zone</NAME>
|
||||
<RETURNS>time_t </RETURNS>
|
||||
time_t time, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>time_to_gdate_with_zone</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
GDate *date, time_t time, icaltimezone *zone
|
||||
</FUNCTION>
|
||||
|
||||
@ -116,6 +116,7 @@ RFC 2445 iCalendar component object.
|
||||
@CAL_COMPONENT_FIELD_COLOR:
|
||||
@CAL_COMPONENT_FIELD_STATUS:
|
||||
@CAL_COMPONENT_FIELD_COMPONENT:
|
||||
@CAL_COMPONENT_FIELD_LOCATION:
|
||||
@CAL_COMPONENT_FIELD_NUM_FIELDS:
|
||||
|
||||
<!-- ##### ENUM CalComponentClassification ##### -->
|
||||
|
||||
@ -40,5 +40,6 @@ cal-recur
|
||||
@cb_data:
|
||||
@tz_cb:
|
||||
@tz_cb_data:
|
||||
@default_timezone:
|
||||
|
||||
|
||||
|
||||
@ -208,6 +208,15 @@ End:
|
||||
@minutes:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION time_add_month ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@time:
|
||||
@months:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION time_add_year ##### -->
|
||||
<para>
|
||||
|
||||
@ -261,6 +270,14 @@ End:
|
||||
@duration:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION time_month_begin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION time_month_end ##### -->
|
||||
<para>
|
||||
|
||||
@ -269,6 +286,15 @@ End:
|
||||
@t:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION time_week_begin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@week_start_day:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION time_week_end ##### -->
|
||||
<para>
|
||||
|
||||
@ -278,6 +304,14 @@ End:
|
||||
@week_start_day:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION time_year_begin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION time_year_end ##### -->
|
||||
<para>
|
||||
|
||||
|
||||
@ -43,16 +43,6 @@ timeutil
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION time_add_month ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@time:
|
||||
@months:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION time_days_in_month ##### -->
|
||||
<para>
|
||||
|
||||
@ -63,34 +53,6 @@ timeutil
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION time_year_begin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION time_month_begin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION time_week_begin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@week_start_day:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION time_day_begin ##### -->
|
||||
<para>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user