epoc32/include/app/calcommon.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     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
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    38 @publishedAll
    38 @publishedAll
    39 @released
    39 @released
    40 */
    40 */
    41 typedef TInt64 TCalFileId;
    41 typedef TInt64 TCalFileId;
    42 
    42 
       
    43 /** Calendar Collection ID.
       
    44 It identifies the same file as TCalFileId does
       
    45 @publishedAll
       
    46 @released
       
    47 */
       
    48 typedef TUint8 TCalCollectionId;
       
    49 
       
    50 /** Calendar NULL file ID.
       
    51 The file ID will be set to KNullFileId if the file is not opened.
       
    52 @publishedAll
       
    53 @released
       
    54 */
       
    55 const TCalFileId KNullFileId = 0;
       
    56 
    43 /** Utility class containing common calendar-related enums.
    57 /** Utility class containing common calendar-related enums.
    44 
    58 
    45 @publishedAll
    59 @publishedAll
    46 @released
    60 @released
    47 */
    61 */
       
    62 
       
    63 
       
    64 
    48 class CalCommon
    65 class CalCommon
    49 	{
    66 	{
    50 public:
    67 public:
    51 
    68 
    52 	/** Entry filter used in the entry view and instance view, filter flags are defined by TCalViewFilterFlags
    69 	/** Entry filter used in the entry view and instance view, filter flags are defined by TCalViewFilterFlags
   224 		/** The file is an older version and will be converted when it is used. */
   241 		/** The file is an older version and will be converted when it is used. */
   225 		EFileNeedsConverting,
   242 		EFileNeedsConverting,
   226 		/** The file is an old version that is not supported. */
   243 		/** The file is an old version that is not supported. */
   227 		EUnsupportedFileVersion
   244 		EUnsupportedFileVersion
   228 		};
   245 		};
       
   246 
       
   247 	/** Class to implement a priority range. This is used to set a priority range when using
       
   248 	CCalFindInstanceSettings.
       
   249 	@publishedAll
       
   250 	@prototype
       
   251 	*/
       
   252 	class TCalPriorityRange
       
   253 		{
       
   254 	public:
       
   255 		IMPORT_C TCalPriorityRange();
       
   256 		IMPORT_C TCalPriorityRange(TUint aHighestPriority, TUint aLowestPriority);
       
   257 		
       
   258 		IMPORT_C TUint LowestPriority() const;
       
   259 		IMPORT_C TUint HighestPriority() const;
       
   260 		
       
   261 	private:
       
   262 		TUint iHighestPriority;
       
   263 		TUint iLowestPriority;
       
   264 		};
       
   265 	
       
   266 	/** Enumeration to define the sort-able attributes that can be sorted on in the
       
   267 	 * instance view 
       
   268 	@publishedAll
       
   269 	@prototype
       
   270 	*/
       
   271 	enum TCalSortAttribute
       
   272 		{
       
   273 		ESortAttrStartTime,
       
   274 		ESortAttrEndTime,
       
   275 		ESortAttrLastModified,
       
   276 		ESortAttrPriority,
       
   277 		ESortAttrType
       
   278 		};
       
   279 	
       
   280 	/** Enumeration to define the sort directions that can be used in sort criteria, 
       
   281 	@publishedAll
       
   282 	@prototype
       
   283 	*/
       
   284 	enum TCalSortDirection
       
   285 		{
       
   286 		/** Sort by ascending order  */
       
   287 		EAscendingOrder,
       
   288 		/** Sort by descending order  */
       
   289 		EDescendingOrder
       
   290 		};
       
   291 
   229 	};
   292 	};
   230 #endif // __CALCOMMON_H__
   293 #endif // __CALCOMMON_H__