Top | ![]() |
![]() |
![]() |
![]() |
void (*ICalComponentForeachTZIDFunc) (ICalParameter *param
,gpointer user_data
);
void (*ICalComponentForeachRecurrenceFunc) (ICalComponent *comp
,ICalTimeSpan *span
,gpointer user_data
);
ICalComponent *
i_cal_component_new (ICalComponentKind kind
);
Create 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
);
Create a new ICalComponent based on a string.
Since: 1.0
ICalComponent *
i_cal_component_new_x (const gchar *x_name
);
Create a new ICalComponent based on name of x property.
Since: 1.0
void
i_cal_component_free (ICalComponent *component
);
Free a ICalComponent.
[skip]
Since: 1.0
gchar *
i_cal_component_as_ical_string (ICalComponent *component
);
Convert a ICalComponent to a string.
Since: 1.0
gboolean
i_cal_component_is_valid (ICalComponent *component
);
Check whether ICalComponent is valid.
Since: 1.0
ICalComponentKind
i_cal_component_isa (const ICalComponent *component
);
Get the type of ICalComponent.
Since: 1.0
gint
i_cal_component_isa_component (ICalComponent *component
);
Check whether the native part of ICalComponent is icalcomponent.
Since: 1.0
void i_cal_component_add_property (ICalComponent *component
,ICalProperty *property
);
Add an ICalProperty into ICalComponent.
Since: 1.0
void i_cal_component_take_property (ICalComponent *component
,ICalProperty *property
);
Add the property
into the component
and unrefs the property
.
[skip]
Since: 1.0
void i_cal_component_remove_property (ICalComponent *component
,ICalProperty *property
);
Remove 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
);
Count the ICalProperty in ICalComponent.
Since: 1.0
ICalComponent *
i_cal_property_get_parent (ICalProperty *property
);
Get 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
);
Set 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
);
Get the current ICalProperty in ICalComponent.
Since: 1.0
ICalProperty * i_cal_component_get_first_property (ICalComponent *component
,ICalPropertyKind kind
);
Get the first ICalProperty with specific kind in ICalComponent.
Since: 1.0
ICalProperty * i_cal_component_get_next_property (ICalComponent *component
,ICalPropertyKind kind
);
Get the next ICalProperty with specific kind in ICalComponent.
Since: 1.0
ICalComponent *
i_cal_component_get_inner (ICalComponent *comp
);
Return 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
);
Add a ICalComponent into another ICalComponent as a child component.
Since: 1.0
void i_cal_component_take_component (ICalComponent *parent
,ICalComponent *child
);
Add 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
);
Remove a child ICalComponent from another ICalComponent.
Since: 1.0
gint i_cal_component_count_components (ICalComponent *component
,ICalComponentKind kind
);
Count the child ICalComponent with the target kind in the parent one.
Since: 1.0
ICalComponent *
i_cal_component_get_parent (ICalComponent *component
);
Get the parent component of the component
.
Since: 3.0
void i_cal_component_set_parent (ICalComponent *component
,ICalComponent *parent
);
Set the parent
ICalComponent of the specified component
.
Since: 3.0
void i_cal_component_merge_component (ICalComponent *comp
,ICalComponent *comp_to_merge
);
This 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
);
Get the current ICalComponent in ICalComponent.
Since: 1.0
ICalComponent * i_cal_component_get_first_component (ICalComponent *component
,ICalComponentKind kind
);
Get the first ICalComponent with specific kind in ICalComponent.
Since: 1.0
ICalComponent * i_cal_component_get_next_component (ICalComponent *component
,ICalComponentKind kind
);
Get the next ICalComponent with specific kind in ICalComponent.
Since: 1.0
ICalCompIter * i_cal_component_begin_component (ICalComponent *component
,ICalComponentKind kind
);
Get the ICalCompIter pointing to the first child ICalComponent. Use ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.
Since: 1.0
ICalCompIter * i_cal_component_end_component (ICalComponent *component
,ICalComponentKind kind
);
Get the ICalCompIter pointing to the end child ICalComponent. Use ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.
Since: 1.0
ICalComponent *
i_cal_comp_iter_next (ICalCompIter *i
);
Get the next ICalComponent pointed by ICalCompIter. Use ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.
Since: 1.0
ICalComponent *
i_cal_comp_iter_prior (ICalCompIter *i
);
Get the prior ICalComponent pointed by ICalCompIter. Use ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.
Since: 1.0
ICalComponent *
i_cal_comp_iter_deref (ICalCompIter *i
);
Get the current ICalComponent pointed by ICalCompIter. Use ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.
Since: 1.0
gint
i_cal_component_check_restrictions (ICalComponent *comp
);
Check the number of restrictions in ICalComponent
Since: 1.0
gint
i_cal_component_count_errors (ICalComponent *comp
);
Count the number of errors in ICalComponent.
Since: 1.0
void
i_cal_component_strip_errors (ICalComponent *comp
);
Remove all X-LIC-ERROR properties.
Since: 1.0
void
i_cal_component_convert_errors (ICalComponent *comp
);
Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
Since: 1.0
gboolean
i_cal_component_kind_is_valid (const ICalComponentKind kind
);
Check if a ICalComponentKind is valid.
Since: 1.0
ICalComponentKind
i_cal_component_kind_from_string (const gchar *string
);
Convert a string to a ICalComponentKind.
Since: 1.0
const gchar *
i_cal_component_kind_to_string (ICalComponentKind kind
);
Convert a ICalComponentKind to a string.
Since: 1.0
ICalComponent *
i_cal_component_get_first_real_component
(ICalComponent *c
);
For VCOMPONENT: Return 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: report the start and end times of an event in UTC
Since: 1.0
void i_cal_component_set_dtstart (ICalComponent *comp
,ICalTime *v
);
Set the dtstart of the ICalComponent.
Since: 1.0
ICalTime *
i_cal_component_get_dtstart (ICalComponent *comp
);
Get the dtstart of the ICalComponent.
Since: 1.0
void i_cal_component_set_dtend (ICalComponent *comp
,ICalTime *v
);
Set the dtend of the ICalComponent.
Since: 1.0
ICalTime *
i_cal_component_get_dtend (ICalComponent *comp
);
Get the dtend of the ICalComponent.
Since: 1.0
void i_cal_component_set_due (ICalComponent *comp
,ICalTime *v
);
Set the due of the ICalComponent.
Since: 1.0
ICalTime *
i_cal_component_get_due (ICalComponent *comp
);
Get the due of the ICalComponent.
Since: 1.0
void i_cal_component_set_duration (ICalComponent *comp
,ICalDuration *v
);
Set the duration of the ICalComponent.
Since: 1.0
ICalDuration *
i_cal_component_get_duration (ICalComponent *comp
);
Get the duration of the ICalComponent.
Since: 1.0
void i_cal_component_set_method (ICalComponent *comp
,ICalPropertyMethod method
);
Set the method of the ICalComponent.
Since: 1.0
ICalPropertyMethod
i_cal_component_get_method (ICalComponent *comp
);
Get the method of the ICalComponent.
Since: 1.0
void i_cal_component_set_dtstamp (ICalComponent *comp
,ICalTime *v
);
Set the dtstamp of the ICalComponent.
Since: 1.0
ICalTime *
i_cal_component_get_dtstamp (ICalComponent *comp
);
Get the dtstamp of the ICalComponent.
Since: 1.0
void i_cal_component_set_summary (ICalComponent *comp
,const gchar *v
);
Set the summary of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_summary (ICalComponent *comp
);
Get the summary of the ICalComponent.
Since: 1.0
void i_cal_component_set_comment (ICalComponent *comp
,const gchar *v
);
Set the comment of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_comment (ICalComponent *comp
);
Get the comment of the ICalComponent.
Since: 1.0
void i_cal_component_set_uid (ICalComponent *comp
,const gchar *v
);
Set the uid of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_uid (ICalComponent *comp
);
Get the uid of the ICalComponent.
Since: 1.0
void i_cal_component_set_relcalid (ICalComponent *comp
,const gchar *v
);
Set the relcalid of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_relcalid (ICalComponent *comp
);
Get the relcalid of the ICalComponent.
Since: 1.0
void i_cal_component_set_recurrenceid (ICalComponent *comp
,ICalTime *v
);
Set the recurrenceid of the ICalComponent.
Since: 1.0
ICalTime *
i_cal_component_get_recurrenceid (ICalComponent *comp
);
Get the recurrenceid of the ICalComponent.
Since: 1.0
void i_cal_component_set_description (ICalComponent *comp
,const gchar *v
);
Set the description of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_description (ICalComponent *comp
);
Get the description of the ICalComponent.
Since: 1.0
void i_cal_component_set_location (ICalComponent *comp
,const gchar *v
);
Set the location of the ICalComponent.
Since: 1.0
const gchar *
i_cal_component_get_location (ICalComponent *comp
);
Get the location of the ICalComponent.
Since: 1.0
void i_cal_component_set_sequence (ICalComponent *comp
,gint v
);
Set the sequence of the ICalComponent.
Since: 1.0
gint
i_cal_component_get_sequence (ICalComponent *comp
);
Get the sequence of the ICalComponent.
Since: 1.0
void i_cal_component_set_status (ICalComponent *comp
,ICalPropertyStatus status
);
Set the status of the ICalComponent.
Since: 1.0
ICalPropertyStatus
i_cal_component_get_status (ICalComponent *comp
);
Get the status of the ICalComponent.
Since: 1.0
void i_cal_component_foreach_tzid (ICalComponent *comp
,ICalComponentForeachTZIDFunc callback
,gpointer user_data
);
Apply 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
);
Cycle through all recurrances 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
);
Decide if this recurrance 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
);
Create a ICalComponent with the type to be vcalendar
Since: 1.0
ICalComponent *
i_cal_component_new_vevent (void
);
Create a ICalComponent with the type to be vevent
Since: 1.0
ICalComponent *
i_cal_component_new_vtodo (void
);
Create a ICalComponent with the type to be vtodo
Since: 1.0
ICalComponent *
i_cal_component_new_vjournal (void
);
Create a ICalComponent with the type to be vjournal
Since: 1.0
ICalComponent *
i_cal_component_new_valarm (void
);
Create a ICalComponent with the type to be valarm
Since: 1.0
ICalComponent *
i_cal_component_new_vfreebusy (void
);
Create a ICalComponent with the type to be vfreebusy
Since: 1.0
ICalComponent *
i_cal_component_new_vtimezone (void
);
Create a ICalComponent with the type to be vtimezone
Since: 1.0
ICalComponent *
i_cal_component_new_xstandard (void
);
Create a ICalComponent with the type to be xstandard
Since: 1.0
ICalComponent *
i_cal_component_new_xdaylight (void
);
Create a ICalComponent with the type to be xdaylight
Since: 1.0
ICalComponent *
i_cal_component_new_vagenda (void
);
Create a ICalComponent with the type to be vagenda
Since: 1.0
ICalComponent *
i_cal_component_new_vquery (void
);
Create a ICalComponent with the type to be vquery
Since: 1.0
ICalComponent *
i_cal_component_new_vavailability (void
);
Create a ICalComponent with the type to be vavailability
Since: 1.0
ICalComponent *
i_cal_component_new_xavailable (void
);
Create a ICalComponent with the type to be xavailable
Since: 1.0
ICalComponent *
i_cal_component_new_vpoll (void
);
Create a ICalComponent with the type to be vpoll
Since: 1.0
ICalComponent *
i_cal_component_new_vvoter (void
);
Create a ICalComponent with the type to be vvoter
Since: 1.0
ICalComponent *
i_cal_component_new_xvote (void
);
Create a ICalComponent with the type to be xvote
Since: 1.0