locale.h File Reference

#include "sal/config.h"
#include "rtl/ustring.h"
#include "sal/saldllapi.h"

Go to the source code of this file.

Classes
struct	_rtl_Locale
	The implementation structure of a locale. More...

Typedefs
typedef struct _rtl_Locale	rtl_Locale
	The implementation structure of a locale. More...

Functions
SAL_DLLPUBLIC rtl_Locale *	rtl_locale_register (const sal_Unicode *language, const sal_Unicode *country, const sal_Unicode *variant)
	Register a locale from language, country and variant. More...
SAL_DLLPUBLIC rtl_Locale *	rtl_locale_getDefault (void)
	Common method of getting the current default Locale. More...
SAL_DLLPUBLIC void	rtl_locale_setDefault (const sal_Unicode *language, const sal_Unicode *country, const sal_Unicode *variant)
	Sets the default. More...
SAL_DLLPUBLIC rtl_uString *	rtl_locale_getLanguage (rtl_Locale *This)
	Getter for programmatic name of field, a lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code. More...
SAL_DLLPUBLIC rtl_uString *	rtl_locale_getCountry (rtl_Locale *This)
	Getter for programmatic name of field, an uppercased two-letter ISO-3166 code. More...
SAL_DLLPUBLIC rtl_uString *	rtl_locale_getVariant (rtl_Locale *This)
	Getter for programmatic name of field. More...
SAL_DLLPUBLIC sal_Int32	rtl_locale_hashCode (rtl_Locale *This)
	Returns the hash code of the locale This. More...
SAL_DLLPUBLIC sal_Int32	rtl_locale_equals (rtl_Locale *This, rtl_Locale *obj)
	Returns true if the locals are equal, otherwise false. More...

Typedef Documentation

typedef struct _rtl_Locale rtl_Locale

The implementation structure of a locale.

Do not create this structure direct. Only use the functions rtl_locale_register and rtl_locale_setDefault. The strings Language, Country and Variant are constants, so it is not necessary to acquire and release them.

Function Documentation

SAL_DLLPUBLIC sal_Int32 rtl_locale_equals	(	rtl_Locale *	This,
		rtl_Locale *	obj
	)

Returns true if the locals are equal, otherwise false.

SAL_DLLPUBLIC rtl_uString* rtl_locale_getCountry

(

rtl_Locale *

This

)

Getter for programmatic name of field, an uppercased two-letter ISO-3166 code.

See Also

getDisplayCountry

SAL_DLLPUBLIC rtl_Locale* rtl_locale_getDefault

(

void

)

Common method of getting the current default Locale.

Deprecated:

LibreOffice itself does not use this anymore, and client code should not have good use for it either. It may eventually be removed.

SAL_DLLPUBLIC rtl_uString* rtl_locale_getLanguage

(

rtl_Locale *

This

)

Getter for programmatic name of field, a lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code.

See Also

getDisplayLanguage

SAL_DLLPUBLIC rtl_uString* rtl_locale_getVariant

(

rtl_Locale *

This

)

Getter for programmatic name of field.

See Also

getDisplayVariant

SAL_DLLPUBLIC sal_Int32 rtl_locale_hashCode

(

rtl_Locale *

This

)

Returns the hash code of the locale This.

SAL_DLLPUBLIC rtl_Locale* rtl_locale_register	(	const sal_Unicode *	language,
		const sal_Unicode *	country,
		const sal_Unicode *	variant
	)

Register a locale from language, country and variant.

Parameters

language	lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code.
country	uppercase two-letter ISO-3166 code. May be null.
variant	vendor and browser specific code. May be null.

SAL_DLLPUBLIC void rtl_locale_setDefault	(	const sal_Unicode *	language,
		const sal_Unicode *	country,
		const sal_Unicode *	variant
	)

Sets the default.

setDefault does not reset the host locale.

Parameters

language	lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code.
country	uppercase two-letter ISO-3166 code.
variant	vendor and browser specific code. See class description.

Deprecated:

LibreOffice itself does not use this anymore, and client code should not have good use for it either. It may eventually be removed.