Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

revision of wxLocale; documented the list of language constants into the wxLanguage enum; modified genlang.py to generate a .h with doxygen comments and removed generation of a .tex script; moved docs for wxXlocale to the right header (xlocale.h)

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56411 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-17 20:27:36 +00:00
parent c82a80e81f
commit 969daeea66
5 changed files with 608 additions and 368 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/doxygen/mainpages/const_langcodes.h
View File

@@ -1,26 +0,0 @@
/////////////////////////////////////////////////////////////////////////////
// Name: const_langcodes.h
// Purpose: Language values enumerated
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@page page_languagecodes Language identifiers
The following wxLanguage constants may be used to specify the language
in wxLocale::Init and are returned by wxLocale::GetSystemLanguage:
<!-- generated code begins here -->
@todo ADAPT THE PYTHON SCRIPTS TO GENERATE HERE THE LIST
This enum is generated by misc/languages/genlang.py
When making changes, please put them into misc/languages/langtabl.txt
<!-- generated code ends here -->
*/

1
docs/doxygen/mainpages/constants.h
View File

@@ -15,7 +15,6 @@ This chapter describes the constants defined by wxWidgets.
@li @subpage page_keycodes @li @subpage page_keycodes
@li @subpage page_keymodifiers @li @subpage page_keymodifiers
@li @subpage page_languagecodes
@li @subpage page_stdevtid @li @subpage page_stdevtid
@li @subpage page_stockitems @li @subpage page_stockitems
@li @subpage page_cppconst @li @subpage page_cppconst

746
interface/wx/intl.h
View File

@@ -6,6 +6,289 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
// --- --- --- generated code begins here --- --- ---
/**
The languages supported by wxLocale.
This enum is generated by misc/languages/genlang.py
When making changes, please put them into misc/languages/langtabl.txt
*/
enum wxLanguage
{
/// User's default/preffered language as got from OS.
wxLANGUAGE_DEFAULT,
/// Unknown language, returned if wxLocale::GetSystemLanguage fails.
wxLANGUAGE_UNKNOWN,
wxLANGUAGE_ABKHAZIAN,
wxLANGUAGE_AFAR,
wxLANGUAGE_AFRIKAANS,
wxLANGUAGE_ALBANIAN,
wxLANGUAGE_AMHARIC,
wxLANGUAGE_ARABIC,
wxLANGUAGE_ARABIC_ALGERIA,
wxLANGUAGE_ARABIC_BAHRAIN,
wxLANGUAGE_ARABIC_EGYPT,
wxLANGUAGE_ARABIC_IRAQ,
wxLANGUAGE_ARABIC_JORDAN,
wxLANGUAGE_ARABIC_KUWAIT,
wxLANGUAGE_ARABIC_LEBANON,
wxLANGUAGE_ARABIC_LIBYA,
wxLANGUAGE_ARABIC_MOROCCO,
wxLANGUAGE_ARABIC_OMAN,
wxLANGUAGE_ARABIC_QATAR,
wxLANGUAGE_ARABIC_SAUDI_ARABIA,
wxLANGUAGE_ARABIC_SUDAN,
wxLANGUAGE_ARABIC_SYRIA,
wxLANGUAGE_ARABIC_TUNISIA,
wxLANGUAGE_ARABIC_UAE,
wxLANGUAGE_ARABIC_YEMEN,
wxLANGUAGE_ARMENIAN,
wxLANGUAGE_ASSAMESE,
wxLANGUAGE_AYMARA,
wxLANGUAGE_AZERI,
wxLANGUAGE_AZERI_CYRILLIC,
wxLANGUAGE_AZERI_LATIN,
wxLANGUAGE_BASHKIR,
wxLANGUAGE_BASQUE,
wxLANGUAGE_BELARUSIAN,
wxLANGUAGE_BENGALI,
wxLANGUAGE_BHUTANI,
wxLANGUAGE_BIHARI,
wxLANGUAGE_BISLAMA,
wxLANGUAGE_BRETON,
wxLANGUAGE_BULGARIAN,
wxLANGUAGE_BURMESE,
wxLANGUAGE_CAMBODIAN,
wxLANGUAGE_CATALAN,
wxLANGUAGE_CHINESE,
wxLANGUAGE_CHINESE_SIMPLIFIED,
wxLANGUAGE_CHINESE_TRADITIONAL,
wxLANGUAGE_CHINESE_HONGKONG,
wxLANGUAGE_CHINESE_MACAU,
wxLANGUAGE_CHINESE_SINGAPORE,
wxLANGUAGE_CHINESE_TAIWAN,
wxLANGUAGE_CORSICAN,
wxLANGUAGE_CROATIAN,
wxLANGUAGE_CZECH,
wxLANGUAGE_DANISH,
wxLANGUAGE_DUTCH,
wxLANGUAGE_DUTCH_BELGIAN,
wxLANGUAGE_ENGLISH,
wxLANGUAGE_ENGLISH_UK,
wxLANGUAGE_ENGLISH_US,
wxLANGUAGE_ENGLISH_AUSTRALIA,
wxLANGUAGE_ENGLISH_BELIZE,
wxLANGUAGE_ENGLISH_BOTSWANA,
wxLANGUAGE_ENGLISH_CANADA,
wxLANGUAGE_ENGLISH_CARIBBEAN,
wxLANGUAGE_ENGLISH_DENMARK,
wxLANGUAGE_ENGLISH_EIRE,
wxLANGUAGE_ENGLISH_JAMAICA,
wxLANGUAGE_ENGLISH_NEW_ZEALAND,
wxLANGUAGE_ENGLISH_PHILIPPINES,
wxLANGUAGE_ENGLISH_SOUTH_AFRICA,
wxLANGUAGE_ENGLISH_TRINIDAD,
wxLANGUAGE_ENGLISH_ZIMBABWE,
wxLANGUAGE_ESPERANTO,
wxLANGUAGE_ESTONIAN,
wxLANGUAGE_FAEROESE,
wxLANGUAGE_FARSI,
wxLANGUAGE_FIJI,
wxLANGUAGE_FINNISH,
wxLANGUAGE_FRENCH,
wxLANGUAGE_FRENCH_BELGIAN,
wxLANGUAGE_FRENCH_CANADIAN,
wxLANGUAGE_FRENCH_LUXEMBOURG,
wxLANGUAGE_FRENCH_MONACO,
wxLANGUAGE_FRENCH_SWISS,
wxLANGUAGE_FRISIAN,
wxLANGUAGE_GALICIAN,
wxLANGUAGE_GEORGIAN,
wxLANGUAGE_GERMAN,
wxLANGUAGE_GERMAN_AUSTRIAN,
wxLANGUAGE_GERMAN_BELGIUM,
wxLANGUAGE_GERMAN_LIECHTENSTEIN,
wxLANGUAGE_GERMAN_LUXEMBOURG,
wxLANGUAGE_GERMAN_SWISS,
wxLANGUAGE_GREEK,
wxLANGUAGE_GREENLANDIC,
wxLANGUAGE_GUARANI,
wxLANGUAGE_GUJARATI,
wxLANGUAGE_HAUSA,
wxLANGUAGE_HEBREW,
wxLANGUAGE_HINDI,
wxLANGUAGE_HUNGARIAN,
wxLANGUAGE_ICELANDIC,
wxLANGUAGE_INDONESIAN,
wxLANGUAGE_INTERLINGUA,
wxLANGUAGE_INTERLINGUE,
wxLANGUAGE_INUKTITUT,
wxLANGUAGE_INUPIAK,
wxLANGUAGE_IRISH,
wxLANGUAGE_ITALIAN,
wxLANGUAGE_ITALIAN_SWISS,
wxLANGUAGE_JAPANESE,
wxLANGUAGE_JAVANESE,
wxLANGUAGE_KANNADA,
wxLANGUAGE_KASHMIRI,
wxLANGUAGE_KASHMIRI_INDIA,
wxLANGUAGE_KAZAKH,
wxLANGUAGE_KERNEWEK,
wxLANGUAGE_KINYARWANDA,
wxLANGUAGE_KIRGHIZ,
wxLANGUAGE_KIRUNDI,
wxLANGUAGE_KONKANI,
wxLANGUAGE_KOREAN,
wxLANGUAGE_KURDISH,
wxLANGUAGE_LAOTHIAN,
wxLANGUAGE_LATIN,
wxLANGUAGE_LATVIAN,
wxLANGUAGE_LINGALA,
wxLANGUAGE_LITHUANIAN,
wxLANGUAGE_MACEDONIAN,
wxLANGUAGE_MALAGASY,
wxLANGUAGE_MALAY,
wxLANGUAGE_MALAYALAM,
wxLANGUAGE_MALAY_BRUNEI_DARUSSALAM,
wxLANGUAGE_MALAY_MALAYSIA,
wxLANGUAGE_MALTESE,
wxLANGUAGE_MANIPURI,
wxLANGUAGE_MAORI,
wxLANGUAGE_MARATHI,
wxLANGUAGE_MOLDAVIAN,
wxLANGUAGE_MONGOLIAN,
wxLANGUAGE_NAURU,
wxLANGUAGE_NEPALI,
wxLANGUAGE_NEPALI_INDIA,
wxLANGUAGE_NORWEGIAN_BOKMAL,
wxLANGUAGE_NORWEGIAN_NYNORSK,
wxLANGUAGE_OCCITAN,
wxLANGUAGE_ORIYA,
wxLANGUAGE_OROMO,
wxLANGUAGE_PASHTO,
wxLANGUAGE_POLISH,
wxLANGUAGE_PORTUGUESE,
wxLANGUAGE_PORTUGUESE_BRAZILIAN,
wxLANGUAGE_PUNJABI,
wxLANGUAGE_QUECHUA,
wxLANGUAGE_RHAETO_ROMANCE,
wxLANGUAGE_ROMANIAN,
wxLANGUAGE_RUSSIAN,
wxLANGUAGE_RUSSIAN_UKRAINE,
wxLANGUAGE_SAMI,
wxLANGUAGE_SAMOAN,
wxLANGUAGE_SANGHO,
wxLANGUAGE_SANSKRIT,
wxLANGUAGE_SCOTS_GAELIC,
wxLANGUAGE_SERBIAN,
wxLANGUAGE_SERBIAN_CYRILLIC,
wxLANGUAGE_SERBIAN_LATIN,
wxLANGUAGE_SERBO_CROATIAN,
wxLANGUAGE_SESOTHO,
wxLANGUAGE_SETSWANA,
wxLANGUAGE_SHONA,
wxLANGUAGE_SINDHI,
wxLANGUAGE_SINHALESE,
wxLANGUAGE_SISWATI,
wxLANGUAGE_SLOVAK,
wxLANGUAGE_SLOVENIAN,
wxLANGUAGE_SOMALI,
wxLANGUAGE_SPANISH,
wxLANGUAGE_SPANISH_ARGENTINA,
wxLANGUAGE_SPANISH_BOLIVIA,
wxLANGUAGE_SPANISH_CHILE,
wxLANGUAGE_SPANISH_COLOMBIA,
wxLANGUAGE_SPANISH_COSTA_RICA,
wxLANGUAGE_SPANISH_DOMINICAN_REPUBLIC,
wxLANGUAGE_SPANISH_ECUADOR,
wxLANGUAGE_SPANISH_EL_SALVADOR,
wxLANGUAGE_SPANISH_GUATEMALA,
wxLANGUAGE_SPANISH_HONDURAS,
wxLANGUAGE_SPANISH_MEXICAN,
wxLANGUAGE_SPANISH_MODERN,
wxLANGUAGE_SPANISH_NICARAGUA,
wxLANGUAGE_SPANISH_PANAMA,
wxLANGUAGE_SPANISH_PARAGUAY,
wxLANGUAGE_SPANISH_PERU,
wxLANGUAGE_SPANISH_PUERTO_RICO,
wxLANGUAGE_SPANISH_URUGUAY,
wxLANGUAGE_SPANISH_US,
wxLANGUAGE_SPANISH_VENEZUELA,
wxLANGUAGE_SUNDANESE,
wxLANGUAGE_SWAHILI,
wxLANGUAGE_SWEDISH,
wxLANGUAGE_SWEDISH_FINLAND,
wxLANGUAGE_TAGALOG,
wxLANGUAGE_TAJIK,
wxLANGUAGE_TAMIL,
wxLANGUAGE_TATAR,
wxLANGUAGE_TELUGU,
wxLANGUAGE_THAI,
wxLANGUAGE_TIBETAN,
wxLANGUAGE_TIGRINYA,
wxLANGUAGE_TONGA,
wxLANGUAGE_TSONGA,
wxLANGUAGE_TURKISH,
wxLANGUAGE_TURKMEN,
wxLANGUAGE_TWI,
wxLANGUAGE_UIGHUR,
wxLANGUAGE_UKRAINIAN,
wxLANGUAGE_URDU,
wxLANGUAGE_URDU_INDIA,
wxLANGUAGE_URDU_PAKISTAN,
wxLANGUAGE_UZBEK,
wxLANGUAGE_UZBEK_CYRILLIC,
wxLANGUAGE_UZBEK_LATIN,
wxLANGUAGE_VALENCIAN,
wxLANGUAGE_VIETNAMESE,
wxLANGUAGE_VOLAPUK,
wxLANGUAGE_WELSH,
wxLANGUAGE_WOLOF,
wxLANGUAGE_XHOSA,
wxLANGUAGE_YIDDISH,
wxLANGUAGE_YORUBA,
wxLANGUAGE_ZHUANG,
wxLANGUAGE_ZULU,
/// For custom, user-defined languages.
wxLANGUAGE_USER_DEFINED
};
// --- --- --- generated code ends here --- --- ---
/**
wxLanguageInfo: encapsulates wxLanguage to OS native lang.desc.
translation information
*/
struct WXDLLIMPEXP_BASE wxLanguageInfo
{
/// wxLanguage id. It should be greater than wxLANGUAGE_USER_DEFINED.
int Language;
wxString CanonicalName; //!< Canonical name, e.g. fr_FR.
#ifdef __WXMSW__
wxUint32 WinLang, //!< Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
WinSublang;
#endif // __WXMSW__
wxString Description; //!< Human-readable name of the language.
wxLayoutDirection LayoutDirection;
#ifdef __WXMSW__
/// Return the LCID corresponding to this language.
wxUint32 GetLCID() const;
#endif // __WXMSW__
/// Return the locale name corresponding to this language usable with
/// setlocale() on the current system
wxString GetLocaleName() const;
};
/** /**
@class wxLocale @class wxLocale
@@ -15,12 +298,17 @@
In wxWidgets this class manages message catalogs which contain the translations In wxWidgets this class manages message catalogs which contain the translations
of the strings used to the current language. of the strings used to the current language.
@b wxPerl note: In wxPerl you can't use the '_' function name, so For a list of the supported languages, please see ::wxLanguage enum values.
These constants may be used to specify the language in wxLocale::Init and
are returned by wxLocale::GetSystemLanguage.
@beginWxPerlOnly
In wxPerl you can't use the '_' function name, so
the @c Wx::Locale module can export the @c gettext and the @c Wx::Locale module can export the @c gettext and
@c gettext_noop under any given name. @c gettext_noop under any given name.
@code @code
# this imports gettext ( equivalent to Wx::GetTranslation # this imports gettext ( equivalent to Wx::GetTranslation
# and gettext_noop ( a noop ) # and gettext_noop ( a noop )
# into your module # into your module
use Wx::Locale qw(:default); use Wx::Locale qw(:default);
@@ -38,7 +326,6 @@
a shorter name for gettext: a shorter name for gettext:
@code @code
#
use Wx::Locale 'gettext' = 't', use Wx::Locale 'gettext' = 't',
'gettext_noop' = 'gettext_noop'; 'gettext_noop' = 'gettext_noop';
@@ -49,41 +336,47 @@
# ... # ...
@endcode @endcode
@endWxPerlOnly
@library{wxbase} @library{wxbase}
@category{FIXME} @category{misc}
@see @ref overview_internationalization, @ref overview_sampleinternat "Internat @see @ref overview_internationalization, @ref page_samples_internat, wxXLocale
sample", wxXLocale
*/ */
class wxLocale class wxLocale
{ {
public: public:
//@{ /**
This is the default constructor and it does nothing to initialize the object:
Init() must be used to do that.
*/
wxLocale();
/** /**
See Init() for parameters description. See Init() for parameters description.
*/
wxLocale(int language,
int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
/**
See Init() for parameters description.
The call of this function has several global side effects which you should The call of this function has several global side effects which you should
understand: first of all, the application locale is changed - note that this understand: first of all, the application locale is changed - note that this
will affect many of standard C library functions such as printf() or strftime(). will affect many of standard C library functions such as printf() or strftime().
Second, this wxLocale object becomes the new current global locale for the Second, this wxLocale object becomes the new current global locale for the
application and so all subsequent calls to wxGetTranslation() will try to application and so all subsequent calls to ::wxGetTranslation() will try to
translate the messages using the message catalogs for this locale. translate the messages using the message catalogs for this locale.
*/ */
wxLocale();
wxLocale(int language,
int flags =
wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
wxLocale(const wxString& name, wxLocale(const wxString& name,
const wxString& short = wxEmptyString, const wxString& short = wxEmptyString,
const wxString& locale = wxEmptyString, const wxString& locale = wxEmptyString,
bool bLoadDefault = true, bool bLoadDefault = true,
bool bConvertEncoding = false); bool bConvertEncoding = false);
//@}
/** /**
The destructor, like the constructor, also has global side effects: the The destructor, like the constructor, also has global side effects: the
previously previously set locale is restored and so the changes described in
set locale is restored and so the changes described in
Init() documentation are rolled back. Init() documentation are rolled back.
*/ */
virtual ~wxLocale(); virtual ~wxLocale();
@@ -92,53 +385,51 @@ public:
/** /**
Add a catalog for use with the current locale: it is searched for in standard Add a catalog for use with the current locale: it is searched for in standard
places (current directory first, then the system one), but you may also prepend places (current directory first, then the system one), but you may also prepend
additional directories to the search path with additional directories to the search path with AddCatalogLookupPathPrefix().
AddCatalogLookupPathPrefix().
All loaded catalogs will be used for message lookup by All loaded catalogs will be used for message lookup by GetString() for
GetString() for the current locale. the current locale.
Returns @true if catalog was successfully loaded, @false otherwise (which might Returns @true if catalog was successfully loaded, @false otherwise (which might
mean that the catalog is not found or that it isn't in the correct format). mean that the catalog is not found or that it isn't in the correct format).
The second form of this method takes two additional arguments, The second form of this method takes two additional arguments,
@a msgIdLanguage and @e msgIdCharset. @a msgIdLanguage and @a msgIdCharset.
@a msgIdLanguage specifies the language of "msgid" strings in source code @a msgIdLanguage specifies the language of "msgid" strings in source code
(i.e. arguments to GetString(), (i.e. arguments to GetString(), wxGetTranslation() and the _() macro).
wxGetTranslation() and the It is used if AddCatalog() cannot find any catalog for current language:
_() macro). It is used if AddCatalog cannot find any if the language is same as source code language, then strings from source
catalog for current language: if the language is same as source code language, code are used instead.
then strings from source code are used instead.
@a msgIdCharset lets you specify the charset used for msgids in sources @a msgIdCharset lets you specify the charset used for msgids in sources
in case they use 8-bit characters (e.g. German or French strings). This in case they use 8-bit characters (e.g. German or French strings).
argument has no effect in Unicode build, because literals in sources are This argument has no effect in Unicode build, because literals in sources are
Unicode strings; you have to use compiler-specific method of setting the right Unicode strings; you have to use compiler-specific method of setting the right
charset when compiling with Unicode. charset when compiling with Unicode.
By default (i.e. when you use the first form), msgid strings are assumed By default (i.e. when you use the first form), msgid strings are assumed
to be in English and written only using 7-bit ASCII characters. to be in English and written only using 7-bit ASCII characters.
If you have to deal with non-English strings or 8-bit characters in the source If you have to deal with non-English strings or 8-bit characters in the
code, see the instructions in source code, see the instructions in @ref overview_nonenglish.
@ref overview_nonenglishoverview "Writing non-English applications".
*/ */
bool AddCatalog(const wxString& domain); bool AddCatalog(const wxString& domain);
bool AddCatalog(const wxString& domain, bool AddCatalog(const wxString& domain, wxLanguage msgIdLanguage,
wxLanguage msgIdLanguage,
const wxString& msgIdCharset); const wxString& msgIdCharset);
//@} //@}
/** /**
Add a prefix to the catalog lookup path: the message catalog files will be Add a prefix to the catalog lookup path: the message catalog files will
looked up under prefix/lang/LC_MESSAGES, prefix/lang and prefix be looked up under prefix/lang/LC_MESSAGES, prefix/lang and prefix
(in this order). (in this order).
This only applies to subsequent invocations of AddCatalog(). This only applies to subsequent invocations of AddCatalog().
*/ */
static void AddCatalogLookupPathPrefix(const wxString& prefix); static void AddCatalogLookupPathPrefix(const wxString& prefix);
/** /**
Adds custom, user-defined language to the database of known languages. This Adds custom, user-defined language to the database of known languages.
database is used in conjunction with the first form of This database is used in conjunction with the first form of Init().
Init().
wxLanguageInfo is defined as follows:
@e Language should be greater than wxLANGUAGE_USER_DEFINED.
Wx::LanguageInfo-new( language, canonicalName, WinLang, WinSubLang, Description
)
*/ */
static void AddLanguage(const wxLanguageInfo& info); static void AddLanguage(const wxLanguageInfo& info);
@@ -147,9 +438,10 @@ public:
given locale, specified either as a two letter ISO language code (for example, given locale, specified either as a two letter ISO language code (for example,
"pt"), a language code followed by the country code ("pt_BR") or a full, human "pt"), a language code followed by the country code ("pt_BR") or a full, human
readable, language description ("Portuguese-Brazil"). readable, language description ("Portuguese-Brazil").
Returns the information for the given language or @NULL if this language Returns the information for the given language or @NULL if this language
is unknown. Note that even if the returned pointer is valid, the caller should is unknown. Note that even if the returned pointer is valid, the caller
@e not delete it. should @e not delete it.
@see GetLanguageInfo() @see GetLanguageInfo()
*/ */
@@ -166,10 +458,11 @@ public:
wxString GetCanonicalName() const; wxString GetCanonicalName() const;
/** /**
Returns the header value for header @e header. The search for @a header is case Returns the header value for header @a header.
sensitive. If an @e domain The search for @a header is case sensitive. If an @a domain is passed,
is passed, this domain is searched. Else all domains will be searched until a this domain is searched. Else all domains will be searched until a
header has been found. header has been found.
The return value is the value of the header if found. Else this will be empty. The return value is the value of the header if found. Else this will be empty.
*/ */
wxString GetHeaderValue(const wxString& header, wxString GetHeaderValue(const wxString& header,
@@ -177,74 +470,90 @@ public:
/** /**
Returns wxLanguage() constant of current language. Returns wxLanguage() constant of current language.
Note that you can call this function only if you used the form of Note that you can call this function only if you used the form of
Init() that takes wxLanguage argument. Init() that takes wxLanguage argument.
*/ */
int GetLanguage() const; int GetLanguage() const;
/** /**
Returns a pointer to wxLanguageInfo structure containing information about the Returns a pointer to wxLanguageInfo structure containing information about
given language or @NULL if this language is unknown. Note that even if the the given language or @NULL if this language is unknown. Note that even if
returned pointer is valid, the caller should @e not delete it. the returned pointer is valid, the caller should @e not delete it.
See AddLanguage() for the wxLanguageInfo
description. See AddLanguage() for the wxLanguageInfo description.
As with Init(), @c wxLANGUAGE_DEFAULT has the As with Init(), @c wxLANGUAGE_DEFAULT has the special meaning if passed
special meaning if passed as an argument to this function and in this case the as an argument to this function and in this case the result of
result of GetSystemLanguage() is used. GetSystemLanguage() is used.
*/ */
static wxLanguageInfo* GetLanguageInfo(int lang) const; static wxLanguageInfo* GetLanguageInfo(int lang) const;
/** /**
Returns English name of the given language or empty string if this Returns English name of the given language or empty string if this
language is unknown. language is unknown.
See GetLanguageInfo() for a remark about
special meaning of @c wxLANGUAGE_DEFAULT. See GetLanguageInfo() for a remark about special meaning of @c wxLANGUAGE_DEFAULT.
*/ */
static wxString GetLanguageName(int lang) const; static wxString GetLanguageName(int lang) const;
/** /**
Returns the locale name as passed to the constructor or Returns the locale name as passed to the constructor or Init().
Init(). This is full, human-readable name,
e.g. "English" or "French". This is a full, human-readable name, e.g. "English" or "French".
*/ */
const wxString GetLocale() const; const wxString& GetLocale() const;
/** /**
Returns the current short name for the locale (as given to the constructor or Returns the current short name for the locale (as given to the constructor or
the Init() function). the Init() function).
*/ */
const wxString GetName() const; const wxString& GetName() const;
//@{
/** /**
Retrieves the translation for a string in all loaded domains unless the szDomain Retrieves the translation for a string in all loaded domains unless the @a domain
parameter is specified (and then only this catalog/domain is searched). parameter is specified (and then only this catalog/domain is searched).
Returns original string if translation is not available
(in this case an error message is generated the first time Returns original string if translation is not available (in this case an
a string is not found; use wxLogNull to suppress it). error message is generated the first time a string is not found; use
The second form is used when retrieving translation of string that has wxLogNull to suppress it).
different singular and plural form in English or different plural forms in some
other language. It takes two extra arguments: @e origString
parameter must contain the singular form of the string to be converted.
It is also used as the key for the search in the catalog.
The @a origString2 parameter is the plural form (in English).
The parameter @a n is used to determine the plural form. If no
message catalog is found @a origString is returned if 'n == 1',
otherwise @e origString2.
See GNU gettext manual for additional information on plural forms handling.
This method is called by the wxGetTranslation()
function and _() macro.
@remarks Domains are searched in the last to first order, i.e. catalogs @remarks Domains are searched in the last to first order, i.e. catalogs
added later override those added before. added later override those added before.
*/ */
const wxString GetString(const wxString& origString, const wxString& GetString(const wxString& origString,
const wxString& domain = wxEmptyString) const; const wxString& domain = wxEmptyString) const;
const const wxString& GetString(const wxString& origString,
const wxString& origString2, /**
size_t n, Retrieves the translation for a string in all loaded domains unless the @a domain
const wxString& domain = NULL) const; parameter is specified (and then only this catalog/domain is searched).
//@}
Returns original string if translation is not available (in this case an
error message is generated the first time a string is not found; use
wxLogNull to suppress it).
This form is used when retrieving translation of string that has different
singular and plural form in English or different plural forms in some
other language.
It takes two extra arguments: @a origString parameter must contain the
singular form of the string to be converted.
It is also used as the key for the search in the catalog.
The @a origString2 parameter is the plural form (in English).
The parameter @a n is used to determine the plural form.
If no message catalog is found @a origString is returned if 'n == 1',
otherwise @a origString2.
See GNU gettext manual for additional information on plural forms handling.
This method is called by the wxGetTranslation() function and _() macro.
@remarks Domains are searched in the last to first order, i.e. catalogs
added later override those added before.
*/
const wxString& GetString(const wxString& origString,
const wxString& origString2,
size_t n,
const wxString& domain = wxEmptyString) const;
/** /**
Returns current platform-specific locale name as passed to setlocale(). Returns current platform-specific locale name as passed to setlocale().
@@ -254,16 +563,16 @@ public:
/** /**
Tries to detect the user's default font encoding. Tries to detect the user's default font encoding.
Returns wxFontEncoding() value or Returns wxFontEncoding() value or @c wxFONTENCODING_SYSTEM if it
@b wxFONTENCODING_SYSTEM if it couldn't be determined. couldn't be determined.
*/ */
static wxFontEncoding GetSystemEncoding() const; static wxFontEncoding GetSystemEncoding() const;
/** /**
Tries to detect the name of the user's default font encoding. This string isn't Tries to detect the name of the user's default font encoding.
particularly useful for the application as its form is platform-dependent and This string isn't particularly useful for the application as its form is
so you should probably use platform-dependent and so you should probably use GetSystemEncoding() instead.
GetSystemEncoding() instead.
Returns a user-readable string value or an empty string if it couldn't be Returns a user-readable string value or an empty string if it couldn't be
determined. determined.
*/ */
@@ -271,86 +580,70 @@ public:
/** /**
Tries to detect the user's default language setting. Tries to detect the user's default language setting.
Returns wxLanguage() value or Returns wxLanguage value or @b wxLANGUAGE_UNKNOWN if the language-guessing
@b wxLANGUAGE_UNKNOWN if the language-guessing algorithm failed. algorithm failed.
*/ */
static int GetSystemLanguage() const; static int GetSystemLanguage() const;
//@{
/** /**
The second form is deprecated, use the first one unless you know what you are Initializes the wxLocale instance.
doing.
The call of this function has several global side effects which you should
understand: first of all, the application locale is changed - note that
this will affect many of standard C library functions such as printf()
or strftime().
Second, this wxLocale object becomes the new current global locale for
the application and so all subsequent calls to wxGetTranslation() will
try to translate the messages using the message catalogs for this locale.
@param language @param language
wxLanguage identifier of the locale. wxLanguage identifier of the locale.
wxLANGUAGE_DEFAULT has special meaning -- wxLocale will use system's @c wxLANGUAGE_DEFAULT has special meaning -- wxLocale will use system's
default default language (see GetSystemLanguage()).
language (see GetSystemLanguage).
@param flags @param flags
Combination of the following: Combination of the following:
- wxLOCALE_LOAD_DEFAULT: Load the message catalog for the given locale
containing the translations of standard wxWidgets messages
automatically.
- wxLOCALE_CONV_ENCODING: Automatically convert message catalogs to
platform's default encoding. Note that it will do only basic
conversion between well-known pair like iso8859-1 and windows-1252 or
iso8859-2 and windows-1250. See @ref overview_nonenglish for
wxLOCALE_LOAD_DEFAULT detailed description of this behaviour.
Note that this flag is meaningless in Unicode build.
Load the message catalog
for the given locale containing the translations of standard wxWidgets
messages
automatically.
wxLOCALE_CONV_ENCODING
Automatically convert message
catalogs to platform's default encoding. Note that it will do only basic
conversion between well-known pair like iso8859-1 and windows-1252 or
iso8859-2 and windows-1250. See Writing non-English applications for
detailed
description of this behaviour. Note that this flag is meaningless in
Unicode build.
@param name @param name
The name of the locale. Only used in diagnostic messages. The name of the locale. Only used in diagnostic messages.
@param short @param short
The standard 2 letter locale abbreviation; it is used as the The standard 2 letter locale abbreviation; it is used as the
directory prefix when looking for the message catalog files. directory prefix when looking for the message catalog files.
@param locale @param locale
The parameter for the call to setlocale(). Note that it is The parameter for the call to setlocale().
platform-specific. Note that it is platform-specific.
@param bLoadDefault @param bLoadDefault
May be set to @false to prevent loading of the message catalog May be set to @false to prevent loading of the message catalog for the
for the given locale containing the translations of standard wxWidgets given locale containing the translations of standard wxWidgets messages.
messages.
This parameter would be rarely used in normal circumstances. This parameter would be rarely used in normal circumstances.
@param bConvertEncoding @param bConvertEncoding
May be set to @true to do automatic conversion of message May be set to @true to do automatic conversion of message catalogs to
catalogs to platform's native encoding. Note that it will do only basic platform's native encoding. Note that it will do only basic conversion
conversion between well-known pair like iso8859-1 and windows-1252 or between well-known pair like iso8859-1 and windows-1252 or iso8859-2
iso8859-2 and windows-1250. and windows-1250.
See Writing non-English applications for detailed See @ref overview_nonenglish for detailed description of this behaviour.
description of this behaviour.
@return @true on success or @false if the given locale couldn't be set.
*/ */
bool Init(int language = wxLANGUAGE_DEFAULT, bool Init(int language = wxLANGUAGE_DEFAULT,
int flags = int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
/**
@deprecated
This form is deprecated, use the other one unless you know what you are doing.
*/
bool Init(const wxString& name, bool Init(const wxString& name,
const wxString& short = wxEmptyString, const wxString& short = wxEmptyString,
const wxString& locale = wxEmptyString, const wxString& locale = wxEmptyString,
bool bLoadDefault = true, bool bLoadDefault = true,
bool bConvertEncoding = false); bool bConvertEncoding = false);
//@}
/** /**
Check whether the operating system and/or C run time environment supports Check whether the operating system and/or C run time environment supports
@@ -369,9 +662,11 @@ public:
/** /**
Check if the given catalog is loaded, and returns @true if it is. Check if the given catalog is loaded, and returns @true if it is.
According to GNU gettext tradition, each catalog
normally corresponds to 'domain' which is more or less the application name. According to GNU gettext tradition, each catalog normally corresponds to
See also: AddCatalog() 'domain' which is more or less the application name.
@see AddCatalog()
*/ */
bool IsLoaded(const char* domain) const; bool IsLoaded(const char* domain) const;
@@ -379,157 +674,10 @@ public:
Returns @true if the locale could be set successfully. Returns @true if the locale could be set successfully.
*/ */
bool IsOk() const; bool IsOk() const;
/**
See @ref overview_languagecodes "list of recognized language constants".
These constants may be used to specify the language
in Init() and are returned by
GetSystemLanguage():
*/
}; };
/**
@class wxXLocale
wxXLocale::wxXLocale
wxXLocale::GetCLocale
wxXLocale::IsOk
Introduction
This class represents a locale object used by so-called xlocale API. Unlike
wxLocale it doesn't provide any non-trivial operations but
simply provides a portable wrapper for POSIX @c locale_t type. It exists
solely to be provided as an argument to various @c wxFoo_l() functions
which are the extensions of the standard locale-dependent functions (hence the
name xlocale). These functions do exactly the same thing as the corresponding
standard @c foo() except that instead of using the global program locale
they use the provided wxXLocale object. For example, if the user runs the
program in French locale, the standard @c printf() function will output
floating point numbers using decimal comma instead of decimal period. If the
program needs to format a floating-point number in a standard format it can
use @c wxPrintf_l(wxXLocale::GetCLocale(), "%g", number) to do it.
Conversely, if a program wanted to output the number in French locale, even if
the current locale is different, it could use wxXLocale(wxLANGUAGE_FRENCH).
Availability
This class is fully implemented only under the platforms where xlocale POSIX
API or equivalent is available. Currently the xlocale API is available under
most of the recent Unix systems (including Linux, various BSD and Mac OS X) and
Microsoft Visual C++ standard library provides a similar API starting from
version 8 (Visual Studio 2005).
If neither POSIX API nor Microsoft proprietary equivalent are available, this
class is still available but works in degraded mode: the only supported locale
is the C one and attempts to create wxXLocale object for any other locale will
fail. You can use the preprocessor macro @c wxHAS_XLOCALE_SUPPORT to
test if full xlocale API is available or only skeleton C locale support is
present.
Notice that wxXLocale is new in wxWidgets 2.9.0 and is not compiled in if
@c wxUSE_XLOCALE was set to 0 during the library compilation.
Locale-dependent functions
Currently the following @c _l-functions are available:
Character classification functions: @c wxIsxxx_l(), e.g.
@c wxIsalpha_l(), @c wxIslower_l() and all the others.
Character transformation functions: @c wxTolower_l() and
@c wxToupper_l()
We hope to provide many more functions (covering numbers, time and formatted
IO) in the near future.
@library{wxbase}
@category{FIXME}
@see wxLocale
*/
class wxXLocale
{
public:
//@{
/**
Creates the locale object corresponding to the specified locale string. The
locale string is system-dependent, use constructor taking wxLanguage for better
portability.
*/
wxLocale();
wxLocale(wxLanguage lang);
wxLocale(const char* loc);
//@}
/**
This class is fully implemented only under the platforms where xlocale POSIX
API or equivalent is available. Currently the xlocale API is available under
most of the recent Unix systems (including Linux, various BSD and Mac OS X) and
Microsoft Visual C++ standard library provides a similar API starting from
version 8 (Visual Studio 2005).
If neither POSIX API nor Microsoft proprietary equivalent are available, this
class is still available but works in degraded mode: the only supported locale
is the C one and attempts to create wxXLocale object for any other locale will
fail. You can use the preprocessor macro @c wxHAS_XLOCALE_SUPPORT to
test if full xlocale API is available or only skeleton C locale support is
present.
Notice that wxXLocale is new in wxWidgets 2.9.0 and is not compiled in if
@c wxUSE_XLOCALE was set to 0 during the library compilation.
*/
/**
Returns the global object representing the "C" locale. For an even shorter
access to this object a global @c wxCLocale variable (implemented as a
macro) is provided and can be used instead of calling this method.
*/
static wxXLocale GetCLocale();
/**
This class represents a locale object used by so-called xlocale API. Unlike
wxLocale it doesn't provide any non-trivial operations but
simply provides a portable wrapper for POSIX @c locale_t type. It exists
solely to be provided as an argument to various @c wxFoo_l() functions
which are the extensions of the standard locale-dependent functions (hence the
name xlocale). These functions do exactly the same thing as the corresponding
standard @c foo() except that instead of using the global program locale
they use the provided wxXLocale object. For example, if the user runs the
program in French locale, the standard @c printf() function will output
floating point numbers using decimal comma instead of decimal period. If the
program needs to format a floating-point number in a standard format it can
use @c wxPrintf_l(wxXLocale::GetCLocale(), "%g", number) to do it.
Conversely, if a program wanted to output the number in French locale, even if
the current locale is different, it could use wxXLocale(wxLANGUAGE_FRENCH).
*/
/**
Returns @true if this object is initialized, i.e. represents a valid locale
or
@false otherwise.
*/
bool IsOk() const;
/**
Currently the following @c _l-functions are available:
Character classification functions: @c wxIsxxx_l(), e.g.
@c wxIsalpha_l(), @c wxIslower_l() and all the others.
Character transformation functions: @c wxTolower_l() and
@c wxToupper_l()
We hope to provide many more functions (covering numbers, time and formatted
IO) in the near future.
@see wxLocale
*/
};
// ============================================================================ // ============================================================================
// Global functions/macros // Global functions/macros
@@ -614,7 +762,7 @@ public:
@header{wx/intl.h} @header{wx/intl.h}
*/ */
const wxString wxGetTranslation(const wxString& string, const wxString& wxGetTranslation(const wxString& string,
const wxString& domain = wxEmptyString); const wxString& domain = wxEmptyString);
/** /**
@@ -639,7 +787,7 @@ const wxString wxGetTranslation(const wxString& string,
@header{wx/intl.h} @header{wx/intl.h}
*/ */
const wxString wxGetTranslation(const wxString& string, const wxString& wxGetTranslation(const wxString& string,
const wxString& plural, size_t n, const wxString& plural, size_t n,
const wxString& domain = wxEmptyString); const wxString& domain = wxEmptyString);
@@ -653,7 +801,7 @@ const wxString wxGetTranslation(const wxString& string,
@header{wx/intl.h} @header{wx/intl.h}
*/ */
const wxString _(const wxString& string); const wxString& _(const wxString& string);
//@} //@}

143
interface/wx/xlocale.h Normal file
View File

@@ -0,0 +1,143 @@
/////////////////////////////////////////////////////////////////////////////
// Name: xlocale.h
// Purpose: interface of wxXLocale
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@class wxXLocale
This class represents a locale object used by so-called xlocale API.
Unlike wxLocale it doesn't provide any non-trivial operations but simply
provides a portable wrapper for POSIX @c locale_t type.
It exists solely to be provided as an argument to various @c wxFoo_l() functions
which are the extensions of the standard locale-dependent functions (hence the
name xlocale). These functions do exactly the same thing as the corresponding
standard @c foo() except that instead of using the global program locale
they use the provided wxXLocale object.
For example, if the user runs the program in French locale, the standard
@c printf() function will output floating point numbers using decimal comma
instead of decimal period. If the program needs to format a floating-point
number in a standard format it can use:
@code wxPrintf_l(wxXLocale::GetCLocale(), "%g", number) @endcode
to do it.
Conversely, if a program wanted to output the number in French locale, even if
the current locale is different, it could use wxXLocale(wxLANGUAGE_FRENCH).
@section xlocale_avail Availability
This class is fully implemented only under the platforms where xlocale POSIX
API or equivalent is available. Currently the xlocale API is available under
most of the recent Unix systems (including Linux, various BSD and Mac OS X) and
Microsoft Visual C++ standard library provides a similar API starting from
version 8 (Visual Studio 2005).
If neither POSIX API nor Microsoft proprietary equivalent are available, this
class is still available but works in degraded mode: the only supported locale
is the C one and attempts to create wxXLocale object for any other locale will
fail. You can use the preprocessor macro @c wxHAS_XLOCALE_SUPPORT to test if
full xlocale API is available or only skeleton C locale support is present.
Notice that wxXLocale is new in wxWidgets 2.9.0 and is not compiled in if
@c wxUSE_XLOCALE was set to 0 during the library compilation.
@section xlocale_func Locale-dependent functions
Currently the following @c _l-functions are available:
Character classification functions: @c wxIsxxx_l(), e.g.
@c wxIsalpha_l(), @c wxIslower_l() and all the others.
Character transformation functions: @c wxTolower_l() and
@c wxToupper_l()
We hope to provide many more functions (covering numbers, time and formatted
IO) in the near future.
@library{wxbase}
@category{misc}
@see wxLocale
*/
class wxXLocale
{
public:
//@{
/**
Creates the locale object corresponding to the specified locale string. The
locale string is system-dependent, use constructor taking wxLanguage for better
portability.
*/
wxLocale();
wxLocale(wxLanguage lang);
wxLocale(const char* loc);
//@}
/**
This class is fully implemented only under the platforms where xlocale POSIX
API or equivalent is available. Currently the xlocale API is available under
most of the recent Unix systems (including Linux, various BSD and Mac OS X) and
Microsoft Visual C++ standard library provides a similar API starting from
version 8 (Visual Studio 2005).
If neither POSIX API nor Microsoft proprietary equivalent are available, this
class is still available but works in degraded mode: the only supported locale
is the C one and attempts to create wxXLocale object for any other locale will
fail. You can use the preprocessor macro @c wxHAS_XLOCALE_SUPPORT to
test if full xlocale API is available or only skeleton C locale support is
present.
Notice that wxXLocale is new in wxWidgets 2.9.0 and is not compiled in if
@c wxUSE_XLOCALE was set to 0 during the library compilation.
*/
/**
Returns the global object representing the "C" locale. For an even shorter
access to this object a global @c wxCLocale variable (implemented as a
macro) is provided and can be used instead of calling this method.
*/
static wxXLocale GetCLocale();
/**
This class represents a locale object used by so-called xlocale API. Unlike
wxLocale it doesn't provide any non-trivial operations but
simply provides a portable wrapper for POSIX @c locale_t type. It exists
solely to be provided as an argument to various @c wxFoo_l() functions
which are the extensions of the standard locale-dependent functions (hence the
name xlocale). These functions do exactly the same thing as the corresponding
standard @c foo() except that instead of using the global program locale
they use the provided wxXLocale object. For example, if the user runs the
program in French locale, the standard @c printf() function will output
floating point numbers using decimal comma instead of decimal period. If the
program needs to format a floating-point number in a standard format it can
use @c wxPrintf_l(wxXLocale::GetCLocale(), "%g", number) to do it.
Conversely, if a program wanted to output the number in French locale, even if
the current locale is different, it could use wxXLocale(wxLANGUAGE_FRENCH).
*/
/**
Returns @true if this object is initialized, i.e. represents a valid locale
or
@false otherwise.
*/
bool IsOk() const;
/**
Currently the following @c _l-functions are available:
Character classification functions: @c wxIsxxx_l(), e.g.
@c wxIsalpha_l(), @c wxIslower_l() and all the others.
Character transformation functions: @c wxTolower_l() and
@c wxToupper_l()
We hope to provide many more functions (covering numbers, time and formatted
IO) in the near future.
@see wxLocale
*/
};

46
misc/languages/genlang.py
View File

@@ -23,13 +23,18 @@ def GenEnum(table):
// --- --- --- generated code begins here --- --- --- // --- --- --- generated code begins here --- --- ---
// This enum is generated by misc/languages/genlang.py /**
// When making changes, please put them into misc/languages/langtabl.txt The languages supported by wxLocale.
This enum is generated by misc/languages/genlang.py
When making changes, please put them into misc/languages/langtabl.txt
*/
enum wxLanguage enum wxLanguage
{ {
// user's default/preffered language as got from OS: /// User's default/preffered language as got from OS.
wxLANGUAGE_DEFAULT, wxLANGUAGE_DEFAULT,
// unknown language, if wxLocale::GetSystemLanguage fails:
/// Unknown language, returned if wxLocale::GetSystemLanguage fails.
wxLANGUAGE_UNKNOWN, wxLANGUAGE_UNKNOWN,
"""); """);
@@ -39,7 +44,7 @@ enum wxLanguage
f.write(' %s,\n' % i[0]) f.write(' %s,\n' % i[0])
knownLangs.append(i[0]) knownLangs.append(i[0])
f.write(""" f.write("""
// for custom, user-defined languages: /// For custom, user-defined languages.
wxLANGUAGE_USER_DEFINED wxLANGUAGE_USER_DEFINED
}; };
@@ -49,34 +54,6 @@ enum wxLanguage
f.close() f.close()
def GenDocs(table):
f = open('_wxlang.tex', 'wt')
f.write("""
%% --- --- --- generated code begins here --- --- ---
%% This enum is generated by misc/languages/genlang.py
%% When making changes, please put them into misc/languages/langtabl.txt
\\begin{twocollist}\\itemsep=0pt
\\twocolitem{wxLANGUAGE\\_DEFAULT}{user's default language as obtained from the operating system}
\\twocolitem{wxLANGUAGE\\_UNKNOWN}{returned by \\helpref{GetSystemLanguage}{wxlocalegetsystemlanguage} if it fails to detect the default language}
\\twocolitem{wxLANGUAGE\\_USER\\_DEFINED}{user defined languages' integer identifiers should start from this}
""");
knownLangs = []
for i in table:
if i[0] not in knownLangs:
f.write('\\twocolitem{%s}{}\n' % (i[0].replace('_','\\_')))
knownLangs.append(i[0])
f.write("""\\end{twocollist}\itemsep=0pt
%% --- --- --- generated code ends here --- --- ---
""")
f.close()
def GenTable(table): def GenTable(table):
all_langs = [] all_langs = []
all_sublangs = [] all_sublangs = []
@@ -156,6 +133,5 @@ void wxLocale::InitLanguagesDB()
table = ReadTable() table = ReadTable()
GenEnum(table) GenEnum(table) # the enum is used also (thanks to doxygen) in the docs
GenTable(table) GenTable(table)
GenDocs(table)