CEvent Class Reference

This class is used to get/set the event specific properties. More...

#include <CEvent.h>

Inheritance diagram for CEvent:

CComponentDetails CComponent

Public Member Functions

 CEvent ()
 CEvent (string szSummary, string szDescription, string szLocation, int iDateStart, int iDateEnd)
 CEvent (string sId, int iType, int iFlags, string szSummary, string szDescription, string szLocation, int iStatus, int iDateStart, int iDateEnd, int iLastModified, int iCreatedTime, int iDateStamp, COrganizer *pOrganizer, vector< CAttendee * >vAttendee, vector< string >vAttachements, int iSequence, int iUId, string szUrl, string szCategory, string szComments, string szContacts, string szRelated, string szResources, vector< CProperties * > vXProp, map< string, vector< CParameters * > > hashMap, string szGeo, string szTransparency, int iPriority)
 ~CEvent ()
bool setGeo (string szGeo)
string getGeo ()
string getTransparency ()
bool setTransparency (string szTransparency)
int getPriority ()
bool setPriority (int iPriority)
 CEvent (CEvent &ref)
const CEventoperator= (const CEvent &right)

Private Attributes

string szGeo
string szTransparency
int iPriority

Detailed Description

This class is used to get/set the event specific properties.

CEvent class


Constructor & Destructor Documentation

CEvent::CEvent (  ) 

this is the default constructor for CEvent class where all variables are being initialised

CEvent::CEvent ( string  szSummary,
string  szDescription,
string  szLocation,
int  iDateStart,
int  iDateEnd 
)

CEvent This is the overloaded parameterized constructor CEvent class where minimum set of members will be intialized.

CEvent::CEvent ( string  sId,
int  iType,
int  iFlags,
string  szSummary,
string  szDescription,
string  szLocation,
int  iStatus,
int  iDateStart,
int  iDateEnd,
int  iLastModified,
int  iCreatedTime,
int  iDateStamp,
COrganizer pOrganizer,
vector< CAttendee * >  vAttendee,
vector< string >  vAttachements,
int  iSequence,
int  iUId,
string  szUrl,
string  szCategory,
string  szComments,
string  szContacts,
string  szRelated,
string  szResources,
vector< CProperties * >  vXProp,
map< string, vector< CParameters * > >  hashMap,
string  szGeo,
string  szTransparency,
int  iPriority 
)

this is the constructor of CEvent where memory is being allocated to all variables

CEvent::~CEvent (  ) 

this is the destructor for CEvent class where all memory is being deallocated or freed

CEvent::CEvent ( CEvent ref  ) 

copy constructor for Cevent class


Member Function Documentation

bool CEvent::setGeo ( string  szGeo  ) 

Parameters:
: string >> used to set geographical parameters(latitude,longitude) of entry created
Returns:
:bool (SUCCESS/FAILURE)
This property specifies information related to the global position for the activity specified by a calendar component.

string CEvent::getGeo (  ) 

Parameters:
:None 
Returns:
: string used to get geographical position of entry value is like "latitude;longitude" eg 12;13
This function is used to get the geographical position of the entry created.

string CEvent::getTransparency (  ) 

Parameters:
:None 
Returns:
: string transp >> used to get transparency of entry valid values can be TRANSPARENT/OPAQUE
This function is used to get the transparency of the entry created.

bool CEvent::setTransparency ( string  szTransparency  ) 

Parameters:
: transp(int) >> used to set transparency of entry valid values can be TRANSPARENT/OPAQUE
Returns:
:bool (SUCCESS/FAILURE)
This function is used to set the transparency of the entry created. Generally, an entry will take up time on an individual calendar. Hence, the event will appear as an opaque interval in a search for busy time. Alternately, the event can have its Time Transparency set to "TRANSPARENT" in order to prevent blocking of the event in searches for busy time.

int CEvent::getPriority (  ) 

Parameters:
:None 
Returns:
: int used to get priority of entry
This function is used to get the priority of the entry created.

bool CEvent::setPriority ( int  iPriority  ) 

Parameters:
: int iPriority used to set priority of entry created
Returns:
:bool (SUCCESS/FAILURE)
This function is used to set the priority of the entry created. The property defines the relative priority for a calendar component.

const CEvent & CEvent::operator= ( const CEvent right  ) 

overloaded assignment operator


Field Documentation

string CEvent::szGeo [private]

Geo parameter

string CEvent::szTransparency [private]

Transparency

int CEvent::iPriority [private]

Priority


The documentation for this class was generated from the following files:
Generated on Tue Feb 24 16:21:33 2009 for calendar-backend by  doxygen 1.5.1