Document domain parameter of wxTranslations::GetTranslatedString().
[wxWidgets.git] / docs / doxygen / groups / funcmacro_locale.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: funcmacro_locale.h
3 // Purpose: wxXLocale-enabled functions
4 // Author: wxWidgets team
5 // Licence: wxWindows licence
6 /////////////////////////////////////////////////////////////////////////////
7
8 /**
9
10 @defgroup group_funcmacro_locale Locale-dependent functions
11 @ingroup group_funcmacro
12
13 Below are a number of functions/macros which accept as last parameter a
14 specific wxXLocale instance.
15
16 For the documentation of function @c wxFunc_l(), please see the documentation
17 of the standard @c Func() function (see e.g. http://www.cppreference.com/wiki/c/string/start)
18 and keep in mind that the wxWidgets function takes as last parameter the
19 locale which should be internally used for locale-dependent operations.
20
21 Last, note that when the @c wxHAS_XLOCALE_SUPPORT symbol is not defined,
22 then wxWidgets will provide implementations of these functions itself
23 and that they are not granted to be thread-safe (and they will work only with the
24 C locale; see @ref xlocale_avail).
25
26
27 */
28