orxLocale.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008- Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */


 
 
#ifndef __orxLOCALE_H_
#define __orxLOCALE_H_
 
 
#include "orxInclude.h"
 

typedef enum __orxLOCALE_EVENT_t
{
  orxLOCALE_EVENT_SELECT_LANGUAGE = 0,                    
  orxLOCALE_EVENT_SET_STRING,                             
 
  orxLOCALE_EVENT_NUMBER,
 
  orxLOCALE_EVENT_NONE = orxENUM_NONE
 
} orxLOCALE_EVENT;

typedef struct __orxLOCALE_EVENT_PAYLOAD_t
{
  const orxSTRING zLanguage;                              
  const orxSTRING zGroup;                                 
  const orxSTRING zStringKey;                             
  const orxSTRING zStringValue;                           
 
} orxLOCALE_EVENT_PAYLOAD;

typedef orxBOOL (orxFASTCALL *orxLOCALE_KEY_FUNCTION)(const orxSTRING _zKey, const orxSTRING _zGroup, void *_pContext);
 

extern orxDLLAPI void orxFASTCALL                         orxLocale_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxLocale_Init();

extern orxDLLAPI void orxFASTCALL                         orxLocale_Exit();
 

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxLocale_SelectLanguage(const orxSTRING _zLanguage, const orxSTRING _zGroup);

extern orxDLLAPI const orxSTRING orxFASTCALL              orxLocale_GetCurrentLanguage(const orxSTRING _zGroup);

extern orxDLLAPI orxBOOL orxFASTCALL                      orxLocale_HasLanguage(const orxSTRING _zLanguage);

extern orxDLLAPI orxU32 orxFASTCALL                       orxLocale_GetLanguageCount();

extern orxDLLAPI const orxSTRING orxFASTCALL              orxLocale_GetLanguage(orxU32 _u32LanguageIndex);
 

extern orxDLLAPI orxBOOL orxFASTCALL                      orxLocale_HasString(const orxSTRING _zKey, const orxSTRING _zGroup);

extern orxDLLAPI const orxSTRING orxFASTCALL              orxLocale_GetString(const orxSTRING _zKey, const orxSTRING _zGroup);

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxLocale_SetString(const orxSTRING _zKey, const orxSTRING _zValue, const orxSTRING _zGroup);

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxLocale_ForAllKeys(const orxLOCALE_KEY_FUNCTION _pfnKeyCallback, const orxSTRING _zGroup, void *_pContext);
 
#endif /*__orxLOCALE_H_*/