WinRecurrence Class Reference
[Win_adapter]

Rapresents a recurrence pattern object for Windows Clients. More...

#include <WinRecurrence.h>

Inheritance diagram for WinRecurrence:

Inheritance graph
[legend]
Collaboration diagram for WinRecurrence:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 WinRecurrence ()
 Default Constructor.
 WinRecurrence (const wstring dataString, const DATE date=0)
 Constructor: fills propertyMap parsing the vCalendar RRULE string.
virtual ~WinRecurrence ()
 Destructor.
virtual int parse (const wstring dataString)
 Parse a vCalendar RRULE string and fills the propertyMap.
virtual wstring & toString ()
 Format and return a vCalendar RRULE string from the propertyMap.
const DATE getStartDate ()
 Returns the startDate (double format).
void setStartDate (const DATE date)
 Sets the startDate (double format).
const bool hasTimezone ()
 Returns the 'useTimezone' flag value.
void setUseTimezone (bool val)
 Sets the 'useTimezone' flag to the given value.

Protected Attributes

DATE startDate
 The start date (double format) of the correspondent event/task It's necessary to parse correctly the RRULE string.
bool useTimezone
 true if the parent calendar has a timezone information, and uses it.

Detailed Description

Rapresents a recurrence pattern object for Windows Clients.

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


Constructor & Destructor Documentation

WinRecurrence::WinRecurrence ( const wstring  dataString,
const DATE  date = 0 
)

Constructor: fills propertyMap parsing the vCalendar RRULE string.

Parameters:
dataString input RRULE string to parse
date start date (double format) of the correspondent event/task


Member Function Documentation

virtual int WinRecurrence::parse ( const wstring  dataString  )  [virtual]

Parse a vCalendar RRULE string and fills the propertyMap.

Parameters:
dataString input RRULE string to parse
Returns:
0 if no errors

Implements WinItem.

Reimplemented in WinRecurrenceSIF.


Member Data Documentation

bool WinRecurrence::useTimezone [protected]

true if the parent calendar has a timezone information, and uses it.

Recurring props are in local time if this flag is true.


The documentation for this class was generated from the following file:
Generated on Fri Jul 25 15:04:26 2008 for Funambol C++ Client Library by  doxygen 1.5.1