// Purpose: interface of wxEncodingConverter
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxEncodingConverter
- @wxheader{encconv.h}
This class is capable of converting strings between two 8-bit encodings/charsets.
- It can also convert from/to Unicode (but only if you compiled wxWidgets
- with wxUSE_WCHAR_T set to 1).
+ It can also convert from/to Unicode.
Only a limited subset of encodings is supported by wxEncodingConverter:
@c wxFONTENCODING_ISO8859_1..15, @c wxFONTENCODING_CP1250..1257 and
@c wxFONTENCODING_KOI8.
@note
-
Please use wxMBConv classes instead if possible. wxCSConv has much better
support for various encodings than wxEncodingConverter.
wxEncodingConverter is useful only if you rely on wxCONVERT_SUBSTITUTE mode
of operation (see wxEncodingConverter::Init()).
@library{wxbase}
- @category{misc}
+ @category{conv}
@see wxFontMapper, wxMBConv, @ref overview_nonenglish
*/
considered a lossless operation.
@note You must call Init() before using this method!
-
- @note wchar_t versions of the method are not available if wxWidgets was
- compiled with @c wxUSE_WCHAR_T set to 0.
*/
bool Convert(const char* input, char* output) const;
bool Convert(const wchar_t* input, wchar_t* output) const;
bool Convert(const wchar_t* input, char* output) const;
/**
- Convert input string according to settings passed to Init() in-place,
- i.e. write the result to the same memory area.
+ Convert input string according to settings passed to Init() in-place.
+
+ With this overload, the conversion result is written to the same memory
+ area from which the input is read.
See the Convert(const char*,char*) const overload for more info.
*/
bool Convert(char* str) const;
+
+ /**
+ Convert input string according to settings passed to Init() in-place.
+
+ With this overload, the conversion result is written to the same memory
+ area from which the input is read.
+
+ See the Convert(const wchar_t*,wchar_t*) const overload for more info.
+ */
bool Convert(wchar_t* str) const;
/**