Class TAgnBasicTodo

TAgnBasicTodo

Support

Supported from 5.0

Description

Used by the CAgnTodo class to store to-do specific entry details. These details include the ID of the to-do list to which the entry belongs, the due and crossed out dates and the display time. Normally, these details are accessed using member functions of the CAgnTodo class. You can get a TAgnBasicTodo instance by calling CAgnTodo::BasicTodo().

Defined in TAgnBasicTodo:
CrossedOutDate(), DisplayTime(), DueDate(), Duration(), IsAlarmSetFromDueDate(), IsAlarmSetFromStartDate(), Priority(), SetAlarmFromDueDate(), SetAlarmFromStartDate(), SetDisplayTime(), SetDueDate(), SetDuration(), SetPriority(), SetTodoListId(), TodoListId()

TAgnDate CrossedOutDate() const;

Description

Returns the crossed out date, i.e. the date on which the action required by the to-do entry was carried out.

Return value

TAgnTime DisplayTime() const;

Description

Returns the display time (a number of minutes from midnight — between zero and 1439 inclusive).

Return value

TAgnDate DueDate() const;

Description

Returns the due date (indicates the date by which the action should be carried out).

Return value

TAgnDurationDays Duration() const;

Description

Returns the duration (the number of days between the start date and the due date).

Return value

TBool IsAlarmSetFromDueDate() const;

Description

Tests whether the alarm is set from the due date, rather than the start date.

Return value

TBool IsAlarmSetFromStartDate() const;

Description

Tests whether the alarm is set from the start date, rather than the due date.

Return value

TUint Priority() const;

Description

Returns the priority of the current to-do entry, as set by SetPriority(). The default is zero.

Return value

TAgnTodoListId TodoListId() const;

Description

Returns the ID of the to-do list to which the entry belongs.

Return value

void SetAlarmFromDueDate();

Description

Sets the alarm date to be a number of days from the due date, rather than from the start date.

void SetAlarmFromStartDate();

Description

Sets the alarm date to be a number of days from the start date, rather than from the due date.

void SetDisplayTime(TAgnTime aDisplayTime);

Description

Sets the display time (the time at which the entry is displayed in dated views — a number of minutes from midnight; between zero and 1439 inclusive).

Parameters

void SetDueDate(TAgnDate aDueDate);

Description

Sets the due date (this should be a null value for an undated to-do).

Parameters

void SetDuration(TAgnDurationDays aDuration);

Description

Sets the duration (the number of days between the start date and the due date).

Parameters

void SetPriority(TUint aPriority);

Description

Sets the priority of the to-do entry.

Parameters

void SetTodoListId(TAgnTodoListId aTodoListId);

Description

Sets the ID of the to-do list to which the entry belongs.

Parameters