AppleEvent Class Reference
[Apple_adapter]

Represents an item object for Apple Event. More...

#include <AppleEvent.h>

Inheritance diagram for AppleEvent:
[legend]

List of all members.

Public Member Functions

 AppleEvent ()
 Default Constructor.
virtual ~AppleEvent ()
 Destructor.
virtual StringBuffer toString ()=0
 Format and return a string from the propertyMap.
virtual int parse (const StringBuffer &dataString)=0
 Parse a string and fills the propertyMap.
char * getVObjectPropertyValue (VObject *vo, const char *propertyName)
 Utility to safe-retrieve the property value inside VObject 'vo'.
virtual long getCRC ()
 Return the crc value of the internal map with all values.
void setAllDayEvent (bool v)
bool getAllDayEvent () const
void setStart (NSDate *d)
NSDate * getStart () const
void setEnd (NSDate *d)
NSDate * getEnd () const
void setIsRecurring (bool v)
bool getIsRecurring ()
void setTitle (const char *v)
const char * getTitle () const
void setNote (const char *v)
const char * getNote () const
void setLocation (const char *v)
const char * getLocation () const
void setReminder (bool v)
bool getReminder () const
void setAlarm1 (NSDate *d)
NSDate * getAlarm1 () const
void setAlarm2 (NSDate *d)
NSDate * getAlarm2 () const
void setEventTimezone (const Timezone &t)
Timezone & getEventTimezone ()
void setBusyStatus (BusyStatus v)
BusyStatus getBusyStatus ()
void setImportance (Importance v)
Importance getImportance ()
void setSensitivity (Sensitivity v)
Sensitivity getSensitivity ()
void setCategories (const char *v)
const char * getCategories () const

Protected Attributes

NSDate * start
 The start date of the event.
NSDate * end
 The end date of the event.
bool allDayEvent
 The event is all day (true) or not (false);.
bool isRecurring
 The event is recurring (true) or not (false); TO BE CONFIRMED IF USED.
StringBuffer title
 The title (subject) of the event.
StringBuffer note
 The note (body) of the event.
StringBuffer location
 The location of the event.
bool reminder
 It represents the alarms of the event.
NSDate * alarmDate1
NSDate * alarmDate2
Timezone timezone
BusyStatus busyStatus
StringBuffer categories
Importance importance
Sensitivity sensitivity

Static Protected Attributes

static unsigned long crc32Table [256]
 The table used to calculate the crc.


Detailed Description

Represents an item object for Apple Event.

Member Function Documentation

virtual long AppleEvent::getCRC (  )  [virtual]

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

It uses only the values of the map not the key. Can be overridden by derived classes if other properties are involved (e.g. Events have recurrence props and exceptions)

Reimplemented in iPhoneEvent.

char* AppleEvent::getVObjectPropertyValue ( VObject *  vo,
const char *  propertyName 
)

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)

virtual int AppleEvent::parse ( const StringBuffer &  dataString  )  [pure virtual]

Parse a string and fills the propertyMap.

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

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

Implemented in iPhoneEvent.

virtual StringBuffer AppleEvent::toString (  )  [pure virtual]

Format and return a string from the propertyMap.

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

Returns:
the string formatted, reference to internal wstring

Implemented in iPhoneEvent.


Member Data Documentation

NSDate* AppleEvent::end [protected]

The end date of the event.

Only date year, month, day are used for an all day event

bool AppleEvent::reminder [protected]

It represents the alarms of the event.

Only 2 alarms are allowed in the system. Only one is populated by the sync. reminder is a shortcut to understand if an alarm exists

NSDate* AppleEvent::start [protected]

The start date of the event.

Only date year, month, day are used for an all day event


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

Generated on Tue Dec 21 15:16:18 2010 for Funambol Outlook Plug-in Library by  doxygen 1.5.7.1