interface/wx/xlocale.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        xlocale.h
   3 // Purpose:     interface of wxXLocale
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11     @class wxXLocale
  12
  13     This class represents a locale object used by so-called xlocale API.
  14
  15     Unlike wxLocale it doesn't provide any non-trivial operations but simply
  16     provides a portable wrapper for POSIX @c locale_t type.
  17
  18     It exists solely to be provided as an argument to various @c wxFoo_l() functions
  19     which are the extensions of the standard locale-dependent functions (hence the
  20     name xlocale). These functions do exactly the same thing as the corresponding
  21     standard @c foo() except that instead of using the global program locale
  22     they use the provided wxXLocale object.
  23
  24     See @ref group_funcmacro_locale for a list of wxXLocale-enabled functions.
  25
  26     Conversely, if a program wanted to output the number in French locale, even if
  27     the current locale is different, it could use wxXLocale(wxLANGUAGE_FRENCH).
  28
  29
  30     @section xlocale_avail Availability
  31
  32     This class is fully implemented only under the platforms where xlocale POSIX
  33     API or equivalent is available. Currently the xlocale API is available under
  34     most of the recent Unix systems (including Linux, various BSD and Mac OS X) and
  35     Microsoft Visual C++ standard library provides a similar API starting from
  36     version 8 (Visual Studio 2005).
  37
  38     If neither POSIX API nor Microsoft proprietary equivalent are available, this
  39     class is still available but works in degraded mode: the only supported locale
  40     is the C one and attempts to create wxXLocale object for any other locale will
  41     fail. You can use the preprocessor macro @c wxHAS_XLOCALE_SUPPORT to test if
  42     full xlocale API is available or only skeleton C locale support is present.
  43
  44     Notice that wxXLocale is new in wxWidgets 2.9.0 and is not compiled in if
  45     @c wxUSE_XLOCALE was set to 0 during the library compilation.
  46
  47
  48     @library{wxbase}
  49     @category{cfg}
  50
  51     @stdobjects
  52     @li ::wxNullXLocale
  53
  54     @see wxLocale
  55 */
  56 class wxXLocale
  57 {
  58 public:
  59     /**
  60         Creates an uninitialized locale object, IsOk() method will return @false.
  61     */
  62     wxXLocale();
  63
  64     /**
  65         Creates the locale object corresponding to the specified language.
  66     */
  67     wxXLocale(wxLanguage lang);
  68
  69     /**
  70         Creates the locale object corresponding to the specified locale string.
  71         The locale string is system-dependent, use constructor taking wxLanguage
  72         for better portability.
  73     */
  74     wxXLocale(const char* loc);
  75
  76     /**
  77         Returns the global object representing the "C" locale.
  78         For an even shorter access to this object a global @c wxCLocale variable
  79         (implemented as a macro) is provided and can be used instead of calling
  80         this method.
  81     */
  82     static wxXLocale& GetCLocale();
  83
  84     /**
  85         Returns @true if this object is initialized, i.e.\ represents a valid locale
  86         or @false otherwise.
  87     */
  88     bool IsOk() const;
  89
  90     /**
  91         Comparison operator.
  92     */
  93     bool operator==(const wxXLocale& loc) const;
  94 };
  95
  96 /**
  97     An empty and invalid wxXLocale object.
  98 */
  99 wxXLocale wxNullXLocale;
 100
 101
 102
 103 // ============================================================================
 104 // Global functions/macros
 105 // ============================================================================
 106
 107 /** @addtogroup group_funcmacro_locale */
 108 //@{
 109
 110 int wxIsalnum_l(wchar_t c, const wxXLocale& loc);
 111 int wxIsalpha_l(wchar_t c, const wxXLocale& loc);
 112 int wxIscntrl_l(wchar_t c, const wxXLocale& loc);
 113 int wxIsdigit_l(wchar_t c, const wxXLocale& loc);
 114 int wxIsgraph_l(wchar_t c, const wxXLocale& loc);
 115 int wxIslower_l(wchar_t c, const wxXLocale& loc);
 116 int wxIsprint_l(wchar_t c, const wxXLocale& loc);
 117 int wxIspunct_l(wchar_t c, const wxXLocale& loc);
 118 int wxIsspace_l(wchar_t c, const wxXLocale& loc);
 119 int wxIsupper_l(wchar_t c, const wxXLocale& loc);
 120 int wxIsxdigit_l(wchar_t c, const wxXLocale& loc);
 121 wchar_t wxTolower_l(wchar_t c, const wxXLocale& loc);
 122 wchar_t wxToupper_l(wchar_t c, const wxXLocale& loc);
 123
 124 double wxStrtod_l(const wchar_t *c, wchar_t **endptr, const wxXLocale& loc);
 125 long wxStrtol_l(const wchar_t *c, wchar_t **endptr, int base, const wxXLocale& loc);
 126 unsigned long wxStrtoul_l(const wchar_t *c, wchar_t **endptr, int base, const wxXLocale& loc);
 127
 128 //@}
 129