Class
ECalComponent
Constructors
e_cal_component_new
Creates a new empty calendar component object. Once created, you should set it from an
existing #icalcomponent structure by using e_cal_component_set_icalcomponent() or with a
new empty component type by using e_cal_component_set_new_vtype().
since: 3.34
e_cal_component_new_from_icalcomponent
Creates a new ECalComponent which will has set icalcomp as
an inner ICalComponent. The newly created ECalComponent takes
ownership of the icalcomp, and if the call to e_cal_component_set_icalcomponent() fails, then icalcomp
is freed.
since: 3.34
e_cal_component_new_from_string
Creates a new calendar component object from the given iCalendar string.
since: 3.34
Instance methods
e_cal_component_abort_sequence
Aborts the sequence change needed in the given calendar component, which means it will not require a sequence commit (via e_cal_component_commit_sequence()) even if the changes done require a sequence increment.
since: 3.34
e_cal_component_add_alarm
Adds an alarm subcomponent to a calendar component. You should have created the alarm by using e_cal_component_alarm_new(); it is invalid to use an
ECalComponentAlarm structure that came from e_cal_component_get_alarm(). After
adding the alarm, the alarm structure is no longer valid because the
internal structures may change and you should get rid of it by using e_cal_component_alarm_free().
since: 3.34
e_cal_component_clone
Creates a new calendar component object by copying the information from another one.
since: 3.34
e_cal_component_commit_sequence
Increments the sequence number property in a calendar component object if it needs it. This needs to be done when any of a number of properties listed in RFC 2445 change values, such as the start and end dates of a component.
since: 3.34
e_cal_component_dup_comment_for_locale
Returns a comment for the given locale. When locale is NULL,
the current locale is assumed. If no such comment for the locale
exists either a comment with no language parameter or the first
found is returned.
since: 3.46
e_cal_component_dup_description_for_locale
Returns a description for the given locale. When locale is NULL,
the current locale is assumed. If no such description for the locale
exists either a description with no language parameter or the first
found is returned.
since: 3.46
e_cal_component_dup_summaries
Queries the summary of a calendar component object. There can be one summary
property per locale. Free the returned GSList with
g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.
since: 3.46
e_cal_component_dup_summary_for_locale
Returns a summary for the given locale. When locale is NULL,
the current locale is assumed. If no such summary for the locale
exists either a summary with no language parameter or the first
found is returned.
since: 3.46
e_cal_component_get_alarm
Queries a particular alarm subcomponent of a calendar component. Free the returned pointer with e_cal_component_alarm_free(), when no longer needed.
since: 3.34
e_cal_component_get_alarm_uids
Builds a list of the unique identifiers of the alarm subcomponents inside a
calendar component. Free the returned GSList with
g_slist_free_full (slist, g_free);, when no longer needed.
since: 3.34
e_cal_component_get_all_alarms
Queries all alarm subcomponents of a calendar component.
Free the returned GSList with g_slist_free_full (slist, e_cal_component_alarm_free);,
when no longer needed.
since: 3.34
e_cal_component_get_as_string
Gets the iCalendar string representation of a calendar component. You should call e_cal_component_commit_sequence() before this function to ensure that the
component’s sequence number is consistent with the state of the object.
since: 3.34
e_cal_component_get_attachments
Queries the attachment properties as ICalAttach objects of the calendar
component object. Changes on these objects are directly affecting the component.
Free the returned GSList with g_slist_free_full (slist, g_object_unref);,
when no longer needed.
since: 3.34
e_cal_component_get_attendees
Queries the attendee properties of the calendar component object.
Free the returned GSList with g_slist_free_full (slist, e_cal_component_attendee_free);,
when no longer needed.
since: 3.34
e_cal_component_get_categories
Queries the categories of the given calendar component. The categories
are returned in the categories argument, which, on success, will contain
a comma-separated list of all categories set in the component.
Free the returned string with g_free(), when no longer needed.
since: 3.34
e_cal_component_get_categories_list
Queries the list of categories of a calendar component object. Each element
in the returned categ_list is a string with the corresponding category.
Free the returned GSList with g_slist_free_full (categories, g_free); , when
no longer needed.
since: 3.34
e_cal_component_get_classification
Queries the classification of a calendar component object. If the classification property is not set on this component, this function returns
E_CAL_COMPONENT_CLASS_NONE.
since: 3.34
e_cal_component_get_comments
Queries the comments of a calendar component object. The comment property can
appear several times inside a calendar component, and so a list of
ECalComponentText is returned. Free the returned GSList with
g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.
since: 3.34
e_cal_component_get_completed
Queries the date at which a calendar compoment object was completed. Free the returned non-NULL pointer with g_object_unref(), when no longer needed.
since: 3.34
e_cal_component_get_contacts
Queries the contact of a calendar component object. The contact property can
appear several times inside a calendar component, and so a list of
ECalComponentText is returned. Free the returned GSList with
g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.
since: 3.34
e_cal_component_get_created
Queries the date in which a calendar component object was created in the calendar store. Free the returned non-NULL pointer with g_object_unref(), when no longer needed.
since: 3.34
e_cal_component_get_descriptions
Queries the description of a calendar component object. Journal components
may have more than one description, and as such this function returns a list of ECalComponentText structures. All other types of components can have at
most one description for a single language. Free the returned GSList with
g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.
since: 3.34
e_cal_component_get_dtend
Queries the date/time end of a calendar component object. In case there’s no DTEND,
but only DTSTART and DURATION, then the end is computed from the later two.
Free the returned ECalComponentDateTime with e_cal_component_datetime_free(),
when no longer needed.
since: 3.34
e_cal_component_get_dtstamp
Queries the date/timestamp property of a calendar component object, which is the last time at which the object was modified by a calendar user agent.
since: 3.34
e_cal_component_get_dtstart
Queries the date/time start of a calendar component object.
Free the returned ECalComponentDateTime with e_cal_component_datetime_free(),
when no longer needed.
since: 3.34
e_cal_component_get_due
Queries the due date/time of a calendar component object. In case there’s no DUE,
but only DTSTART and DURATION, then the due is computed from the later two.
Free the returned ECalComponentDateTime with e_cal_component_datetime_free(),
when no longer needed.
since: 3.34
e_cal_component_get_exdates
Queries the list of exception date properties in a calendar component object.
Free the returned GSList with g_slist_free_full (exdates, e_cal_component_datetime_free);,
when no longer needed.
since: 3.34
e_cal_component_get_exrule_properties
Queries the list of exception rule properties of a calendar component object. Free the list with g_slist_free_full (slist, g_object_unref);, when no longer needed.
since: 3.34
e_cal_component_get_exrules
Queries the list of exception rule properties of a calendar component object. Free the returned list with g_slist_free_full (slist, g_object_unref);, when no longer needed.
since: 3.34
e_cal_component_get_geo
Gets the geographic position property of a calendar component object. Free the returned non-NULL object with g_object_unref(), when no longer needed.
since: 3.34
e_cal_component_get_icalcomponent
Queries the #icalcomponent structure that a calendar component object is wrapping.
since: 3.34
e_cal_component_get_id
Get the ID of the component as an ECalComponentId. The return value should
be freed with e_cal_component_id_free(), when no longer needed.
since: 3.34
e_cal_component_get_last_modified
Queries the time at which a calendar component object was last modified in the calendar store. Free the returned non-NULL pointer with g_object_unref(), when no longer needed.
since: 3.34
e_cal_component_get_location
Queries the location property of a calendar component object.
since: 3.34
e_cal_component_get_organizer
Queries the organizer property of a calendar component object. Free the returned structure with e_cal_component_organizer_free(), when no longer needed.
since: 3.34
e_cal_component_get_percent_complete
Queries the percent-complete property of a calendar component object.
since: 3.34
e_cal_component_get_priority
Queries the priority property of a calendar component object.
since: 3.34
e_cal_component_get_rdates
Queries the list of recurrence date properties in a calendar component
object. Free the returned GSList with g_slist_free_full (slist, e_cal_component_period_free);,
when no longer needed.
since: 3.34
e_cal_component_get_recurid
Queries the recurrence id property of a calendar component object.
Free the returned ECalComponentRange with e_cal_component_range_free(),
whe no longer needed.
since: 3.34
e_cal_component_get_rrule_properties
Queries a list of recurrence rule properties of a calendar component object. Free the list with g_slist_free_full (slist, g_object_unref);, when no longer needed.
since: 3.34
e_cal_component_get_rrules
Queries the list of recurrence rule properties of a calendar component object. Free the returned list with g_slist_free_full (slist, g_object_unref);, when no longer needed.
since: 3.34
e_cal_component_get_sequence
Queries the sequence number of a calendar component object.
since: 3.34
e_cal_component_get_summary
Queries the summary of a calendar component object. It returns the first found summary property of the component. To get a summary suitable for a specific locale use e_cal_component_dup_summary_for_locale().
since: 3.34
e_cal_component_get_transparency
Queries the time transparency of a calendar component object.
since: 3.34
e_cal_component_get_url
Queries the uniform resource locator property of a calendar component object. Free the returned URL with g_free(), when no longer needed.
since: 3.34
e_cal_component_has_attendees
Queries a calendar component object for the existence of attendees.
since: 3.34
e_cal_component_has_exceptions
Queries whether a calendar component object has any exception dates or exception rules.
since: 3.34
e_cal_component_has_exdates
Queries whether a calendar component object has any exception dates defined for it.
since: 3.34
e_cal_component_has_exrules
Queries whether a calendar component object has any exception rules defined for it.
since: 3.34
e_cal_component_has_organizer
Check whether a calendar component object has an organizer or not.
since: 3.34
e_cal_component_has_rdates
Queries whether a calendar component object has any recurrence dates defined for it.
since: 3.34
e_cal_component_has_recurrences
Queries whether a calendar component object has any recurrence dates or recurrence rules.
since: 3.34
e_cal_component_has_rrules
Queries whether a calendar component object has any recurrence rules defined for it.
since: 3.34
e_cal_component_has_simple_recurrence
Checks whether the given calendar component object has simple recurrence rules or more complicated ones.
since: 3.34
e_cal_component_is_instance
Checks whether a calendar component object is an instance of a recurring event.
since: 3.34
e_cal_component_remove_alarm
Removes an alarm subcomponent from a calendar component. If the alarm that
corresponds to the specified auid had been fetched with
e_cal_component_get_alarm(), then those alarm structures will be invalid; you
should get rid of them with e_cal_component_alarm_free() before using this function.
since: 3.34
e_cal_component_set_categories_list
Sets the list of categories of a calendar component object.
since: 3.34
e_cal_component_set_classification
Sets the classification property of a calendar component object. To unset
the property, specify E_CAL_COMPONENT_CLASS_NONE for classif.
since: 3.34
e_cal_component_set_comments
Sets the comments of a calendar component object. The comment property can
appear several times inside a calendar component, and so a list of
ECalComponentText structures is used.
since: 3.34
e_cal_component_set_completed
Sets the date at which a calendar component object was completed.
since: 3.34
e_cal_component_set_contacts
Sets the contact of a calendar component object. The contact property can
appear several times inside a calendar component, and so a list of
ECalComponentText structures is used.
since: 3.34
e_cal_component_set_created
Sets the date in which a calendar component object is created in the calendar store. This should only be used inside a calendar store application, i.e. not by calendar user agents.
since: 3.34
e_cal_component_set_descriptions
Sets the description of a calendar component object. Journal components may
have more than one description, and as such this function takes in a list of
ECalComponentText structures. All other types of components can have
at most one description.
since: 3.34
e_cal_component_set_dtend
Sets the date/time end property of a calendar component object.
since: 3.34
e_cal_component_set_dtstamp
Sets the date/timestamp of a calendar component object. This should be called whenever a calendar user agent makes a change to a component’s properties.
since: 3.34
e_cal_component_set_dtstart
Sets the date/time start property of a calendar component object.
since: 3.34
e_cal_component_set_exdates
Sets the list of exception dates in a calendar component object.
since: 3.34
e_cal_component_set_exrules
Sets the list of exception rules in a calendar component object.
since: 3.34
e_cal_component_set_geo
Sets the geographic position property on a calendar component object.
since: 3.34
e_cal_component_set_icalcomponent
Sets the contents of a calendar component object from an ICalComponent.
If the comp already had an ICalComponent set into it, it will
be freed automatically.
since: 3.34
e_cal_component_set_last_modified
Sets the time at which a calendar component object was last stored in the calendar store. This should not be called by plain calendar user agents.
since: 3.34
e_cal_component_set_new_vtype
Clears any existing component data from a calendar component object and
creates a new ICalComponent of the specified type for it. The only property
that will be set in the new component will be its unique identifier.
since: 3.34
e_cal_component_set_percent_complete
Sets percent complete. The percent can be between 0 and 100, inclusive.
A special value -1 can be used to remove the percent complete property.
since: 3.34
e_cal_component_set_priority
Sets the priority property of a calendar component object. The priority can be between 0 and 9, inclusive.
A special value -1 can be used to remove the priority property.
since: 3.34
e_cal_component_set_rdates
Sets the list of recurrence dates in a calendar component object.
since: 3.34
e_cal_component_set_recurid
Sets the recurrence id property of a calendar component object.
since: 3.34
e_cal_component_set_rrules
Sets the list of recurrence rules in a calendar component object.
since: 3.34
e_cal_component_set_sequence
Sets the sequence number of a calendar component object. A special value -1 can be used to remove the sequence number property.
since: 3.34
e_cal_component_set_summaries
Sets the summary of a calendar component object. The summaries can have each different language, otherwise it’s not allowed to have more than one summary property.
since: 3.46
e_cal_component_set_transparency
Sets the time transparency of a calendar component object. Use E_CAL_COMPONENT_TRANSP_NONE to unset the property.
since: 3.34
e_cal_component_set_uid
Sets the unique identifier string of a calendar component object.
since: 3.34
e_cal_component_set_url
Sets the uniform resource locator property of a calendar component object. A NULL or an empty string removes the property.
since: 3.34
e_cal_component_strip_errors
Strips all error messages from the calendar component. Those error messages are added to the iCalendar string representation whenever an invalid is used for one of its fields.
since: 3.34
Signals
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.