MIMEDirVComponent

MIMEDirVComponent

typedef struct {
	GObject parent;

	MIMEDirVComponentPriv *priv;
} MIMEDirVComponent;

enum MIMEDirClassification

typedef enum {
	MIMEDIR_CLASS_PUBLIC,
	MIMEDIR_CLASS_PRIVATE,
	MIMEDIR_CLASS_CONFIDENTIAL,
	MIMEDIR_CLASS_CUSTOM
} MIMEDirClassification;

Classification of an iCalendar component object, i.e. the "secrecy level".

enum MIMEDirStatus

typedef enum {
	MIMEDIR_STATUS_UNKNOWN,
	MIMEDIR_STATUS_CANCELLED,
	MIMEDIR_STATUS_TENTATIVE,	/* VEvent */
	MIMEDIR_STATUS_CONFIRMED,
	MIMEDIR_STATUS_NEEDS_ACTION,	/* VTodo */
	MIMEDIR_STATUS_COMPLETED,
	MIMEDIR_STATUS_IN_PROCESS,
	MIMEDIR_STATUS_DRAFT,		/* VJournal */
	MIMEDIR_STATUS_FINAL
} MIMEDirStatus;

MIMEDIR_VCOMPONENT_PERCENT_NONE

#define MIMEDIR_VCOMPONENT_PERCENT_NONE (101)

Used to signify that a percentage is unknown or unset.

mimedir_vcomponent_read_from_profile ()

gboolean            mimedir_vcomponent_read_from_profile
                                                        (MIMEDirVComponent *vcomponent,
                                                         MIMEDirProfile *profile,
                                                         GError **error);

Clears the supplied vComponent object and re-initializes it with data read from the supplied profile. If an error occurs during the read, error will be set and FALSE will be returned. Otherwise, TRUE is returned.

mimedir_vcomponent_write_to_profile ()

MIMEDirProfile*     mimedir_vcomponent_write_to_profile (MIMEDirVComponent *vcomponent,
                                                         const gchar *profile_name);

Saves the vcomponent object to a newly allocated profile object.

mimedir_vcomponent_get_categories_as_string ()

gchar*              mimedir_vcomponent_get_categories_as_string
                                                        (MIMEDirVComponent *vcomponent);

Returns the categories of this object as a human-readable, comma-separated string. The returned string should be freed with g_free().

mimedir_vcomponent_set_alarm_list ()

void                mimedir_vcomponent_set_alarm_list   (MIMEDirVComponent *vcomponent,
                                                         const GList *list);

Sets the list of alarms of this component.

mimedir_vcomponent_get_alarm_list ()

const GList*        mimedir_vcomponent_get_alarm_list   (MIMEDirVComponent *vcomponent);

Returns all alarms of this component. The list must not be modified by the caller. The MIMEDirVAlarm objects in this list must be g_object_ref()'ed when they are to be used by the caller.

mimedir_vcomponent_set_attendee_list ()

void                mimedir_vcomponent_set_attendee_list
                                                        (MIMEDirVComponent *vcomponent,
                                                         const GList *list);

Sets the list of attendees for this component.

mimedir_vcomponent_get_attendee_list ()

const GList*        mimedir_vcomponent_get_attendee_list
                                                        (MIMEDirVComponent *vcomponent);

Returns the list of attendees to this particular component.

mimedir_vcomponent_set_opaque ()

void                mimedir_vcomponent_set_opaque       (MIMEDirVComponent *vcomponent,
                                                         gboolean opaque);

Sets whether an event is to be considered opaque or transparent. A transparent event does not consume time on the calendar.

mimedir_vcomponent_get_opaque ()

gboolean            mimedir_vcomponent_get_opaque       (MIMEDirVComponent *vcomponent);

Returns whether an event is opaque or transparent. Transparent events do not consume time on the calendar.

mimedir_vcomponent_set_classification ()

void                mimedir_vcomponent_set_classification
                                                        (MIMEDirVComponent *vcomponent,
                                                         MIMEDirClassification classification,
                                                         const gchar *klass);

Sets the new security classification to classification. If and only if the classification is MIMEDIR_CLASS_CUSTOM klass must be pointing to a string to use as security classification. Be sure you know what you're doing when using MIMEDIR_CLASS_CUSTOM!

mimedir_vcomponent_get_classification ()

MIMEDirClassification mimedir_vcomponent_get_classification
                                                        (MIMEDirVComponent *vcomponent,
                                                         const gchar **klass);

Returns the component's security classification. If the class ist MIMEDIR_CLASS_CUSTOM and klass is not NULL, klass will be filled to point to a string that signifies the security classification.

mimedir_vcomponent_set_location ()

void                mimedir_vcomponent_set_location     (MIMEDirVComponent *vcomponent,
                                                         const gchar *location,
                                                         const gchar *uri);

Sets the venue, such as a conference or meeting room. uri, if not NULL, points to an alternate representation such as an web site or an LDAP entry.

If location is NULL the property will be unset. In this case, uri must be NULL as well.

mimedir_vcomponent_get_location ()

const gchar*        mimedir_vcomponent_get_location     (MIMEDirVComponent *vcomponent,
                                                         const gchar **uri);

Retrieves the venue, such as a conference or meeting room. If this property is not set, NULL will be returned.

If uri is not NULL, it will be set to an URI to an alternate representation (if one was set). If no alternate representation URI was given, uri will be set to NULL.

mimedir_vcomponent_set_geopos ()

void                mimedir_vcomponent_set_geopos       (MIMEDirVComponent *vcomponent,
                                                         gdouble latitude,
                                                         gdouble longitude);

Sets this component's geographic position to latitude/longitude.

mimedir_vcomponent_get_geopos ()

void                mimedir_vcomponent_get_geopos       (MIMEDirVComponent *vcomponent,
                                                         gdouble *latitude,
                                                         gdouble *longitude);

Sets latitude and longitude to the component's geographical position.

mimedir_vcomponent_set_recurrence ()

void                mimedir_vcomponent_set_recurrence   (MIMEDirVComponent *vcomponent,
                                                         MIMEDirRecurrence *recurrence);

Sets the recurrence information for vcomponent. If recurrence is NULL, this component does not recur.

mimedir_vcomponent_get_recurrence ()

MIMEDirRecurrence*  mimedir_vcomponent_get_recurrence   (MIMEDirVComponent *vcomponent);

Returns the recurrence object associated with this component or NULL if there is no recurrence object.

mimedir_vcomponent_set_allday ()

void                mimedir_vcomponent_set_allday       (MIMEDirVComponent *vcomponent,
                                                         gboolean allday);

Set the allday flag to allday.

mimedir_vcomponent_get_allday ()

gboolean            mimedir_vcomponent_get_allday       (MIMEDirVComponent *vcomponent);

Return TRUE if the event lasts a whole day, FALSE otherwise.

mimedir_vcomponent_does_recur ()

gboolean            mimedir_vcomponent_does_recur       (MIMEDirVComponent *vcomponent);

Return TRUE if the component has an associated recurrence object.

mimedir_vcomponent_get_next_occurence ()

MIMEDirDateTime*    mimedir_vcomponent_get_next_occurence
                                                        (MIMEDirVComponent *vcomponent,
                                                         MIMEDirDateTime *after);

Returns the first occurence of this component after or at the date specified by the after argument. If after is NULL, the very first occurence is returned. If there is no occurence after the specified date, NULL is returned.

mimedir_vcomponent_get_occurences_between ()

GList*              mimedir_vcomponent_get_occurences_between
                                                        (MIMEDirVComponent *vcomponent,
                                                         MIMEDirDateTime *start,
                                                         MIMEDirDateTime *end);

Return a list of MIMEDirDateTime objects that specify the start and end dates of all occurences of vcomponent that overlap with the time interval between start and end. If end is NULL, all occurences that intersect with start are returned.

Every second element in the list may be NULL in which case there is no end time for the occurence.

The returned list should be freed with mimedir_vcomponent_free_occurences().

mimedir_vcomponent_free_occurences ()

void                mimedir_vcomponent_free_occurences  (GList *list);

Frees a GList as returned by mimedir_vcomponent_get_occurences_between().

mimedir_vcomponent_set_attachment_list ()

void                mimedir_vcomponent_set_attachment_list
                                                        (MIMEDirVComponent *vcomponent,
                                                         GList *list);

Sets the list of attachments of vcomponent to list, freeing the old list.

mimedir_vcomponent_get_attachment_list ()

GList*              mimedir_vcomponent_get_attachment_list
                                                        (MIMEDirVComponent *vcomponent);

Returns the list of attachments of vcomponent. This list is to be considered read-only and must not be altered in any way.