epoc32/include/app/calcategory.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/calcategory.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,96 @@
     1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// 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
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __CALCATEGORY_H__
    1.20 +#define __CALCATEGORY_H__
    1.21 +
    1.22 +#include <e32base.h>
    1.23 +
    1.24 +class CCalCategoryImpl;
    1.25 +
    1.26 +/** Calendar categories can be associated with a calendar entry.
    1.27 +
    1.28 +There are 12 built in category types defined by TCalCategoryType. Additionally,
    1.29 +it is possible to define extended category types which are held as a descriptor
    1.30 +of any length.
    1.31 +
    1.32 +Any number of categories can be specified for an entry. CCalEntry provides member 
    1.33 +functions for adding, deleting and fetching categories for an entry. 
    1.34 +
    1.35 +CCalCategoryManager functions enable the client to add\\delete\\fetch categories 
    1.36 +from a Calendar session and to get a list of entries filtered by their category. 
    1.37 +@publishedAll
    1.38 +@released
    1.39 +*/
    1.40 +NONSHARABLE_CLASS(CCalCategory) : public CBase
    1.41 +    {
    1.42 +public:
    1.43 +	/** Calendar category type.
    1.44 +	@publishedAll
    1.45 +	@released
    1.46 +	*/
    1.47 +	enum TCalCategoryType 
    1.48 +		{
    1.49 +		/** Appointment */
    1.50 +		ECalAppointment,
    1.51 +		/** Business */
    1.52 +		ECalBusiness,
    1.53 +		/** Education */
    1.54 +		ECalEducation,	
    1.55 +		/** Holiday */
    1.56 +		ECalHoliday,
    1.57 +		/** Meeting */
    1.58 +		ECalMeeting,
    1.59 +		/** All other types */
    1.60 +		ECalMiscellaneous, 
    1.61 +		/** Personal */
    1.62 +		ECalPersonal,
    1.63 +		/** Phone call */
    1.64 +		ECalPhoneCall,
    1.65 +		/** Sick day */
    1.66 +		ECalSickDay,
    1.67 +		/** Special occasion */
    1.68 +		ECalSpecialOccasion,
    1.69 +		/** Travel */
    1.70 +		ECalTravel,
    1.71 +		/** Vacation */
    1.72 +		ECalVacation,
    1.73 +		/** Extended */
    1.74 +		ECalExtended
    1.75 +		};
    1.76 +
    1.77 +public:
    1.78 +	IMPORT_C static CCalCategory* NewL(TCalCategoryType aCategory);
    1.79 +	IMPORT_C static CCalCategory* NewL(const TDesC& aExtendedName);
    1.80 +	IMPORT_C ~CCalCategory();
    1.81 +
    1.82 +	IMPORT_C TCalCategoryType Category() const;
    1.83 +	IMPORT_C const TDesC& ExtendedCategoryName() const;
    1.84 +	
    1.85 +public:	
    1.86 +	CCalCategoryImpl* Impl() const;
    1.87 +	static CCalCategory* NewL(CCalCategoryImpl* aImpl);
    1.88 +
    1.89 +private:
    1.90 +	CCalCategory();
    1.91 +	CCalCategory(CCalCategoryImpl* aImpl);
    1.92 +	void ConstructL(TCalCategoryType aCategory);
    1.93 +	void ConstructL(const TDesC& aExtendedName);
    1.94 +
    1.95 +private: // member data
    1.96 +	CCalCategoryImpl* iCalCategoryImpl;
    1.97 +	};
    1.98 +	
    1.99 +#endif // __CALCATEGORY_H__