Class TAgnInstanceDateTimeId

TAgnInstanceDateTimeId

Support

Supported from 5.0

Description

An instance ID which additionally stores the instance’s start and end dates / times. CAgnDayDateTimeInstanceList is a list of TAgnInstanceDateTimeIds. It is populated using CAgnModel::PopulateDayDateTimeInstanceListL(). The date and time are stored using agenda model dates and times i.e. a number of days since the agenda model’s minimum valid date and a number of minutes since midnight, respectively.

Derivation

TAgnEntryId Uniquely identifies an agenda entry in an agenda file TAgnId The base class for agenda entry and to-do list ID types TAgnInstanceDateTimeId An instance ID which additionally stores the instance's start and end dates / times TAgnInstanceId Identifies an instance of an entry in the agenda instance model (CAgnModel), with an entry ID (TAgnEntryId) and an agenda date (TAgnDate)

Defined in TAgnInstanceDateTimeId:
EndDate(), EndTime(), HasNullEndTime(), HasNullStartTime(), SetEndDate(), SetEndTime(), SetStartDate(), SetStartTime(), StartDate(), StartTime()

Inherited from TAgnId:
Id(), IsNullId(), SetNullId(), operator<(), operator>()

Inherited from TAgnInstanceId:
Date(), ExternalizeL(), InternalizeL(), IsNullInstanceId(), SetDate(), SetIdAndDate(), SetNullInstanceId(), operator!=(), operator==()

void SetStartTime(TAgnTime aTime);

Description

Sets the start time of the current ID.

Parameters

TAgnTime aTime The start time.

void SetEndTime(TAgnTime aTime);

Description

Sets the end time of the current ID.

Parameters

TAgnTime aTime The end time.

void SetStartDate(TAgnDate aDate);

Description

Sets the start date of the current ID.

Parameters

TAgnDate aDate The start date.

void SetEndDate(TAgnDate aDate);

Description

Sets the end date of the current ID.

Parameters

TAgnDate aDate The end date.

TTimeIntervalMinutes StartTime() const;

Description

Gets the start time of the current ID. A panic occurs if the start time is NULL.

Return value

TTimeIntervalMinutes The start time.

TTimeIntervalMinutes EndTime() const;

Description

Gets the end time of the current ID. A panic occurs if the end time is NULL.

Return value

TTimeIntervalMinutes The end time.

TTime StartDate() const;

Description

Gets the start date of the current ID.

Return value

TTime The start date.

TTime EndDate() const;

Description

Gets the end date of the current ID.

Return value

TTime The end date.

TBool HasNullStartTime() const;

Description

Tests whether the current entry has a NULL start time.

Return value

TBool True if the start time is NULL, otherwise False.

TBool HasNullEndTime() const;

Description

Tests whether the current entry has a NULL end time.

Return value

TBool True if the end time is NULL, otherwise False.