Collapse all Symbian^3 Product Developer Library

CTzUserNames Class Reference

class CTzUserNames : public CBase

The CTzUserNames class is used to encapsulate the names for a user-defined time zone.

When creating an instance of this class the client can specify the following names:

Long standard time name, for example "Mountain Standard Time"
Short standard time name, for example "MST"
Long daylight saving time name, for example "Mountain Daylight Time"
Short daylight saving time name, for example "MDT"
City name, for example "Shiprock"
Region name, for example "America"

The client can also read these names.

Inherits from

CTzUserNames
- CBase

Public Member Functions
	~CTzUserNames()
IMPORT_C const TDesC &	CityName()
IMPORT_C const TDesC &	DaylightSaveName()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C CTzUserNames *	NewL(const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)
IMPORT_C CTzUserNames *	NewL(RReadStream &)
IMPORT_C CTzUserNames *	NewLC(const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)
IMPORT_C const TDesC &	RegionName()
IMPORT_C const TDesC &	ShortDaylightSaveName()
IMPORT_C const TDesC &	ShortStandardName()
IMPORT_C TInt	SizeOfObject()
IMPORT_C const TDesC &	StandardName()

Private Member Functions
	CTzUserNames()
void	ConstructL(const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
HBufC *	iCityName
HBufC *	iDaylightName
HBufC *	iRegionName
HBufC *	iShortDaylightName
HBufC *	iShortStandardName
HBufC *	iStandardName

Constructor & Destructor Documentation

CTzUserNames()

CTzUserNames

(

)

[private]

~CTzUserNames()

IMPORT_C

~CTzUserNames

(

)

Destroys this CTzUserNames object.

Member Functions Documentation

CityName()

IMPORT_C const TDesC &

CityName

(

)

const

Returns the city name for this object.

ConstructL(const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)

void	ConstructL	(	const TDesC &	aStandardName,
			const TDesC &	aShortStandardName,
			const TDesC &	aDayLightSaveName,
			const TDesC &	aShortDayLightSaveName,
			const TDesC &	aCityName,
			const TDesC &	aRegionName
		)	[private]

Parameters

const TDesC & aStandardName
const TDesC & aShortStandardName
const TDesC & aDayLightSaveName
const TDesC & aShortDayLightSaveName
const TDesC & aCityName
const TDesC & aRegionName

DaylightSaveName()

IMPORT_C const TDesC &

DaylightSaveName

(

)

const

Returns the daylight saving time name for this object.

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises user-defined time zone names to the given stream.

Parameters

RWriteStream & aStream

Stream to which the object should be externalised.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalizes user-defined time zone names from the given read stream.

Parameters

RReadStream & aStream

Stream from which the object should be internalised.

NewL(const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)

IMPORT_C CTzUserNames *	NewL	(	const TDesC &	aStandardName,
			const TDesC &	aShortStandardName,
			const TDesC &	aDaylightSaveName,
			const TDesC &	aShortDaylightSaveName,
			const TDesC &	aCityName,
			const TDesC &	aRegionName
		)	[static]

Creates a user-defined time zone names object from the given names.

Parameters

const TDesC & aStandardName	The standard time name.
const TDesC & aShortStandardName	The short standard time name.
const TDesC & aDaylightSaveName	The daylight saving time name.
const TDesC & aShortDaylightSaveName	The short daylight saving time name.
const TDesC & aCityName	The city name.
const TDesC & aRegionName	The region name.

NewL(RReadStream &)

IMPORT_C CTzUserNames *

NewL

(

RReadStream &

aStream

)

[static]

Creates a new user-defined time zone names object from the given stream.

Parameters

RReadStream & aStream

Stream with the time zone rules to be used to create a CTzRules object.

NewLC(const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)

IMPORT_C CTzUserNames *	NewLC	(	const TDesC &	aStandardName,
			const TDesC &	aShortStandardName,
			const TDesC &	aDayLightSaveName,
			const TDesC &	aShortDaylightSaveName,
			const TDesC &	aCityName,
			const TDesC &	aRegionName
		)	[static]

Creates a user-defined time zone names object from the given names leaving the newly created object on the cleanup stack.

Parameters

const TDesC & aStandardName	The standard time name.
const TDesC & aShortStandardName	The short standard time name.
const TDesC & aDayLightSaveName	The daylight saving time name.
const TDesC & aShortDaylightSaveName	The short daylight saving time name.
const TDesC & aCityName	The city name.
const TDesC & aRegionName	The region name.

RegionName()

IMPORT_C const TDesC &

RegionName

(

)

const

Returns the region name for this object.

ShortDaylightSaveName()

IMPORT_C const TDesC &

ShortDaylightSaveName

(

)

const

Returns the short daylight saving time name for this object.

ShortStandardName()

IMPORT_C const TDesC &

ShortStandardName

(

)

const

Returns the short standard time name for this object.

SizeOfObject()

IMPORT_C TInt

SizeOfObject

(

)

const

Determines the size of this object.

StandardName()

IMPORT_C const TDesC &

StandardName

(

)

const

Returns the standard time name for this object.

Member Data Documentation

HBufC * iCityName

HBufC *

iCityName

[private]

HBufC * iDaylightName

HBufC *

iDaylightName

[private]

HBufC * iRegionName

HBufC *

iRegionName

[private]

HBufC * iShortDaylightName

HBufC *

iShortDaylightName

[private]

HBufC * iShortStandardName

HBufC *

iShortStandardName

[private]

HBufC * iStandardName

HBufC *

iStandardName

[private]