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