Class TAgnMonthlyByDaysRpt

TAgnMonthlyByDaysRpt

Support

Supported from 5.0

Description

Stores the days in a month on which a repeat can occur, for instance Tuesday in the first week, Sunday in the last week.

Derivation

TAgnMonthlyByDaysRpt Stores the days in a month on which a repeat can occur, for instance Tuesday in the first week, Sunday in the last week TAgnMonthlyRpt Provides common behaviour shared by the two monthly repeat types TAgnMonthlyByDaysRpt and TAgnMonthlyByDatesRpt TAgnRpt This class stores the repeat details common to all agenda model repeat types

Defined in TAgnMonthlyByDaysRpt:
ClearAllDays(), ClearWeek(), ExternalizeL(), InternalizeL(), IsDaySet(), NumDaysSet(), SetDay(), TAgnMonthlyByDaysRpt(), UnsetDay(), operator==()

Inherited from TAgnMonthlyRpt:
FindRptEndDate(), InstanceCount()

Inherited from TAgnRpt:
ClearAll(), DisplayNextOnly(), EndDate(), EndDateAsAgnDate(), Interval(), RepeatForever(), SetDisplayNextOnly(), SetEndDate(), SetInterval(), SetRepeatForever(), SetStartDate(), StartDate(), StartDateAsAgnDate()

TAgnMonthlyByDaysRpt();

Description

The default C++ constructor is used to construct a monthly by days repeat object. The monthly repeat days are all cleared.

TAgnMonthlyByDaysRpt(const TAgnRpt& aRpt);

Description

The C++ copy constructor constructs a new TAgnMonthlyByDaysRpt object from an existing TAgnRpt-derived object. The monthly repeat days are all cleared.

Parameters

const TAgnRpt& aRpt The object to be copied.

TAgnMonthlyByDaysRpt(const TAgnMonthlyByDaysRpt& aRpt);

Description

The C++ copy constructor constructs a new TAgnMonthlyByDaysRpt object from an existing one.

Parameters

const TAgnMonthlyByDaysRpt& aRpt The object to be copied.

void ClearAllDays();

Description

Clears all the monthly repeat days.

void ClearWeek(TWeekInMonth aWeek);

Description

Clears all repeat days for the specified week.

Parameters

TWeekInMonth aWeek The week to be cleared.

void SetDay(TDay aDay,TWeekInMonth aWeek);

Description

Adds a day in the specified week to the repeat object.

Parameters

TDay aDay The day to be added. TWeekInMonth aWeek The week in the month for the day to be added.

void UnsetDay(TDay aDay,TWeekInMonth aWeek);

Description

Unsets a day in the specified week from the repeat object.

Parameters

TDay aDay The day to be unset. TWeekInMonth aWeek The week in the month for the day to be removed.

TBool IsDaySet(TDay aDay,TWeekInMonth aWeek) const;

Description

Tests whether a day is set in the given week.

Parameters

TDay aDay The day to be tested for. TWeekInMonth aWeek The week in the month.

Return value

TBool True if set, False if not set.

TInt NumDaysSet() const;

Description

Returns the number of repeat days in the month which are set.

Return value

TInt The number of days set.

TBool operator==(const TAgnMonthlyByDaysRpt& aRpt) const;

Description

Compares two monthly by day repeat objects for equality.

Parameters

const TAgnMonthlyByDaysRpt& aRpt The object to be compared.

Return value

TBool True if all repeat details agree, otherwise False.

virtual void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises the monthly by days repeat object to a write stream.

Parameters

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

virtual void InternalizeL(RReadStream& aStream);

Description

Internalises the monthly by days repeat object to a read stream.

Parameters

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