ICalGLib.Component

g GObject.Object GObject.Object ICalGLib.Object ICalGLib.Object GObject.Object->ICalGLib.Object ICalGLib.Component ICalGLib.Component ICalGLib.Object->ICalGLib.Component

Subclasses:

None

Methods

Inherited:

ICalGLib.Object (11), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

kind_from_string (string)

class

kind_is_valid (kind)

class

kind_to_string (kind)

class

new (kind)

class

new_from_string (str)

class

new_vagenda ()

class

new_valarm ()

class

new_vavailability ()

class

new_vcalendar ()

class

new_vevent ()

class

new_vfreebusy ()

class

new_vjournal ()

class

new_vpoll ()

class

new_vquery ()

class

new_vtimezone ()

class

new_vtodo ()

class

new_vvoter ()

class

new_x (x_name)

class

new_xavailable ()

class

new_xdaylight ()

class

new_xstandard ()

class

new_xvote ()

add_component (child)

add_property (property)

as_ical_string ()

begin_component (kind)

check_restrictions ()

clone ()

convert_errors ()

count_components (kind)

count_errors ()

count_properties (kind)

end_component (kind)

foreach_recurrence (start, end, callback, *user_data)

foreach_tzid (callback, *user_data)

get_comment ()

get_current_component ()

get_current_property ()

get_description ()

get_dtend ()

get_dtstamp ()

get_dtstart ()

get_due ()

get_duration ()

get_first_component (kind)

get_first_property (kind)

get_first_real_component ()

get_inner ()

get_location ()

get_method ()

get_next_component (kind)

get_next_property (kind)

get_parent ()

get_recurrenceid ()

get_relcalid ()

get_sequence ()

get_span ()

get_status ()

get_summary ()

get_timezone (tzid)

get_uid ()

is_valid ()

isa ()

isa_component ()

merge_component (comp_to_merge)

remove_component (child)

remove_property (property)

set_comment (v)

set_description (v)

set_dtend (v)

set_dtstamp (v)

set_dtstart (v)

set_due (v)

set_duration (v)

set_location (v)

set_method (method)

set_parent (parent)

set_recurrenceid (v)

set_relcalid (v)

set_sequence (v)

set_status (status)

set_summary (v)

set_uid (v)

strip_errors ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

ICalGLib.Object (5)

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class ICalGLib.Component(**kwargs)
Bases:

ICalGLib.Object

Abstract:

No

Structure:

ICalGLib.ComponentClass

This is the ICalGLib.Component instance.

classmethod kind_from_string(string)
Parameters:

string (str) – A string

Returns:

A ICalGLib.ComponentKind

Return type:

ICalGLib.ComponentKind

Converts a string to a ICalGLib.ComponentKind.

New in version 1.0.

classmethod kind_is_valid(kind)
Parameters:

kind (ICalGLib.ComponentKind) – A ICalGLib.ComponentKind

Returns:

1 if kind id a ICalGLib.Component but not the ICalGLib.ComponentKind.NO_COMPONENT, 0 if not.

Return type:

bool

Checks if a ICalGLib.ComponentKind is valid.

New in version 1.0.

classmethod kind_to_string(kind)
Parameters:

kind (ICalGLib.ComponentKind) – A ICalGLib.ComponentKind

Returns:

The string representation of kind.

Return type:

str

Converts a ICalGLib.ComponentKind to a string.

New in version 1.0.

classmethod new(kind)
Parameters:

kind (ICalGLib.ComponentKind) – The ICalGLib.ComponentKind

Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a new ICalGLib.Component with specific type.

New in version 1.0.

classmethod new_from_string(str)
Parameters:

str (str) – The string used to create ICalGLib.Component

Returns:

The newly created ICalGLib.Component based on str.

Return type:

ICalGLib.Component

Creates a new ICalGLib.Component based on a string.

New in version 1.0.

classmethod new_vagenda()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vagenda.

New in version 1.0.

classmethod new_valarm()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be valarm.

New in version 1.0.

classmethod new_vavailability()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vavailability.

New in version 1.0.

classmethod new_vcalendar()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vcalendar.

New in version 1.0.

classmethod new_vevent()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vevent.

New in version 1.0.

classmethod new_vfreebusy()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vfreebusy.

New in version 1.0.

classmethod new_vjournal()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vjournal.

New in version 1.0.

classmethod new_vpoll()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vpoll.

New in version 1.0.

classmethod new_vquery()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vquery.

New in version 1.0.

classmethod new_vtimezone()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vtimezone.

New in version 1.0.

classmethod new_vtodo()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vtodo.

New in version 1.0.

classmethod new_vvoter()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be vvoter.

New in version 1.0.

classmethod new_x(x_name)
Parameters:

x_name (str) – The name of x property

Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a new ICalGLib.Component based on name of x property.

New in version 1.0.

classmethod new_xavailable()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be xavailable.

New in version 1.0.

classmethod new_xdaylight()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be xdaylight.

New in version 1.0.

classmethod new_xstandard()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be xstandard.

New in version 1.0.

classmethod new_xvote()
Returns:

The newly created ICalGLib.Component.

Return type:

ICalGLib.Component

Creates a ICalGLib.Component with the type to be xvote.

New in version 1.0.

add_component(child)
Parameters:

child (ICalGLib.Component) – A child ICalGLib.Component

Adds a ICalGLib.Component into another ICalGLib.Component as a child component.

New in version 1.0.

add_property(property)
Parameters:

property (ICalGLib.Property) – An ICalGLib.Property

Adds an ICalGLib.Property into ICalGLib.Component.

New in version 1.0.

as_ical_string()
Returns:

The string representation of ICalGLib.Component.

Return type:

str

Converts a ICalGLib.Component to a string.

New in version 1.0.

begin_component(kind)
Parameters:

kind (ICalGLib.ComponentKind) – A ICalGLib.ComponentKind

Returns:

A ICalGLib.CompIter

Return type:

ICalGLib.CompIter

Gets the ICalGLib.CompIter pointing to the first child ICalGLib.Component.

New in version 1.0.

check_restrictions()
Returns:

The number of restrictions in self

Return type:

int

Checks the number of restrictions in ICalGLib.Component.

New in version 1.0.

clone()
Returns:

The newly deeply cloned ICalGLib.Component.

Return type:

ICalGLib.Component

Deeply clone a ICalGLib.Component.

New in version 1.0.

convert_errors()

Converts some X-LIC-ERROR properties into RETURN-STATUS properties.

New in version 1.0.

count_components(kind)
Parameters:

kind (ICalGLib.ComponentKind) – The target ICalGLib.ComponentKind

Returns:

The count of child ICalGLib.Component in the parent one.

Return type:

int

Counts the child ICalGLib.Component with the target kind in the parent one.

New in version 1.0.

count_errors()
Returns:

The count of errors.

Return type:

int

Counts the number of errors in ICalGLib.Component.

New in version 1.0.

count_properties(kind)
Parameters:

kind (ICalGLib.PropertyKind) – A ICalGLib.PropertyKind

Returns:

The number of ICalGLib.Property.

Return type:

int

Counts the number of ICalGLib.Property in ICalGLib.Component.

New in version 1.0.

end_component(kind)
Parameters:

kind (ICalGLib.ComponentKind) – A ICalGLib.ComponentKind

Returns:

A ICalGLib.CompIter

Return type:

ICalGLib.CompIter

Gets the ICalGLib.CompIter pointing to the end child ICalGLib.Component.

New in version 1.0.

foreach_recurrence(start, end, callback, *user_data)
Parameters:

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.

New in version 3.0.5.

foreach_tzid(callback, *user_data)
Parameters:

Applies the same manipulation on every tzid in ICalGLib.Component.

New in version 3.0.5.

get_comment()
Returns:

The comment of self.

Return type:

str

Gets the comment of the ICalGLib.Component.

New in version 1.0.

get_current_component()
Returns:

The current ICalGLib.Component.

Return type:

ICalGLib.Component

Gets the current ICalGLib.Component in ICalGLib.Component.

New in version 1.0.

get_current_property()
Returns:

The current ICalGLib.Property.

Return type:

ICalGLib.Property

Gets the current ICalGLib.Property in ICalGLib.Component.

New in version 1.0.

get_description()
Returns:

The description of self.

Return type:

str

Gets the description of the ICalGLib.Component.

New in version 1.0.

get_dtend()
Returns:

A ICalGLib.Time.

Return type:

ICalGLib.Time

Gets the dtend of the ICalGLib.Component.

New in version 1.0.

get_dtstamp()
Returns:

A ICalGLib.Time.

Return type:

ICalGLib.Time

Gets the dtstamp of the ICalGLib.Component.

New in version 1.0.

get_dtstart()
Returns:

A ICalGLib.Time.

Return type:

ICalGLib.Time

Gets the dtstart of the ICalGLib.Component.

New in version 1.0.

get_due()
Returns:

A ICalGLib.Time.

Return type:

ICalGLib.Time

Gets the due of the ICalGLib.Component.

New in version 1.0.

get_duration()
Returns:

An ICalGLib.Duration.

Return type:

ICalGLib.Duration

Gets the duration of the ICalGLib.Component.

New in version 1.0.

get_first_component(kind)
Parameters:

kind (ICalGLib.ComponentKind) – A ICalGLib.ComponentKind

Returns:

The first ICalGLib.Component.

Return type:

ICalGLib.Component or None

Gets the first ICalGLib.Component with specific kind in ICalGLib.Component.

New in version 1.0.

get_first_property(kind)
Parameters:

kind (ICalGLib.PropertyKind) – A ICalGLib.PropertyKind

Returns:

The first ICalGLib.Property.

Return type:

ICalGLib.Property or None

Gets the first ICalGLib.Property with specific kind in ICalGLib.Component.

New in version 1.0.

get_first_real_component()
Returns:

A reference to the first VEVENT, VTODO or VJOURNAL

Return type:

ICalGLib.Component

For VCOMPONENT: Returns a reference to the first VEVENT, VTODO or VJOURNAL.

New in version 1.0.

get_inner()
Returns:

The first VEVENT, VTODO or VJOURNAL sub-component.

Return type:

ICalGLib.Component or None

Returns the first VEVENT, VTODO or VJOURNAL sub-component of cop, or comp if it is one of those types.

New in version 1.0.

get_location()
Returns:

The location of self.

Return type:

str

Gets the location of the ICalGLib.Component.

New in version 1.0.

get_method()
Returns:

A ICalGLib.PropertyMethod.

Return type:

ICalGLib.PropertyMethod

Gets the method of the ICalGLib.Component.

New in version 1.0.

get_next_component(kind)
Parameters:

kind (ICalGLib.ComponentKind) – A ICalGLib.ComponentKind

Returns:

The next ICalGLib.Component.

Return type:

ICalGLib.Component or None

Gets the next ICalGLib.Component with specific kind in ICalGLib.Component.

New in version 1.0.

get_next_property(kind)
Parameters:

kind (ICalGLib.PropertyKind) – A ICalGLib.PropertyKind

Returns:

The next ICalGLib.Property.

Return type:

ICalGLib.Property or None

Gets the next ICalGLib.Property with specific kind in ICalGLib.Component.

New in version 1.0.

get_parent()
Returns:

The parent ICalGLib.Component of the self.

Return type:

ICalGLib.Component or None

Gets the parent component of the self.

New in version 3.0.

get_recurrenceid()
Returns:

A ICalGLib.Time.

Return type:

ICalGLib.Time

Gets the recurrenceid of the ICalGLib.Component.

New in version 1.0.

get_relcalid()
Returns:

The relcalid of self.

Return type:

str

Gets the relcalid of the ICalGLib.Component.

New in version 1.0.

get_sequence()
Returns:

The sequence of self.

Return type:

int

Gets the sequence of the ICalGLib.Component.

New in version 1.0.

get_span()
Returns:

A ICalGLib.TimeSpan.

Return type:

ICalGLib.TimeSpan

For VEVENT, VTODO, VJOURNAL and VTIMEZONE: reports the start and end times of an event in UTC.

New in version 1.0.

get_status()
Returns:

A ICalGLib.PropertyStatus.

Return type:

ICalGLib.PropertyStatus

Gets the status of the ICalGLib.Component.

New in version 1.0.

get_summary()
Returns:

The summary of self.

Return type:

str

Gets the summary of the ICalGLib.Component.

New in version 1.0.

get_timezone(tzid)
Parameters:

tzid (str) – A string representing timezone

Returns:

A ICalGLib.Timezone.

Return type:

ICalGLib.Timezone or None

Returns the icaltimezone in the component corresponding to the TZID, or None if it can’t be found.

New in version 1.0.

get_uid()
Returns:

The uid of self.

Return type:

str

Gets the uid of the ICalGLib.Component.

New in version 1.0.

is_valid()
Returns:

1 if yes, 0 if not.

Return type:

bool

Checks whether ICalGLib.Component is valid.

New in version 1.0.

isa()
Returns:

A ICalGLib.ComponentKind.

Return type:

ICalGLib.ComponentKind

Gets the type of ICalGLib.Component.

New in version 1.0.

isa_component()
Returns:

1 if yes, 0 if not.

Return type:

int

Checks whether the native part of ICalGLib.Component is icalcomponent.

New in version 1.0.

merge_component(comp_to_merge)
Parameters:

comp_to_merge (ICalGLib.Component) – A ICalGLib.Component. After merged it will not exist any more.

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.

New in version 1.0.

remove_component(child)
Parameters:

child (ICalGLib.Component) – A child ICalGLib.Component

Removes a child ICalGLib.Component from another ICalGLib.Component.

New in version 1.0.

remove_property(property)
Parameters:

property (ICalGLib.Property) – A ICalGLib.Property

Removes ICalGLib.Property from ICalGLib.Component. Caution: The compare is based on address. So you must use the original ICalGLib.Property as the target.

New in version 1.0.

set_comment(v)
Parameters:

v (str) – A string representing comment

Sets the comment of the ICalGLib.Component.

New in version 1.0.

set_description(v)
Parameters:

v (str) – A string representing description

Sets the description of the ICalGLib.Component.

New in version 1.0.

set_dtend(v)
Parameters:

v (ICalGLib.Time) – A ICalGLib.Time

Sets the dtend of the ICalGLib.Component.

New in version 1.0.

set_dtstamp(v)
Parameters:

v (ICalGLib.Time) – A ICalGLib.Time

Sets the dtstamp of the ICalGLib.Component.

New in version 1.0.

set_dtstart(v)
Parameters:

v (ICalGLib.Time) – A ICalGLib.Time

Sets the dtstart of the ICalGLib.Component.

New in version 1.0.

set_due(v)
Parameters:

v (ICalGLib.Time) – A ICalGLib.Time

Sets the due of the ICalGLib.Component.

New in version 1.0.

set_duration(v)
Parameters:

v (ICalGLib.Duration) – A ICalGLib.Duration

Sets the duration of the ICalGLib.Component.

New in version 1.0.

set_location(v)
Parameters:

v (str) – A string representing location

Sets the location of the ICalGLib.Component.

New in version 1.0.

set_method(method)
Parameters:

method (ICalGLib.PropertyMethod) – A ICalGLib.PropertyMethod

Sets the method of the ICalGLib.Component.

New in version 1.0.

set_parent(parent)
Parameters:

parent (ICalGLib.Component or None) – An ICalGLib.Component, a new parent

Sets the parent ICalGLib.Component of the specified self.

New in version 3.0.

set_recurrenceid(v)
Parameters:

v (ICalGLib.Time) – A ICalGLib.Time

Sets the recurrenceid of the ICalGLib.Component.

New in version 1.0.

set_relcalid(v)
Parameters:

v (str) – A string representing relcalid

Sets the relcalid of the ICalGLib.Component.

New in version 1.0.

set_sequence(v)
Parameters:

v (int) – The sequence number

Sets the sequence of the ICalGLib.Component.

New in version 1.0.

set_status(status)
Parameters:

status (ICalGLib.PropertyStatus) – A ICalGLib.PropertyStatus

Sets the status of the ICalGLib.Component.

New in version 1.0.

set_summary(v)
Parameters:

v (str) – A string representing summary

Sets the summary of the ICalGLib.Component.

New in version 1.0.

set_uid(v)
Parameters:

v (str) – A string representing uid

Sets the uid of the ICalGLib.Component.

New in version 1.0.

strip_errors()

Removes all X-LIC-ERROR properties.

New in version 1.0.