A class wrapping the libical icalcomponent functions. More...

#include <vcomponent.h>

Inheritance diagram for VComponent:

Public Member Functions
	VComponent (const VComponent &) throw (icalerrorenum)

	VComponent (icalcomponent *v) throw (icalerrorenum)

	VComponent (string str) throw (icalerrorenum)

	VComponent (icalcomponent_kind kind) throw (icalerrorenum)

bool	add (VComponent &)

void	add_component (VComponent *child)

void	add_property (ICalProperty *property)
	Working with properties.

string	as_ical_string () throw (icalerrorenum)

icalcompiter	begin_component (icalcomponent_kind kind)
	Using external iterators.

void	convert_errors ()
	Convert some X-LIC-ERROR properties into RETURN-STATUS properties.

int	count_components (icalcomponent_kind kind)

int	count_errors ()
	Working with embedded error properties.

int	count_properties (icalproperty_kind kind)

VComponent *	current (icalcompiter *i)

void	detach ()

icalcompiter	end_component (icalcomponent_kind kind)

string	get_comment ()

VComponent *	get_current_component ()
	Iterate through components. More...

ICalProperty *	get_current_property ()

string	get_description ()

struct icaltimetype	get_dtend ()

struct icaltimetype	get_dtstamp ()

struct icaltimetype	get_dtstart ()

struct icaltimetype	get_due ()

struct icaldurationtype	get_duration ()

VComponent *	get_first_component (icalcomponent_kind kind)

ICalProperty *	get_first_property (icalproperty_kind kind)

VComponent *	get_first_real_component ()

VComponent *	get_inner ()

string	get_location ()

icalproperty_method	get_method ()

VComponent *	get_next_component (icalcomponent_kind kind)

ICalProperty *	get_next_property (icalproperty_kind kind)

struct icaltimetype	get_recurrenceid ()

string	get_relcalid ()

int	get_sequence ()

virtual struct icaltime_span	get_span ()

int	get_status ()

string	get_summary ()

string	get_uid ()

bool	is_valid ()

icalcomponent_kind	isa ()

int	isa_component (void *component)

void	new_from_string (string str)

VComponent *	next (icalcompiter *i)

	operator icalcomponent * ()

VComponent &	operator= (const VComponent &) throw (icalerrorenum)

VComponent *	prev (icalcompiter *i)

int	recurrence_is_excluded (struct icaltimetype dtstart, struct icaltimetype recurtime)

bool	remove (VComponent &, bool ignoreValue)
	Note: the VComponent kind have to be the same. More...

void	remove_component (VComponent *child)

void	remove_property (ICalProperty *property)

void	set_comment (string v)

void	set_description (string v)

void	set_dtend (struct icaltimetype v)

void	set_dtstamp (struct icaltimetype v)

void	set_dtstart (struct icaltimetype v)

void	set_due (struct icaltimetype v)

void	set_duration (struct icaldurationtype v)

void	set_location (string v)

void	set_method (icalproperty_method method)

void	set_recurrenceid (struct icaltimetype v)

void	set_relcalid (string v)

void	set_sequence (int v)

void	set_status (enum icalproperty_status v)

void	set_summary (string v)

void	set_uid (string v)

void	strip_errors ()
	Remove all X-LIC-ERROR properties.

bool	update (VComponent &, bool removeMissing)

Static Public Member Functions
static string	kind_to_string (icalcomponent_kind kind)

static icalcomponent_kind	string_to_kind (string str)
	Kind conversion routines.

Detailed Description

A class wrapping the libical icalcomponent functions.

Exceptions

icalerrorenum Any errors generated in libical are propogated via this exception type.

Member Function Documentation

VComponent* VComponent::get_current_component ( )

Iterate through components.

Iteration Routines. There are two forms of iterators, internal and external. The internal ones came first, and are almost completely sufficient, but they fail badly when you want to construct a loop that removes components from the container.

struct icaltimetype VComponent::get_dtend ( )

read

For the icalcomponent routines only, dtend and duration are tied together. If you call the set routine for one and the other exists, the routine will calculate the change to the other. That is, if there is a DTEND and you call set_duration, the routine will modify DTEND to be the sum of DTSTART and the duration. If you call a get routine for one and the other exists, the routine will calculate the return value. If you call a set routine and neither exists, the routine will create the apropriate property

VComponent* VComponent::get_first_real_component ( )

For VCOMPONENT: Return a reference to the first VEVENT, VTODO, or VJOURNAL

VComponent* VComponent::get_inner ( )

Return the first VEVENT, VTODO or VJOURNAL sub-component if it is one of those types

virtual struct icaltime_span VComponent::get_span ( )

readvirtual

For VEVENT, VTODO, VJOURNAL and VTIMEZONE: report the start and end times of an event in UTC

bool VComponent::remove	(	VComponent &	,
		bool	ignoreValue
	)

Note: the VComponent kind have to be the same.

helper functions for adding/removing/updating property and sub-components

The documentation for this class was generated from the following file:

vcomponent.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation