X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..9e9574fe45b176ee74bba8fad7574cf9906145d1:/interface/wx/encconv.h diff --git a/interface/wx/encconv.h b/interface/wx/encconv.h index a7821321ce..579f4fc1e7 100644 --- a/interface/wx/encconv.h +++ b/interface/wx/encconv.h @@ -2,31 +2,27 @@ // Name: encconv.h // 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 */ @@ -66,9 +62,6 @@ public: 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; @@ -76,12 +69,23 @@ public: 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; /**