TExtendedLocale Class Reference

Extended locale class. More...

#include <e32std.h>

Public Member Functions
IMPORT_C	TExtendedLocale ()
	Default constructor.
IMPORT_C void	LoadSystemSettings ()
	Load system wide locale settings.
IMPORT_C TInt	SaveSystemSettings ()
	Make the current locale information system wide.
IMPORT_C TInt	LoadLocale (const TDesC &aLocaleDllName)
	Loads a locale Dll and get the locale information.
IMPORT_C TInt	LoadLocale (const TDesC &aLanguageLocaleDllName, const TDesC &aRegionLocaleDllName, const TDesC &aCollationLocaleDllName)
	Loads locale data from three locale dlls, which are language, region, and collation locale dlls.
IMPORT_C TInt	LoadLocaleAspect (TUint aAspectGroup, const TDesC &aLocaleDllName)
	Loads a DLL and get some locale information.
IMPORT_C TInt	LoadLocaleAspect (const TDesC &aLocaleDllName)
	Loads a DLL and get some locale information.
IMPORT_C TInt	SetCurrencySymbol (const TDesC &aSymbol)
	Sets the currency symbol.
IMPORT_C TInt	GetLocaleDllName (TLocaleAspect aLocaleDataSet, TDes &aDllName)
	Returns the name of the DLL containing the given bits of locale information.
IMPORT_C TCollationMethod	GetPreferredCollationMethod (TInt index=0)
	Get the preferred collation method for the preferred charset.
IMPORT_C TPtrC	GetCurrencySymbol ()
	Get the Currency Symbol from SLocaleLocaleSettings object.
IMPORT_C TPtrC	GetLongDateFormatSpec ()
	Get the Long Date Format from SLocaleTimeDateFormat object.
IMPORT_C TPtrC	GetShortDateFormatSpec ()
	Get the Short Date Format from SLocaleTimeDateFormat object.
IMPORT_C TPtrC	GetTimeFormatSpec ()
	Get the Time Format from SLocaleTimeDateFormat object.
TLocale *	GetLocale ()
	Get the pointer to the TLocale object contained in this extended locale.

Detailed Description

Extended locale class.

This class holds a collection of locale information. It contains a TLocale internally. It has methods to load a locale DLL and to set the system wide locale information.

API status

Published to all clients. Released API.

Definition at line 2556 of file e32std.h.

Constructor & Destructor Documentation

TExtendedLocale()

IMPORT_C TExtendedLocale::TExtendedLocale

(

)

Default constructor.

It constructs an empty object

This is an empty copy of TExtendedLocale. To get the system locale you can use TExtendedLocale::LoadSystemSettings. The current settings may be saved to the system with TLocale::SaveSystemSettings().

TExtendedLocale::LoadSystemSettings TExtendedLocale::SaveSystemSettings

(generated from Symbian Developer Library)

Member Function Documentation

GetCurrencySymbol()

IMPORT_C TPtrC TExtendedLocale::GetCurrencySymbol

(

)

Get the Currency Symbol from SLocaleLocaleSettings object.

(generated from Symbian Developer Library)

GetLocale()

TLocale * TExtendedLocale::GetLocale ( )

inline

Get the pointer to the TLocale object contained in this extended locale.

(generated from Symbian Developer Library)

GetLocaleDllName()

IMPORT_C TInt TExtendedLocale::GetLocaleDllName	(	TLocaleAspect	aLocaleDataSet,
		TDes &	aDllName
	)

Returns the name of the DLL containing the given bits of locale information.

Given the bits of locale information specified in aLocaleDataSet, it returns the name of the locale DLL storing the information. TExtendedLocale can contain information from different DLLs.

Parameters

aLocaleDataSet	The TLocaleAspect specifying a group of locale properties
aDllName	The descriptor that will contain the name of DLL containing the specifying bits of locale information (valid if the method is successful)

(generated from Symbian Developer Library)

GetLongDateFormatSpec()

IMPORT_C TPtrC TExtendedLocale::GetLongDateFormatSpec

(

)

Get the Long Date Format from SLocaleTimeDateFormat object.

(generated from Symbian Developer Library)

GetPreferredCollationMethod()

IMPORT_C TCollationMethod TExtendedLocale::GetPreferredCollationMethod

(

TInt

index = 0

)

Get the preferred collation method for the preferred charset.

Note that some charsets may contain more than one collation method (e.g "dictionary" v "phonebook" ordering) so an optional index parameter can be used to select between them.

Parameters

index

Optional parameter specifying the index of the collation method in the locale to get. This is the responsibility of the caller to make sure that the index is less than the total number of collation methods in the preferred charset in this locale.

Panic condition: USER 185 In both debug and release builds, if either the current charset is not set up or aIndex is greater than or equal to the total number of collation methods in the preferred charset in this locale.

(generated from Symbian Developer Library)

GetShortDateFormatSpec()

IMPORT_C TPtrC TExtendedLocale::GetShortDateFormatSpec

(

)

Get the Short Date Format from SLocaleTimeDateFormat object.

(generated from Symbian Developer Library)

GetTimeFormatSpec()

IMPORT_C TPtrC TExtendedLocale::GetTimeFormatSpec

(

)

Get the Time Format from SLocaleTimeDateFormat object.

(generated from Symbian Developer Library)

LoadLocale() [1/2]

IMPORT_C TInt TExtendedLocale::LoadLocale	(	const TDesC &	aLanguageLocaleDllName,
		const TDesC &	aRegionLocaleDllName,
		const TDesC &	aCollationLocaleDllName
	)

Loads locale data from three locale dlls, which are language, region, and collation locale dlls.

It loads three locale DLLs and it initialises the contents of this TExtendedLocale with the locale information stored in the DLLs. The locale information is only stored in this TExtendedLocale. If you want to set the system wide settings with the locale information in the DLL, you can call TExtendedLocale::SaveSystemSettings after calling this function.

TExtendedLocale::SaveSystemSettings

Parameters

aLanguageLocaleDllName	The name of the language locale DLL to be loaded
aRegionLocaleDllName	The name of the region locale DLL to be loaded
aCollationLocaleDllName	The name of the collation locale DLL to be loaded

(generated from Symbian Developer Library)

LoadLocale() [2/2]

IMPORT_C TInt TExtendedLocale::LoadLocale

(

const TDesC &

aLocaleDllName

)

Loads a locale Dll and get the locale information.

It loads a locale DLL and it initialises the contents of this TExtendedLocale with the locale information stored in the DLL. The locale information is only stored in this TExtendedLocale. If you want to set the system wide settings with the locale information in the DLL, you can call TExtendedLocale::SaveSystemSettings after calling this function.

TExtendedLocale::SaveSystemSettings

Parameters

aLocaleDllName

The name of the locale DLL to be loaded

(generated from Symbian Developer Library)

LoadLocaleAspect() [1/2]

IMPORT_C TInt TExtendedLocale::LoadLocaleAspect

(

const TDesC &

aLocaleDllName

)

Loads a DLL and get some locale information.

It loads the specified locale DLL, and it overwrites locale information in this TExtendedLocale with the locale information stored in the DLL. The locale information is only stored in this TExtendedLocale. If you want to set the system wide settings with the locale information in the DLL, you can call TExtendedLocale::SaveSystemSettings after calling this function.

TExtendedLocale::SaveSystemSettings

Parameters

aLocaleDllName

The name of the locale DLL to be loaded

(generated from Symbian Developer Library)

LoadLocaleAspect() [2/2]

IMPORT_C TInt TExtendedLocale::LoadLocaleAspect	(	TUint	aAspectGroup,
		const TDesC &	aLocaleDllName
	)

Loads a DLL and get some locale information.

It loads the specified locale DLL and depending on the aAspectGroup it overwrites locale information in this TExtendedLocale with the locale information stored in the DLL. aAspectGroup is a bitmap of TLocaleAspect values specifying what to be overwritten. The locale information is only stored in this TExtendedLocale. If you want to set the system wide settings with the locale information in the DLL, you can call TExtendedLocale::SaveSystemSettings after calling this function.

TLocaleAspect TExtendedLocale::SaveSystemSettings

Parameters

aAspectGroup	A bitmap of TLocaleAspect values specifying what to be overwritten in this TExtendedLocale. (eg.: ELocaleLanguageSettings | ELocaleTimeDateSettings)
aLocaleDllName	The name of the locale DLL to be loaded

(generated from Symbian Developer Library)

LoadSystemSettings()

IMPORT_C void TExtendedLocale::LoadSystemSettings

(

)

Load system wide locale settings.

It initialises this TExtendedLocale with the system wide locale settings. The settings stored in the TExtendedLocale are overwritten with the system wide locale.

TExtendedLocale::SaveSystemSettings

(generated from Symbian Developer Library)

SaveSystemSettings()

IMPORT_C TInt TExtendedLocale::SaveSystemSettings

(

)

Make the current locale information system wide.

It overwrites the system wide locale information with the locale information stored in this TExtendedLocale. This will generate a notification for system locale changes. In case of an error, the locale might be in an unconsistent state.

capability

WriteDeviceData

(generated from Symbian Developer Library)

SetCurrencySymbol()

IMPORT_C TInt TExtendedLocale::SetCurrencySymbol

(

const TDesC &

aSymbol

)

Sets the currency symbol.

It sets the currency symbol. The maximum lenght for the currency symbol is KMaxCurrencySymbol. Trying to pass a descriptor longer than that, will result in a panic.

Parameters

aSymbol

The new currency symbol

Panic condition: USER 119, if the length of aSymbol is greater than KMaxCurrencySymbol.

capability

WriteDeviceData

(generated from Symbian Developer Library)

---

The documentation for this class was generated from the following files:

• e32std.h
• e32std.h.dox