epoc32/include/calcategorymanager.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #ifndef __CALCATEGORYMANAGER_H__
    17 #define __CALCATEGORYMANAGER_H__
    18 
    19 #include <e32base.h>
    20 
    21 class MCalProgressCallBack;
    22 class CCalCategory;
    23 class CCalEntry;
    24 class CCalCategoryManagerImpl;
    25 class CCalSession;
    26 
    27 /** A category manager used to manipulate the categories held by the Calendar store. 
    28 
    29 There are 12 built-in category types which are specified by CCalCategory::TCalCategoryType. 
    30 In addition, clients can create as many of their own categories as they like by giving a name to the category.
    31 This class is used along with the class CCalCategory to manipulate the categories in the file, for instance to 
    32 add, delete and get a list of entries filtered by their category. 
    33 
    34 @publishedAll
    35 @released
    36 */
    37 NONSHARABLE_CLASS(CCalCategoryManager) : public CBase
    38     {
    39 public:
    40 
    41 	IMPORT_C static CCalCategoryManager* NewL(CCalSession& aSession);
    42 	IMPORT_C ~CCalCategoryManager();
    43 
    44 	IMPORT_C TInt CategoryCountL() const;
    45 	IMPORT_C CCalCategory* CategoryL(TInt aIndex) const;
    46 	IMPORT_C void AddCategoryL(const CCalCategory& aCategory);
    47 	IMPORT_C void FilterCategoryL(const CCalCategory& aCategory, RPointerArray<CCalEntry>& aEntries, MCalProgressCallBack& aProgressCallBack);
    48 	IMPORT_C void FilterCategoryL(const CCalCategory& aCategory, RPointerArray<CCalEntry>& aEntries);
    49 	IMPORT_C void DeleteCategoryL(const CCalCategory& aCategory, MCalProgressCallBack& aProgressCallBack);
    50 	
    51 private:
    52 	CCalCategoryManager();
    53 	void ConstructL(CCalSession& aSession);
    54 
    55 private:
    56 	CCalCategoryManagerImpl* iCCalCategoryManagerImpl;
    57 	};
    58 	
    59 #endif // __CALCATEGORYMANAGER_H__