Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <calcommon.h>

Class CalCommon

class CalCommon;

Description

Utility class containing common calendar-related enums.

Members

Defined in CalCommon:


Member classes


Class TCalTimeRange

class TCalTimeRange;

Description

Class to implement a time range in the Instance view and Entry view.

Members

Defined in CalCommon::TCalTimeRange:

Construction and destruction


TCalTimeRange(TCalTime,TCalTime)

Capability: Illegal

IMPORT_C TCalTimeRange(TCalTime aStartTime, TCalTime aEndTime);

Description

Construct a CalCommon::TCalTimeRange.

Parameters

TCalTime aStartTime

Start time of time range

TCalTime aEndTime

End time of time range


TCalTimeRange(TCalTime,TCalTime)

Capability: Illegal

IMPORT_C TCalTimeRange(TCalTime aStartTime, TCalTime aEndTime);

Description

Parameters

TCalTime aStartTime

TCalTime aEndTime

Member functions


StartTime()const

Capability: Illegal

IMPORT_C TCalTime StartTime() const;

Description

Returns the start time of the range.

Return value

TCalTime

The start time of the range.


EndTime()const

Capability: Illegal

IMPORT_C TCalTime EndTime() const;

Description

Returns the end time of the range.

Return value

TCalTime

The end time of the range.


StartTime()const

Capability: Illegal

IMPORT_C TCalTime StartTime() const;

Description

Return value

TCalTime


EndTime()const

Capability: Illegal

IMPORT_C TCalTime EndTime() const;

Description

Return value

TCalTime

[Top]


Member enumerations


Enum TCalViewFilterFlags

TCalViewFilterFlags

Description

Entry filter flags used in the entry view and instance view.

EIncludeAppts

Include timed appointments.

EIncludeReminder

Include appointments which only have a start time.

EIncludeEvents

Include all-day events.

EIncludeAnnivs

Include anniversaries.

EIncludeCompletedTodos

Include completed todos.

EIncludeIncompletedTodos

Include incompleted todos.

EIncludeAlarmedOnly

Remove non-alarmed entries. This flag cannot be used by itself.

EIncludeRptsNextInstanceOnly

Include next only instance of a repeat entry.

EIncludeAll

Include all entries (appointments, day events, anniversaries and todos).


Enum TCalViewFilterFlags

TCalViewFilterFlags

Description

Entry filter flags used in the entry view and instance view.

EIncludeAppts

Include timed appointments.

EIncludeReminder

Include appointments which only have a start time.

EIncludeEvents

Include all-day events.

EIncludeAnnivs

Include anniversaries.

EIncludeCompletedTodos

Include completed todos.

EIncludeIncompletedTodos

Include incompleted todos.

EIncludeAlarmedOnly

Remove non-alarmed entries. This flag cannot be used by itself.

EIncludeRptsNextInstanceOnly

Include next only instance of a repeat entry.

EInstanceStartTimeWithinRange

By default all instances which overlap the time range are found. Use the EInstanceStartTimeWithinRange flag to only include instances whose start time is inside the search time range.

Note that setting both the EInstanceStartTimeWithinRange and EInstanceEndTimeWithinRange flags will only include instances which are completely within the search time range.

EInstanceEndTimeWithinRange

By default all instances which overlap the time range are found. Use the EInstanceEndTimeWithinRange flag to only include instances whose end time is inside the search time range.

Note that setting both the EInstanceStartTimeWithinRange and EInstanceEndTimeWithinRange flags will only include instances which are completely within the search time range.

EIncludeAll

Include all entries (appointments, day events, anniversaries and todos).


Enum TRecurrenceRange

TRecurrenceRange

Description

The range of instances referred to in a recurrence ID or instance view.

EThisOnly

Only this instance is referenced.

EThisAndAll

This and all other instances are referenced.

EThisAndFuture

This and all future instances are referenced.

EThisAndPrior

This and all previous instances are referenced.


Enum TCalSearchBehaviour

TCalSearchBehaviour

Description

Search filter for use in the CCalInstanceView::FindInstanceL(RPointerArray< CCalInstance > &,CalCommon::TCalViewFilter,const CalCommon::TCalTimeRange &)const function.

EFoldedTextSearch

Search for folded text.

EExactTextSearch

Search for the exact text.


Enum TRecurrenceRange

TRecurrenceRange

Description

The range of instances referred to in a recurrence ID or instance view.

EThisOnly

Only this instance is referenced.

EThisAndAll

This and all other instances are referenced.

EThisAndFuture

This and all future instances are referenced.

EThisAndPrior

This and all previous instances are referenced.


Enum TCalSearchBehaviour

TCalSearchBehaviour

Description

Search filter for use in the CCalInstanceView::FindInstanceL(RPointerArray< CCalInstance > &,CalCommon::TCalViewFilter,const CalCommon::TCalTimeRange &)const function. Note that a folded text search is used if exact text search is not specified. The summary text field is always searched. It is possible to specify additional text fields to be searched as well.

EFoldedTextSearch

Search for folded text.

EExactTextSearch

Search for the exact text.

ESearchAllTextFields

Include all possible text fields during a text search.

[Top]


Member type definitions


Typedef TCalViewFilter

typedef TUint CalCommon::TCalViewFilter;

Description

Entry filter used in the entry view and instance view, filter flags are defined by TCalViewFilterFlags


Typedef TCalViewFilter

typedef TUint CalCommon::TCalViewFilter;

Description

Entry filter used in the entry view and instance view, filter flags are defined by TCalViewFilterFlags