mirror of
https://github.com/libretro/scummvm.git
synced 2025-01-05 17:20:30 +00:00
ec24687ce4
Adding @defgroup and @ingroup doxygen tags into all headers in the common folder that contain doxygen blocks. This improves the structure, readability, and findability of information in the resulting output. This commit targets purely structure and does not deal with the content of the currently existing doxygen documentation.
111 lines
2.5 KiB
C++
111 lines
2.5 KiB
C++
/* ScummVM - Graphic Adventure Engine
|
|
*
|
|
* ScummVM is the legal property of its developers, whose names
|
|
* are too numerous to list here. Please refer to the COPYRIGHT
|
|
* file distributed with this source distribution.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef COMMON_LANGUAGE_H
|
|
#define COMMON_LANGUAGE_H
|
|
|
|
#include "common/scummsys.h"
|
|
|
|
namespace Common {
|
|
|
|
/**
|
|
* @defgroup common_language Language
|
|
* @ingroup common
|
|
*
|
|
* @brief API for managing game language.
|
|
*
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
class String;
|
|
|
|
/**
|
|
* List of game language.
|
|
*/
|
|
enum Language {
|
|
ZH_ANY, // Generic Chinese (when only one game version exist)
|
|
ZH_CNA,
|
|
ZH_TWN,
|
|
HR_HRV,
|
|
CZ_CZE,
|
|
DA_DAN,
|
|
NL_NLD,
|
|
EN_ANY, // Generic English (when only one game version exist)
|
|
EN_GRB,
|
|
EN_USA,
|
|
ET_EST,
|
|
FI_FIN,
|
|
FR_FRA,
|
|
DE_DEU,
|
|
GR_GRE,
|
|
HE_ISR,
|
|
HU_HUN,
|
|
IT_ITA,
|
|
JA_JPN,
|
|
KO_KOR,
|
|
LV_LAT,
|
|
NB_NOR,
|
|
FA_IRN,
|
|
PL_POL,
|
|
PT_BRA,
|
|
PT_POR,
|
|
RU_RUS,
|
|
SK_SVK,
|
|
ES_ESP,
|
|
SE_SWE,
|
|
TR_TUR,
|
|
UA_UKR,
|
|
SR_SER,
|
|
|
|
UNK_LANG = -1 // Use default language (i.e. none specified)
|
|
};
|
|
|
|
struct LanguageDescription {
|
|
const char *code;
|
|
const char *unixLocale;
|
|
const char *description;
|
|
Language id;
|
|
};
|
|
|
|
extern const LanguageDescription g_languages[];
|
|
|
|
|
|
/** Convert a string containing a language name into a Language enum value. */
|
|
extern Language parseLanguage(const String &str);
|
|
extern Language parseLanguageFromLocale(const char *locale);
|
|
extern const char *getLanguageCode(Language id);
|
|
extern const char *getLanguageLocale(Language id);
|
|
extern const char *getLanguageDescription(Language id);
|
|
|
|
// TODO: Document this GUIO related function
|
|
const String getGameGUIOptionsDescriptionLanguage(Common::Language lang);
|
|
|
|
// TODO: Document this GUIO related function
|
|
bool checkGameGUIOptionLanguage(Common::Language lang, const String &str);
|
|
|
|
/** @} */
|
|
|
|
} // End of namespace Common
|
|
|
|
#endif
|