LibICal::VComponent Class Reference

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

#include <vcomponent_cxx.hpp>

Inheritance diagram for LibICal::VComponent:

Public Member Functions
bool	add (VComponent &)
void	add_component (VComponent *child)
void	add_property (ICalProperty *property)
	Working with properties.
std::string	as_ical_string ()
icalcompiter	begin_component (const icalcomponent_kind &kind)
	Using external iterators.
void	convert_errors ()
	Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
int	count_components (const icalcomponent_kind &kind)
int	count_errors ()
	Working with embedded error properties.
int	count_properties (const icalproperty_kind &kind)
void	detach ()
icalcompiter	end_component (const icalcomponent_kind &kind)
std::string	get_comment () const
VComponent *	get_current_component ()
	Iterate through components.
ICalProperty *	get_current_property ()
std::string	get_description () const
struct icaltimetype	get_dtend () const
struct icaltimetype	get_dtstamp () const
struct icaltimetype	get_dtstart () const
struct icaltimetype	get_due () const
struct icaldurationtype	get_duration () const
VComponent *	get_first_component (const icalcomponent_kind &kind)
ICalProperty *	get_first_property (const icalproperty_kind &kind)
VComponent *	get_first_real_component ()
VComponent *	get_inner ()
std::string	get_location () const
icalproperty_method	get_method () const
VComponent *	get_next_component (const icalcomponent_kind &kind)
ICalProperty *	get_next_property (const icalproperty_kind &kind)
struct icaltimetype	get_recurrenceid () const
std::string	get_relcalid () const
int	get_sequence () const
virtual struct icaltime_span	get_span ()
int	get_status () const
std::string	get_summary () const
std::string	get_uid () const
bool	is_valid ()
icalcomponent_kind	isa ()
bool	isa_component (const void *component)
void	new_from_string (const std::string &str)
	operator icalcomponent * ()
VComponent &	operator= (const VComponent &)
bool	recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
bool	remove (VComponent &, bool ignoreValue)
	Note: the VComponent kind have to be the same.
void	remove_component (VComponent *child)
void	remove_property (ICalProperty *property)
void	set_comment (const std::string &v)
void	set_description (const std::string &v)
void	set_dtend (const struct icaltimetype &v)
void	set_dtstamp (const struct icaltimetype &v)
void	set_dtstart (const struct icaltimetype &v)
void	set_due (const struct icaltimetype &v)
void	set_duration (const struct icaldurationtype &v)
void	set_location (const std::string &v)
void	set_method (const icalproperty_method &method)
void	set_recurrenceid (const struct icaltimetype &v)
void	set_relcalid (const std::string &v)
void	set_sequence (const int &v)
void	set_status (const enum icalproperty_status &v)
void	set_summary (const std::string &v)
void	set_uid (const std::string &v)
void	strip_errors ()
	Remove all X-LIC-ERROR properties.
bool	update (VComponent &, bool removeMissing)
	VComponent (const icalcomponent_kind &kind)
	VComponent (const std::string &str)
	Constructor.
	VComponent (const VComponent &)
	VComponent (icalcomponent *v)

Static Public Member Functions
static VComponent *	current (icalcompiter *i)
static std::string	kind_to_string (const icalcomponent_kind &kind)
static VComponent *	next (icalcompiter *i)
static VComponent *	prev (icalcompiter *i)
static icalcomponent_kind	string_to_kind (const std::string &str)
	Kind conversion routines.

Detailed Description

A class wrapping the libical icalcomponent functions.

Exceptions

icalerrorenum

Any errors generated in libical are propagated via this exception type.

Definition at line 37 of file vcomponent_cxx.hpp.

Constructor & Destructor Documentation

VComponent() [1/5]

VComponent::VComponent

(

)

Definition at line 30 of file vcomponent_cxx.cpp.

VComponent() [2/5]

VComponent::VComponent

(

const VComponent &

v

)

Definition at line 35 of file vcomponent_cxx.cpp.

~VComponent()

VComponent::~VComponent ( )

virtual

Definition at line 65 of file vcomponent_cxx.cpp.

VComponent() [3/5]

VComponent::VComponent ( icalcomponent * v )

explicit

Definition at line 70 of file vcomponent_cxx.cpp.

VComponent() [4/5]

VComponent::VComponent ( const std::string & str )

explicit

Constructor.

Create a new VComponent from a string.

Exceptions

ICAL_MALFORMEDDATA_ERROR

Catch this error if you

Definition at line 86 of file vcomponent_cxx.cpp.

VComponent() [5/5]

VComponent::VComponent ( const icalcomponent_kind & kind )

explicit

Definition at line 97 of file vcomponent_cxx.cpp.

Member Function Documentation

add()

bool VComponent::add

(

VComponent &

fromC

)

Definition at line 611 of file vcomponent_cxx.cpp.

add_component()

void VComponent::add_component

(

VComponent *

child

)

Definition at line 185 of file vcomponent_cxx.cpp.

add_property()

void VComponent::add_property

(

ICalProperty *

property

)

Working with properties.

Definition at line 142 of file vcomponent_cxx.cpp.

as_ical_string()

std::string VComponent::as_ical_string

(

)

Definition at line 105 of file vcomponent_cxx.cpp.

begin_component()

icalcompiter VComponent::begin_component

(

const icalcomponent_kind &

kind

)

Using external iterators.

Definition at line 278 of file vcomponent_cxx.cpp.

convert_errors()

void VComponent::convert_errors

(

)

Convert some X-LIC-ERROR properties into RETURN-STATUS properties.

Definition at line 316 of file vcomponent_cxx.cpp.

count_components()

int VComponent::count_components

(

const icalcomponent_kind &

kind

)

Definition at line 195 of file vcomponent_cxx.cpp.

count_errors()

int VComponent::count_errors

(

)

Working with embedded error properties.

Definition at line 304 of file vcomponent_cxx.cpp.

count_properties()

int VComponent::count_properties

(

const icalproperty_kind &

kind

)

Definition at line 154 of file vcomponent_cxx.cpp.

current()

VComponent * VComponent::current ( icalcompiter * i )

static

Definition at line 298 of file vcomponent_cxx.cpp.

detach()

void VComponent::detach

(

)

Definition at line 60 of file vcomponent_cxx.cpp.

end_component()

icalcompiter VComponent::end_component

(

const icalcomponent_kind &

kind

)

Definition at line 283 of file vcomponent_cxx.cpp.

get_comment()

std::string VComponent::get_comment

(

)

const

Definition at line 432 of file vcomponent_cxx.cpp.

get_current_component()

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.

Definition at line 207 of file vcomponent_cxx.cpp.

get_current_property()

ICalProperty * VComponent::get_current_property

(

)

Definition at line 160 of file vcomponent_cxx.cpp.

get_description()

std::string VComponent::get_description

(

)

const

Definition at line 422 of file vcomponent_cxx.cpp.

get_dtend()

struct icaltimetype VComponent::get_dtend

(

)

const

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 appropriate property

Definition at line 352 of file vcomponent_cxx.cpp.

get_dtstamp()

struct icaltimetype VComponent::get_dtstamp

(

)

const

Definition at line 392 of file vcomponent_cxx.cpp.

get_dtstart()

struct icaltimetype VComponent::get_dtstart

(

)

const

Definition at line 332 of file vcomponent_cxx.cpp.

get_due()

struct icaltimetype VComponent::get_due

(

)

const

Definition at line 362 of file vcomponent_cxx.cpp.

get_duration()

struct icaldurationtype VComponent::get_duration

(

)

const

Definition at line 372 of file vcomponent_cxx.cpp.

get_first_component()

VComponent * VComponent::get_first_component

(

const icalcomponent_kind &

kind

)

Definition at line 213 of file vcomponent_cxx.cpp.

get_first_property()

ICalProperty * VComponent::get_first_property

(

const icalproperty_kind &

kind

)

Definition at line 166 of file vcomponent_cxx.cpp.

get_first_real_component()

VComponent * VComponent::get_first_real_component

(

)

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

Definition at line 493 of file vcomponent_cxx.cpp.

get_inner()

VComponent * VComponent::get_inner

(

)

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

Definition at line 180 of file vcomponent_cxx.cpp.

get_location()

std::string VComponent::get_location

(

)

const

Definition at line 412 of file vcomponent_cxx.cpp.

get_method()

icalproperty_method VComponent::get_method

(

)

const

Definition at line 382 of file vcomponent_cxx.cpp.

get_next_component()

VComponent * VComponent::get_next_component

(

const icalcomponent_kind &

kind

)

Definition at line 245 of file vcomponent_cxx.cpp.

get_next_property()

ICalProperty * VComponent::get_next_property

(

const icalproperty_kind &

kind

)

Definition at line 172 of file vcomponent_cxx.cpp.

get_recurrenceid()

struct icaltimetype VComponent::get_recurrenceid

(

)

const

Definition at line 462 of file vcomponent_cxx.cpp.

get_relcalid()

std::string VComponent::get_relcalid

(

)

const

Definition at line 452 of file vcomponent_cxx.cpp.

get_sequence()

int VComponent::get_sequence

(

)

const

Definition at line 472 of file vcomponent_cxx.cpp.

get_span()

struct icaltime_span VComponent::get_span ( )

virtual

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

Definition at line 500 of file vcomponent_cxx.cpp.

get_status()

int VComponent::get_status

(

)

const

Returns the status VComponent status.

Returns

the status property or ICAL_STATUS_NONE if a problem parsing the status was detected.

Definition at line 482 of file vcomponent_cxx.cpp.

get_summary()

std::string VComponent::get_summary

(

)

const

Definition at line 402 of file vcomponent_cxx.cpp.

get_uid()

std::string VComponent::get_uid

(

)

const

Definition at line 442 of file vcomponent_cxx.cpp.

is_valid()

bool VComponent::is_valid

(

)

Definition at line 116 of file vcomponent_cxx.cpp.

isa()

icalcomponent_kind VComponent::isa

(

)

Definition at line 124 of file vcomponent_cxx.cpp.

isa_component()

bool VComponent::isa_component

(

const void *

component

)

Definition at line 130 of file vcomponent_cxx.cpp.

kind_to_string()

std::string VComponent::kind_to_string ( const icalcomponent_kind & kind )

static

Definition at line 327 of file vcomponent_cxx.cpp.

new_from_string()

void VComponent::new_from_string

(

const std::string &

str

)

Definition at line 135 of file vcomponent_cxx.cpp.

next()

VComponent * VComponent::next ( icalcompiter * i )

static

Definition at line 288 of file vcomponent_cxx.cpp.

operator icalcomponent *()

LibICal::VComponent::operator icalcomponent * ( )

inline

Definition at line 49 of file vcomponent_cxx.hpp.

operator=()

VComponent & VComponent::operator=

(

const VComponent &

v

)

Definition at line 43 of file vcomponent_cxx.cpp.

prev()

VComponent * VComponent::prev ( icalcompiter * i )

static

Definition at line 293 of file vcomponent_cxx.cpp.

recurrence_is_excluded()

bool VComponent::recurrence_is_excluded	(	struct icaltimetype *	dtstart,
		struct icaltimetype *	recurtime )

Definition at line 505 of file vcomponent_cxx.cpp.

remove()

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

Note: the VComponent kind have to be the same.

Definition at line 512 of file vcomponent_cxx.cpp.

remove_component()

void VComponent::remove_component

(

VComponent *

child

)

Definition at line 190 of file vcomponent_cxx.cpp.

remove_property()

void VComponent::remove_property

(

ICalProperty *

property

)

Definition at line 147 of file vcomponent_cxx.cpp.

set_comment()

void VComponent::set_comment

(

const std::string &

v

)

Definition at line 437 of file vcomponent_cxx.cpp.

set_description()

void VComponent::set_description

(

const std::string &

v

)

Definition at line 427 of file vcomponent_cxx.cpp.

set_dtend()

void VComponent::set_dtend

(

const struct icaltimetype &

v

)

Definition at line 357 of file vcomponent_cxx.cpp.

set_dtstamp()

void VComponent::set_dtstamp

(

const struct icaltimetype &

v

)

Definition at line 397 of file vcomponent_cxx.cpp.

set_dtstart()

void VComponent::set_dtstart

(

const struct icaltimetype &

v

)

Definition at line 337 of file vcomponent_cxx.cpp.

set_due()

void VComponent::set_due

(

const struct icaltimetype &

v

)

Definition at line 367 of file vcomponent_cxx.cpp.

set_duration()

void VComponent::set_duration

(

const struct icaldurationtype &

v

)

Definition at line 377 of file vcomponent_cxx.cpp.

set_location()

void VComponent::set_location

(

const std::string &

v

)

Definition at line 417 of file vcomponent_cxx.cpp.

set_method()

void VComponent::set_method

(

const icalproperty_method &

method

)

Definition at line 387 of file vcomponent_cxx.cpp.

set_recurrenceid()

void VComponent::set_recurrenceid

(

const struct icaltimetype &

v

)

Definition at line 467 of file vcomponent_cxx.cpp.

set_relcalid()

void VComponent::set_relcalid

(

const std::string &

v

)

Definition at line 457 of file vcomponent_cxx.cpp.

set_sequence()

void VComponent::set_sequence

(

const int &

v

)

Definition at line 477 of file vcomponent_cxx.cpp.

set_status()

void VComponent::set_status

(

const enum icalproperty_status &

v

)

Definition at line 487 of file vcomponent_cxx.cpp.

set_summary()

void VComponent::set_summary

(

const std::string &

v

)

Definition at line 407 of file vcomponent_cxx.cpp.

set_uid()

void VComponent::set_uid

(

const std::string &

v

)

Definition at line 447 of file vcomponent_cxx.cpp.

string_to_kind()

icalcomponent_kind VComponent::string_to_kind ( const std::string & str )

static

Kind conversion routines.

Definition at line 322 of file vcomponent_cxx.cpp.

strip_errors()

void VComponent::strip_errors

(

)

Remove all X-LIC-ERROR properties.

Definition at line 310 of file vcomponent_cxx.cpp.

update()

bool VComponent::update	(	VComponent &	fromC,
		bool	removeMissing )

Definition at line 568 of file vcomponent_cxx.cpp.