epoc32/include/app/calentry.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:
    16 #ifndef __CALENTRY_H__
    16 #ifndef __CALENTRY_H__
    17 #define __CALENTRY_H__
    17 #define __CALENTRY_H__
    18 
    18 
    19 #include <calcommon.h>
    19 #include <calcommon.h>
    20 
    20 
       
    21 /** Minimum latitude in degrees.
       
    22 @see CCalGeoValue::SetLatLongL
       
    23 @publishedAll
       
    24 @released
       
    25 */
    21 const TReal KCalGEOMinLatitude = -90;
    26 const TReal KCalGEOMinLatitude = -90;
       
    27 
       
    28 /** Maximum latitude in degrees.
       
    29 @see CCalGeoValue::SetLatLongL
       
    30 @publishedAll
       
    31 @released
       
    32 */
    22 const TReal KCalGEOMaxLatitude  = 90;
    33 const TReal KCalGEOMaxLatitude  = 90;
       
    34 
       
    35 /** Minimum longitude in degrees.
       
    36 @see CCalGeoValue::SetLatLongL
       
    37 @publishedAll
       
    38 @released
       
    39 */
    23 const TReal KCalGEOMinLongitude = -180;
    40 const TReal KCalGEOMinLongitude = -180;
       
    41 
       
    42 /** Maximum longitude in degrees.
       
    43 @see CCalGeoValue::SetLatLongL
       
    44 @publishedAll
       
    45 @released
       
    46 */
    24 const TReal KCalGEOMaxLongitude  = 180;
    47 const TReal KCalGEOMaxLongitude  = 180;
    25 
    48 
       
    49 /** Maximum number of decimal places for longitude and latitude values.
       
    50 The position specified to CCalGeoValue::SetLatLongL will be truncated 
       
    51 to KGEOMaxDecimalPoint decimal places
       
    52 @see CCalGeoValue::SetLatLongL
       
    53 @publishedAll
       
    54 @released
       
    55 */
    26 const TUint KCalGEOMaxDecimalPlaces = 6;
    56 const TUint KCalGEOMaxDecimalPlaces = 6;
    27 
    57 
    28 class CCalAlarm;
    58 class CCalAlarm;
    29 class CCalAttachment;
    59 class CCalAttachment;
    30 class CCalAttendee;
    60 class CCalAttendee;
   162 	/** The busy status of an entry and corresponds to the TRANSP property in the iCalendar (RFC 2445) and vCalendar specifications.
   192 	/** The busy status of an entry and corresponds to the TRANSP property in the iCalendar (RFC 2445) and vCalendar specifications.
   163 	In the vCalendar specification, the TRANSP property can be any positive integer value. 0 is opaque and blocks time, 1 
   193 	In the vCalendar specification, the TRANSP property can be any positive integer value. 0 is opaque and blocks time, 1 
   164 	is transparent and doesn't block time. Any higher values have an implementation-specific meaning.
   194 	is transparent and doesn't block time. Any higher values have an implementation-specific meaning.
   165 	In the iCalendar specification (RFC 2445), the TRANSP property can be either OPAQUE (blocks time) or TRANSPARENT (doesn't block time).
   195 	In the iCalendar specification (RFC 2445), the TRANSP property can be either OPAQUE (blocks time) or TRANSPARENT (doesn't block time).
   166 	@publishedPartner
   196 	@publishedPartner
   167 	@prototype
   197 	@released
   168 	*/
   198 	*/
   169 	enum TTransp
   199 	enum TTransp
   170 		{
   200 		{
   171 		/** The entry blocks time. */
   201 		/** The entry blocks time. */
   172 		ETranspBusy,
   202 		ETranspBusy,
   281 
   311 
   282 	IMPORT_C CCalGeoValue* GeoValueL() const;
   312 	IMPORT_C CCalGeoValue* GeoValueL() const;
   283 	IMPORT_C void SetGeoValueL(const CCalGeoValue& aGeoValue);
   313 	IMPORT_C void SetGeoValueL(const CCalGeoValue& aGeoValue);
   284 	IMPORT_C void ClearGeoValueL();
   314 	IMPORT_C void ClearGeoValueL();
   285 
   315 
   286 	// Internal APIs (Used by Java)
       
   287 	IMPORT_C TCalTime NextInstanceForLocalUIDL(const TCalTime& aTime) const;
   316 	IMPORT_C TCalTime NextInstanceForLocalUIDL(const TCalTime& aTime) const;
   288 	IMPORT_C TCalTime PreviousInstanceForLocalUIDL(const TCalTime& aTime) const;
   317 	IMPORT_C TCalTime PreviousInstanceForLocalUIDL(const TCalTime& aTime) const;
   289 	
   318 
   290 	IMPORT_C TCalTime FindRptUntilTimeL(TInt aCount);
   319 	IMPORT_C TCalTime FindRptUntilTimeL(TInt aCount);
   291 
   320     
   292 	
       
   293 public:
   321 public:
   294 	// Internal APIs
   322 	// Internal APIs
   295 	static CCalEntry* NewL(CCalEntryImpl* aImpl);
   323 	static CCalEntry* NewL(CCalEntryImpl* aImpl);
   296 	CCalEntryImpl* Impl() const;
   324 	CCalEntryImpl* Impl() const;
   297 	
   325 	TUint8 ShortFileIdL();
       
   326 
   298 private:
   327 private:
   299 	void ConstructL(TType aType, HBufC8* aUid, TMethod aMethod, TUint aSeqNum, const TCalTime& aRecurrenceId, CalCommon::TRecurrenceRange aRange);
   328 	void ConstructL(TType aType, HBufC8* aUid, TMethod aMethod, TUint aSeqNum, const TCalTime& aRecurrenceId, CalCommon::TRecurrenceRange aRange);
   300 	void ConstructL(TType aType, HBufC8* aUid, TMethod aMethod, TUint aSeqNum);
   329 	void ConstructL(TType aType, HBufC8* aUid, TMethod aMethod, TUint aSeqNum);
   301 	void ConstructL(CCalEntryImpl* aImpl);
   330 	void ConstructL(CCalEntryImpl* aImpl);
   302 
   331 
   327 	};
   356 	};
   328 
   357 
   329 
   358 
   330 /** Class representing the geographical location of a calendar entry.
   359 /** Class representing the geographical location of a calendar entry.
   331 This corresponds to the GEO property as defined in vCalendar / iCalendar (RFC 2445). It contains a latitude and a longitude.
   360 This corresponds to the GEO property as defined in vCalendar / iCalendar (RFC 2445). It contains a latitude and a longitude.
   332 @publishedPartner
   361 @publishedAll
   333 @prototype
   362 @released
   334 */
   363 */
   335 NONSHARABLE_CLASS(CCalGeoValue) : public CBase
   364 NONSHARABLE_CLASS(CCalGeoValue) : public CBase
   336 	{
   365 	{
   337 public:
   366 public:
   338 	IMPORT_C static CCalGeoValue* NewL();
   367 	IMPORT_C static CCalGeoValue* NewL();
   345 	TReal iLatitude;
   374 	TReal iLatitude;
   346 	TReal iLongitude;
   375 	TReal iLongitude;
   347 	};
   376 	};
   348 
   377 
   349 #endif // __CALENTRY_H__
   378 #endif // __CALENTRY_H__
       
   379