Class TAgnYearlyByDayRpt

TAgnYearlyByDayRpt

Support

Supported from 5.0

Description

A yearly by day repeat. In addition to a start date, stores the day in the week, and the week in the month on which the repeat should occur, e.g. Wednesday of the third week of November every year.

Derivation

TAgnRpt This class stores the repeat details common to all agenda model repeat types TAgnYearlyByDayRpt A yearly by day repeat

Defined in TAgnYearlyByDayRpt:
ExternalizeL(), FindRptEndDate(), GetStartDay(), InstanceCount(), InternalizeL(), SetStartDay(), TAgnYearlyByDayRpt()

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

TAgnYearlyByDayRpt(const TAgnRpt& aRpt);

Description

The C++ copy constructor copies a new TAgnYearlyByDayRpt object from a TAgnRpt-derived object.

Parameters

const TAgnRpt& aRpt The object to be copied.

TAgnYearlyByDayRpt(const TAgnYearlyByDayRpt& aRpt);

Description

The C++ copy constructor copies a new TAgnYearlyByDayRpt object from an existing one.

Parameters

const TAgnYearlyByDayRpt& aRpt The object to be copied.

void SetStartDay(TDay aDay,TWeekInMonth aWeek,TMonth aMonth,TInt aYear);

Description

Sets the repeat’s start date using the details specified.

Parameters

TDay aDay The start day. TWeekInMonth aWeek The start week in the month. TMonth aMonth The start month. TInt aYear The start year.

virtual TTime FindRptEndDate(TUint aCount) const;

Description

Calculates the repeat’s end date from the specified number of instances.

Parameters

TUint aCount The number of instances.

Return value

TTime The end date. If the end date is beyond the end of the agenda’s valid date range, a NULL value is returned.

void GetStartDay(TDay& aDay,TWeekInMonth& aWeek,TMonth& aMonth,TInt& aYear) const;

Description

Returns the start day, week, month and year for the current start date.

Parameters

TDay& aDay On return, the start day. TWeekInMonth& aWeek On return, the week in the month of the start date. TMonth& aMonth On return, the month of the start date. TInt& aYear On return, the year of the start date.

virtual TUint InstanceCount() const;

Description

Returns the number of yearly repeat instances.

Return value

TUint The number of instances.

virtual void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises the yearly by day 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 yearly by day repeat object from a read stream.

Parameters

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