Class CCalCategory

class CCalCategory : public CBase;

Description

Calendar categories can be associated with a calendar entry.

There are 12 built in category types defined by TCalCategoryType. Additionally, it is possible to define extended category types which are held as a descriptor of any length.

Any number of categories can be specified for an entry. CCalEntry provides member functions for adding, deleting and fetching categories for an entry.

CCalCategoryManager functions enable the client to add\delete\fetch categories from a Calendar session and to get a list of entries filtered by their category.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CCalCategory - Calendar categories can be associated with a calendar entry.

Members

Defined in CCalCategory:

• Category()const
• Category()constGets the category type.
• ECalAppointmentAppointment
• ECalAppointmentAppointment
• ECalBusinessBusiness
• ECalBusinessBusiness
• ECalEducationEducation
• ECalEducationEducation
• ECalExtendedExtended
• ECalExtendedExtended
• ECalHolidayHoliday
• ECalHolidayHoliday
• ECalMeetingMeeting
• ECalMeetingMeeting
• ECalMiscellaneousAll other types
• ECalMiscellaneousAll other types
• ECalPersonalPersonal
• ECalPersonalPersonal
• ECalPhoneCallPhone call
• ECalPhoneCallPhone call
• ECalSickDaySick day
• ECalSickDaySick day
• ECalSpecialOccasionSpecial occasion
• ECalSpecialOccasionSpecial occasion
• ECalTravelTravel
• ECalTravelTravel
• ECalVacationVacation
• ECalVacationVacation
• ExtendedCategoryName()const
• ExtendedCategoryName()constGets the extended category name.
• NewL(TCalCategoryType)
• NewL(TCalCategoryType)Allocates and constructs a category object of one of the standard types.
• NewL(const TDesC &)
• NewL(const TDesC &)Allocates and constructs a category object of user-defined type with specified c...
• TCalCategoryTypeCalendar category type.
• TCalCategoryTypeCalendar category type.
• ~CCalCategory()
• ~CCalCategory()The destructor frees all resources owned by the category, prior to its destructi...

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Capability:

Illegal

IMPORT_C static CCalCategory* NewL(TCalCategoryType aCategory);

Description

Parameters

CCalCategory::TCalCategoryType aCategory

Return value

CCalCategory *

Capability:

Illegal

IMPORT_C static CCalCategory* NewL(TCalCategoryType aCategory);

Description

Allocates and constructs a category object of one of the standard types.

Parameters

CCalCategory::TCalCategoryType aCategory The category type.

Return value

CCalCategory * Pointer to newly created category object.

Capability:

Illegal

IMPORT_C static CCalCategory* NewL(const TDesC &aExtendedName);

Description

Parameters

const TDesC16 &aExtendedName

Return value

CCalCategory *

Capability:

Illegal

IMPORT_C ~CCalCategory();

Description

Capability:

Illegal

IMPORT_C static CCalCategory* NewL(const TDesC &aExtendedName);

Description

Allocates and constructs a category object of user-defined type with specified category name.

Parameters

const TDesC16 &aExtendedName The extended category name.

Return value

CCalCategory * Pointer to newly created category object.

Capability:

Illegal

IMPORT_C ~CCalCategory();

Description

The destructor frees all resources owned by the category, prior to its destruction.

Capability:

Illegal

IMPORT_C TCalCategoryType Category() const;

Description

Return value

CCalCategory::TCalCategoryType

Capability:

Illegal

IMPORT_C TCalCategoryType Category() const;

Description

Gets the category type.

Return value

CCalCategory::TCalCategoryType The category type.

Capability:

Illegal

IMPORT_C const TDesC& ExtendedCategoryName() const;

Description

Return value

const TDesC16 &

Capability:

Illegal

IMPORT_C const TDesC& ExtendedCategoryName() const;

Description

Gets the extended category name.

Return value

const TDesC16 & The extended category name if there is one, otherwise an empty descriptor.

TCalCategoryType

Description

Calendar category type.

ECalAppointment Appointment ECalBusiness Business ECalEducation Education ECalHoliday Holiday ECalMeeting Meeting ECalMiscellaneous All other types ECalPersonal Personal ECalPhoneCall Phone call ECalSickDay Sick day ECalSpecialOccasion Special occasion ECalTravel Travel ECalVacation Vacation ECalExtended Extended

TCalCategoryType

Description

Calendar category type.

ECalAppointment Appointment ECalBusiness Business ECalEducation Education ECalHoliday Holiday ECalMeeting Meeting ECalMiscellaneous All other types ECalPersonal Personal ECalPhoneCall Phone call ECalSickDay Sick day ECalSpecialOccasion Special occasion ECalTravel Travel ECalVacation Vacation ECalExtended Extended