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 ()
bool setGeo (string szGeo)
string getGeo ()
string getTransparency ()
bool setTransparency (string szTransparency)
int getPriority ()
bool setPriority (int iPriority)
 CEvent (CEvent &ref)
const CEvent & operator= (const CEvent &right)
string toString ()

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

Parameters:
None 
Returns:
None
this is the default constructor for CEvent class where all variables are being initialised

References CComponent::setType().

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

headers used in this file CEvent This is the overloaded parameterized constructor CEvent class where minimum set of members will be intialized.

References CComponent::setType().

CEvent::~CEvent (  ) 

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

~CEvent Default destructor

CEvent::CEvent ( CEvent &  ref  ) 

copy constructor for Cevent class

References iPriority, szGeo, and szTransparency.

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.

setGeo Function to set the value for Geo

Parameters:
szGeo Geography value
Returns:
boolean (TRUE/FALSE)

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.

getGeo Function to get the Geo

Parameters:
none 
Returns:
geo

References szGeo.

Referenced by CCalendar::addEventCompDetails(), and CCalendar::modifyEvent().

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.

getTransparency Function to get the transparency for an entry

Parameters:
None 
Returns:
transp Transparency of entry

References szTransparency.

Referenced by CCalendar::addEventCompDetails(), and CCalendar::modifyEvent().

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.

setTransparency

Parameters:
transp Transparency of entry
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.

getPriority Function to get the Todo priority.

Parameters:
none 
Returns:
int priority of todo .

References iPriority.

Referenced by CCalendar::addEventCompDetails(), and CCalendar::modifyEvent().

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.

setPriority

Parameters:
integer pripority
Returns:
bool
This function will be used to set priority of todo returns true when priority is set correctly.

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

overloaded assignment operator

References iPriority, CComponentDetails::operator=(), szGeo, and szTransparency.

string CEvent::toString (  ) 

toString

Reimplemented from CComponentDetails.

References CComponent::getAlarm(), CComponent::getAllDay(), CComponent::getCalendarId(), CComponent::getCreatedTime(), CComponent::getDateEnd(), CComponent::getDateStart(), CComponent::getDescription(), CComponent::getFlags(), CComponent::getGUid(), CComponent::getId(), CComponent::getLastModified(), CComponent::getLocation(), CComponent::getRecurrence(), CComponent::getStatus(), CComponent::getSummary(), CComponent::getType(), CComponent::getUntil(), iPriority, CComponent::pAlarm, szGeo, szTransparency, CRecurrence::toString(), and CAlarm::toString().

Field Documentation

string CEvent::szGeo [private]

Geo parameter

Referenced by CEvent(), getGeo(), operator=(), and toString().

string CEvent::szTransparency [private]

Transparency

Referenced by CEvent(), getTransparency(), operator=(), and toString().

int CEvent::iPriority [private]

Priority

Referenced by CEvent(), getPriority(), operator=(), and toString().

The documentation for this class was generated from the following files:
Generated on Tue Jul 27 14:17:50 2010 for calendar-backend by  doxygen 1.5.6