icalcomponent.h File Reference

#include "icalproperty.h"
#include "icalvalue.h"
#include "icalenums.h"
#include "pvl.h"

Include dependency graph for icalcomponent.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	icalcompiter
Typedefs
typedef struct icalcomponent_impl	icalcomponent
Functions
icalcomponent *	icalcompiter_deref (icalcompiter *i)
icalcomponent *	icalcompiter_next (icalcompiter *i)
icalcomponent *	icalcompiter_prior (icalcompiter *i)
void	icalcomponent_add_component (icalcomponent *parent, icalcomponent *child)
void	icalcomponent_add_property (icalcomponent *component, icalproperty *property)
char *	icalcomponent_as_ical_string (icalcomponent *component)
icalcompiter	icalcomponent_begin_component (icalcomponent *component, icalcomponent_kind kind)
int	icalcomponent_check_restrictions (icalcomponent *comp)
void	icalcomponent_convert_errors (icalcomponent *component)
int	icalcomponent_count_components (icalcomponent *component, icalcomponent_kind kind)
int	icalcomponent_count_errors (icalcomponent *component)
int	icalcomponent_count_properties (icalcomponent *component, icalproperty_kind kind)
icalcompiter	icalcomponent_end_component (icalcomponent *component, icalcomponent_kind kind)
void	icalcomponent_foreach_recurrence (icalcomponent *comp, struct icaltimetype start, struct icaltimetype end, void(*callback)(icalcomponent *comp, struct icaltime_span *span, void *data), void *callback_data)
void	icalcomponent_foreach_tzid (icalcomponent *comp, void(*callback)(icalparameter *param, void *data), void *callback_data)
void	icalcomponent_free (icalcomponent *component)
const char *	icalcomponent_get_comment (icalcomponent *comp)
icalcomponent *	icalcomponent_get_current_component (icalcomponent *component)
icalproperty *	icalcomponent_get_current_property (icalcomponent *component)
const char *	icalcomponent_get_description (icalcomponent *comp)
struct icaltimetype	icalcomponent_get_dtend (icalcomponent *comp)
struct icaltimetype	icalcomponent_get_dtstamp (icalcomponent *comp)
struct icaltimetype	icalcomponent_get_dtstart (icalcomponent *comp)
struct icaltimetype	icalcomponent_get_due (icalcomponent *comp)
struct icaldurationtype	icalcomponent_get_duration (icalcomponent *comp)
icalcomponent *	icalcomponent_get_first_component (icalcomponent *component, icalcomponent_kind kind)
icalproperty *	icalcomponent_get_first_property (icalcomponent *component, icalproperty_kind kind)
icalcomponent *	icalcomponent_get_first_real_component (icalcomponent *c)
icalcomponent *	icalcomponent_get_inner (icalcomponent *comp)
const char *	icalcomponent_get_location (icalcomponent *comp)
icalproperty_method	icalcomponent_get_method (icalcomponent *comp)
icalcomponent *	icalcomponent_get_next_component (icalcomponent *component, icalcomponent_kind kind)
icalproperty *	icalcomponent_get_next_property (icalcomponent *component, icalproperty_kind kind)
icalcomponent *	icalcomponent_get_parent (icalcomponent *component)
struct icaltimetype	icalcomponent_get_recurrenceid (icalcomponent *comp)
const char *	icalcomponent_get_relcalid (icalcomponent *comp)
int	icalcomponent_get_sequence (icalcomponent *comp)
struct icaltime_span	icalcomponent_get_span (icalcomponent *comp)
enum icalproperty_status	icalcomponent_get_status (icalcomponent *comp)
const char *	icalcomponent_get_summary (icalcomponent *comp)
icaltimezone *	icalcomponent_get_timezone (icalcomponent *comp, const char *tzid)
const char *	icalcomponent_get_uid (icalcomponent *comp)
int	icalcomponent_is_valid (icalcomponent *component)
icalcomponent_kind	icalcomponent_isa (const icalcomponent *component)
int	icalcomponent_isa_component (void *component)
int	icalcomponent_kind_is_valid (const icalcomponent_kind kind)
const char *	icalcomponent_kind_to_string (icalcomponent_kind kind)
void	icalcomponent_merge_component (icalcomponent *comp, icalcomponent *comp_to_merge)
icalcomponent *	icalcomponent_new (icalcomponent_kind kind)
icalcomponent *	icalcomponent_new_clone (icalcomponent *component)
icalcomponent *	icalcomponent_new_from_string (char *str)
icalcomponent *	icalcomponent_new_vagenda ()
icalcomponent *	icalcomponent_new_valarm ()
icalcomponent *	icalcomponent_new_vcalendar ()
icalcomponent *	icalcomponent_new_vevent ()
icalcomponent *	icalcomponent_new_vfreebusy ()
icalcomponent *	icalcomponent_new_vjournal ()
icalcomponent *	icalcomponent_new_vquery ()
icalcomponent *	icalcomponent_new_vtimezone ()
icalcomponent *	icalcomponent_new_vtodo ()
icalcomponent *	icalcomponent_new_xdaylight ()
icalcomponent *	icalcomponent_new_xstandard ()
void	icalcomponent_remove_component (icalcomponent *parent, icalcomponent *child)
void	icalcomponent_remove_property (icalcomponent *component, icalproperty *property)
void	icalcomponent_set_comment (icalcomponent *comp, const char *v)
void	icalcomponent_set_description (icalcomponent *comp, const char *v)
void	icalcomponent_set_dtend (icalcomponent *comp, struct icaltimetype v)
void	icalcomponent_set_dtstamp (icalcomponent *comp, struct icaltimetype v)
void	icalcomponent_set_dtstart (icalcomponent *comp, struct icaltimetype v)
void	icalcomponent_set_due (icalcomponent *comp, struct icaltimetype v)
void	icalcomponent_set_duration (icalcomponent *comp, struct icaldurationtype v)
void	icalcomponent_set_location (icalcomponent *comp, const char *v)
void	icalcomponent_set_method (icalcomponent *comp, icalproperty_method method)
void	icalcomponent_set_parent (icalcomponent *component, icalcomponent *parent)
void	icalcomponent_set_recurrenceid (icalcomponent *comp, struct icaltimetype v)
void	icalcomponent_set_relcalid (icalcomponent *comp, const char *v)
void	icalcomponent_set_sequence (icalcomponent *comp, int v)
void	icalcomponent_set_status (icalcomponent *comp, enum icalproperty_status v)
void	icalcomponent_set_summary (icalcomponent *comp, const char *v)
void	icalcomponent_set_uid (icalcomponent *comp, const char *v)
icalcomponent_kind	icalcomponent_string_to_kind (const char *string)
void	icalcomponent_strip_errors (icalcomponent *component)
icalcomponent *	icalcomponent_vanew (icalcomponent_kind kind,...)
int	icalproperty_recurrence_is_excluded (icalcomponent *comp, struct icaltimetype *dtstart, struct icaltimetype *recurtime)

---

Typedef Documentation

typedef struct icalcomponent_impl icalcomponent

Definition at line 33 of file icalcomponent.h.

---

Function Documentation

icalcomponent* icalcompiter_deref

(

icalcompiter *

i

)

icalcomponent* icalcompiter_next

(

icalcompiter *

i

)

icalcomponent* icalcompiter_prior

(

icalcompiter *

i

)

void icalcomponent_add_component	(	icalcomponent *	parent,
		icalcomponent *	child
	)

void icalcomponent_add_property	(	icalcomponent *	component,
		icalproperty *	property
	)

char* icalcomponent_as_ical_string

(

icalcomponent *

component

)

icalcompiter icalcomponent_begin_component	(	icalcomponent *	component,
		icalcomponent_kind	kind
	)

int icalcomponent_check_restrictions

(

icalcomponent *

comp

)

void icalcomponent_convert_errors

(

icalcomponent *

component

)

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

int icalcomponent_count_components	(	icalcomponent *	component,
		icalcomponent_kind	kind
	)

int icalcomponent_count_errors

(

icalcomponent *

component

)

Count embedded errors.

int icalcomponent_count_properties	(	icalcomponent *	component,
		icalproperty_kind	kind
	)

icalcompiter icalcomponent_end_component	(	icalcomponent *	component,
		icalcomponent_kind	kind
	)

void icalcomponent_foreach_recurrence	(	icalcomponent *	comp,
		struct icaltimetype	start,
		struct icaltimetype	end,
		void(*)(icalcomponent *comp, struct icaltime_span *span, void *data)	callback,
		void *	callback_data
	)

void icalcomponent_foreach_tzid	(	icalcomponent *	comp,
		void(*)(icalparameter *param, void *data)	callback,
		void *	callback_data
	)

Calls the given function for each TZID parameter found in the component, and any subcomponents.

void icalcomponent_free

(

icalcomponent *

component

)

const char* icalcomponent_get_comment

(

icalcomponent *

comp

)

icalcomponent* icalcomponent_get_current_component

(

icalcomponent *

component

)

icalproperty* icalcomponent_get_current_property

(

icalcomponent *

component

)

const char* icalcomponent_get_description

(

icalcomponent *

comp

)

struct icaltimetype icalcomponent_get_dtend

(

icalcomponent *

comp

)

[read]

struct icaltimetype icalcomponent_get_dtstamp

(

icalcomponent *

comp

)

[read]

struct icaltimetype icalcomponent_get_dtstart

(

icalcomponent *

comp

)

[read]

struct icaltimetype icalcomponent_get_due

(

icalcomponent *

comp

)

[read]

struct icaldurationtype icalcomponent_get_duration

(

icalcomponent *

comp

)

[read]

icalcomponent* icalcomponent_get_first_component	(	icalcomponent *	component,
		icalcomponent_kind	kind
	)

icalproperty* icalcomponent_get_first_property	(	icalcomponent *	component,
		icalproperty_kind	kind
	)

icalcomponent* icalcomponent_get_first_real_component

(

icalcomponent *

c

)

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

icalcomponent* icalcomponent_get_inner

(

icalcomponent *

comp

)

const char* icalcomponent_get_location

(

icalcomponent *

comp

)

icalproperty_method icalcomponent_get_method

(

icalcomponent *

comp

)

icalcomponent* icalcomponent_get_next_component	(	icalcomponent *	component,
		icalcomponent_kind	kind
	)

icalproperty* icalcomponent_get_next_property	(	icalcomponent *	component,
		icalproperty_kind	kind
	)

icalcomponent* icalcomponent_get_parent

(

icalcomponent *

component

)

struct icaltimetype icalcomponent_get_recurrenceid

(

icalcomponent *

comp

)

[read]

const char* icalcomponent_get_relcalid

(

icalcomponent *

comp

)

int icalcomponent_get_sequence

(

icalcomponent *

comp

)

struct icaltime_span icalcomponent_get_span

(

icalcomponent *

comp

)

[read]

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

enum icalproperty_status icalcomponent_get_status

(

icalcomponent *

comp

)

const char* icalcomponent_get_summary

(

icalcomponent *

comp

)

icaltimezone* icalcomponent_get_timezone	(	icalcomponent *	comp,
		const char *	tzid
	)

Returns the icaltimezone in the component corresponding to the TZID, or NULL if it can't be found.

const char* icalcomponent_get_uid

(

icalcomponent *

comp

)

int icalcomponent_is_valid

(

icalcomponent *

component

)

icalcomponent_kind icalcomponent_isa

(

const icalcomponent *

component

)

int icalcomponent_isa_component

(

void *

component

)

int icalcomponent_kind_is_valid

(

const icalcomponent_kind

kind

)

const char* icalcomponent_kind_to_string

(

icalcomponent_kind

kind

)

void icalcomponent_merge_component	(	icalcomponent *	comp,
		icalcomponent *	comp_to_merge
	)

This takes 2 VCALENDAR components and merges the second one into the first, resolving any problems with conflicting TZIDs.

comp_to_merge will no longer exist after calling this function.

icalcomponent* icalcomponent_new

(

icalcomponent_kind

kind

)

icalcomponent* icalcomponent_new_clone

(

icalcomponent *

component

)

icalcomponent* icalcomponent_new_from_string

(

char *

str

)

icalcomponent* icalcomponent_new_vagenda

(

)

icalcomponent* icalcomponent_new_valarm

(

)

icalcomponent* icalcomponent_new_vcalendar

(

)

icalcomponent* icalcomponent_new_vevent

(

)

icalcomponent* icalcomponent_new_vfreebusy

(

)

icalcomponent* icalcomponent_new_vjournal

(

)

icalcomponent* icalcomponent_new_vquery

(

)

icalcomponent* icalcomponent_new_vtimezone

(

)

icalcomponent* icalcomponent_new_vtodo

(

)

icalcomponent* icalcomponent_new_xdaylight

(

)

icalcomponent* icalcomponent_new_xstandard

(

)

void icalcomponent_remove_component	(	icalcomponent *	parent,
		icalcomponent *	child
	)

void icalcomponent_remove_property	(	icalcomponent *	component,
		icalproperty *	property
	)

void icalcomponent_set_comment	(	icalcomponent *	comp,
		const char *	v
	)

void icalcomponent_set_description	(	icalcomponent *	comp,
		const char *	v
	)

void icalcomponent_set_dtend	(	icalcomponent *	comp,
		struct icaltimetype	v
	)

void icalcomponent_set_dtstamp	(	icalcomponent *	comp,
		struct icaltimetype	v
	)

void icalcomponent_set_dtstart	(	icalcomponent *	comp,
		struct icaltimetype	v
	)

void icalcomponent_set_due	(	icalcomponent *	comp,
		struct icaltimetype	v
	)

void icalcomponent_set_duration	(	icalcomponent *	comp,
		struct icaldurationtype	v
	)

void icalcomponent_set_location	(	icalcomponent *	comp,
		const char *	v
	)

void icalcomponent_set_method	(	icalcomponent *	comp,
		icalproperty_method	method
	)

void icalcomponent_set_parent	(	icalcomponent *	component,
		icalcomponent *	parent
	)

void icalcomponent_set_recurrenceid	(	icalcomponent *	comp,
		struct icaltimetype	v
	)

void icalcomponent_set_relcalid	(	icalcomponent *	comp,
		const char *	v
	)

void icalcomponent_set_sequence	(	icalcomponent *	comp,
		int	v
	)

void icalcomponent_set_status	(	icalcomponent *	comp,
		enum icalproperty_status	v
	)

void icalcomponent_set_summary	(	icalcomponent *	comp,
		const char *	v
	)

void icalcomponent_set_uid	(	icalcomponent *	comp,
		const char *	v
	)

icalcomponent_kind icalcomponent_string_to_kind

(

const char *

string

)

void icalcomponent_strip_errors

(

icalcomponent *

component

)

Remove all X-LIC-ERROR properties.

icalcomponent* icalcomponent_vanew	(	icalcomponent_kind	kind,
			...
	)

int icalproperty_recurrence_is_excluded	(	icalcomponent *	comp,
		struct icaltimetype *	dtstart,
		struct icaltimetype *	recurtime
	)