WinTaskSIF Class Reference
[Windows Adapter]

Rapresents an event object for Windows Clients, for SIF format. More...

#include <WinTaskSIF.h>

Inheritance diagram for WinTaskSIF:
[legend]
Collaboration diagram for WinTaskSIF:
[legend]

List of all members.

Public Member Functions

 WinTaskSIF ()
 Default Constructor.
 WinTaskSIF (const wstring dataString, const wchar_t **fields, const wchar_t **recFields)
 Constructor: fills propertyMap parsing the passed SIF.
 ~WinTaskSIF ()
 Destructor.
WinRecurrenceSIFgetRecPattern ()
 Returns a pointer to the (internally owned) WinRecurrenceSIF.
int parse (const wstring dataString)
 Parse a SIF string and fills the propertyMap.
wstring & toString ()
 Format and return a SIF string from the propertyMap.
wstring adaptToSIFSpecs (const wstring &propName, const wstring &propValue)
 Transform the value of the specified property according to the SIF specifications.

Private Attributes

wstring sif
 Internal string formatted (SIF).
const wchar_t ** sifFields
 NULL terminated array of SIF fields names.
WinRecurrenceSIF recPatternSIF
 The recurrence pattern object for SIF data, containing recurring properties.


Detailed Description

Rapresents an event object for Windows Clients, for SIF format.

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


Constructor & Destructor Documentation

WinTaskSIF::WinTaskSIF ( const wstring  dataString,
const wchar_t **  fields,
const wchar_t **  recFields 
)

Constructor: fills propertyMap parsing the passed SIF.

Parameters:
dataString the input SIF string
fields the NULL terminated array of SIF fields
fields the NULL terminated array of SIF fields for recurrence pattern


Member Function Documentation

wstring WinTaskSIF::adaptToSIFSpecs ( const wstring &  propName,
const wstring &  propValue 
)

Transform the value of the specified property according to the SIF specifications.

The values are formatted following the vcard and icalendar specs that in some cases they are different from the SIF expectations. If there are no differences, propValue is returned.

Parameters:
propName [IN] the property name
propValue [IN] the property value
Returns:
the converted value if necessary

WinRecurrenceSIF* WinTaskSIF::getRecPattern (  )  [virtual]

Returns a pointer to the (internally owned) WinRecurrenceSIF.

Note:
: overrides the method of WinTask, to return a SIF formatted string.

Reimplemented from WinTask.

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

Parse a SIF string and fills the propertyMap.

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

Parameters:
dataString input SIF string to be parsed
Returns:
0 if no errors

Reimplemented from WinTask.

wstring& WinTaskSIF::toString (  )  [virtual]

Format and return a SIF string from the propertyMap.

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

Returns:
the SIF string formatted, reference to internal wstring

Reimplemented from WinTask.


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

Generated on Tue Apr 6 13:00:44 2010 for Funambol Outlook Plug-in Library by  doxygen 1.5.7.1