Top |
void (*ICalComponentForeachTZIDFunc) (ICalParameter *param
,gpointer user_data
);
void (*ICalComponentForeachRecurrenceFunc) (ICalComponent *comp
,ICalTimeSpan *span
,gpointer user_data
);
ICalComponent *
i_cal_component_new (ICalComponentKind kind
);
Creates a new ICalComponent with specific type.
Since: 1.0
ICalComponent *
i_cal_component_clone (ICalComponent *component
);
Deeply clone a ICalComponent.
Since: 1.0
ICalComponent *
i_cal_component_new_from_string (const gchar *str
);
Creates a new ICalComponent based on a string.
Since: 1.0
ICalComponent *
i_cal_component_new_x (const gchar *x_name
);
Creates a new ICalComponent based on name of x property.
Since: 1.0
void
i_cal_component_free (ICalComponent *component
);
Frees a ICalComponent.
[skip]
Since: 1.0
gchar *
i_cal_component_as_ical_string (ICalComponent *component
);
Converts a ICalComponent to a string.
Since: 1.0
gboolean
i_cal_component_is_valid (ICalComponent *component
);
Checks whether ICalComponent is valid.
Since: 1.0
ICalComponentKind
i_cal_component_isa (const ICalComponent *component
);
Gets the type of ICalComponent.
Since: 1.0
gint
i_cal_component_isa_component (ICalComponent *component
);
Checks whether the native part of ICalComponent is icalcomponent.
Since: 1.0
void i_cal_component_add_property (ICalComponent *component
,ICalProperty *property
);
Adds an ICalProperty into ICalComponent.
Since: 1.0
void i_cal_component_take_property (ICalComponent *component
,ICalProperty *property
);
Adds the property
into the component
and unrefs the property
.
[skip]
Since: 1.0
void i_cal_component_remove_property (ICalComponent *component
,ICalProperty *property
);
Removes ICalProperty from ICalComponent. Caution: The compare is based on address. So you must use the original ICalProperty as the target.
Since: 1.0
gint i_cal_component_count_properties (ICalComponent *component
,ICalPropertyKind kind
);
Counts the number of ICalProperty in ICalComponent.
Since: 1.0
ICalComponent *
i_cal_property_get_parent (ICalProperty *property
);
Gets the parent component of the property. Use with caution. When icalproperty is deallocated, it won't deallocate its parent. However the ICalComponent object created using this method will be deallocated (if no reference in other places). So You need to make sure there is another reference except the one in ICalProperty.
Since: 2.0
void i_cal_property_set_parent (ICalProperty *property
,ICalComponent *component
);
Sets the parent ICalComponent of the specified ICalProperty.
Since: 3.0
ICalTime * i_cal_property_get_datetime_with_component (ICalProperty *prop
,ICalComponent *comp
);
If the property is a DATE-TIME with a TZID parameter and a corresponding VTIMEZONE is present in the component, the returned component will already be in the correct timezone; otherwise the caller is responsible for converting it.
The comp
can be NULL, in which case the parent of the prop
is used to find
the corresponding time zone.
Since: 3.0.5
ICalProperty *
i_cal_component_get_current_property (ICalComponent *component
);
Gets the current ICalProperty in ICalComponent.
Since: 1.0
ICalProperty * i_cal_component_get_first_property (ICalComponent *component
,ICalPropertyKind kind
);
Gets the first ICalProperty with specific kind in ICalComponent.
Since: 1.0
ICalProperty * i_cal_component_get_next_property (ICalComponent *component
,ICalPropertyKind kind
);
Gets the next ICalProperty with specific kind in ICalComponent.
Since: 1.0
ICalComponent *
i_cal_component_get_inner (ICalComponent *comp
);
Returns the first VEVENT, VTODO or VJOURNAL sub-component of cop, or comp if it is one of those types.
Since: 1.0
void i_cal_component_add_component (ICalComponent *parent
,ICalComponent *child
);
Adds a ICalComponent into another ICalComponent as a child component.
Since: 1.0
void i_cal_component_take_component (ICalComponent *parent
,ICalComponent *child
);
Adds the child
into the parent
as a child component and unrefs the child
.
[skip]
Since: 1.0
void i_cal_component_remove_component (ICalComponent *parent
,ICalComponent *child
);
Removes a child ICalComponent from another ICalComponent.
Since: 1.0
gint i_cal_component_count_components (ICalComponent *component
,ICalComponentKind kind
);
Counts the child ICalComponent with the target kind in the parent one.
Since: 1.0
ICalComponent *
i_cal_component_get_parent (ICalComponent *component
);
Gets the parent component of the component
.
Since: 3.0
void i_cal_component_set_parent (ICalComponent *component
,ICalComponent *parent
);
Sets the parent
ICalComponent of the specified component
.
Since: 3.0
void i_cal_component_merge_component (ICalComponent *comp
,ICalComponent *comp_to_merge
);
Takes 2 VCALENDAR components and merges the second one into the first, resolving any problems with conflicting TZIDs. comp_to_merge will no longer exist after calling this function.
comp |
The ICalComponent |
|
comp_to_merge |
A ICalComponent. After merged it will not exist any more. |
[in] |
Since: 1.0
ICalComponent *
i_cal_component_get_current_component (ICalComponent *component
);
Gets the current ICalComponent in ICalComponent.
Since: 1.0
ICalComponent * i_cal_component_get_first_component (ICalComponent *component
,ICalComponentKind kind
);
Gets the first ICalComponent with specific kind in ICalComponent.
Since: 1.0
ICalComponent * i_cal_component_get_next_component (ICalComponent *component
,ICalComponentKind kind
);
Gets the next ICalComponent with specific kind in ICalComponent.
Since: 1.0
ICalCompIter * i_cal_component_begin_component (ICalComponent *component
,ICalComponentKind kind
);
Gets the ICalCompIter pointing to the first child ICalComponent.
Since: 1.0
ICalCompIter * i_cal_component_end_component (ICalComponent *component
,ICalComponentKind kind
);
Gets the ICalCompIter pointing to the end child ICalComponent.
Since: 1.0
ICalComponent *
i_cal_comp_iter_next (ICalCompIter *i
);
Gets the next ICalComponent pointed by ICalCompIter.
Since: 1.0
ICalComponent *
i_cal_comp_iter_prior (ICalCompIter *i
);
Gets the prior ICalComponent pointed by ICalCompIter.
Since: 1.0
ICalComponent *
i_cal_comp_iter_deref (ICalCompIter *i
);
Gets the current ICalComponent pointed by ICalCompIter.
Since: 1.0
gint
i_cal_component_check_restrictions (ICalComponent *comp
);
Checks the number of restrictions in ICalComponent.
Since: 1.0
gint
i_cal_component_count_errors (ICalComponent *comp
);
Counts the number of errors in ICalComponent.
Since: 1.0
void
i_cal_component_strip_errors (ICalComponent *comp
);
Removes all X-LIC-ERROR properties.
Since: 1.0
void
i_cal_component_convert_errors (ICalComponent *comp
);
Converts some X-LIC-ERROR properties into RETURN-STATUS properties.
Since: 1.0
gboolean
i_cal_component_kind_is_valid (const ICalComponentKind kind
);
Checks if a ICalComponentKind is valid.
Since: 1.0
ICalComponentKind
i_cal_component_kind_from_string (const gchar *string
);
Converts a string to a ICalComponentKind.
Since: 1.0
const gchar *
i_cal_component_kind_to_string (ICalComponentKind kind
);
Converts a ICalComponentKind to a string.
Since: 1.0
ICalComponent *
i_cal_component_get_first_real_component
(ICalComponent *c
);
For VCOMPONENT: Returns a reference to the first VEVENT, VTODO or VJOURNAL.
Since: 1.0
ICalTimeSpan *
i_cal_component_get_span (ICalComponent *comp
);
For VEVENT, VTODO, VJOURNAL and VTIMEZONE: reports the start and end times of an event in UTC.
Since: 1.0
void i_cal_component_set_dtstart (ICalComponent *comp
,ICalTime *v
);
Sets the dtstart of the ICalComponent.
Since: 1.0
ICalTime *
i_cal_component_get_dtstart (ICalComponent *comp
);
Gets the dtstart of the ICalComponent.
Since: 1.0
void i_cal_component_set_dtend (ICalComponent *comp
,ICalTime *v
);
Sets the dtend of the ICalComponent.
Since: 1.0
ICalTime *
i_cal_component_get_dtend (ICalComponent *comp
);
Gets the dtend of the ICalComponent.
Since: 1.0
void i_cal_component_set_due (ICalComponent *comp
,ICalTime *v
);
Sets the due of the ICalComponent.
Since: 1.0
ICalTime *
i_cal_component_get_due (ICalComponent *comp
);
Gets the due of the ICalComponent.
Since: 1.0
void i_cal_component_set_duration (ICalComponent *comp
,ICalDuration *v
);
Sets the duration of the ICalComponent.
Since: 1.0
ICalDuration *
i_cal_component_get_duration (ICalComponent *comp
);
Gets the duration of the ICalComponent.
Since: 1.0
void i_cal_component_set_method (ICalComponent *comp
,ICalPropertyMethod method
);
Sets the method of the ICalComponent.
Since: 1.0
ICalPropertyMethod
i_cal_component_get_method (ICalComponent *comp
);
Gets the method of the ICalComponent.
Since: 1.0
void i_cal_component_set_dtstamp (ICalComponent *comp
,ICalTime *v
);
Sets the dtstamp of the ICalComponent.
Since: 1.0
ICalTime *
i_cal_component_get_dtstamp (ICalComponent *comp
);
Gets the dtstamp of the ICalComponent.
Since: 1.0
void i_cal_component_set_summary (ICalComponent *comp
,const gchar *v
);
Sets the summary of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_summary (ICalComponent *comp
);
Gets the summary of the ICalComponent.
Since: 1.0
void i_cal_component_set_comment (ICalComponent *comp
,const gchar *v
);
Sets the comment of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_comment (ICalComponent *comp
);
Gets the comment of the ICalComponent.
Since: 1.0
void i_cal_component_set_uid (ICalComponent *comp
,const gchar *v
);
Sets the uid of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_uid (ICalComponent *comp
);
Gets the uid of the ICalComponent.
Since: 1.0
void i_cal_component_set_relcalid (ICalComponent *comp
,const gchar *v
);
Sets the relcalid of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_relcalid (ICalComponent *comp
);
Gets the relcalid of the ICalComponent.
Since: 1.0
void i_cal_component_set_recurrenceid (ICalComponent *comp
,ICalTime *v
);
Sets the recurrenceid of the ICalComponent.
Since: 1.0
ICalTime *
i_cal_component_get_recurrenceid (ICalComponent *comp
);
Gets the recurrenceid of the ICalComponent.
Since: 1.0
void i_cal_component_set_description (ICalComponent *comp
,const gchar *v
);
Sets the description of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_description (ICalComponent *comp
);
Gets the description of the ICalComponent.
Since: 1.0
void i_cal_component_set_location (ICalComponent *comp
,const gchar *v
);
Sets the location of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_location (ICalComponent *comp
);
Gets the location of the ICalComponent.
Since: 1.0
void i_cal_component_set_sequence (ICalComponent *comp
,gint v
);
Sets the sequence of the ICalComponent.
Since: 1.0
gint
i_cal_component_get_sequence (ICalComponent *comp
);
Gets the sequence of the ICalComponent.
Since: 1.0
void i_cal_component_set_status (ICalComponent *comp
,ICalPropertyStatus status
);
Sets the status of the ICalComponent.
Since: 1.0
ICalPropertyStatus
i_cal_component_get_status (ICalComponent *comp
);
Gets the status of the ICalComponent.
Since: 1.0
void i_cal_component_foreach_tzid (ICalComponent *comp
,ICalComponentForeachTZIDFunc callback
,gpointer user_data
);
Applies the same manipulation on every tzid in ICalComponent.
comp |
The ICalComponent to be queried |
|
callback |
The callback function. |
[scope call] |
user_data |
The data for callback function. |
[nullable][closure callback] |
Since: 3.0.5
void i_cal_component_foreach_recurrence (ICalComponent *comp
,ICalTime *start
,ICalTime *end
,ICalComponentForeachRecurrenceFunc callback
,gpointer user_data
);
Cycles through all recurrences of an event. This function will call the specified callback function for once for the base value of DTSTART, and foreach recurring date/time value. It will filter out events that are specified as an EXDATE or an EXRULE.
comp |
The ICalComponent to be queried |
|
start |
Ignore timespans before this |
|
end |
Ignore timespans after this |
|
callback |
Function called for each timespan within the range. |
[scope call] |
user_data |
The user data for callback function. |
[nullable][closure callback] |
Since: 3.0.5
ICalTimezone * i_cal_component_get_timezone (ICalComponent *comp
,const gchar *tzid
);
Returns the icaltimezone in the component corresponding to the TZID, or NULL if it can't be found.
Since: 1.0
gboolean i_cal_property_recurrence_is_excluded (ICalComponent *comp
,ICalTime *dtstart
,ICalTime *recurtime
);
Decides if this recurrence is acceptable. This function decides if a specific recurrence value is excluded by EXRULE or EXDATE properties.
comp |
||
dtstart |
The base dtstart value for this component |
|
recurtime |
The time to test against |
Since: 1.0
ICalComponent *
i_cal_component_new_vcalendar (void
);
Creates a ICalComponent with the type to be vcalendar.
Since: 1.0
ICalComponent *
i_cal_component_new_vevent (void
);
Creates a ICalComponent with the type to be vevent.
Since: 1.0
ICalComponent *
i_cal_component_new_vtodo (void
);
Creates a ICalComponent with the type to be vtodo.
Since: 1.0
ICalComponent *
i_cal_component_new_vjournal (void
);
Creates a ICalComponent with the type to be vjournal.
Since: 1.0
ICalComponent *
i_cal_component_new_valarm (void
);
Creates a ICalComponent with the type to be valarm.
Since: 1.0
ICalComponent *
i_cal_component_new_vfreebusy (void
);
Creates a ICalComponent with the type to be vfreebusy.
Since: 1.0
ICalComponent *
i_cal_component_new_vtimezone (void
);
Creates a ICalComponent with the type to be vtimezone.
Since: 1.0
ICalComponent *
i_cal_component_new_xstandard (void
);
Creates a ICalComponent with the type to be xstandard.
Since: 1.0
ICalComponent *
i_cal_component_new_xdaylight (void
);
Creates a ICalComponent with the type to be xdaylight.
Since: 1.0
ICalComponent *
i_cal_component_new_vagenda (void
);
Creates a ICalComponent with the type to be vagenda.
Since: 1.0
ICalComponent *
i_cal_component_new_vquery (void
);
Creates a ICalComponent with the type to be vquery.
Since: 1.0
ICalComponent *
i_cal_component_new_vavailability (void
);
Creates a ICalComponent with the type to be vavailability.
Since: 1.0
ICalComponent *
i_cal_component_new_xavailable (void
);
Creates a ICalComponent with the type to be xavailable.
Since: 1.0
ICalComponent *
i_cal_component_new_vpoll (void
);
Creates a ICalComponent with the type to be vpoll.
Since: 1.0
ICalComponent *
i_cal_component_new_vvoter (void
);
Creates a ICalComponent with the type to be vvoter.
Since: 1.0
ICalComponent *
i_cal_component_new_xvote (void
);
Creates a ICalComponent with the type to be xvote.
Since: 1.0