![]() | ![]() | ![]() | MIME Directory Library Reference Manual | ![]() |
---|
#include <mimedir/mimedir-vcomponent.h> struct MIMEDirVComponent; enum MIMEDirClassification; enum MIMEDirStatus; #define MIMEDIR_VCOMPONENT_PERCENT_NONEgboolean mimedir_vcomponent_read_from_profile (MIMEDirVComponent *vcomponent
,MIMEDirProfile *profile
,); MIMEDirProfile * mimedir_vcomponent_write_to_profile (
GError **errorMIMEDirVComponent *vcomponent
,const
);gchar *profile_namegchar * mimedir_vcomponent_get_categories_as_string (MIMEDirVComponent *vcomponent
);void mimedir_vcomponent_set_alarm_list (MIMEDirVComponent *vcomponent
,const
); constGList *listGList * mimedir_vcomponent_get_alarm_list (MIMEDirVComponent *vcomponent
);void mimedir_vcomponent_set_attendee_list (MIMEDirVComponent *vcomponent
,const
); constGList *listGList * mimedir_vcomponent_get_attendee_list (MIMEDirVComponent *vcomponent
);void mimedir_vcomponent_set_opaque (MIMEDirVComponent *vcomponent
,);
gboolean opaquegboolean mimedir_vcomponent_get_opaque (MIMEDirVComponent *vcomponent
);void mimedir_vcomponent_set_classification (MIMEDirVComponent *vcomponent
,MIMEDirClassification classification
,const
); MIMEDirClassification mimedir_vcomponent_get_classification (gchar *klassMIMEDirVComponent *vcomponent
,const
);gchar **klassvoid mimedir_vcomponent_set_location (MIMEDirVComponent *vcomponent
,const
,gchar *locationconst
); constgchar *urigchar * mimedir_vcomponent_get_location (MIMEDirVComponent *vcomponent
,const
);gchar **urivoid mimedir_vcomponent_set_geopos (MIMEDirVComponent *vcomponent
,,
gdouble latitude);
gdouble longitudevoid mimedir_vcomponent_get_geopos (MIMEDirVComponent *vcomponent
,,
gdouble *latitude);
gdouble *longitudevoid mimedir_vcomponent_set_recurrence (MIMEDirVComponent *vcomponent
,MIMEDirRecurrence *recurrence
); MIMEDirRecurrence * mimedir_vcomponent_get_recurrence (MIMEDirVComponent *vcomponent
);void mimedir_vcomponent_set_allday (MIMEDirVComponent *vcomponent
,);
gboolean alldaygboolean mimedir_vcomponent_get_allday (MIMEDirVComponent *vcomponent
);gboolean mimedir_vcomponent_does_recur (MIMEDirVComponent *vcomponent
); MIMEDirDateTime * mimedir_vcomponent_get_next_occurence (MIMEDirVComponent *vcomponent
,MIMEDirDateTime *after
);GList * mimedir_vcomponent_get_occurences_between (MIMEDirVComponent *vcomponent
,MIMEDirDateTime *start
,MIMEDirDateTime *end
);void mimedir_vcomponent_free_occurences ();
GList *listvoid mimedir_vcomponent_set_attachment_list (MIMEDirVComponent *vcomponent
,);
GList *listGList * mimedir_vcomponent_get_attachment_list (MIMEDirVComponent *vcomponent
);
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".
MIMEDIR_CLASS_PUBLIC | Public classification |
MIMEDIR_CLASS_PRIVATE | Private classification |
MIMEDIR_CLASS_CONFIDENTIAL | Confidential classification |
MIMEDIR_CLASS_CUSTOM | Custom classification (string attached) |
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_STATUS_UNKNOWN | Unknown status |
MIMEDIR_STATUS_CANCELLED | Cancelled appointment |
MIMEDIR_STATUS_TENTATIVE | Tentative appointment |
MIMEDIR_STATUS_CONFIRMED | Confirmed appointment |
MIMEDIR_STATUS_NEEDS_ACTION | Needs action |
MIMEDIR_STATUS_COMPLETED | Item completed |
MIMEDIR_STATUS_IN_PROCESS | Item being worked on |
MIMEDIR_STATUS_DRAFT | Preliminary item |
MIMEDIR_STATUS_FINAL | Final item |
#define MIMEDIR_VCOMPONENT_PERCENT_NONE (101)
Used to signify that a percentage is unknown or unset.
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
vcomponent : | a vComponent object |
profile : | a profile object |
error : | error storage location or |
Returns : | success indicator |
MIMEDirProfile * mimedir_vcomponent_write_to_profile (MIMEDirVComponent *vcomponent
,const
);gchar *profile_name
Saves the vcomponent object to a newly allocated profile object.
vcomponent : | a vcomponent |
profile_name : | the new profile type |
Returns : | a new profile |
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()
vcomponent : | a MIMEDirVComponent object |
Returns : | a human-readable string |
void mimedir_vcomponent_set_alarm_list (MIMEDirVComponent *vcomponent
,const
);GList *list
Sets the list of alarms of this component.
vcomponent : | a MIMEDirVComponent object |
list : | a |
constGList * 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()
vcomponent : | a MIMEDirVComponent object |
Returns : | a |
void mimedir_vcomponent_set_attendee_list (MIMEDirVComponent *vcomponent
,const
);GList *list
Sets the list of attendees for this component.
vcomponent : | a MIMEDirVComponent object |
list : | a |
constGList * mimedir_vcomponent_get_attendee_list (MIMEDirVComponent *vcomponent
);
Returns the list of attendees to this particular component.
vcomponent : | a MIMEDirVComponent object |
Returns : | a |
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.
vcomponent : | a MIMEDirVComponent object |
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.
vcomponent : | a MIMEDirVComponent object |
Returns : | a boolean value |
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!
vcomponent : | a MIMEDirVComponent object |
classification : | the new security classification |
klass : | textual security classficiation |
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 klass
will be filled
to point to a string that signifies the security classification.
vcomponent : | a MIMEDirVComponent object |
klass : | pointer to a string storage location or |
Returns : | the security classification |
void mimedir_vcomponent_set_location (MIMEDirVComponent *vcomponent
,const
,gchar *locationconst
);gchar *uri
Sets the venue, such as a conference or meeting room. uri
, if not
If location
is uri
must be
vcomponent : | a MIMEDirVComponent object |
location : | location specification or |
uri : | optional alternate URI or |
constgchar * 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,
If uri
is not uri
will be set to
vcomponent : | a MIMEDirVComponent object |
uri : | uri storage pointer or |
Returns : | location string or |
void mimedir_vcomponent_set_geopos (MIMEDirVComponent *vcomponent
,,
gdouble latitude);
gdouble longitude
Sets this component's geographic position to latitude
/longitude
.
vcomponent : | a MIMEDirVComponent object |
latitude : | latitude from -90 to +90 degrees |
longitude : | longitude from -180 to + 180 degrees |
void mimedir_vcomponent_get_geopos (MIMEDirVComponent *vcomponent
,,
gdouble *latitude);
gdouble *longitude
Sets latitude
and longitude
to the component's geographical position.
vcomponent : | a MIMEDirVComponent object |
latitude : | pointer to a |
longitude : | pointer to a |
void mimedir_vcomponent_set_recurrence (MIMEDirVComponent *vcomponent
,MIMEDirRecurrence *recurrence
);
Sets the recurrence information for vcomponent
. If recurrence
is
vcomponent : | a MIMEDirVComponent object |
recurrence : | a MIMEDirRecurrence object or |
MIMEDirRecurrence * mimedir_vcomponent_get_recurrence (MIMEDirVComponent *vcomponent
);
Returns the recurrence object associated with this component or
vcomponent : | a MIMEDirVComponent object |
Returns : | a MIMEDirRecurrence object or |
void mimedir_vcomponent_set_allday (MIMEDirVComponent *vcomponent
,);
gboolean allday
Set the allday flag to allday
.
vcomponent : | a MIMEDirVComponent object |
allday : |
gboolean mimedir_vcomponent_get_allday (MIMEDirVComponent *vcomponent
);
Return
vcomponent : | a MIMEDirVComponent object |
Returns : |
gboolean mimedir_vcomponent_does_recur (MIMEDirVComponent *vcomponent
);
Return
vcomponent : | a MIMEDirVComponent object |
Returns : |
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
vcomponent : | a MIMEDirVComponent object |
after : | a MIMEDirDateTime object |
Returns : | a MIMEDirDateTime object or |
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 start
are returned.
Every second element in the list may be
The returned list should be freed with mimedir_vcomponent_free_occurences()
.
vcomponent : | a MIMEDirVComponent object |
start : | start time |
end : | end time, may be |
Returns : | a |
void mimedir_vcomponent_free_occurences ();
GList *list
Frees a mimedir_vcomponent_get_occurences_between()
.
list : | a |
void mimedir_vcomponent_set_attachment_list (MIMEDirVComponent *vcomponent
,);
GList *list
Sets the list of attachments of vcomponent
to list
, freeing the old list.
vcomponent : | a MIMEDirVComponent object |
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.
vcomponent : | a MIMEDirVComponent object |
Returns : | read-only |
<<< MIMEDirVCal | MIMEDirVAlarm >>> |