Top | ![]() |
![]() |
![]() |
![]() |
void e_vcard_construct_with_uid (EVCard *evc
,const gchar *str
,const gchar *uid
);
FIXME: Document me!
Since 3.4
EVCard *
e_vcard_new_from_string (const gchar *str
);
Creates a new EVCard from the passed-in string representation.
gchar * e_vcard_to_string (EVCard *evc
,EVCardFormat format
);
Exports evc
to a string representation, specified
by the format
argument.
gboolean
e_vcard_is_parsed (EVCard *evc
);
Check if the evc
has been parsed already. Used for debugging.
Since 3.2
void
e_vcard_dump_structure (EVCard *evc
);
Prints a dump of evc
's structure to stdout. Used for
debugging.
EVCardAttribute * e_vcard_attribute_new (const gchar *attr_group
,const gchar *attr_name
);
Creates a new EVCardAttribute with the specified group and attribute names.
void
e_vcard_attribute_free (EVCardAttribute *attr
);
Frees an attribute, its values and its parameters.
EVCardAttribute *
e_vcard_attribute_copy (EVCardAttribute *attr
);
Makes a copy of attr
.
void e_vcard_remove_attributes (EVCard *evc
,const gchar *attr_group
,const gchar *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.
void e_vcard_remove_attribute (EVCard *evc
,EVCardAttribute *attr
);
Removes attr
from evc
and frees it.
void e_vcard_append_attribute (EVCard *evc
,EVCardAttribute *attr
);
Appends attr
to evc
to the end of a list of attributes.
Since 2.32
void e_vcard_append_attribute_with_value (EVCard *evcard
,EVCardAttribute *attr
,const gchar *value
);
Appends attr
to evcard
, setting it to value
.
For attribute addition is used e_vcard_append_attribute()
.
evcard |
an EVCard |
|
attr |
an EVCardAttribute to append. |
[transfer full] |
value |
a value to assign to the attribute |
Since 2.32
void e_vcard_append_attribute_with_values (EVCard *evcard
,EVCardAttribute *attr
,...
);
Appends attr
to evcard
, assigning the list of values to it.
For attribute addition is used e_vcard_append_attribute()
.
evcard |
an |
|
attr |
an EVCardAttribute to append. |
[transfer full] |
... |
a |
Since 2.32
void e_vcard_add_attribute (EVCard *evc
,EVCardAttribute *attr
);
Adds attr
to evc
. It's added to the beginning of a list of attributes.
void e_vcard_add_attribute_with_value (EVCard *evcard
,EVCardAttribute *attr
,const gchar *value
);
Adds attr
to evcard
, setting it to value
. For attribute addition
is used e_vcard_add_attribute()
.
evcard |
an EVCard |
|
attr |
an EVCardAttribute to add. |
[transfer full] |
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.
For attribute addition is used e_vcard_add_attribute()
.
evcard |
an |
|
attr |
an EVCardAttribute to add. |
[transfer full] |
... |
a |
void e_vcard_attribute_add_value (EVCardAttribute *attr
,const gchar *value
);
Adds value
to attr
's list of values.
void e_vcard_attribute_add_value_decoded (EVCardAttribute *attr
,const gchar *value
,gint len
);
Decodes value
according to the encoding used for attr
, and
adds it to attr
's list of values.
void e_vcard_attribute_add_values (EVCardAttribute *attr
,...
);
Adds a list of values to attr
.
void
e_vcard_attribute_remove_values (EVCardAttribute *attr
);
Removes all values from attr
.
void e_vcard_attribute_remove_value (EVCardAttribute *attr
,const gchar *s
);
Removes from the value list in attr
the value s
.
void
e_vcard_attribute_remove_params (EVCardAttribute *attr
);
Removes all parameters from attr
.
void e_vcard_attribute_remove_param (EVCardAttribute *attr
,const gchar *param_name
);
Removes the parameter param_name
from the attribute attr
.
Since 1.12
void e_vcard_attribute_remove_param_value (EVCardAttribute *attr
,const gchar *param_name
,const gchar *s
);
Removes the value s
from the parameter param_name
on the attribute attr
.
EVCardAttributeParam *
e_vcard_attribute_param_new (const gchar *name
);
Creates a new parameter named name
.
void
e_vcard_attribute_param_free (EVCardAttributeParam *param
);
Frees param
and its values.
EVCardAttributeParam *
e_vcard_attribute_param_copy (EVCardAttributeParam *param
);
Makes a copy of param
.
void e_vcard_attribute_add_param (EVCardAttribute *attr
,EVCardAttributeParam *param
);
Adds param
to attr
's list of parameters.
It tests for duplicities, only new parameters are added,
when a new parameter already exists in attr, then those
values are merged, also without creating duplicities.
When we will not add whole param, then it's freed here.
void e_vcard_attribute_add_param_with_value (EVCardAttribute *attr
,EVCardAttributeParam *param
,const gchar *value
);
Adds value
to param
, then adds param
to attr
.
void e_vcard_attribute_add_param_with_values (EVCardAttribute *attr
,EVCardAttributeParam *param
,...
);
Adds the list of values to param
, then adds param
to attr
.
void e_vcard_attribute_param_add_value (EVCardAttributeParam *param
,const gchar *value
);
Adds value
to param
's list of values.
void e_vcard_attribute_param_add_values (EVCardAttributeParam *param
,...
);
Adds a list of values to param
.
void
e_vcard_attribute_param_remove_values (EVCardAttributeParam *param
);
Removes and frees all values from param
.
const gchar *
e_vcard_attribute_param_get_name (EVCardAttributeParam *param
);
Gets the name of param
.
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.
EVCardAttribute * e_vcard_get_attribute (EVCard *evc
,const gchar *name
);
Get the attribute name
from evc
. The EVCardAttribute is owned by
evcard
and should not be freed. If the attribute does not exist, NULL
is
returned.
EVCardAttribute * e_vcard_get_attribute_if_parsed (EVCard *evc
,const gchar *name
);
Similar to e_vcard_get_attribute()
but this method will not attempt to
parse the vcard if not already parsed.
Since 3.4
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.
const gchar *
e_vcard_attribute_get_group (EVCardAttribute *attr
);
Gets the group name of attr
.
const gchar *
e_vcard_attribute_get_name (EVCardAttribute *attr
);
Gets the name of attr
.
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.
A list of string values. They
will all be non-NULL
, but may be empty strings. The list itself may be
empty.
[transfer none][element-type utf8]
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.
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.
A list of elements of type EVCardAttributeParam.
[transfer none][element-type EVCardAttributeParam]
GList * e_vcard_attribute_get_param (EVCardAttribute *attr
,const gchar *name
);
Gets the list of values for the paramater name
from attr
. The list and its
contents are owned by attr
, and must not be freed.
gchar *
e_vcard_attribute_get_value (EVCardAttribute *attr
);
Gets the value of a single-valued EVCardAttribute, attr
.
A newly allocated string representing the value, or NULL
if the attribute has no value.
[allow-none]
GString *
e_vcard_attribute_get_value_decoded (EVCardAttribute *attr
);
Gets the value of a single-valued EVCardAttribute, attr
, decoding
it if necessary.
Note: this function seems currently to be unused. Could be removed.
gboolean e_vcard_attribute_has_type (EVCardAttribute *attr
,const gchar *typestr
);
Checks if attr
has an EVCardAttributeParam of the specified type.
gboolean
e_vcard_attribute_is_single_valued (EVCardAttribute *attr
);
Checks if attr
has a single value.
gchar *
e_vcard_escape_string (const gchar *s
);
Escapes a string according to RFC2426, section 5.
#define EVC_X_DEST_EMAIL "X-EVOLUTION-DEST-EMAIL"
EVC_X_DEST_EMAIL
is deprecated and should not be used in newly-written code.
#define EVC_X_DEST_NAME "X-EVOLUTION-DEST-NAME"
EVC_X_DEST_NAME
is deprecated and should not be used in newly-written code.