CalCommon Class Reference

#include <app/calcommon.h>

Link against: calendarservice.lib

class CalCommon

Nested Classes and Structures

Public Member Type Definitions
typedef	TUint TCalViewFilter

Public Member Enumerations
enum	TCalFileVersionSupport { EFileIsCurrentVersion, EFileNeedsConverting, EUnsupportedFileVersion }
enum	TCalSearchBehaviour { EFoldedTextSearch, EExactTextSearch, ESearchEntryLocation, ESearchEntryDescription, ..., ESearchAllTextFields }
enum	TCalSortAttribute { ESortAttrStartTime, ESortAttrEndTime, ESortAttrLastModified, ESortAttrPriority, ESortAttrType }
enum	TCalSortDirection { EAscendingOrder, EDescendingOrder }
enum	TCalViewFilterFlags { EIncludeAppts, EIncludeReminder, EIncludeEvents, EIncludeAnnivs, ..., EIncludeAll }
enum	TRecurrenceRange { EThisOnly, EThisAndAll, EThisAndFuture, EThisAndPrior }

Detailed Description

Utility class containing common calendar-related enums.

Member Type Definition Documentation

Typedef TCalViewFilter

typedef TUint

TCalViewFilter

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

Member Enumeration Documentation

Enum TCalFileVersionSupport

Enumeration returned when opening a file to indicate whether the file is the current version, needs converting, or is unsupported.

Enumerator	Value	Description
EFileIsCurrentVersion		The file is the current version and can be loaded immediately.
EFileNeedsConverting		The file is an older version and will be converted when it is used.
EUnsupportedFileVersion		The file is an old version that is not supported.

Enum TCalSearchBehaviour

Search filter for use in the CCalInstanceView::FindInstanceL() 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.

Enumerator	Value	Description
EFoldedTextSearch	0x0	Search for folded text.
EExactTextSearch	0x1	Search for the exact text.
ESearchEntryLocation	0x2	Search location during a text search.
ESearchEntryDescription	0x4	Search description during a text search.
ESearchAttendeeAddress	0x8	Search attendee addresses during a text search.
ESearchAttendeeSentByAddress	0x10	Search attendee sent by addresses during a text search.
ESearchAttendeeCommonName	0x20	Search attendee common names during a text search.
ESearchOrganizerAddress	0x40	Search organizer's address during a text search.
ESearchOrganizerSentByAddress	0x80	Search organizer's sent by address during a text search.
ESearchOrganizerCommonName	0x100	Search organizer's common name during a text search.
ESearchAllTextFields	ESearchEntryLocation\|ESearchEntryDescription\| ESearchAttendeeAddress\|ESearchAttendeeSentByAddress\|ESearchAttendeeCommonName\| ESearchOrganizerAddress\|ESearchOrganizerSentByAddress\|ESearchOrganizerCommonName	Include all possible text fields during a text search.

Enum TCalSortAttribute

Enumeration to define the sort-able attributes that can be sorted on in the instance view

Enumerator	Value	Description
ESortAttrStartTime
ESortAttrEndTime
ESortAttrLastModified
ESortAttrPriority
ESortAttrType

Enum TCalSortDirection

Enumeration to define the sort directions that can be used in sort criteria,

Enumerator	Value	Description
EAscendingOrder		Sort by ascending order
EDescendingOrder		Sort by descending order

Enum TCalViewFilterFlags

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

Enumerator	Value	Description
EIncludeAppts	0x01	Include appointments.
EIncludeReminder	0x02	Include reminders.
EIncludeEvents	0x04	Include all-day events.
EIncludeAnnivs	0x08	Include anniversaries.
EIncludeCompletedTodos	0x10	Include completed todos.
EIncludeIncompletedTodos	0x20	Include incompleted todos.
EIncludeAlarmedOnly	0x40	Remove non-alarmed entries. This flag cannot be used by itself.
EIncludeRptsNextInstanceOnly	0x80	Include next only instance of a repeat entry.
EInstanceStartTimeWithinRange	0x100	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	0x200	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.
EExcludeInstanceAdjoiningRange	0x400	By default all instances which adjoin the search range are found. Use the EExcludeInstanceAdjoiningRange flag to exclude instances that are outside, but adjoin the search range. Instances that are outside, but adjoin the search start or end time are excluded. Instances that both start and end on the search start time are included. Instances that both start and end on the search end time are excluded.
EIncludeAll	EIncludeAppts\|EIncludeReminder\|EIncludeEvents\|EIncludeAnnivs\| EIncludeCompletedTodos\|EIncludeIncompletedTodos	Include all entries (appointments, day events, reminders, anniversaries and todos).

Enum TRecurrenceRange

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

Enumerator	Value	Description
EThisOnly		Only this instance is referenced. If the user set EThisOnly when a repeating child entry is created and stored to the file, only the parent instance referred to by the child's recurrence ID will be replaced.
EThisAndAll		This and all other instances are referenced.
EThisAndFuture		This and all future instances are referenced.
EThisAndPrior		This and all previous instances are referenced.