epoc32/include/app/caltime.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/caltime.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
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 __CALTIME_H__
williamr@2
    17
#define __CALTIME_H__
williamr@2
    18
williamr@2
    19
#include <e32base.h>
williamr@2
    20
williamr@2
    21
/** Represents a date/time, as used in the Calendar API.
williamr@2
    22
williamr@2
    23
This stores a single TTime, which may be set in UTC or local or floating local 
williamr@2
    24
time, and can be retrieved in either UTC or system local time.
williamr@2
    25
williamr@2
    26
There are references to null time throughout the Interim API - this means Time::NullTTime().
williamr@2
    27
williamr@2
    28
@publishedAll
williamr@2
    29
@released
williamr@2
    30
*/
williamr@2
    31
NONSHARABLE_CLASS(TCalTime)
williamr@2
    32
	{
williamr@2
    33
public:
williamr@2
    34
williamr@2
    35
	/** The time mode for a calendar time
williamr@2
    36
	@publishedAll
williamr@2
    37
	@released
williamr@2
    38
	*/
williamr@2
    39
	enum TTimeMode
williamr@2
    40
		{
williamr@2
    41
		/** Floating time. */
williamr@2
    42
		EFloating,
williamr@2
    43
		/** Fixed time in UTC format. */
williamr@2
    44
		EFixedUtc,
williamr@2
    45
		/** Fixed time in local time with time zone reference format. */
williamr@2
    46
		EFixedTimeZone
williamr@2
    47
		};
williamr@2
    48
williamr@2
    49
public:
williamr@2
    50
	IMPORT_C TCalTime();
williamr@2
    51
	
williamr@2
    52
	IMPORT_C void SetTimeLocalFloatingL(const TTime& aLocalTime);
williamr@2
    53
	IMPORT_C void SetTimeUtcL(const TTime& aUtcTime);
williamr@2
    54
	IMPORT_C void SetTimeLocalL(const TTime& aLocalTime);
williamr@2
    55
	IMPORT_C TTimeMode TimeMode() const; 
williamr@2
    56
	IMPORT_C TTime TimeUtcL() const;
williamr@2
    57
	IMPORT_C TTime TimeLocalL() const;
williamr@2
    58
	
williamr@2
    59
	IMPORT_C static TTime MaxTime();
williamr@2
    60
	IMPORT_C static TTime MinTime();
williamr@2
    61
private:
williamr@2
    62
	TTime	iTime;
williamr@2
    63
	TUint8	iTimeMode;  
williamr@2
    64
	TInt8	iReserved1;
williamr@2
    65
	TInt16 	iReserved2;
williamr@2
    66
	};
williamr@2
    67
	
williamr@2
    68
#endif // __CALTIME_H__