epoc32/include/app/calcommon.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
     1.1 --- a/epoc32/include/app/calcommon.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/app/calcommon.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,9 +1,9 @@
     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 +// under the terms of "Eclipse Public License v1.0"
     1.9  // which accompanies this distribution, and is available
    1.10 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12  //
    1.13  // Initial Contributors:
    1.14  // Nokia Corporation - initial contribution.
    1.15 @@ -40,11 +40,28 @@
    1.16  */
    1.17  typedef TInt64 TCalFileId;
    1.18  
    1.19 +/** Calendar Collection ID.
    1.20 +It identifies the same file as TCalFileId does
    1.21 +@publishedAll
    1.22 +@released
    1.23 +*/
    1.24 +typedef TUint8 TCalCollectionId;
    1.25 +
    1.26 +/** Calendar NULL file ID.
    1.27 +The file ID will be set to KNullFileId if the file is not opened.
    1.28 +@publishedAll
    1.29 +@released
    1.30 +*/
    1.31 +const TCalFileId KNullFileId = 0;
    1.32 +
    1.33  /** Utility class containing common calendar-related enums.
    1.34  
    1.35  @publishedAll
    1.36  @released
    1.37  */
    1.38 +
    1.39 +
    1.40 +
    1.41  class CalCommon
    1.42  	{
    1.43  public:
    1.44 @@ -226,5 +243,51 @@
    1.45  		/** The file is an old version that is not supported. */
    1.46  		EUnsupportedFileVersion
    1.47  		};
    1.48 +
    1.49 +	/** Class to implement a priority range. This is used to set a priority range when using
    1.50 +	CCalFindInstanceSettings.
    1.51 +	@publishedAll
    1.52 +	@prototype
    1.53 +	*/
    1.54 +	class TCalPriorityRange
    1.55 +		{
    1.56 +	public:
    1.57 +		IMPORT_C TCalPriorityRange();
    1.58 +		IMPORT_C TCalPriorityRange(TUint aHighestPriority, TUint aLowestPriority);
    1.59 +		
    1.60 +		IMPORT_C TUint LowestPriority() const;
    1.61 +		IMPORT_C TUint HighestPriority() const;
    1.62 +		
    1.63 +	private:
    1.64 +		TUint iHighestPriority;
    1.65 +		TUint iLowestPriority;
    1.66 +		};
    1.67 +	
    1.68 +	/** Enumeration to define the sort-able attributes that can be sorted on in the
    1.69 +	 * instance view 
    1.70 +	@publishedAll
    1.71 +	@prototype
    1.72 +	*/
    1.73 +	enum TCalSortAttribute
    1.74 +		{
    1.75 +		ESortAttrStartTime,
    1.76 +		ESortAttrEndTime,
    1.77 +		ESortAttrLastModified,
    1.78 +		ESortAttrPriority,
    1.79 +		ESortAttrType
    1.80 +		};
    1.81 +	
    1.82 +	/** Enumeration to define the sort directions that can be used in sort criteria, 
    1.83 +	@publishedAll
    1.84 +	@prototype
    1.85 +	*/
    1.86 +	enum TCalSortDirection
    1.87 +		{
    1.88 +		/** Sort by ascending order  */
    1.89 +		EAscendingOrder,
    1.90 +		/** Sort by descending order  */
    1.91 +		EDescendingOrder
    1.92 +		};
    1.93 +
    1.94  	};
    1.95  #endif // __CALCOMMON_H__