vcardcomponent.h File Reference

Defines the data structure representing vCard components. More...

Go to the source code of this file.

Enumerations
enum	vcardcomponent_kind {   VCARD_NO_COMPONENT, VCARD_ANY_COMPONENT, VCARD_XROOT_COMPONENT, VCARD_VCARD_COMPONENT,   VCARD_NUM_COMPONENT_TYPES }

Functions
void	vcardcomponent_add_component (vcardcomponent *parent, vcardcomponent *child)
void	vcardcomponent_add_property (vcardcomponent *comp, vcardproperty *property)
char *	vcardcomponent_as_vcard_string (vcardcomponent *comp)
char *	vcardcomponent_as_vcard_string_r (vcardcomponent *comp)
int	vcardcomponent_check_restrictions (vcardcomponent *comp)
vcardcomponent *	vcardcomponent_clone (const vcardcomponent *old)
	Deeply clones an vcard. Returns a pointer to the memory for the newly cloned vcard. More...
int	vcardcomponent_count_components (vcardcomponent *comp, vcardcomponent_kind kind)
int	vcardcomponent_count_errors (vcardcomponent *comp)
	Returns the number of errors encountered parsing the data. More...
int	vcardcomponent_count_properties (vcardcomponent *comp, vcardproperty_kind kind, int ignore_alts)
void	vcardcomponent_free (vcardcomponent *comp)
vcardcomponent *	vcardcomponent_get_current_component (vcardcomponent *comp)
vcardproperty *	vcardcomponent_get_current_property (vcardcomponent *comp)
vcardcomponent *	vcardcomponent_get_first_component (vcardcomponent *comp, vcardcomponent_kind kind)
vcardproperty *	vcardcomponent_get_first_property (vcardcomponent *comp, vcardproperty_kind kind)
const char *	vcardcomponent_get_fn (vcardcomponent *comp)
vcardcomponent *	vcardcomponent_get_next_component (vcardcomponent *comp, vcardcomponent_kind kind)
vcardproperty *	vcardcomponent_get_next_property (vcardcomponent *comp, vcardproperty_kind kind)
const char *	vcardcomponent_get_uid (vcardcomponent *comp)
enum vcardproperty_version	vcardcomponent_get_version (vcardcomponent *comp)
bool	vcardcomponent_is_valid (const vcardcomponent *comp)
vcardcomponent_kind	vcardcomponent_isa (const vcardcomponent *comp)
bool	vcardcomponent_isa_component (const void *comp)
bool	vcardcomponent_kind_is_valid (const vcardcomponent_kind kind)
const char *	vcardcomponent_kind_to_string (vcardcomponent_kind kind)
vcardcomponent *	vcardcomponent_new (vcardcomponent_kind kind)
	Constructor.
vcardcomponent *	vcardcomponent_new_from_string (const char *str)
	Constructor.
void	vcardcomponent_normalize (vcardcomponent *comp)
	Normalizes (reorders and sorts the properties) the specified vcard comp. More...
void	vcardcomponent_remove_component (vcardcomponent *parent, vcardcomponent *child)
void	vcardcomponent_remove_property (vcardcomponent *comp, vcardproperty *property)
vcardcomponent_kind	vcardcomponent_string_to_kind (const char *string)
void	vcardcomponent_strip_errors (vcardcomponent *comp)
	Removes all X-LIC-ERROR properties.
void	vcardcomponent_transform (vcardcomponent *impl, vcardproperty_version version)
LIBICAL_SENTINEL vcardcomponent *	vcardcomponent_vanew (vcardcomponent_kind kind,...)
	Constructor.
vcardcomponent *	vcardproperty_get_parent (const vcardproperty *property)
	Returns the parent vcard for the specified property.
void	vcardproperty_set_parent (vcardproperty *property, vcardcomponent *comp)
	Sets the parent vcard for the specified vcardproperty property. More...

Detailed Description

Defines the data structure representing vCard components.

Definition in file vcardcomponent.h.

Function Documentation

vcardcomponent* vcardcomponent_clone

(

const vcardcomponent *

old

)

Deeply clones an vcard. Returns a pointer to the memory for the newly cloned vcard.

Since

4.0

Definition at line 113 of file vcardcomponent.c.

int vcardcomponent_count_errors

(

vcardcomponent *

comp

)

Returns the number of errors encountered parsing the data.

This function counts the number times the X-LIC-ERROR occurs in the data structure.

Definition at line 534 of file vcardcomponent.c.

void vcardcomponent_normalize

(

vcardcomponent *

comp

)

Normalizes (reorders and sorts the properties) the specified vcard comp.

Since

3.0

Definition at line 713 of file vcardcomponent.c.

void vcardproperty_set_parent	(	vcardproperty *	property,
		vcardcomponent *	comp
	)

Sets the parent vcard for the specified vcardproperty property.

Since

3.0

Definition at line 992 of file vcardproperty.c.