ECal.ComponentDateTime¶

Fields¶

None

Methods¶

class	`new` (value, tzid)
class	`new_take` (value, tzid)
	`copy` ()
	`get_tzid` ()
	`get_value` ()
	`set` (value, tzid)
	`set_tzid` (tzid)
	`set_value` (value)
	`take_tzid` (tzid)
	`take_value` (value)

Details¶

class ECal.ComponentDateTime¶

An opaque structure containing an ICalGLib.Time describing the date/time value and also its TZID parameter. Use the functions below to work with it.

classmethod new(value, tzid)¶

Parameters:

value (ICalGLib.Time) – an ICalGLib.Time as a value
tzid (str or None) – timezone ID for the value, or None

Returns:

a new ECal.ComponentDateTime

Return type:

ECal.ComponentDateTime

Creates a new ECal.ComponentDateTime instance, which holds the value and tzid. The returned structure should be freed with e_cal_component_datetime_free(), when no longer needed.

Added in version 3.34.

classmethod new_take(value, tzid)¶

Parameters:

value (ICalGLib.Time) – an ICalGLib.Time as a value
tzid (str or None) – timezone ID for the value, or None

Returns:

a new ECal.ComponentDateTime

Return type:

ECal.ComponentDateTime

Creates a new ECal.ComponentDateTime instance, which holds the value and tzid. It is similar to ECal.ComponentDateTime.new(), except this function assumes ownership of the value and tzid. The returned structure should be freed with e_cal_component_datetime_free(), when no longer needed.

Added in version 3.34.

copy()¶

Returns:: a new ECal.ComponentDateTime, copy of self
Return type:: ECal.ComponentDateTime

Creates a new copy of self. The returned structure should be freed with e_cal_component_datetime_free() when no longer needed.

Added in version 3.34.

get_tzid()¶

Returns:: a TZID of self, or None
Return type:: str or None

Returns the TZID stored with the self. The string is owned by self and it’s valid until the self is freed or its TZID overwritten. It never returns an empty string, it returns either set TZID parameter value or None, when none is set.

Added in version 3.34.

get_value()¶

Returns:: a value of self, as an ICalGLib.Time
Return type:: ICalGLib.Time

Returns the value stored with the self. The object is owned by self and it’s valid until the self is freed or its value overwritten.

Added in version 3.34.

set(value, tzid)¶

Parameters:

value (ICalGLib.Time) – an ICalGLib.Time as a value
tzid (str or None) – timezone ID for the value, or None

Sets both value and tzid in one call. Use ECal.ComponentDateTime.set_value() and ECal.ComponentDateTime.set_tzid() to set them separately.

Added in version 3.34.

set_tzid(tzid)¶

Parameters:: tzid (str or None) – the TZID to set, or None

Sets the tzid of the self. Any previously set TZID is freed. An empty string or a None as tzid is treated as none TZID.

Added in version 3.34.

set_value(value)¶

Parameters:: value (ICalGLib.Time) – the value to set, as an ICalGLib.Time

Sets the value of the self. Any previously set value is freed.

Added in version 3.34.

take_tzid(tzid)¶

Parameters:: tzid (str or None) – the TZID to take, or None

Sets the tzid of the self and assumes ownership of tzid. Any previously set TZID is freed. An empty string or a None as tzid is treated as none TZID.

Added in version 3.34.

take_value(value)¶

Parameters:: value (ICalGLib.Time) – the value to take, as an ICalGLib.Time

Sets the value of the self and assumes ownership of the value. Any previously set value is freed.

Added in version 3.34.