CICalRuleSegment Class Reference

class CICalRuleSegment : public CBase

Class representing a recurrence rule value segment.

Inherits from

Constructor & Destructor Documentation

CICalRuleSegment()

CICalRuleSegment ( ) [private]

Constructor

~CICalRuleSegment()

~CICalRuleSegment ( )

Destructor

Member Functions Documentation

ConstructL(const TDesC &)

void ConstructL ( const TDesC & aSource ) [private]
Internal construction.
leave
Leaves with KErrInvalidRuleSegment if the rule segment has no "type".
leave
Leaves with KErrRuleSegmentHasNoValue if the rule segment has no value.
leave
Leaves if there is an error adding a value to this rule segment.

Parameters

const TDesC & aSource Descriptor containing details of the segment.

FreqL()

IMPORT_C TFreq FreqL ( ) const
Access method for the segment value as a frequency enumeration. Only the first value is used.
leave
Leaves with KErrRuleTypeNotFrequency if this rule segment does not contain a frequency.
leave
Leaves with KErrRuleFrequencyUnknown if the frequency cannot be determined.

NewL(const TDesC &)

CICalRuleSegment * NewL ( const TDesC & aSource ) [static]

Static factory construction. Not exported as this class is only provided as a utility for breaking down recurrence rules into segments - it is only ever created by the CICalValue class.

Parameters

const TDesC & aSource TDesC containing the rule segment information

NewLC(const TDesC &)

CICalRuleSegment * NewLC ( const TDesC & aSource ) [static]

Static factory construction. Not exported as this class is only provided as a utility for breaking down recurrence rules into segments - it is only ever created by the CICalValue class.

Parameters

const TDesC & aSource TDesC containing the rule segment information

SetTypeL(const TDesC &)

void SetTypeL ( const TDesC & aType ) [private]

Sets the type of a rule segment.

Parameters

const TDesC & aType The type as a descriptor.

Type()

IMPORT_C TSegmentType Type ( ) const

Access method for the segment type as an enumeration.

TypeName()

IMPORT_C const TDesC & TypeName ( ) const

Access method for the segment type as a descriptor.

Values()

IMPORT_C const RPointerArray < CICalValue > & Values ( ) const

Access method for the value array.

Member Enumerations Documentation

Enum TFreq

Enumerators

EFreqSecondly

Frequency in seconds.

EFreqMinutely

Frequency in minutes.

EFreqHourly

Frequency in hours.

EFreqDaily

Frequency in days.

EFreqWeekly

Frequency in weeks.

EFreqMonthly

Frequency in months.

EFreqYearly

Frequency in years.

Enum TSegmentType

Enumerators

ESegFreq

A frequency (FREQ) segment.

ESegUntil

An UNTIL segment.

ESegCount

A COUNT segment.

ESegInterval

An INTERVAL segment.

ESegBySecond

A BYSECOND segment.

ESegByMinute

A BYMINUTE segment.

ESegByHour

A BYHOUR segment.

ESegByDay

A BYDAY segment.

ESegByMonthDay

A BYMONTHDAY segment.

ESegByYearDay

A BYYEARDAY segment.

ESegByWeekNo

A BYWEEKNO segment.

ESegByMonth

A BYMONTH segment.

ESegByPos

A BYSETPOS segment.

ESegWkSt

A WKST segment.

ESegExtension

An X-name extension segment.

Member Data Documentation

TSegmentType iType

TSegmentType iType [private]

HBufC * iTypeString

HBufC * iTypeString [private]

RPointerArray< CICalValue > iValues

RPointerArray < CICalValue > iValues [private]