WinEventSIF Class Reference
[Win_adapter]

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

#include <WineventSIF.h>

Inheritance diagram for WinEventSIF:

Inheritance graph
[legend]
Collaboration diagram for WinEventSIF:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 WinEventSIF ()
 Default Constructor.
 WinEventSIF (const wstring dataString, const wchar_t **fields, const wchar_t **recFields)
 Constructor: fills propertyMap parsing the passed SIF.
 ~WinEventSIF ()
 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.
wstring adaptFromSIFSpecs (const wstring &propName, const wstring &propValue)
 Transform the value of the specified property found in SIF structure to the one expected by Outlook.

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

WinEventSIF::WinEventSIF ( 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

WinRecurrenceSIF* WinEventSIF::getRecPattern (  )  [virtual]

Returns a pointer to the (internally owned) WinRecurrenceSIF.

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

Reimplemented from WinEvent.

int WinEventSIF::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 WinEvent.

wstring& WinEventSIF::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 WinEvent.

wstring WinEventSIF::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

wstring WinEventSIF::adaptFromSIFSpecs ( const wstring &  propName,
const wstring &  propValue 
)

Transform the value of the specified property found in SIF structure to the one expected by Outlook.

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 the same value is returned.

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


The documentation for this class was generated from the following file:
Generated on Tue Jun 10 17:20:35 2008 for Funambol C++ Client Library by  doxygen 1.5.2