ICal.Component – libical-glib Reference Manual
Component
Object Hierarchy:
ICal.Component
ICal.Component
ICal.Component
ICal.Object
ICal.Object
ICal.Object->ICal.Component
GLib.Object
GLib.Object
GLib.Object->ICal.Object
Description:
[
CCode
( type_id =
"i_cal_component_get_type ()"
) ]
public
class
Component
:
Object
This is the ICalComponent instance.
Namespace:
ICal
Package:
libical-glib
Content:
Creation methods:
public
Component
(
ComponentKind
kind)
Creates a new
Component
with specific type.
public
Component.from_string
(
string
str)
Creates a new
Component
based on a string.
public
Component.vagenda
()
Creates a
Component
with the type to be vagenda.
public
Component.valarm
()
Creates a
Component
with the type to be valarm.
public
Component.vavailability
()
Creates a
Component
with the type to be vavailability.
public
Component.vcalendar
()
Creates a
Component
with the type to be vcalendar.
public
Component.vevent
()
Creates a
Component
with the type to be vevent.
public
Component.vfreebusy
()
Creates a
Component
with the type to be vfreebusy.
public
Component.vjournal
()
Creates a
Component
with the type to be vjournal.
public
Component.vpoll
()
Creates a
Component
with the type to be vpoll.
public
Component.vquery
()
Creates a
Component
with the type to be vquery.
public
Component.vtimezone
()
Creates a
Component
with the type to be vtimezone.
public
Component.vtodo
()
Creates a
Component
with the type to be vtodo.
public
Component.vvoter
()
Creates a
Component
with the type to be vvoter.
public
Component.x
(
string
x_name)
Creates a new
Component
based on name of x property.
public
Component.xavailable
()
Creates a
Component
with the type to be xavailable.
public
Component.xdaylight
()
Creates a
Component
with the type to be xdaylight.
public
Component.xstandard
()
Creates a
Component
with the type to be xstandard.
public
Component.xvote
()
Creates a
Component
with the type to be xvote.
Methods:
public
void
add_component
(
Component
child)
Adds a
Component
into another
Component
as a child component.
public
void
add_property
(
Property
property)
Adds an
Property
into
Component
.
public
string
as_ical_string
()
Converts a
Component
to a string.
public
CompIter
begin_component
(
ComponentKind
kind)
Gets the
CompIter
pointing to the first child
Component
.
public
int
check_restrictions
()
Checks the number of restrictions in
Component
.
public
Component
clone
()
Deeply clone a
Component
.
public
void
convert_errors
()
Converts some X-LIC-ERROR properties into RETURN-STATUS properties.
public
int
count_components
(
ComponentKind
kind)
Counts the child
Component
with the target kind in the parent one.
public
int
count_errors
()
Counts the number of errors in
Component
.
public
int
count_properties
(
PropertyKind
kind)
Counts the number of
Property
in
Component
.
public
CompIter
end_component
(
ComponentKind
kind)
Gets the
CompIter
pointing to the end child
Component
.
public
void
foreach_recurrence
(
Time
start,
Time
end,
ComponentForeachRecurrenceFunc
? callback)
Cycles through all recurrences of an event.
public
void
foreach_tzid
(
ComponentForeachTZIDFunc
? callback)
Applies the same manipulation on every tzid in
Component
.
public
unowned
string
get_comment
()
Gets the comment of the
Component
.
public
Component
get_current_component
()
Gets the current
Component
in
Component
.
public
Property
get_current_property
()
Gets the current
Property
in
Component
.
public
unowned
string
get_description
()
Gets the description of the
Component
.
public
Time
get_dtend
()
Gets the dtend of the
Component
.
public
Time
get_dtstamp
()
Gets the dtstamp of the
Component
.
public
Time
get_dtstart
()
Gets the dtstart of the
Component
.
public
Time
get_due
()
Gets the due of the
Component
.
public
Duration
get_duration
()
Gets the duration of the
Component
.
public
Component
?
get_first_component
(
ComponentKind
kind)
Gets the first
Component
with specific kind in
Component
.
public
Property
?
get_first_property
(
PropertyKind
kind)
Gets the first
Property
with specific kind in
Component
.
public
Component
get_first_real_component
()
For VCOMPONENT: Returns a reference to the first VEVENT, VTODO or VJOURNAL.
public
Component
?
get_inner
()
Returns the first VEVENT, VTODO or VJOURNAL sub-component of cop, or comp if it is one of those types.
public
unowned
string
get_location
()
Gets the location of the
Component
.
public
PropertyMethod
get_method
()
Gets the method of the
Component
.
public
Component
?
get_next_component
(
ComponentKind
kind)
Gets the next
Component
with specific kind in
Component
.
public
Property
?
get_next_property
(
PropertyKind
kind)
Gets the next
Property
with specific kind in
Component
.
public
Component
?
get_parent
()
Gets the parent component of the
this
.
public
Time
get_recurrenceid
()
Gets the recurrenceid of the
Component
.
public
unowned
string
get_relcalid
()
Gets the relcalid of the
Component
.
public
int
get_sequence
()
Gets the sequence of the
Component
.
public
TimeSpan
get_span
()
For VEVENT, VTODO, VJOURNAL and VTIMEZONE: reports the start and end times of an event in UTC.
public
PropertyStatus
get_status
()
Gets the status of the
Component
.
public
unowned
string
get_summary
()
Gets the summary of the
Component
.
public
Timezone
?
get_timezone
(
string
tzid)
Returns the icaltimezone in the component corresponding to the TZID, or NULL if it can't be found.
public
unowned
string
get_uid
()
Gets the uid of the
Component
.
public
bool
is_valid
()
Checks whether
Component
is valid.
public
ComponentKind
isa
()
Gets the type of
Component
.
public
int
isa_component
()
Checks whether the native part of
Component
is icalcomponent.
public
void
merge_component
(
Component
comp_to_merge)
Takes 2 VCALENDAR components and merges the second one into the first, resolving any problems with conflicting TZIDs.
public
void
remove_component
(
Component
child)
Removes a child
Component
from another
Component
.
public
void
remove_property
(
Property
property)
Removes
Property
from
Component
.
public
void
set_comment
(
string
v)
Sets the comment of the
Component
.
public
void
set_description
(
string
v)
Sets the description of the
Component
.
public
void
set_dtend
(
Time
v)
Sets the dtend of the
Component
.
public
void
set_dtstamp
(
Time
v)
Sets the dtstamp of the
Component
.
public
void
set_dtstart
(
Time
v)
Sets the dtstart of the
Component
.
public
void
set_due
(
Time
v)
Sets the due of the
Component
.
public
void
set_duration
(
Duration
v)
Sets the duration of the
Component
.
public
void
set_location
(
string
v)
Sets the location of the
Component
.
public
void
set_method
(
PropertyMethod
method)
Sets the method of the
Component
.
public
void
set_parent
(
Component
? parent)
Sets the
parent
Component
of the specified
this
.
public
void
set_recurrenceid
(
Time
v)
Sets the recurrenceid of the
Component
.
public
void
set_relcalid
(
string
v)
Sets the relcalid of the
Component
.
public
void
set_sequence
(
int
v)
Sets the sequence of the
Component
.
public
void
set_status
(
PropertyStatus
status)
Sets the status of the
Component
.
public
void
set_summary
(
string
v)
Sets the summary of the
Component
.
public
void
set_uid
(
string
v)
Sets the uid of the
Component
.
public
void
strip_errors
()
Removes all X-LIC-ERROR properties.
Inherited Members:
All known members inherited from class ICal.Object
add_depender
always_destroy
free_global_objects
get_always_destroy
get_is_global_memory
is_global_memory
native
native_destroy_func
owner
ref_owner
remove_depender
remove_owner
set_always_destroy
set_native_destroy_func
set_owner
steal_native
All known members inherited from class GLib.Object
@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data
get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer
replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref
2022 vala-language.org