epoc32/include/mw/tzid.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
//
williamr@4
    15
williamr@4
    16
#ifndef __TZID_H__
williamr@4
    17
#define __TZID_H__
williamr@4
    18
williamr@4
    19
#include <e32base.h>
williamr@4
    20
#include <s32strm.h>
williamr@4
    21
williamr@4
    22
/**
williamr@4
    23
Represents an invalid time zone numeric identifier.
williamr@4
    24
williamr@4
    25
@internalTechnology
williamr@4
    26
*/
williamr@4
    27
const TUint KInvalidTzId = 0xffffffff;
williamr@4
    28
williamr@4
    29
/**
williamr@4
    30
Encapsulates a time zone identifier.
williamr@4
    31
williamr@4
    32
The identifier may be either a name or a number.
williamr@4
    33
williamr@4
    34
@publishedAll
williamr@4
    35
@released
williamr@4
    36
@since 9.1
williamr@4
    37
*/
williamr@4
    38
class CTzId : public CBase
williamr@4
    39
	{
williamr@4
    40
public:
williamr@4
    41
	IMPORT_C ~CTzId();
williamr@4
    42
	
williamr@4
    43
	/** 
williamr@4
    44
	This should not be used. For internal use only. 
williamr@4
    45
	*/
williamr@4
    46
	IMPORT_C CTzId* CloneL() const;
williamr@4
    47
	
williamr@4
    48
	IMPORT_C static CTzId* NewL(TUint aNumericId);
williamr@4
    49
	IMPORT_C static CTzId* NewL(const TDesC8& aNameIdentity);
williamr@4
    50
	
williamr@4
    51
	/** 
williamr@4
    52
	This should not be used. For internal use only.
williamr@4
    53
	*/
williamr@4
    54
	IMPORT_C static CTzId* NewL(RReadStream& aStream);
williamr@4
    55
	
williamr@4
    56
	/** 
williamr@4
    57
	This should not be used. For internal use only. 
williamr@4
    58
	*/
williamr@4
    59
	IMPORT_C void SetId(TUint aNumericId);
williamr@4
    60
	
williamr@4
    61
	/** 
williamr@4
    62
	This should not be used. For internal use only. 
williamr@4
    63
	*/
williamr@4
    64
	IMPORT_C void SetIdL(const TDesC8& aNameIdentity);
williamr@4
    65
	
williamr@4
    66
	/** 
williamr@4
    67
	This should not be used. For internal use only. 
williamr@4
    68
	*/
williamr@4
    69
	IMPORT_C void InternalizeL(RReadStream& aStream);
williamr@4
    70
	
williamr@4
    71
	/** 
williamr@4
    72
	This should not be used. For internal use only.
williamr@4
    73
	*/
williamr@4
    74
	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
williamr@4
    75
williamr@4
    76
	IMPORT_C const TDesC8& TimeZoneNameID() const;
williamr@4
    77
	IMPORT_C TUint TimeZoneNumericID() const;
williamr@4
    78
williamr@4
    79
	IMPORT_C TBool IsUserTzId() const;
williamr@4
    80
	IMPORT_C static TBool IsUserTzId(TUint aTzId);
williamr@4
    81
williamr@4
    82
	IMPORT_C TBool operator==(const CTzId& aTZId) const;
williamr@4
    83
	inline TBool operator!=(const CTzId& aTZId) const;
williamr@4
    84
williamr@4
    85
public:
williamr@4
    86
	void SetIdL(TUint aNumRefId, const TDesC8& aZoneIdentity);
williamr@4
    87
williamr@4
    88
private:
williamr@4
    89
	void ConstructL();
williamr@4
    90
	CTzId();
williamr@4
    91
	CTzId(TUint aNumericId);
williamr@4
    92
williamr@4
    93
private:
williamr@4
    94
	HBufC8* iZoneId;
williamr@4
    95
	TUint32 iReferenceId;
williamr@4
    96
	};
williamr@4
    97
williamr@4
    98
#include <tzid.inl>
williamr@4
    99
williamr@4
   100
#endif