Collapse all Symbian^3 Application Developer Library

TCalRRule Class Reference

class TCalRRule

Class representing iCal repeat types.

This supports the following standard iCal properties:

FREQ (rule type),
DTSTART (start date),
UNTIL (end date),
COUNT (number of instances),
INTERVAL (interval between instances),
BYDAY,
BYMONTHDAY,
BYYEARDAY,
WKST (start day of week).

Note that the repeat rule type (FREQ) must be set before any of the following properties can be set, since their behaviour is dependent on the rule type: BYDAY, BYMONTHDAY, BYYEARDAY

The WKST parameter is only significant in weekly repeat rules with an interval of greater than 1.

The repeat rule type may not be changed once it has been set.

If the start date of the entry does not match an instance of its repeat rule then the entry's start date will be moved forward to the first matching instance. For example, if the rule repeats every Wednesday but the start date of the entry is Monday, then the start date will be changed to the Wednesday.

Nested Classes and Structures

TCalRRule::TDayOfMonth

Public Member Functions
	TCalRRule ()
	TCalRRule ( TType )
IMPORT_C TUint	Count ()
IMPORT_C TCalTime	DtStart ()
IMPORT_C void	GetByDayL ( RArray < TDay > &)
IMPORT_C void	GetByDayL ( RArray < TDayOfMonth > &)
IMPORT_C void	GetByMonthDayL ( RArray < TInt > &)
IMPORT_C void	GetByMonthL ( RArray < TMonth > &)
IMPORT_C TInt	Interval ()
IMPORT_C void	SetByDay (const RArray < TDay > &)
IMPORT_C void	SetByDay (const RArray < TDayOfMonth > &)
IMPORT_C void	SetByMonth (const RArray < TMonth >)
IMPORT_C void	SetByMonthDay (const RArray < TInt > &)
IMPORT_C void	SetCount ( TUint )
IMPORT_C void	SetDtStart (const TCalTime &)
IMPORT_C void	SetInterval ( TInt )
IMPORT_C void	SetType ( TType )
IMPORT_C void	SetUntil (const TCalTime &)
void	SetUntilAndCount (const TCalTime &, TUint )
IMPORT_C void	SetWkSt ( TDay )
IMPORT_C TType	Type ()
IMPORT_C TCalTime	Until ()
IMPORT_C TDay	WkSt ()

Private Member Functions
TBool	GetNthBit ( TUint )
void	InitialiseData ()
TUint	MapToBitsWeekdays ( TDay )
void	SetNthBit ( TUint )

Public Member Enumerations
enum	TType { EInvalid = 0, EDaily , EWeekly , EMonthly , EYearly }

Private Attributes
TUint64	iBuffer
TInt	iCount
TCalTime	iDtStart
TUint8	iInterval
TInt32	iReserved
TInt32	iReserved2
TType	iType
TCalTime	iUntil
TDay	iWkSt

Constructor & Destructor Documentation

TCalRRule()

IMPORT_C

TCalRRule

(

)

TCalRRule(TType)

IMPORT_C

TCalRRule

(

TType

aType

)

Parameters

TType aType

Member Functions Documentation

Count()

IMPORT_C TUint

Count

(

)

const

DtStart()

IMPORT_C TCalTime

DtStart

(

)

const

GetByDayL(RArray< TDay > &)

IMPORT_C void

GetByDayL

(

RArray < TDay > &

aDays

)

const

Parameters

RArray < TDay > & aDays

GetByDayL(RArray< TDayOfMonth > &)

IMPORT_C void

GetByDayL

(

RArray < TDayOfMonth > &

aDays

)

const

Parameters

RArray < TDayOfMonth > & aDays

GetByMonthDayL(RArray< TInt > &)

IMPORT_C void

GetByMonthDayL

(

RArray < TInt > &

aMonthDays

)

const

Parameters

RArray < TInt > & aMonthDays

GetByMonthL(RArray< TMonth > &)

IMPORT_C void

GetByMonthL

(

RArray < TMonth > &

aMonths

)

const

Parameters

RArray < TMonth > & aMonths

GetNthBit(TUint)

TBool

GetNthBit

(

TUint

aNum

)

const [private]

Parameters

TUint aNum

InitialiseData()

void

InitialiseData

(

)

[private]

Interval()

IMPORT_C TInt

Interval

(

)

const

MapToBitsWeekdays(TDay)

TUint

MapToBitsWeekdays

(

TDay

aDay

)

[private]

Parameters

TDay aDay

SetByDay(const RArray< TDay > &)

IMPORT_C void

SetByDay

(

const RArray < TDay > &

aDays

)

Parameters

const RArray < TDay > & aDays

SetByDay(const RArray< TDayOfMonth > &)

IMPORT_C void

SetByDay

(

const RArray < TDayOfMonth > &

aDays

)

Parameters

const RArray < TDayOfMonth > & aDays

SetByMonth(const RArray< TMonth >)

IMPORT_C void

SetByMonth

(

const RArray < TMonth >

aMonths

)

Parameters

const RArray < TMonth > aMonths

SetByMonthDay(const RArray< TInt > &)

IMPORT_C void

SetByMonthDay

(

const RArray < TInt > &

aMonthDays

)

Parameters

const RArray < TInt > & aMonthDays

SetCount(TUint)

IMPORT_C void

SetCount

(

TUint

aCount

)

Parameters

TUint aCount

SetDtStart(const TCalTime &)

IMPORT_C void

SetDtStart

(

const TCalTime &

aTime

)

Parameters

const TCalTime & aTime

SetInterval(TInt)

IMPORT_C void

SetInterval

(

TInt

aInterval

)

Parameters

TInt aInterval

SetNthBit(TUint)

void

SetNthBit

(

TUint

aNum

)

[private]

Parameters

TUint aNum

SetType(TType)

IMPORT_C void

SetType

(

TType

aType

)

Parameters

TType aType

SetUntil(const TCalTime &)

IMPORT_C void

SetUntil

(

const TCalTime &

aTime

)

Parameters

const TCalTime & aTime

SetUntilAndCount(const TCalTime &, TUint)

void	SetUntilAndCount	(	const TCalTime &	aTime,
			TUint	aCount
		)

Parameters

const TCalTime & aTime
TUint aCount

SetWkSt(TDay)

IMPORT_C void

SetWkSt

(

TDay

aDay

)

Parameters

TDay aDay

Type()

IMPORT_C TType

Type

(

)

const

Until()

IMPORT_C TCalTime

Until

(

)

const

WkSt()

IMPORT_C TDay

WkSt

(

)

const

Member Enumerations Documentation

Enum TType

Types of repeat rule.

Enumerators

EInvalid = 0	The type has not yet been defined.
EDaily	Rule which repeats based on a number of days.
EWeekly	Rule which repeats based on a number of weeks.
EMonthly	Rule which repeats based on a number of months.
EYearly	Rule which repeats based on a number of years.