Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: agmrptd.h
Link against: agnmodel.lib

Class TAgnMonthlyByDatesRpt

TAgnMonthlyByDatesRpt

Support

Supported from 5.0

Description

Stores the dates in a month on which a repeat can occur.

Derivation

TAgnMonthlyByDatesRptStores the dates in a month on which a repeat can occur
TAgnMonthlyRptProvides common behaviour shared by the two monthly repeat types TAgnMonthlyByDaysRpt and TAgnMonthlyByDatesRpt
TAgnRptThis class stores the repeat details common to all agenda model repeat types

Defined in TAgnMonthlyByDatesRpt:
ClearAllDates(), ExternalizeL(), InternalizeL(), IsDateSet(), NumDatesSet(), SetDate(), TAgnMonthlyByDatesRpt(), UnsetDate(), operator==()

Inherited from TAgnMonthlyRpt:
FindRptEndDate(), InstanceCount()

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


Construction


TAgnMonthlyByDatesRpt()

TAgnMonthlyByDatesRpt();

Description

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


TAgnMonthlyByDatesRpt()

TAgnMonthlyByDatesRpt(const TAgnRpt& aRpt);

Description

The C++ copy constructor constructs a new TAgnMonthlyByDatesRpt object from an existing TAgnRpt-derived object. All monthly repeat dates are cleared.

Parameters

const TAgnRpt& aRpt

The object to be copied.


TAgnMonthlyByDatesRpt()

TAgnMonthlyByDatesRpt(const TAgnMonthlyByDatesRpt& aRpt);

Description

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

Parameters

const TAgnMonthlyByDatesRpt& aRpt

The object to be copied.

[Top]


Set repeat details


ClearAllDates()

void ClearAllDates();

Description

Clears all the monthly repeat dates.


SetDate()

void SetDate(TUint aDateInMonth);

Description

Sets the date specified.

Parameters

TUint aDateInMonth

The date to be added, (between 0 and 30 inclusive).


UnsetDate()

void UnsetDate(TUint aDateInMonth);

Description

Removes the supplied date from the list of dates.

Parameters

TUint aDateInMonth

The date to be removed (between 0 and 30 inclusive).

[Top]


Get repeat details


IsDateSet()

TBool IsDateSet(TUint aDateInMonth) const;

Description

Tests whether the supplied date is set.

Parameters

TUint aDateInMonth

The date to be tested for (between 0 and 30 inclusive).

Return value

TBool

True if set, False if not set.


NumDatesSet()

TInt NumDatesSet() const;

Description

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

Return value

TInt

The number of dates set.

[Top]


Comparison


operator==()

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

Description

Compares two monthly by date repeat objects for equality.

Parameters

const TAgnMonthlyByDatesRpt& aRpt

The object to be compared.

Return value

TBool

True if all repeat details agree, otherwise False.

[Top]


Stream persistence


ExternalizeL()

virtual void ExternalizeL(RWriteStream& aStream) const;

Description

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

Parameters

RWriteStream& aStream

Stream to which the object should be externalised.


InternalizeL()

virtual void InternalizeL(RReadStream& aStream);

Description

Internalises the monthly by date repeat object from a read stream.

Parameters

RReadStream& aStream

Stream from which the object should be internalised.