Component
Object Hierarchy:
Description:
Namespace: ECal
Package: libecal-2.0
Content:
Creation methods:
- public Component ()
Creates a new empty calendar component object.
- public Component.from_icalcomponent (owned Component icalcomp)
Creates a new Component which will has set
icalcomp
as an inner Component. - public Component.from_string (string calobj)
Creates a new calendar component object from the given iCalendar string.
- public Component.vtype (ComponentVType vtype)
Creates a new Component of type
vtype
.
Methods:
- public void abort_sequence ()
Aborts the sequence change needed in the given calendar component, which means it will not require a sequence commit (via commit_sequence ) even if the changes done require a sequence increment.
- public void add_alarm (ComponentAlarm alarm)
Adds an alarm subcomponent to a calendar component.
- public Component clone ()
Creates a new calendar component object by copying the information from another one.
- public void commit_sequence ()
Increments the sequence number property in a calendar component object if it needs it.
- public ComponentText? dup_comment_for_locale (string? locale)
Returns a comment for the given
locale
. - public ComponentText? dup_description_for_locale (string? locale)
Returns a description for the given
locale
. - public SList<ComponentText>? dup_summaries ()
Queries the summary of a calendar component object.
- public ComponentText? dup_summary_for_locale (string? locale)
Returns a summary for the given
locale
. - public ComponentAlarm? get_alarm (string auid)
Queries a particular alarm subcomponent of a calendar component.
- public SList<string>? get_alarm_uids ()
Builds a list of the unique identifiers of the alarm subcomponents inside a calendar component.
- public SList<ComponentAlarm>? get_all_alarms ()
Queries all alarm subcomponents of a calendar component.
- public string get_as_string ()
Gets the iCalendar string representation of a calendar component.
- public SList<Attach>? get_attachments ()
Queries the attachment properties as Attach objects of the calendar component object.
- public SList<ComponentAttendee>? get_attendees ()
Queries the attendee properties of the calendar component object.
- public string? get_categories ()
Queries the categories of the given calendar component.
- public SList<string>? get_categories_list ()
Queries the list of categories of a calendar component object.
- public ComponentClassification get_classification ()
Queries the classification of a calendar component object.
- public SList<ComponentText>? get_comments ()
Queries the comments of a calendar component object.
- public Time? get_completed ()
Queries the date at which a calendar compoment object was completed.
- public SList<ComponentText> get_contacts ()
Queries the contact of a calendar component object.
- public Time? get_created ()
Queries the date in which a calendar component object was created in the calendar store.
- public SList<ComponentText>? get_descriptions ()
Queries the description of a calendar component object.
- public ComponentDateTime? get_dtend ()
Queries the date/time end of a calendar component object.
- public Time? 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.
- public ComponentDateTime? get_dtstart ()
Queries the date/time start of a calendar component object.
- public ComponentDateTime? get_due ()
Queries the due date/time of a calendar component object.
- public SList<ComponentDateTime>? get_exdates ()
Queries the list of exception date properties in a calendar component object.
- public SList<Property>? get_exrule_properties ()
Queries the list of exception rule properties of a calendar component object.
- public SList<Recurrence>? get_exrules ()
Queries the list of exception rule properties of a calendar component object.
- public Geo? get_geo ()
Gets the geographic position property of a calendar component object.
- public unowned Component? get_icalcomponent ()
Queries the
icalcomponent
structure that a calendar component object is wrapping. - public ComponentId get_id ()
Get the ID of the component as an ComponentId.
- public Time? get_last_modified ()
Queries the time at which a calendar component object was last modified in the calendar store.
- public string? get_location ()
Queries the location property of a calendar component object.
- public ComponentOrganizer? get_organizer ()
Queries the organizer property of a calendar component object.
- public int get_percent_complete ()
Queries the percent-complete property of a calendar component object.
- public int get_priority ()
Queries the priority property of a calendar component object.
- public SList<ComponentPeriod>? get_rdates ()
Queries the list of recurrence date properties in a calendar component object.
- public ComponentRange? get_recurid ()
Queries the recurrence id property of a calendar component object.
- public string get_recurid_as_string ()
Gets the recurrence ID property as a string.
- public SList<Property>? get_rrule_properties ()
Queries a list of recurrence rule properties of a calendar component object.
- public SList<Recurrence>? get_rrules ()
Queries the list of recurrence rule properties of a calendar component object.
- public int get_sequence ()
Queries the sequence number of a calendar component object.
- public PropertyStatus get_status ()
Queries the status property of a calendar component object.
- public ComponentText? get_summary ()
Queries the summary of a calendar component object.
- public ComponentTransparency get_transparency ()
Queries the time transparency of a calendar component object.
- public unowned string get_uid ()
Queries the unique identifier of a calendar component object.
- public string? get_url ()
Queries the uniform resource locator property of a calendar component object.
- public ComponentVType get_vtype ()
Queries the type of a calendar component object.
- public bool has_alarms ()
Checks whether the component has any alarms.
- public bool has_attachments ()
Queries the component to see if it has attachments.
- public bool has_attendees ()
Queries a calendar component object for the existence of attendees.
- public bool has_exceptions ()
Queries whether a calendar component object has any exception dates or exception rules.
- public bool has_exdates ()
Queries whether a calendar component object has any exception dates defined for it.
- public bool has_exrules ()
Queries whether a calendar component object has any exception rules defined for it.
- public bool has_organizer ()
Check whether a calendar component object has an organizer or not.
- public bool has_rdates ()
Queries whether a calendar component object has any recurrence dates defined for it.
- public bool has_recurrences ()
Queries whether a calendar component object has any recurrence dates or recurrence rules.
- public bool has_rrules ()
Queries whether a calendar component object has any recurrence rules defined for it.
- public bool has_simple_recurrence ()
Checks whether the given calendar component object has simple recurrence rules or more complicated ones.
- public bool is_instance ()
Checks whether a calendar component object is an instance of a recurring event.
- public void remove_alarm (string auid)
Removes an alarm subcomponent from a calendar component.
- public void remove_all_alarms ()
Remove all alarms from the calendar component
- public void set_attachments (SList<Attach>? attachments)
Sets the attachments of the calendar component object.
- public void set_attendees (SList<ComponentAttendee>? attendee_list)
Sets the attendees of a calendar component object
- public void set_categories (string categories)
Sets the list of categories for a calendar component.
- public void set_categories_list (SList<string> categ_list)
Sets the list of categories of a calendar component object.
- public void set_classification (ComponentClassification classif)
Sets the classification property of a calendar component object.
- public void set_comments (SList<ComponentText> text_list)
Sets the comments of a calendar component object.
- public void set_completed (Time? tt)
Sets the date at which a calendar component object was completed.
- public void set_contacts (SList<ComponentText> text_list)
Sets the contact of a calendar component object.
- public void set_created (Time? tt)
Sets the date in which a calendar component object is created in the calendar store.
- public void set_descriptions (SList<ComponentText> text_list)
Sets the description of a calendar component object.
- public void set_dtend (ComponentDateTime? dt)
Sets the date/time end property of a calendar component object.
- public void set_dtstamp (Time tt)
Sets the date/timestamp of a calendar component object.
- public void set_dtstart (ComponentDateTime? dt)
Sets the date/time start property of a calendar component object.
- public void set_due (ComponentDateTime? dt)
Sets the due date/time property of a calendar component object.
- public void set_exdates (SList<ComponentDateTime>? exdate_list)
Sets the list of exception dates in a calendar component object.
- public void set_exrules (SList<Recurrence>? recur_list)
Sets the list of exception rules in a calendar component object.
- public void set_geo (Geo? geo)
Sets the geographic position property on a calendar component object.
- public bool set_icalcomponent (owned Component? icalcomp)
Sets the contents of a calendar component object from an Component.
- public void set_last_modified (Time? tt)
Sets the time at which a calendar component object was last stored in the calendar store.
- public void set_location (string? location)
Sets the location property of a calendar component object.
- public void set_new_vtype (ComponentVType type)
Clears any existing component data from a calendar component object and creates a new Component of the specified type for it.
- public void set_organizer (ComponentOrganizer? organizer)
Sets the organizer of a calendar component object
- public void set_percent_complete (int percent)
Sets percent complete.
- public void set_priority (int priority)
Sets the priority property of a calendar component object.
- public void set_rdates (SList<ComponentPeriod>? rdate_list)
Sets the list of recurrence dates in a calendar component object.
- public void set_recurid (ComponentRange? recur_id)
Sets the recurrence id property of a calendar component object.
- public void set_rrules (SList<Recurrence>? recur_list)
Sets the list of recurrence rules in a calendar component object.
- public void set_sequence (int sequence)
Sets the sequence number of a calendar component object.
- public void set_status (PropertyStatus status)
Sets the status property of a calendar component object.
- public void set_summaries (SList<ComponentText> text_list)
Sets the summary of a calendar component object.
- public void set_summary (ComponentText summary)
Sets the summary of a calendar component object.
- public void set_transparency (ComponentTransparency transp)
Sets the time transparency of a calendar component object.
- public void set_uid (string uid)
Sets the unique identifier string of a calendar component object.
- public void set_url (string? url)
Sets the uniform resource locator property of a calendar component object.
- public void strip_errors ()
Strips all error messages from the calendar component.
Inherited Members:
All known members inherited from class GLib.Object