Class CAgnCategory

CAgnCategory

Support

Supported from 6.0

Description

A category associated with an agenda entry. The category's type is held as a TAgnCategoryType value (an enumerated type, see below). The set of possible categories is as defined in the vCalendar 1.0 standard, with the addition of an "Extended" category type.

The Extended category type allows for user-defined categories. An extended name is needed for an extended category. The name can be assigned a descriptor of any size.

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

Derivation

CAgnCategory A category associated with an agenda entry CBase Base class for all classes to be instantiated on the heap

Defined in CAgnCategory:
Category(), Copy(), EAppointment, EBusiness, EEducation, EExtended, EHoliday, EMeeting, EMiscellaneous, EPersonal, EPhoneCall, ESickDay, ESpecialOccasion, ETravel, EVacation, ExtendedCategoryName(), NewL(), TAgnCategoryType

Inherited from CBase:
operator new()

static CAgnCategory* NewL(TAgnCategoryType aCategory);

Description

Allocates and constructs a category object of the specified standard type. To create a category of user-defined type, use the other overload of NewL().

Parameters

TAgnCategoryType aCategory The category type.

static CAgnCategory* NewL(const TDesc& aExtendedName);

Description

Allocates and constructs a category object of user-defined type, with an extended name.

Parameters

const TDesc& aExtendedName The extended category name.

void Copy(CAgnCategory* aSource);

Description

Makes a copy of a category.

Parameters

CAgnCategory* aSource Pointer to the category to copy.

TAgnCategoryType Category() const;

Description

Gets the category type.

Return value

TAgnCategoryType The category type.

TPtrC ExtendedCategoryName() const;

Description

Gets the extended category name.

Return value

TPtrC The extended category name if there is one, otherwise an empty descriptor.

TAgnCategoryType

Description

Agenda category type

EAppointment Appointment EBusiness Business EEducation Education EHoliday Holiday EMeeting Meeting EMiscellaneous All other types EPersonal Personal EPhoneCall Phone call ESickDay Sick day ESpecialOccasion Special occasion ETravel Travel EVacation Vacation EExtended Extended