orx  stable
Portable Game Engine
orxLocale.h
Go to the documentation of this file.
1 /* Orx - Portable Game Engine
2  *
3  * Copyright (c) 2008-2017 Orx-Project
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  *
18  * 2. Altered source versions must be plainly marked as such, and must not be
19  * misrepresented as being the original software.
20  *
21  * 3. This notice may not be removed or altered from any source
22  * distribution.
23  */
24 
43 #ifndef __orxLOCALE_H_
44 #define __orxLOCALE_H_
45 
46 
47 #include "orxInclude.h"
48 
49 
52 typedef enum __orxLOCALE_EVENT_t
53 {
58 
59  orxLOCALE_EVENT_NONE = orxENUM_NONE
60 
62 
65 typedef struct __orxLOCALE_EVENT_PAYLOAD_t
66 {
67  const orxSTRING zLanguage;
68  const orxSTRING zStringKey;
69  const orxSTRING zStringValue;
72 
73 
76 extern orxDLLAPI void orxFASTCALL orxLocale_Setup();
77 
81 extern orxDLLAPI orxSTATUS orxFASTCALL orxLocale_Init();
82 
85 extern orxDLLAPI void orxFASTCALL orxLocale_Exit();
86 
87 
91 extern orxDLLAPI orxSTATUS orxFASTCALL orxLocale_SelectLanguage(const orxSTRING _zLanguage);
92 
96 extern orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetCurrentLanguage();
97 
102 extern orxDLLAPI orxBOOL orxFASTCALL orxLocale_HasLanguage(const orxSTRING _zLanguage);
103 
107 extern orxDLLAPI orxU32 orxFASTCALL orxLocale_GetLanguageCounter();
108 
113 extern orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetLanguage(orxU32 _u32LanguageIndex);
114 
115 
120 extern orxDLLAPI orxBOOL orxFASTCALL orxLocale_HasString(const orxSTRING _zKey);
121 
126 extern orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetString(const orxSTRING _zKey);
127 
133 extern orxDLLAPI orxSTATUS orxFASTCALL orxLocale_SetString(const orxSTRING _zKey, const orxSTRING _zValue);
134 
138 extern orxDLLAPI orxU32 orxFASTCALL orxLocale_GetKeyCounter();
139 
144 extern orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetKey(orxU32 _u32KeyIndex);
145 
146 #endif /*__orxLOCALE_H_*/
147 
orxDLLAPI orxBOOL orxFASTCALL orxLocale_HasLanguage(const orxSTRING _zLanguage)
orxDLLAPI void orxFASTCALL orxLocale_Setup()
orxDLLAPI orxSTATUS orxFASTCALL orxLocale_SelectLanguage(const orxSTRING _zLanguage)
orxDLLAPI orxBOOL orxFASTCALL orxLocale_HasString(const orxSTRING _zKey)
orxDLLAPI orxSTATUS orxFASTCALL orxLocale_Init()
orxDLLAPI void orxFASTCALL orxLocale_Exit()
orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetLanguage(orxU32 _u32LanguageIndex)
orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetString(const orxSTRING _zKey)
const orxSTRING zStringValue
Definition: orxLocale.h:69
const orxSTRING zLanguage
Definition: orxLocale.h:67
orxSTATUS
Definition: orxType.h:243
orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetKey(orxU32 _u32KeyIndex)
orxLOCALE_EVENT
Definition: orxLocale.h:52
orxDLLAPI orxU32 orxFASTCALL orxLocale_GetKeyCounter()
#define orxDLLAPI
Definition: orxDecl.h:387
const orxSTRING zStringKey
Definition: orxLocale.h:68
orxDLLAPI const orxSTRING orxFASTCALL orxLocale_GetCurrentLanguage()
orxDLLAPI orxSTATUS orxFASTCALL orxLocale_SetString(const orxSTRING _zKey, const orxSTRING _zValue)
orxDLLAPI orxU32 orxFASTCALL orxLocale_GetLanguageCounter()

Generated for orx by doxygen 1.5.6