WinEvent Class Reference
[Windows Adapter]

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

#include <WinEvent.h>

Inheritance diagram for WinEvent:

Inheritance graph
[legend]
Collaboration diagram for WinEvent:

Collaboration graph
[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.
int parse (const wstring dataString)
 Parse a vCalendar string and fills the propertyMap.
wstring & toString ()
 Format and return a vCalendar string from the propertyMap.
WinRecurrencegetRecPattern ()
 Returns a pointer to the (internally owned) WinRecurrence.
list< wstring > * getExcludeDates ()
 Returns a pointer to the list (internally owned) of exclude dates.
list< wstring > * getIncludeDates ()
 Returns a pointer to the list (internally owned) of include dates.
list< WinRecipient > * getRecipients ()
 Returns a pointer to the list (internally owned) of recipients.

Private Member Functions

bool checkVCalendarTypeAndVersion (VObject *vo)
 Checks the productID and version of VObject passed for vCalendar.
WCHAR * getVObjectPropertyValue (VObject *vo, const WCHAR *propertyName)
 Utility to safe-retrieve the property value inside VObject 'vo'.

Private Attributes

wstring vCalendar
 Internal string formatted (VCALENDAR).
WinRecurrence recPattern
 The recurrence pattern object, containing recurring properties.
list< wstring > excludeDate
 List of occurrences dates to exclude (recurring exceptions to delete).
list< wstring > includeDate
 List of occurrences dates to include (recurring exceptions to add).
list< WinRecipientrecipients
 List of recipients (attendees) for this event.

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

bool WinEvent::checkVCalendarTypeAndVersion ( VObject *  vo  )  [private]

Checks the productID and version of VObject passed for vCalendar.

Parameters:
vo the VObject to check
Returns:
true if productID is correct

WCHAR* WinEvent::getVObjectPropertyValue ( VObject *  vo,
const WCHAR *  propertyName 
) [private]

Utility to safe-retrieve the property value inside VObject 'vo'.

Parameters:
vo : VObject to read from
propertyName : the property name requested
Returns:
the property value (NULL if not found)

int WinEvent::parse ( const wstring  dataString  ) 

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

wstring& WinEvent::toString (  ) 

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


The documentation for this class was generated from the following file:
Generated on Mon Feb 4 09:51:00 2008 for Funambol Outlook Plug-in Library by  doxygen 1.5.2