Class TAgnLiteEntry

TAgnLiteEntry

Support

Supported from 5.0

Description

Provides a set of enquiry functions which allow read-only access to most (but not all) of an entry's details. It is intended for use when you have an instance ID, and want to access some details about the entry but without the overhead of creating a CAgnEntry* on the heap. Use CAgnIndexedModel::GetLiteEntryL() to get an instance of this class. A call to GetLiteEntryL() is also faster than a call to FetchInstanceL() because the details are obtained from memory and not from the store.

Defined in TAgnLiteEntry:
AlarmDaysWarning(), AlarmTime(), CrossedOutDate(), DisplayInYearView(), DisplayTime(), Duration(), EndDate(), EntrySymbol(), HasAlarm(), HasDefaultDisplayTime(), HasEntrySymbol(), HasExceptions(), Id(), IsADayNote(), IsAlarmSetFromDueDate(), IsAlarmSetFromStartDate(), IsCrossedOut(), IsDated(), IsNull(), IsRepeating(), IsStoredInline(), IsTentative(), Priority(), RptDef(), StartDate(), TodoListId(), Type()

CAgnEntry::TType Type() const;

Description

Gets the entry type.

Return value

TTimeIntervalMinutes DisplayTime() const;

Description

Gets the display time. The display time is the time at which the entry is displayed in dated views, as a number of minutes from midnight.

Return value

TBool HasDefaultDisplayTime() const;

Description

Tests whether the entry uses the default display time.

Return value

TBool DisplayInYearView() const;

Description

Tests whether the entry should be displayed in the year view.

Return value

TBool HasEntrySymbol() const;

Description

Tests whether the entry has an entry symbol.

Return value

TChar EntrySymbol() const;

Description

Gets the entry symbol.

Return value

TBool IsRepeating() const;

Description

Tests whether the entry is repeating.

Return value

const CAgnRptDef* RptDef() const;

Description

Gets a pointer to the entry’s repeat details, including exceptions

Return value

TBool HasExceptions() const;

Description

Tests whether or not a repeating entry has any repeat exceptions.

Return value

TAgnEntryId Id() const;

Description

Gets the entry ID.

Return value

TBool IsADayNote() const;

Description

Tests whether the entry is a day note.

Return value

TBool IsCrossedOut() const;

Description

Tests whether the entry is crossed out.

Return value

TBool IsNull() const;

Description

Tests whether the entry is NULL.

Return value

TBool IsStoredInline() const;

Description

Tests whether the entry's rich text is stored inline (within the same stream as the entry), or out of line (in an embedded store).

Return value

TBool IsTentative() const;

Description

Tests whether the entry is tentative (i.e. not yet confirmed).

Return value

TAgnTodoListId TodoListId() const;

Description

Gets the ID of the to-do list to which the entry belongs. If the entry is not a to-do, then a NULL ID is returned.

Return value

TBool IsAlarmSetFromDueDate() const;

Description

Tests whether the alarm date is set relative to the entry’s due date.

Return value

TBool IsAlarmSetFromStartDate() const;

Description

Tests whether the alarm date is set relative to the entry’s start date.

Return value

TUint Priority() const;

Description

Gets the priority of the to-do entry.

Return value

TTime CrossedOutDate() const;

Description

Gets the to-do entry's crossed out date, i.e. the date on which the action required by the to-do entry was carried out. If the entry has no crossed out date (e.g. the entry is not a to-do), the function returns a NULL date.

Return value

TTimeIntervalDays AlarmDaysWarning() const;

Description

Returns the number of days warning for the entry’s alarm. The number of days warning is a time interval in days and is the number of days before an entry’s start date, that the alarm is set to sound. Returns zero if the entry is not alarmed.

Return value

TTimeIntervalMinutes AlarmTime() const;

Description

Returns the time of the alarm as a time interval in minutes from midnight.

Return value

TBool HasAlarm() const;

Description

Tests whether the entry has an alarm.

Return value

TBool IsDated() const;

Description

Tests whether the entry is dated. All entries are dated, except undated to-do entries.

Return value

TTime StartDate() const;

Description

Gets the start date for the entry as a TTime.

Return value

TTime EndDate() const;

Description

Gets the end date for the entry as a TTime.

Return value

TTimeIntervalDays Duration() const;

Description

Gets the duration of the entry. This is the difference in days between the start and end dates.

Return value