epoc32/include/calcategory.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
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 __CALCATEGORY_H__
williamr@2
    17
#define __CALCATEGORY_H__
williamr@2
    18
williamr@2
    19
#include <e32base.h>
williamr@2
    20
williamr@2
    21
class CCalCategoryImpl;
williamr@2
    22
williamr@2
    23
/** Calendar categories can be associated with a calendar entry.
williamr@2
    24
williamr@2
    25
There are 12 built in category types defined by TCalCategoryType. Additionally,
williamr@2
    26
it is possible to define extended category types which are held as a descriptor
williamr@2
    27
of any length.
williamr@2
    28
williamr@2
    29
Any number of categories can be specified for an entry. CCalEntry provides member 
williamr@2
    30
functions for adding, deleting and fetching categories for an entry. 
williamr@2
    31
williamr@2
    32
CCalCategoryManager functions enable the client to add\\delete\\fetch categories 
williamr@2
    33
from a Calendar session and to get a list of entries filtered by their category. 
williamr@2
    34
@publishedAll
williamr@2
    35
@released
williamr@2
    36
*/
williamr@2
    37
NONSHARABLE_CLASS(CCalCategory) : public CBase
williamr@2
    38
    {
williamr@2
    39
public:
williamr@2
    40
	/** Calendar category type.
williamr@2
    41
	@publishedAll
williamr@2
    42
	@released
williamr@2
    43
	*/
williamr@2
    44
	enum TCalCategoryType 
williamr@2
    45
		{
williamr@2
    46
		/** Appointment */
williamr@2
    47
		ECalAppointment,
williamr@2
    48
		/** Business */
williamr@2
    49
		ECalBusiness,
williamr@2
    50
		/** Education */
williamr@2
    51
		ECalEducation,	
williamr@2
    52
		/** Holiday */
williamr@2
    53
		ECalHoliday,
williamr@2
    54
		/** Meeting */
williamr@2
    55
		ECalMeeting,
williamr@2
    56
		/** All other types */
williamr@2
    57
		ECalMiscellaneous, 
williamr@2
    58
		/** Personal */
williamr@2
    59
		ECalPersonal,
williamr@2
    60
		/** Phone call */
williamr@2
    61
		ECalPhoneCall,
williamr@2
    62
		/** Sick day */
williamr@2
    63
		ECalSickDay,
williamr@2
    64
		/** Special occasion */
williamr@2
    65
		ECalSpecialOccasion,
williamr@2
    66
		/** Travel */
williamr@2
    67
		ECalTravel,
williamr@2
    68
		/** Vacation */
williamr@2
    69
		ECalVacation,
williamr@2
    70
		/** Extended */
williamr@2
    71
		ECalExtended
williamr@2
    72
		};
williamr@2
    73
williamr@2
    74
public:
williamr@2
    75
	IMPORT_C static CCalCategory* NewL(TCalCategoryType aCategory);
williamr@2
    76
	IMPORT_C static CCalCategory* NewL(const TDesC& aExtendedName);
williamr@2
    77
	IMPORT_C ~CCalCategory();
williamr@2
    78
williamr@2
    79
	IMPORT_C TCalCategoryType Category() const;
williamr@2
    80
	IMPORT_C const TDesC& ExtendedCategoryName() const;
williamr@2
    81
	
williamr@2
    82
public:	
williamr@2
    83
	CCalCategoryImpl* Impl() const;
williamr@2
    84
	static CCalCategory* NewL(CCalCategoryImpl* aImpl);
williamr@2
    85
williamr@2
    86
private:
williamr@2
    87
	CCalCategory();
williamr@2
    88
	CCalCategory(CCalCategoryImpl* aImpl);
williamr@2
    89
	void ConstructL(TCalCategoryType aCategory);
williamr@2
    90
	void ConstructL(const TDesC& aExtendedName);
williamr@2
    91
williamr@2
    92
private: // member data
williamr@2
    93
	CCalCategoryImpl* iCalCategoryImpl;
williamr@2
    94
	};
williamr@2
    95
	
williamr@2
    96
#endif // __CALCATEGORY_H__