CTodo Class Reference

This class contains the details of Todo component. Inherited from CComponentDetails. More...

#include <CTodo.h>

Inheritance diagram for CTodo:

Public Member Functions
bool	setGeo (string szGeo)
string	getGeo ()
int	getDue ()
bool	setDue (int iDue)
int	getCompleted ()
bool	setCompleted (int iCompleted)
bool	setPercentComplete (int iPercentComplete)
int	getPercentComplete ()
int	getPriority ()
bool	setPriority (int iPriority)
	CTodo (CTodo &ref)
CTodo &	operator= (CTodo &right)
	CTodo ()
	CTodo (string szSummary, int iDateStart, int iStatus)
	~CTodo ()
string	toString ()
Private Attributes
string	szGeo
int	iDue
int	iCompleted
int	iPercentComplete
int	iPriority

---

Detailed Description

This class contains the details of Todo component. Inherited from CComponentDetails.

CTodo class

---

Constructor & Destructor Documentation

CTodo::CTodo

(

CTodo &

ref

)

copy Constructor

References iCompleted, iDue, iPercentComplete, iPriority, and szGeo.

CTodo::CTodo

(

)

calTodo

Parameters:

none

Returns:

None Default constructor

References CComponent::setType().

CTodo::CTodo	(	string	szSummary,
		int	iTodoDue,
		int	iStatus
	)

include files CTodo Overloaded constructor for CTodo class

References CComponent::setType().

CTodo::~CTodo

(

)

~CTodo

Parameters:

none

Returns:

none destructor

---

Member Function Documentation

bool CTodo::setGeo

(

string

szGeo

)

Parameters:

string

szGeo consisting folat variables (Latitude and Longitude)

Returns:

bool

This function will be used to set geo for a todo entry The geo is combination of latitude and longitude.ex: 120.98;45.64 returns true when geo is set correctly. returns false when geo is empty.

setGeo

Parameters:

str

Latitude and Longitude

Returns:

bool

This function will be used to set geo for a todo entry The geo is combination of latitude and longitude.ex: 120.98;45.64 returns true when geo is set correctly. returns false when geo is empty.

Referenced by CCalendar::getTodo(), and CCalendar::getTodos().

string CTodo::getGeo

(

)

Parameters:

none

Returns:

string geo value in form of string (Latitude;longitude)

This function will be used to extract geo for a todo entry The geo is combination of latitude and longitude.ex: 120.98;45.64 returns geo string

see setGeo().

getGeo

Parameters:

none

Returns:

geo string

This function will be used to extract geo for a todo entry which has been previously set using setGeo().The geo is combination of latitude and longitude.ex: 120.98;45.64 returns geo string

References szGeo.

Referenced by CCalendar::addTodoCompDetails().

int CTodo::getDue

(

)

Parameters:

none

Returns:

due time in int

This function will be used to due time for a todo returns due time

see setDue().

getDue

Parameters:

none

Returns:

due time int

This function will be used to due time for a todo which has been previously set using setTodoDue() returns due time

References CComponent::getDateStart(), and iDue.

bool CTodo::setDue

(

int

iDue

)

Parameters:

int

due time

Returns:

bool

This function will be used to set due date for a todo entry returns true when due date is set correctly. returns false when due date is empty.

see getDue().

setDue

Parameters:

int

time

Returns:

bool

This function will be used to set due date for a todo entry

returns true when due date is set correctly. returns false when due date is empty.

int CTodo::getCompleted

(

)

Parameters:

none

Returns:

completed in int

This function will be used to completed time for a todo returns completed time see setCompleted().

getCompleted

Parameters:

none

Returns:

completed time int

This function will be used to completed time for a todo which has been previously set using setTodoComp() returns completed time

References iCompleted.

Referenced by CCalendar::addTodoCompDetails(), and CCalendar::modifyTodo().

bool CTodo::setCompleted

(

int

iCompleted

)

Parameters:

int

completed time

Returns:

bool

This function will be used to set completed date for a todo entry

returns true when date is set correctly. returns false when date is empty.

see getCompleted().

setCompleted

Parameters:

int

time

Returns:

bool

This function will be used to set completed date for a todo entry

returns true when date is set correctly. returns false when date is empty.

Referenced by CCalendar::addTodoCompDetails(), CCalendar::getTodo(), CCalendar::getTodos(), and CCalendar::modifyTodo().

bool CTodo::setPercentComplete

(

int

iPercentComplete

)

Parameters:

integer

percentage of todo completed

Returns:

bool This function will be used to set percentage of todo completed for a todo entry returns true when percent is set correctly.

see getPercentComplete().

setPercentComplete

Parameters:

integer

P percentage of todo completed

Returns:

bool This function will be used to set percentage of todo completed for a todo entry returns true when percent is set correctly.

int CTodo::getPercentComplete

(

)

Parameters:

none

Returns:

int percentage of todo completed. This function will be used to extract percent of todo completed for a todo entry which has been previously set using setPercentComplete().

getPercentComplete

Parameters:

none

Returns:

int percentage of todo completed. This function will be used to extract percent of todo completed for a todo entry which has been previously set using setPercent().

References iPercentComplete.

Referenced by CCalendar::addTodoCompDetails(), and CCalendar::modifyTodo().

int CTodo::getPriority

(

)

Parameters:

none

Returns:

int priority of todo . This function will be used to extract priority of todo which has been previously set using setPriority().

getPriority Function to get the priority value

Parameters:

none

Returns:

int Todo priority

References iPriority.

Referenced by CCalendar::addTodoCompDetails(), and CCalendar::modifyTodo().

bool CTodo::setPriority

(

int

iPriority

)

Parameters:

integer

pripority

Returns:

bool

This function will be used to set priority of todo returns true when priority is set correctly.

setPriority

Parameters:

integer

pripority

Returns:

bool

This function will be used to set priority of todo returns true when priority is set correctly.

CTodo & CTodo::operator=

(

CTodo &

right

)

overloaded assignment operator

References iCompleted, iDue, iPercentComplete, iPriority, CComponentDetails::operator=(), and szGeo.

string CTodo::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(), iCompleted, iDue, iPercentComplete, iPriority, CComponent::pAlarm, szGeo, CRecurrence::toString(), and CAlarm::toString().

Referenced by CCalendar::getTodo(), and CCalendar::getTodos().

---

Field Documentation

string CTodo::szGeo [private]

Geo parameter

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

int CTodo::iDue [private]

Todo due

Referenced by CTodo(), getDue(), operator=(), and toString().

int CTodo::iCompleted [private]

Todo completed

Referenced by CTodo(), getCompleted(), operator=(), and toString().

int CTodo::iPercentComplete [private]

Todo percent complete

Referenced by CTodo(), getPercentComplete(), operator=(), and toString().

int CTodo::iPriority [private]

Todo priority

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

---

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

• /home/bifh2/fremantle-i386-fremantle-pe1.cs2007q3/work/calendar-backend-0.8/include/CTodo.h
• /home/bifh2/fremantle-i386-fremantle-pe1.cs2007q3/work/calendar-backend-0.8/src/CTodo.cpp