Class TAgnTodoDefaults

TAgnTodoDefaults

Support

Supported from 5.0

Description

Contains the default settings for new to-do entries; owned by a to-do list. Additionally contains a TAgnAlarmDefaults object, which specifies default alarm settings.

CAgnTodoList::SetTodoDefaults() is used to set up an object of this class and CAgnTodoList::TodoDefaults() retrieves it.

Defined in TAgnTodoDefaults:
AlarmDefaults(), BackgroundColor(), DaysWarning(), DisplayDueDateAs(), EntrySymbol(), ExternalizeL(), HasEntrySymbol(), InternalizeL(), IsDated(), ReplicationStatus(), SetAlarmDefaults(), SetBackgroundColor(), SetDaysWarning(), SetDisplayDueDateAs(), SetEntrySymbol(), SetHasEntrySymbol(), SetIsDated(), SetReplicationStatus(), TAgnTodoDefaults(), operator==()

TAgnTodoDefaults();

Description

Default C++ constructor. The initial values are mentioned in the descriptions for the following functions.

TBool HasEntrySymbol() const;

Description

Tests whether the default to-do entry settings include an entry symbol. This value is initialised to EFalse.

Return value

TBool ETrue if the default to-do entry settings include an entry symbol, otherwise EFalse.

const TAgnAlarmDefaults& AlarmDefaults() const;

Description

Gets the default alarm settings. These settings are initialised to: no alarm, zero days warning, alarm time = 525, sound name = Chimes.

Return value

TAgnAlarmDefaults& The default alarm settings.

TTimeIntervalDays DaysWarning() const;

Description

Gets the default number of days warning for a to-do entry. This value is initialised to zero.

Return value

TTimeIntervalDays The default number of days warning for a to-do entry.

CAgnTodo::TDisplayDueDateAs DisplayDueDateAs() const;

Description

Gets the default display mode for the due date. This value is initialised to CAgnTodo::EAutomatic.

Return value

CAgnTodo::TDisplayDueDateAs The default display mode for the due date.

TChar EntrySymbol() const;

Description

Gets the default entry symbol for to-do entries. This value is initialised to 'T'. The entry symbol is the character which is displayed in year views to represent an entry.

Return value

TChar The default entry symbol for to-do entries.

TBool IsDated() const;

Description

Tests whether to-do entries are dated by default. This value is initialised to EFalse.

Return value

TBool ETrue if to-do entries are dated by default, otherwise EFalse.

TAgnReplicationData::TStatus ReplicationStatus() const;

Description

Gets the default replication status for to-do entries. This value is initialised to TAgnReplicationData::EOpen. Replication status is used to define access rights to agenda information; public, private or confidential.

Return value

TAgnReplicationData::TStatus The default replication status for to-do entries.

TRgb BackgroundColor() const;

Support

Supported from 6.0

Description

Gets the background colour. This is the default background colour assigned to entry symbols for to-do entries. This value is initialised to KRgbBlack.

Return value

TRgb The background colour for entry symbols.

void SetAlarmDefaults(const TAgnAlarmDefaults& aAlarmDefaults);

Description

Sets the default alarm settings for to-do entries.

Parameters

const TAgnAlarmDefaults& aAlarmDefaults The new default alarm settings.

void SetDaysWarning(TTimeIntervalDays aDaysWarning);

Description

Sets the default number of days warning for to-do entries.

Parameters

TTimeIntervalDays aDaysWarning The new default number of days warning.

void SetDisplayDueDateAs(CAgnTodo::TDisplayDueDateAs aDisplayAs);

Description

Sets the default display mode for the due date.

Parameters

CAgnTodo::TDisplayDueDateAs aDisplayAs The new default display mode for the due date.

void SetEntrySymbol(TChar aEntrySymbol);

Description

Sets the default entry symbol for to-do entries. The entry symbol is the character which is displayed in year views to represent an entry.

Parameters

TChar aEntrySymbol The new default entry symbol.

void SetHasEntrySymbol(TBool aSetting);

Description

Sets whether new to-do entries should have an entry symbol by default.

Parameters

TBool aSetting ETrue if new to-do entries should have an entry symbol by default. EFalse if not.

void SetIsDated(TBool aIsDated);

Description

Sets whether new to-do entries should be dated by default.

Parameters

TBool aIsDated ETrue if new to-do entries should be dated by default, EFalse if not.

void SetReplicationStatus(TAgnReplicationData::TStatus aStatus);

Description

Sets the default replication status for to-do entries. Replication status is used to define access rights to agenda information; public, private or confidential.

Parameters

TAgnReplicationData::TStatus aStatus The new default replication status for to-do entries.

void SetBackgroundColor(const TRgb& aColor);

Support

Supported from 6.0

Description

Sets the background colour. This is the default background colour assigned to entry symbols for to-do entries.

Parameters

const TRgb& aColor The default background colour for entry symbols.

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises a to-do defaults object to a write stream. The presence of this function means that the standard templated operator<<() is available to externalise objects of this class.

Parameters

RWriteStream& aStream Stream to which the object should be externalised.

void InternalizeL(RReadStream& aStream);

Description

Internalises a to-do defaults object from a read stream. The presence of this function means that the standard templated operator>>() is available to internalise objects of this class.

Parameters

RReadStream& aStream Stream from which the object should be internalised.

TBool operator==(const TAgnTodoDefaults& aOther) const;

Description

Compares two default to-do settings objects for equivalence.

Parameters

const TAgnTodoDefaults& aOther A default to-do settings object to compare with the current object.

Return value

TBool ETrue if all the default settings are the same, otherwise EFalse.