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_X_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.
int	vcardcomponent_count_components (vcardcomponent *comp, vcardcomponent_kind kind)
int	vcardcomponent_count_errors (vcardcomponent *comp)
	Returns the number of errors encountered parsing the data.
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.
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.

Detailed Description

Defines the data structure representing vCard components.

Definition in file vcardcomponent.h.

Enumeration Type Documentation

vcardcomponent_kind

enum vcardcomponent_kind

Definition at line 23 of file vcardcomponent.h.

Function Documentation

vcardcomponent_add_component()

void vcardcomponent_add_component	(	vcardcomponent *	parent,
		vcardcomponent *	child )

Definition at line 430 of file vcardcomponent.c.

vcardcomponent_add_property()

void vcardcomponent_add_property	(	vcardcomponent *	comp,
		vcardproperty *	property )

Definition at line 285 of file vcardcomponent.c.

vcardcomponent_as_vcard_string()

char * vcardcomponent_as_vcard_string

(

vcardcomponent *

comp

)

Definition at line 177 of file vcardcomponent.c.

vcardcomponent_as_vcard_string_r()

char * vcardcomponent_as_vcard_string_r

(

vcardcomponent *

comp

)

Definition at line 188 of file vcardcomponent.c.

vcardcomponent_check_restrictions()

int vcardcomponent_check_restrictions

(

vcardcomponent *

comp

)

Definition at line 538 of file vcardcomponent.c.

vcardcomponent_clone()

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 114 of file vcardcomponent.c.

vcardcomponent_count_components()

int vcardcomponent_count_components	(	vcardcomponent *	comp,
		vcardcomponent_kind	kind )

Definition at line 469 of file vcardcomponent.c.

vcardcomponent_count_errors()

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 544 of file vcardcomponent.c.

vcardcomponent_count_properties()

int vcardcomponent_count_properties	(	vcardcomponent *	comp,
		vcardproperty_kind	kind,
		int	ignore_alts )

Definition at line 333 of file vcardcomponent.c.

vcardcomponent_free()

void vcardcomponent_free

(

vcardcomponent *

comp

)

Definition at line 136 of file vcardcomponent.c.

vcardcomponent_get_current_component()

vcardcomponent * vcardcomponent_get_current_component

(

vcardcomponent *

comp

)

Definition at line 487 of file vcardcomponent.c.

vcardcomponent_get_current_property()

vcardproperty * vcardcomponent_get_current_property

(

vcardcomponent *

comp

)

Definition at line 377 of file vcardcomponent.c.

vcardcomponent_get_first_component()

vcardcomponent * vcardcomponent_get_first_component	(	vcardcomponent *	comp,
		vcardcomponent_kind	kind )

Definition at line 498 of file vcardcomponent.c.

vcardcomponent_get_first_property()

vcardproperty * vcardcomponent_get_first_property	(	vcardcomponent *	comp,
		vcardproperty_kind	kind )

Definition at line 388 of file vcardcomponent.c.

vcardcomponent_get_fn()

const char * vcardcomponent_get_fn

(

vcardcomponent *

comp

)

Definition at line 1331 of file vcardcomponent.c.

vcardcomponent_get_next_component()

vcardcomponent * vcardcomponent_get_next_component	(	vcardcomponent *	comp,
		vcardcomponent_kind	kind )

Definition at line 516 of file vcardcomponent.c.

vcardcomponent_get_next_property()

vcardproperty * vcardcomponent_get_next_property	(	vcardcomponent *	comp,
		vcardproperty_kind	kind )

Definition at line 405 of file vcardcomponent.c.

vcardcomponent_get_uid()

const char * vcardcomponent_get_uid

(

vcardcomponent *

comp

)

Definition at line 1316 of file vcardcomponent.c.

vcardcomponent_get_version()

enum vcardproperty_version vcardcomponent_get_version

(

vcardcomponent *

comp

)

Definition at line 1300 of file vcardcomponent.c.

vcardcomponent_is_valid()

bool vcardcomponent_is_valid

(

const vcardcomponent *

comp

)

Definition at line 259 of file vcardcomponent.c.

vcardcomponent_isa()

vcardcomponent_kind vcardcomponent_isa

(

const vcardcomponent *

comp

)

Definition at line 269 of file vcardcomponent.c.

vcardcomponent_isa_component()

bool vcardcomponent_isa_component

(

const void *

comp

)

Definition at line 276 of file vcardcomponent.c.

vcardcomponent_kind_is_valid()

bool vcardcomponent_kind_is_valid

(

const vcardcomponent_kind

kind

)

Definition at line 591 of file vcardcomponent.c.

vcardcomponent_kind_to_string()

const char * vcardcomponent_kind_to_string

(

vcardcomponent_kind

kind

)

Definition at line 604 of file vcardcomponent.c.

vcardcomponent_new()

vcardcomponent * vcardcomponent_new

(

vcardcomponent_kind

kind

)

Constructor.

Definition at line 80 of file vcardcomponent.c.

vcardcomponent_new_from_string()

vcardcomponent * vcardcomponent_new_from_string

(

const char *

str

)

Constructor.

Definition at line 109 of file vcardcomponent.c.

vcardcomponent_normalize()

void vcardcomponent_normalize

(

vcardcomponent *

comp

)

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

Since

3.0

Definition at line 725 of file vcardcomponent.c.

vcardcomponent_remove_component()

void vcardcomponent_remove_component	(	vcardcomponent *	parent,
		vcardcomponent *	child )

Definition at line 444 of file vcardcomponent.c.

vcardcomponent_remove_property()

void vcardcomponent_remove_property	(	vcardcomponent *	comp,
		vcardproperty *	property )

Definition at line 304 of file vcardcomponent.c.

vcardcomponent_string_to_kind()

vcardcomponent_kind vcardcomponent_string_to_kind

(

const char *

string

)

Definition at line 617 of file vcardcomponent.c.

vcardcomponent_strip_errors()

void vcardcomponent_strip_errors

(

vcardcomponent *

comp

)

Removes all X-LIC-ERROR properties.

Definition at line 561 of file vcardcomponent.c.

vcardcomponent_transform()

void vcardcomponent_transform	(	vcardcomponent *	impl,
		vcardproperty_version	version )

Definition at line 1274 of file vcardcomponent.c.

vcardcomponent_vanew()

LIBICAL_SENTINEL vcardcomponent * vcardcomponent_vanew	(	vcardcomponent_kind	kind,
			... )

Constructor.

Definition at line 89 of file vcardcomponent.c.

vcardproperty_get_parent()

vcardcomponent * vcardproperty_get_parent

(

const vcardproperty *

property

)

Returns the parent vcard for the specified property.

Definition at line 1004 of file vcardproperty.c.

vcardproperty_set_parent()

void vcardproperty_set_parent	(	vcardproperty *	property,
		vcardcomponent *	comp )

Sets the parent vcard for the specified vcardproperty property.

Since

3.0

Definition at line 997 of file vcardproperty.c.