| class CAgnCategory : public CBase |
A category associated with an agenda entry.
The category's type is held as a TAgnCategoryType value. 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 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's category support functions enable you to find the categories used in a file and to get a list of entries filtered by their category.
These properties are identical to those accessible through the CCalCategory interface.
| Public Member Functions | |
|---|---|
| ~CAgnCategory() | |
| CCalCategory::TCalCategoryType | Category() |
| IMPORT_C const TDesC & | ExtendedCategoryName() |
| IMPORT_C void | ExternalizeL(RWriteStream &) |
| IMPORT_C void | InternalizeL(RReadStream &) |
| IMPORT_C CAgnCategory * | NewL(CCalCategory::TCalCategoryType) |
| IMPORT_C CAgnCategory * | NewL(const TDesC &) |
| IMPORT_C CAgnCategory * | NewL(RReadStream &) |
| IMPORT_C CAgnCategory * | NewL(const CAgnCategory &) |
| Private Member Functions | |
|---|---|
| CAgnCategory() | |
| void | ConstructL(CCalCategory::TCalCategoryType, const TDesC &) |
| void | CopyL(const CAgnCategory &) |
| CAgnCategory * | CreateCategoryL(CCalCategory::TCalCategoryType, const TDesC &) |
| Private Attributes | |
|---|---|
| CCalCategory::TCalCategoryType | iCategoryType |
| HBufC * | iExtendedCategoryName |
| CCalCategory::TCalCategoryType | Category | ( | ) | const [inline] |
Gets the category type.
The category type.
| void | ConstructL | ( | CCalCategory::TCalCategoryType | aCategory, |
| const TDesC & | aExtendedName | |||
| ) | [private] | |||
| CCalCategory::TCalCategoryType aCategory | |
| const TDesC & aExtendedName |
| void | CopyL | ( | const CAgnCategory & | aCategory | ) | [private] |
Makes a copy of a category.
| const CAgnCategory & aCategory | Pointer to the category to copy. |
| CAgnCategory * | CreateCategoryL | ( | CCalCategory::TCalCategoryType | aCategory, |
| const TDesC & | aExtendedName | |||
| ) | [private, static] | |||
| CCalCategory::TCalCategoryType aCategory | |
| const TDesC & aExtendedName |
| IMPORT_C const TDesC & | ExtendedCategoryName | ( | ) | const |
Gets the extended category name.
The extended category name if there is one, otherwise an empty descriptor.
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
| RWriteStream & aStream |
| IMPORT_C void | InternalizeL | ( | RReadStream & | aStream | ) |
| RReadStream & aStream |
| IMPORT_C CAgnCategory * | NewL | ( | CCalCategory::TCalCategoryType | aCategory | ) | [static] |
Allocates and constructs a category object of one of the standard types.
To create a category of user-defined type, use the other overload of NewL().
| CCalCategory::TCalCategoryType aCategory | The category type. |
| IMPORT_C CAgnCategory * | NewL | ( | const TDesC & | aExtendedName | ) | [static] |
Allocates and constructs a category object of user-defined type, with the specified category name.
To create a category of a standard type, use the other overload of NewL().
| const TDesC & aExtendedName | The extended category name. |
| IMPORT_C CAgnCategory * | NewL | ( | RReadStream & | aStream | ) | [static] |
| RReadStream & aStream |
| IMPORT_C CAgnCategory * | NewL | ( | const CAgnCategory & | aCategory | ) | [static] |
| const CAgnCategory & aCategory |