ECal.ComponentText¶

Fields¶

None

Methods¶

class	`new` (value, altrep)
class	`new_from_property` (property)
	`copy` ()
	`fill_property` (property)
	`get_altrep` ()
	`get_language` ()
	`get_value` ()
	`set_altrep` (altrep)
	`set_from_property` (property)
	`set_language` (language)
	`set_value` (value)

Details¶

class ECal.ComponentText¶

Contains description string and an alternate representation URI for text properties. Use the functions below to work with it.

classmethod new(value, altrep)¶

Parameters:

value (str or None) – description text
altrep (str or None) – alternate representation URI

Returns:

a newly allocated ECal.ComponentText

Return type:

ECal.ComponentText

Creates a new ECal.ComponentText describing text properties. The returned structure should be freed with e_cal_component_text_free(), when no longer needed.

New in version 3.34.

classmethod new_from_property(property)¶

Parameters:: property (ICalGLib.Property) – an ICalGLib.Property
Returns:: a newly allocated ECal.ComponentText
Return type:: ECal.ComponentText

Created a new ECal.ComponentText filled with values from the property. The property should hold a text value.

New in version 3.46.

copy()¶

Returns:: a newly allocated ECal.ComponentText, copy of self. The returned structure should be freed with e_cal_component_text_free(), when no longer needed.
Return type:: ECal.ComponentText

New in version 3.34.

fill_property(property)¶

Parameters:: property (ICalGLib.Property) – an ICalGLib.Property

Fills the property with the content of the self.

New in version 3.46.

get_altrep()¶

Returns:: the alternate representation URI of the self
Return type:: str

New in version 3.34.

get_language()¶

Returns:: the language of the self
Return type:: str

New in version 3.46.

get_value()¶

Returns:: the description string of the self
Return type:: str

New in version 3.34.

set_altrep(altrep)¶

Parameters:: altrep (str or None) – alternate representation URI to set

Set the altrep as the alternate representation URI of the self.

New in version 3.34.

set_from_property(property)¶

Parameters:: property (ICalGLib.Property) – an ICalGLib.Property

Fill the self structure with the information from the property. The property should hold a text value.

New in version 3.46.

set_language(language)¶

Parameters:: language (str or None) – language of the self

Set the language as the language of the self. The language tag is defined in RFC 5646. For example en-US, not en_US.

New in version 3.46.

set_value(value)¶

Parameters:: value (str or None) – description string to set

Set the value as the description string of the self.

New in version 3.34.