CalComponent
RFC 2445 iCalendar component object.
The #CalComponent object provides a wrapper over the &libical;
functions for manipulating calendar components. #CalComponent
presents a GTK+-like interface to calendar components according to
RFC 2445.
While &libical; supports almost all of the features of the
iCalendar RFCs, applications are normally not interested in all
the mindless gunk that is there. Still, applications should do
their best not to drop extension fields from calendar components
or any other extra information they do not support (including
standard fields they are not interested in). The #CalComponent
object provides a wrapper over
icalcomponent structures from &libical;
so that no information in them will be lost even if the
application is not designed to handle it. Also, #CalComponent
provides a higher-level API to many of the &libical; operations so
as to make it less painful to deal with iCalendar components.
A #CalComponent object starts out empty. It must be initialized
from an existing icalcomponent structure
by using the cal_component_set_icalcomponent() function, or from a
completely new data by specifying the desired component type to
the cal_component_set_new_vtype() function.
#CalComponent will create an internal map of the properties in the
icalcomponent structure and then allow
random access to them via the #CalComponent API functions;
normally the &libical; API would have to be used by creating many
iterators and other unpleasant constructs. #CalComponent keeps
handles to the properties it scanned from the
icalcomponent and will let the parent
application modify them at any time without having to do any
iteration.
Eventually a #CalComponent may be turned into the RFC 2445 string
representation of an iCalendar component by using the
cal_component_get_as_string() function. Applications can then
transfer this interoperable
“Interoperable.” Heavens, I love that word.
string to other programs that deal with iCalendar.
Casts a #GtkObject to a #CalComponent.
@obj: A GTK+ object.
Calendar component types as defined by RFC 2445. These values can
be used to create a new calendar component by passing them to the
cal_component_set_new_vtype() function. They are also the return
value of the cal_component_get_vtype() function. The only time
the @CAL_COMPONENT_NO_TYPE value is used is when querying the
vtype of an uninitialized #CalComponent.
@CAL_COMPONENT_NO_TYPE: Returned from cal_component_get_vtype() to
indicate an uninitialized #CalComponent object.
@CAL_COMPONENT_EVENT: Indicates a VEVENT component.
@CAL_COMPONENT_TODO: Indicates a VTODO component.
@CAL_COMPONENT_JOURNAL: Indicates a VJOURNAL component.
@CAL_COMPONENT_FREEBUSY: Indicates a VFREEBUSY component.
@CAL_COMPONENT_TIMEZONE: Indicates a VTIMEZOME component.
These values are used as identifiers for #ETable columns. These
are used by the calendar GUI code in &Evolution;.
@CAL_COMPONENT_FIELD_CATEGORIES: Component's list of categories.
@CAL_COMPONENT_FIELD_CLASSIFICATION: Component's classification.
@CAL_COMPONENT_FIELD_COMPLETED: Component's completion date.
@CAL_COMPONENT_FIELD_DTEND: Component's ending date.
@CAL_COMPONENT_FIELD_DTSTART: Component's starting date.
@CAL_COMPONENT_FIELD_DUE: Component's due date.
@CAL_COMPONENT_FIELD_GEO: Component's geographical position.
@CAL_COMPONENT_FIELD_PERCENT: Component's percent completed value.
@CAL_COMPONENT_FIELD_PRIORITY: Component's priority.
@CAL_COMPONENT_FIELD_SUMMARY: Component's summary.
@CAL_COMPONENT_FIELD_TRANSPARENCY: Component's transparency value.
@CAL_COMPONENT_FIELD_URL: Component's URL.
@CAL_COMPONENT_FIELD_HAS_ALARMS: Whether the component has any alarms.
@CAL_COMPONENT_FIELD_ICON: Which icon to use for the component.
@CAL_COMPONENT_FIELD_COMPLETE: Whether the component has been completed.
@CAL_COMPONENT_FIELD_RECURRING: Whether the component has any recurrences.
@CAL_COMPONENT_FIELD_OVERDUE: Whether the component is overdue.
@CAL_COMPONENT_FIELD_COLOR: Which color to use for the component.
@CAL_COMPONENT_FIELD_NUM_FIELDS: Total number of enumerated fields.
Values for the access classification property of a calendar
component.
@CAL_COMPONENT_CLASS_NONE: Indicates that no access classification has
been set for the corresponding component.
@CAL_COMPONENT_CLASS_PUBLIC: Public access.
@CAL_COMPONENT_CLASS_PRIVATE: Private access.
@CAL_COMPONENT_CLASS_CONFIDENTIAL: Confidential access.
@CAL_COMPONENT_CLASS_UNKNOWN: Unknown access classification value,
used when &libical; returns something #CalComponent does not know
about.
This structure defines a date and time value.
Defines how a period of time is specified.
@CAL_COMPONENT_PERIOD_DATETIME: Indicates that the period is specified
by starting and ending date/time values.
@CAL_COMPONENT_PERIOD_DURATION: Indicates that the period is specified
as a starding date/time and a duration value.
This structure defines a period of time.
This structure defines the value of a text property that may have
an alternate representation parameter.
@CAL_COMPONENT_TRANSP_NONE:
@CAL_COMPONENT_TRANSP_TRANSPARENT:
@CAL_COMPONENT_TRANSP_OPAQUE:
@CAL_COMPONENT_TRANSP_UNKNOWN:
@Returns:
@Returns:
@comp:
@Returns:
@comp:
@type:
@comp:
@icalcomp:
@Returns:
@comp:
@Returns:
@comp:
@Returns:
@comp:
@Returns:
@comp:
@comp:
@uid:
@comp:
@uid:
@comp:
@categ_list:
@comp:
@categ_list:
@comp:
@classif:
@comp:
@classif:
@comp:
@text_list:
@comp:
@text_list:
@comp:
@t:
@comp:
@t:
@comp:
@t:
@comp:
@t:
@comp:
@text_list:
@comp:
@text_list:
@comp:
@dt:
@comp:
@dt:
@comp:
@t:
@comp:
@t:
@comp:
@dt:
@comp:
@dt:
@comp:
@dt:
@comp:
@dt:
@comp:
@exdate_list:
@comp:
@exdate_list:
@comp:
@recur_list:
@comp:
@recur_list:
@comp:
@geo:
@comp:
@geo:
@comp:
@t:
@comp:
@t:
@comp:
@percent:
@comp:
@percent:
@comp:
@priority:
@comp:
@priority:
@comp:
@period_list:
@comp:
@period_list:
@comp:
@Returns:
@comp:
@recur_list:
@comp:
@recur_list:
@comp:
@Returns:
@comp:
@sequence:
@comp:
@sequence:
@comp:
@summary:
@comp:
@summary:
@comp:
@transp:
@comp:
@transp:
@comp:
@url:
@comp:
@url:
@comp:
@pilot_id:
@comp:
@pilot_id:
@comp:
@pilot_status:
@comp:
@pilot_status:
@categ_list:
@dt:
@exdate_list:
@geo:
@t:
@percent:
@priority:
@period_list:
@recur_list:
@sequence:
@text_list:
@CAL_COMPONENT_ALARM_NONE:
@CAL_COMPONENT_ALARM_AUDIO:
@CAL_COMPONENT_ALARM_DISPLAY:
@CAL_COMPONENT_ALARM_EMAIL:
@CAL_COMPONENT_ALARM_PROCEDURE:
@CAL_COMPONENT_ALARM_UNKNOWN:
@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE:
@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE:
@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START:
@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END:
@comp:
@Returns:
@comp:
@Returns:
@alarm:
@alarm:
@action:
@alarm:
@action:
@alarm:
@trigger:
@alarm:
@trigger:
@trigger: