![]() |
![]() |
![]() |
Evolution API Reference: libebook, the Addressbook Library | ![]() |
---|---|---|---|---|
EVCard; enum EVCardFormat; EVCardAttribute; EVCardAttributeParam; void e_vcard_construct (EVCard *evc, const char *str); EVCard* e_vcard_new (void); EVCard* e_vcard_new_from_string (const char *str); char* e_vcard_to_string (EVCard *evc, EVCardFormat format); void e_vcard_dump_structure (EVCard *evc); EVCardAttribute* e_vcard_attribute_new (const char *attr_group, const char *attr_name); void e_vcard_attribute_free (EVCardAttribute *attr); EVCardAttribute* e_vcard_attribute_copy (EVCardAttribute *attr); void e_vcard_remove_attributes (EVCard *evcard, const char *attr_group, const char *attr_name); void e_vcard_remove_attribute (EVCard *evcard, EVCardAttribute *attr); void e_vcard_add_attribute (EVCard *evcard, EVCardAttribute *attr); void e_vcard_add_attribute_with_value (EVCard *evcard, EVCardAttribute *attr, const char *value); void e_vcard_add_attribute_with_values (EVCard *evcard, EVCardAttribute *attr, ...); void e_vcard_attribute_add_value (EVCardAttribute *attr, const char *value); void e_vcard_attribute_add_value_decoded (EVCardAttribute *attr, const char *value, int len); void e_vcard_attribute_add_values (EVCardAttribute *attr, ...); void e_vcard_attribute_remove_values (EVCardAttribute *attr); void e_vcard_attribute_remove_params (EVCardAttribute *attr); EVCardAttributeParam* e_vcard_attribute_param_new (const char *param_name); void e_vcard_attribute_param_free (EVCardAttributeParam *param); EVCardAttributeParam* e_vcard_attribute_param_copy (EVCardAttributeParam *param); void e_vcard_attribute_add_param (EVCardAttribute *attr, EVCardAttributeParam *param); void e_vcard_attribute_add_param_with_value (EVCardAttribute *attr, EVCardAttributeParam *param, const char *value); void e_vcard_attribute_add_param_with_values (EVCardAttribute *attr, EVCardAttributeParam *param, ...); void e_vcard_attribute_param_add_value (EVCardAttributeParam *param, const char *value); void e_vcard_attribute_param_add_values (EVCardAttributeParam *param, ...); void e_vcard_attribute_param_remove_values (EVCardAttributeParam *param); GList* e_vcard_get_attributes (EVCard *evcard); const char* e_vcard_attribute_get_group (EVCardAttribute *attr); const char* e_vcard_attribute_get_name (EVCardAttribute *attr); GList* e_vcard_attribute_get_values (EVCardAttribute *attr); GList* e_vcard_attribute_get_values_decoded (EVCardAttribute *attr); GList* e_vcard_attribute_get_params (EVCardAttribute *attr); const char* e_vcard_attribute_param_get_name (EVCardAttributeParam *param); GList* e_vcard_attribute_param_get_values (EVCardAttributeParam *param); #define EVC_ADR #define EVC_BDAY #define EVC_CALURI #define EVC_CATEGORIES #define EVC_EMAIL #define EVC_ENCODING #define EVC_FBURL #define EVC_FN #define EVC_ICSCALENDAR #define EVC_LABEL #define EVC_LOGO #define EVC_MAILER #define EVC_NICKNAME #define EVC_N #define EVC_NOTE #define EVC_ORG #define EVC_PHOTO #define EVC_PRODID #define EVC_QUOTEDPRINTABLE #define EVC_REV #define EVC_ROLE #define EVC_TEL #define EVC_TITLE #define EVC_TYPE #define EVC_UID #define EVC_URL #define EVC_VALUE #define EVC_VERSION #define EVC_X_AIM #define EVC_X_ANNIVERSARY #define EVC_X_ASSISTANT #define EVC_X_BIRTHDAY #define EVC_X_BLOG_URL #define EVC_X_FILE_AS #define EVC_X_ICQ #define EVC_X_JABBER #define EVC_X_LIST_SHOW_ADDRESSES #define EVC_X_LIST #define EVC_X_MANAGER #define EVC_X_MSN #define EVC_X_SPOUSE #define EVC_X_WANTS_HTML #define EVC_X_YAHOO
Does the low-level parsing work for contact information. This data is more conveniently accessed through the EContact object.
EVCard* e_vcard_new (void);
Creates a new, blank EVCard.
Returns : | A new, blank EVCard. |
EVCard* e_vcard_new_from_string (const char *str);
Creates a new EVCard from the passed-in string representation.
str : | a string representation of the vcard to create |
Returns : | A new EVCard. |
char* e_vcard_to_string (EVCard *evc, EVCardFormat format);
Exports evc to a string representation, specified by the format argument.
evc : | the EVCard to export |
format : | the format to export to |
Returns : | A newly allocated string representing the vcard. |
void e_vcard_dump_structure (EVCard *evc);
Prints a dump of evc's structure to stdout. Used for debugging.
evc : | the EVCard to dump |
EVCardAttribute* e_vcard_attribute_new (const char *attr_group, const char *attr_name);
Creates a new EVCardAttribute with the specified group and attribute names.
attr_group : | a group name |
attr_name : | an attribute name |
Returns : | A new EVCardAttribute. |
void e_vcard_attribute_free (EVCardAttribute *attr);
Frees an attribute, its values and its parameters.
attr : | attribute to free |
EVCardAttribute* e_vcard_attribute_copy (EVCardAttribute *attr);
Makes a copy of attr.
attr : | attribute to copy |
Returns : | A new EVCardAttribute identical to attr. |
void e_vcard_remove_attributes (EVCard *evcard, const char *attr_group, const char *attr_name);
Removes all the attributes with group name and attribute name equal to passed in values. If attr_group is NULL or an empty string, it removes all the attributes with passed in name irrespective of their group names.
evcard : | |
attr_group : | group name of attributes to be removed |
attr_name : | name of the arributes to be removed |
void e_vcard_remove_attribute (EVCard *evcard, EVCardAttribute *attr);
Removes attr from evc and frees it.
evcard : | |
attr : | an EVCardAttribute to remove |
void e_vcard_add_attribute (EVCard *evcard, EVCardAttribute *attr);
Adds attr to evc.
evcard : | |
attr : | an EVCardAttribute to add |
void e_vcard_add_attribute_with_value (EVCard *evcard, EVCardAttribute *attr, const char *value);
Adds attr to evcard, setting it to value.
evcard : | an EVCard |
attr : | an EVCardAttribute to add |
value : | a value to assign to the attribute |
void e_vcard_add_attribute_with_values (EVCard *evcard, EVCardAttribute *attr, ...);
Adds attr to evcard, assigning the list of values to it.
evcard : | an EVCard |
attr : | an EVCardAttribute to add |
... : | a NULL-terminated list of values to assign to the attribute |
void e_vcard_attribute_add_value (EVCardAttribute *attr, const char *value);
Adds value to attr's list of values.
attr : | an EVCardAttribute |
value : | a string value |
void e_vcard_attribute_add_value_decoded (EVCardAttribute *attr, const char *value, int len);
Decodes value according to the encoding used for attr, and adds it to attr's list of values.
attr : | an EVCardAttribute |
value : | an encoded value |
len : | the length of the encoded value, in bytes |
void e_vcard_attribute_add_values (EVCardAttribute *attr, ...);
Adds a list of values to attr.
attr : | an EVCardAttribute ...: a NULL-terminated list of strings |
... : |
void e_vcard_attribute_remove_values (EVCardAttribute *attr);
Removes all values from attr.
attr : | an EVCardAttribute |
void e_vcard_attribute_remove_params (EVCardAttribute *attr);
Removes all parameters from attr.
attr : | an EVCardAttribute |
EVCardAttributeParam* e_vcard_attribute_param_new (const char *param_name);
Creates a new parameter named name.
param_name : | |
Returns : | A new EVCardAttributeParam. |
void e_vcard_attribute_param_free (EVCardAttributeParam *param);
Frees param and its values.
param : | an EVCardAttributeParam |
EVCardAttributeParam* e_vcard_attribute_param_copy (EVCardAttributeParam *param);
Makes a copy of param.
param : | an EVCardAttributeParam |
Returns : | a new EVCardAttributeParam identical to param. |
void e_vcard_attribute_add_param (EVCardAttribute *attr, EVCardAttributeParam *param);
Adds param to attr's list of parameters.
attr : | an EVCardAttribute |
param : | an EVCardAttributeParam to add |
void e_vcard_attribute_add_param_with_value (EVCardAttribute *attr, EVCardAttributeParam *param, const char *value);
Adds value to param, then adds param to attr.
attr : | an EVCardAttribute |
param : | an EVCardAttributeParam |
value : | a string value |
void e_vcard_attribute_add_param_with_values (EVCardAttribute *attr, EVCardAttributeParam *param, ...);
Adds the list of values to param, then adds param to attr.
attr : | an EVCardAttribute |
param : | an EVCardAttributeParam ...: a NULL-terminated list of strings |
... : |
void e_vcard_attribute_param_add_value (EVCardAttributeParam *param, const char *value);
Adds value to param's list of values.
param : | an EVCardAttributeParam |
value : | a string value to add |
void e_vcard_attribute_param_add_values (EVCardAttributeParam *param, ...);
Adds a list of values to param.
param : | an EVCardAttributeParam ...: a NULL-terminated list of strings |
... : |
void e_vcard_attribute_param_remove_values (EVCardAttributeParam *param);
Removes and frees all values from param.
param : | an EVCardAttributeParam |
GList* e_vcard_get_attributes (EVCard *evcard);
Gets the list of attributes from evcard. The list and its contents are owned by evcard, and must not be freed.
evcard : | an EVCard |
Returns : | A list of attributes of type EVCardAttribute. |
const char* e_vcard_attribute_get_group (EVCardAttribute *attr);
Gets the group name of attr.
attr : | an EVCardAttribute |
Returns : | The attribute's group name. |
const char* e_vcard_attribute_get_name (EVCardAttribute *attr);
Gets the name of attr.
attr : | an EVCardAttribute |
Returns : | The attribute's name. |
GList* e_vcard_attribute_get_values (EVCardAttribute *attr);
Gets the list of values from attr. The list and its contents are owned by attr, and must not be freed.
attr : | an EVCardAttribute |
Returns : | A list of string values. |
GList* e_vcard_attribute_get_values_decoded (EVCardAttribute *attr);
Gets the list of values from attr, decoding them if necessary. The list and its contents are owned by attr, and must not be freed.
attr : | an EVCardAttribute |
Returns : | A list of values of type GString. |
GList* e_vcard_attribute_get_params (EVCardAttribute *attr);
Gets the list of parameters from attr. The list and its contents are owned by attr, and must not be freed.
attr : | an EVCardAttribute |
Returns : | A list of elements of type EVCardAttributeParam. |
const char* e_vcard_attribute_param_get_name (EVCardAttributeParam *param);
Gets the name of param.
param : | an EVCardAttributeParam |
Returns : | The name of the parameter. |
GList* e_vcard_attribute_param_get_values (EVCardAttributeParam *param);
Gets the list of values from param. The list and its contents are owned by param, and must not be freed.
param : | an EVCardAttributeParam |
Returns : | A list of string elements representing the parameter's values. |
#define EVC_ICSCALENDAR "ICSCALENDAR" /* XXX should this be X-EVOLUTION-ICSCALENDAR? */