Location:
QikEditCategoryObserver.h
class MQikEditCategoryObserver;
Description
Edit category dialog observer interface.
The edit category dialog calls these functions on its MQikEditCategoryObserver when categories are added, removed or changed. Applications using categories should implement this interface, and take the appropriate actions when called — it is up to the application to make sure that there are no inconsistencies between the category model and the categorised items after these methods have been called.
Members
Defined in MQikEditCategoryObserver:
DoAddCategoryL(), DoDeleteCategoryL(), DoMergeCategoriesL(), DoRenameCategoryL(), IsCategoryEmpty(), OkToAddCategory(), OkToDeleteCategory(), OkToMergeCategories(), OkToRenameCategory()
See also:
virtual TBool OkToAddCategory() const=0;
Description
Tests whether the user is allowed to add a category.
Return value
TBool
|
ETrue if the user is allowed to add a category, otherwise EFalse . |
|
virtual TBool DoAddCategoryL(TInt &aHandle)=0;
Description
Adds a new category. If a category already exists with the specified handle then change it.
Parameters
TInt &aHandle |
The handle of the category to be added. The handle is declared as a reference so it can be changed within this function if needed. |
|
Return value
TBool
|
ETrue if the operation was successful, otherwise EFalse . |
|
virtual TBool OkToRenameCategory(TInt aHandle, const TDesC &aNewName) const=0;
Description
Tests whether the user is allowed to rename a category.
Parameters
TInt aHandle |
The handle of the category to be renamed. |
const TDesC &aNewName |
The new name of the category. |
|
Return value
TBool
|
ETrue if the user is allowed to rename a category, otherwise EFalse . |
|
virtual TBool DoRenameCategoryL(TInt aHandle, const TDesC &aNewName)=0;
Description
Renames a category.
Parameters
TInt aHandle |
The handle of the category to be renamed. |
const TDesC &aNewName |
The new name for the category. |
|
Return value
TBool
|
ETrue if the renaming was successful, otherwise EFalse . |
|
virtual TBool OkToMergeCategories(TInt aSourceHandle, TInt aTargetHandle) const=0;
Description
Tests whether the user is allowed to merge two categories.
Parameters
TInt aSourceHandle |
The source category to be merged then deleted. |
TInt aTargetHandle |
The target category file to be merged. |
|
Return value
TBool
|
ETrue if the user is allowed to merge categories, otherwise EFalse . |
|
virtual TBool DoMergeCategoriesL(TInt aSourceHandle, TInt aTargetHandle)=0;
Description
Merge categories.
The application should move all items from the aSourceHandle category to the aTargetHandle category. The aSourceHandle category should then be deleted.
Parameters
TInt aSourceHandle |
The source category to be merged then deleted. |
TInt aTargetHandle |
The target category file to be merged. |
|
Return value
TBool
|
ETrue if the merge was successful, otherwise EFalse . |
|
virtual TBool OkToDeleteCategory(TInt aHandle) const=0;
Description
Tests whether the user is allowed to delete a category.
Parameters
TInt aHandle |
The handle of the category that the user wants to delete. |
|
Return value
TBool
|
ETrue if the user is allowed to delete a category, otherwise EFalse . |
|
virtual TBool DoDeleteCategoryL(TInt aHandle)=0;
Description
Deletes the specified category. The application should move all items in this category to the Unfiled category.
Parameters
TInt aHandle |
The handle of the category to be deleted. |
|
Return value
TBool
|
ETrue if the deletion was successful, otherwise EFalse . |
|
virtual TBool IsCategoryEmpty(TInt aHandle) const=0;
Description
Tests whether a category is empty. In other words, whether it has any items or not.
Parameters
TInt aHandle |
The handle of the category to be tested. |
|
Return value
TBool
|
ETrue if the category is empty, otherwise EFalse . |
|
![[Index]](../../../../_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../_stock/btn_next_wt.gif){kind=small}
![[Previous]](../../../../_stock/btn_prev.gif){kind=small}
![[Top]](../../../../_stock/btn_top.gif)
![[Next]](../../../../_stock/btn_next.gif){kind=small}