WinEvent Class Reference
[Win_adapter]

Rapresents an event object for Windows Clients. More...

#include <WinEvent.h>

Inheritance diagram for WinEvent:

[legend]Collaboration diagram for WinEvent:

[legend]List of all members.

Public Member Functions
	WinEvent ()
	Default Constructor.
	WinEvent (const wstring dataString)
	Constructor: fills propertyMap parsing the passed vCalendar string.
	~WinEvent ()
	Destructor.
virtual int	parse (const wstring dataString)
	Parse a vCalendar string and fills the propertyMap.
virtual wstring &	toString ()
	Format and return a vCalendar string from the propertyMap.
virtual WinRecurrence *	getRecPattern ()
	Returns a pointer to the (internally owned) WinRecurrence.
exceptionList *	getExcludeDates ()
	Returns a pointer to the list (internally owned) of exclude dates.
exceptionList *	getIncludeDates ()
	Returns a pointer to the list (internally owned) of include dates.
recipientList *	getRecipients ()
	Returns a pointer to the list (internally owned) of recipients.
const TIME_ZONE_INFORMATION *	getTimezone ()
	Returns a pointer to the timezone information for this event, NULL if timezone is not used (not set).
void	setTimezone (const TIME_ZONE_INFORMATION *tz)
	Copies the given timezone for this event. 'useTimezone' is set to true.
bool	hasTimezone ()
	Returns true if this event has a timezone information, and uses it.
long	getCRC ()
	Return the crc value of the internal map with all values.
Protected Member Functions
void	getIntervalOfRecurrence (int *yearBegin, int *yearEnd)
	Retrieves the interval when the recurrence occurrs, in years.
Protected Attributes
exceptionList	excludeDate
	List of occurrences dates to exclude (recurring exceptions to delete).
exceptionList	includeDate
	List of occurrences dates to include (recurring exceptions to add).
recipientList	recipients
	List of recipients (attendees) for this event.
TIME_ZONE_INFORMATION	tzInfo
	The timezone structure for this event.
bool	useTimezone
	true if this event has a timezone information, and uses it.

---

Detailed Description

Rapresents an event object for Windows Clients.

The object can be filled passing a vCalendar, or filling directly the map. Calling 'toString()' a vCalendar is formatted and returned.

---

Member Function Documentation

void WinEvent::getIntervalOfRecurrence	(	int *	yearBegin,
		int *	yearEnd
	)			[protected]

Retrieves the interval when the recurrence occurrs, in years.

It checks the "Start" property and the "PatternEndDate" property.

Parameters:

	yearBegin	[IN-OUT] the year when recurrence begins
	yearEnd	[IN-OUT] the year when recurrence ends

virtual int WinEvent::parse

(

const wstring

dataString

)

[virtual]

Parse a vCalendar string and fills the propertyMap.

The map is cleared and will contain only found properties at the end of the parsing.

Parameters:

dataString

input vCalendar string to be parsed

Returns:

0 if no errors

Implements WinItem.

Reimplemented in WinEventSIF.

virtual wstring& WinEvent::toString

(

)

[virtual]

Format and return a vCalendar string from the propertyMap.

Not supported properties are ignored and so not formatted as they don't have a correspondence in propertyMap.

Returns:

the vCalendar string formatted, reference to internal wstring

Implements WinItem.

Reimplemented in WinEventSIF.

long WinEvent::getCRC

(

)

[virtual]

Return the crc value of the internal map with all values.

It uses only the values of the map not the key. Overrides method of WinItem, to include recurring properties and event exceptions in the crc.

Reimplemented from WinItem.

---

Member Data Documentation

TIME_ZONE_INFORMATION WinEvent::tzInfo [protected]

The timezone structure for this event.

It can be set/get using getTimezone() and setTimezone() methods. If the timezone is set, it will be formatted following vCalendar 1.0 specs when calling toString() method ("TZ" and "DAYLIGHT" properties).

Note:

Recurring properties will be in local time if timezone is used.

---

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

• src/include/windows/vocl/WinEvent.h

---