OrxLocale

Data Structures
struct	orxLOCALE_EVENT_PAYLOAD
Enumerations
enum	orxLOCALE_EVENT { orxLOCALE_EVENT_SELECT_LANGUAGE = 0, orxLOCALE_EVENT_SET_STRING, orxLOCALE_EVENT_NUMBER, orxLOCALE_EVENT_NONE = orxENUM_NONE }
Functions
orxDLLAPI void orxFASTCALL	orxLocale_Exit ()
orxDLLAPI const orxSTRING orxFASTCALL	orxLocale_GetCurrentLanguage ()
orxDLLAPI const orxSTRING orxFASTCALL	orxLocale_GetKey (orxS32 _s32KeyIndex)
orxDLLAPI orxS32 orxFASTCALL	orxLocale_GetKeyCounter ()
orxDLLAPI const orxSTRING orxFASTCALL	orxLocale_GetLanguage (orxS32 _s32LanguageIndex)
orxDLLAPI orxS32 orxFASTCALL	orxLocale_GetLanguageCounter ()
orxDLLAPI const orxSTRING orxFASTCALL	orxLocale_GetString (const orxSTRING _zKey)
orxDLLAPI orxBOOL orxFASTCALL	orxLocale_HasLanguage (const orxSTRING _zLanguage)
orxDLLAPI orxBOOL orxFASTCALL	orxLocale_HasString (const orxSTRING _zKey)
orxDLLAPI orxSTATUS orxFASTCALL	orxLocale_Init ()
orxDLLAPI orxSTATUS orxFASTCALL	orxLocale_SelectLanguage (const orxSTRING _zLanguage)
orxDLLAPI orxSTATUS orxFASTCALL	orxLocale_SetString (const orxSTRING _zKey, const orxSTRING _zValue)
orxDLLAPI void orxFASTCALL	orxLocale_Setup ()

---

Detailed Description

Localization module Module that handles localized strings

---

Enumeration Type Documentation

enum orxLOCALE_EVENT

Event enum

Enumerator:

orxLOCALE_EVENT_SELECT_LANGUAGE	Event sent when selecting a language
orxLOCALE_EVENT_SET_STRING	Event sent when setting a string
orxLOCALE_EVENT_NUMBER
orxLOCALE_EVENT_NONE

Definition at line 52 of file orxLocale.h.

---

Function Documentation

orxDLLAPI void orxFASTCALL orxLocale_Exit

(

)

Exits from the Locale Module

orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetCurrentLanguage

(

)

Gets current language

Returns:

Current selected language

orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetKey

(

orxS32

_s32KeyIndex )

Gets key for the current language at the given index

Parameters:

[in]

_s32KeyIndex

Index of the desired key

Returns:

orxSTRING if exist, orxNULL otherwise

orxDLLAPI orxS32 orxFASTCALL orxLocale_GetKeyCounter

(

)

Gets key counter for the current language

Returns:

Key counter the current language if valid, 0 otherwise

orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetLanguage

(

orxS32

_s32LanguageIndex )

Gets language at the given index

Parameters:

[in]

_s32LanguageIndex

Index of the desired language

Returns:

orxSTRING if exist, orxSTRING_EMPTY otherwise

orxDLLAPI orxS32 orxFASTCALL orxLocale_GetLanguageCounter

(

)

Gets language counter

Returns:

Number of languages defined

orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetString

(

const orxSTRING

_zKey )

Reads a string in the current language for the given key

Parameters:

[in]

_zKey

Key name

Returns:

The value

orxDLLAPI orxBOOL orxFASTCALL orxLocale_HasLanguage

(

const orxSTRING

_zLanguage )

Has given language? (if not correctly defined, false will be returned)

Parameters:

[in]

_zLanguage

Concerned language

Returns:

orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxLocale_HasString

(

const orxSTRING

_zKey )

Has string for the given key?

Parameters:

[in]

_zKey

Key name

Returns:

orxTRUE / orxFALSE

orxDLLAPI orxSTATUS orxFASTCALL orxLocale_Init

(

)

Initializes the Locale Module

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxLocale_SelectLanguage

(

const orxSTRING

_zLanguage )

Selects current working language

Parameters:

[in]

_zLanguage

Language to select

orxDLLAPI orxSTATUS orxFASTCALL orxLocale_SetString	(	const orxSTRING	_zKey,
		const orxSTRING	_zValue
	)

Writes a string in the current language for the given key

Parameters:

[in]	_zKey	Key name
[in]	_zValue	Value

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxLocale_Setup

(

)

Locale module setup