X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..034ad06337f97ffa3742fd8d9a8df2a4e9d5ed4a:/docs/latex/wx/tmbconv.tex diff --git a/docs/latex/wx/tmbconv.tex b/docs/latex/wx/tmbconv.tex index 4401bfa99b..4ef2750a27 100644 --- a/docs/latex/wx/tmbconv.tex +++ b/docs/latex/wx/tmbconv.tex @@ -1,25 +1,26 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% Name: tmbconv.tex -%% Purpose: Overview of the wxMBConv classes in wxWindows +%% Purpose: Overview of the wxMBConv classes in wxWidgets %% Author: Ove Kaaven %% Modified by: %% Created: 25.03.00 %% RCS-ID: $Id$ %% Copyright: (c) 2000 Ove Kaaven -%% Licence: wxWindows license +%% Licence: wxWindows licence %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{wxMBConv classes overview}\label{mbconvclasses} -Classes: \helpref{wxMBConv}{wxmbconv}, \helpref{wxMBConvFile}{wxmbconvfile}, +Classes: \helpref{wxMBConv}{wxmbconv}, wxMBConvLibc, \helpref{wxMBConvUTF7}{wxmbconvutf7}, \helpref{wxMBConvUTF8}{wxmbconvutf8}, -\helpref{wxCSConv}{wxcsconv} +\helpref{wxCSConv}{wxcsconv}, +\helpref{wxMBConvUTF16}{wxmbconvutf16}, \helpref{wxMBConvUTF32}{wxmbconvutf32} -The wxMBConv classes in wxWindows enables an Unicode-aware application to +The wxMBConv classes in wxWidgets enable an Unicode-aware application to easily convert between Unicode and the variety of 8-bit encoding systems still in use. -\subsection{Background: The need for conversion} +\subsection{Background: The need for conversion}\label{needforconversion} As programs are becoming more and more globalized, and users exchange documents across country boundaries as never before, applications increasingly need to @@ -39,9 +40,9 @@ Unicode data from one Unicode-aware system to another may need encoding to an 8-bit multibyte encoding (UTF-7 or UTF-8 is typically used for this purpose), to pass unhindered through any traditional transport channels. -\subsection{Background: The wxString class} +\subsection{Background: The wxString class}\label{conversionandwxstring} -If you have compiled wxWindows in Unicode mode, the wxChar type will become +If you have compiled wxWidgets in Unicode mode, the wxChar type will become identical to wchar\_t rather than char, and a wxString stores wxChars. Hence, all wxString manipulation in your application will then operate on Unicode strings, and almost as easily as working with ordinary char strings (you @@ -51,31 +52,29 @@ literals). But often, your environment doesn't want Unicode strings. You could be sending data over a network, or processing a text file for some other application. You need a way to quickly convert your easily-handled Unicode data to and from a -traditional 8-bit-encoding. And this is what the wxMBConv classes do. +traditional 8-bit encoding. And this is what the wxMBConv classes do. -\subsection{wxMBConv classes} +\subsection{wxMBConv classes}\label{wxmbconvclasses} The base class for all these conversions is the wxMBConv class (which itself implements standard libc locale conversion). Derived classes include -wxMBConvFile, wxMBConvUTF7, wxMBConvUTF8, and wxCSConv, which implement -different kinds of conversions. You can also derive your own class for your -own custom encoding and use it, should you need it. All you need to do is -override the MB2WC and WC2MB methods. +wxMBConvLibc, several different wxMBConvUTFxxx classes, and wxCSConv, which +implement different kinds of conversions. You can also derive your own class +for your own custom encoding and use it, should you need it. All you need to do +is override the MB2WC and WC2MB methods. -\subsection{wxMBConv objects} +\subsection{wxMBConv objects}\label{wxmbconvobjects} -In C++, for a class to be useful and possible to pass around, it needs to be -instantiated. All of the wxWindows-provided wxMBConv classes have predefined -instances (wxConvLibc, wxConvFile, wxConvUTF7, wxConvUTF8, wxConvLocal). -You can use these predefined objects directly, or you can instantiate your own -objects. +Several of the wxWidgets-provided wxMBConv classes have predefined instances +(wxConvLibc, wxConvFileName, wxConvUTF7, wxConvUTF8, wxConvLocal). You can use +these predefined objects directly, or you can instantiate your own objects. -A variable, wxConvCurrent, points to the conversion object that the user interface -is supposed to use, in the case that the user interface is not Unicode-based (like -with GTK+ 1.2). By default, it points to wxConvLibc or wxConvLocal, depending on -which works best on the current platform. +A variable, wxConvCurrent, points to the conversion object that the user +interface is supposed to use, in the case that the user interface is not +Unicode-based (like with GTK+ 1.2). By default, it points to wxConvLibc or +wxConvLocal, depending on which works best on the current platform. -\subsection{wxCSConv} +\subsection{wxCSConv}\label{wxcsconvclass} The wxCSConv class is special because when it is instantiated, you can tell it which character set it should use, which makes it meaningful to keep many @@ -86,11 +85,11 @@ The predefined wxCSConv instance, wxConvLocal, is preset to use the default user character set, but you should rarely need to use it directly, it is better to go through wxConvCurrent. -\subsection{Converting strings} +\subsection{Converting strings}\label{convertingstrings} Once you have chosen which object you want to use to convert your text, here is how you would use them with wxString. These examples all assume -that you are using a Unicode build of wxWindows, although they will still +that you are using a Unicode build of wxWidgets, although they will still compile in a non-Unicode build (they just won't convert anything). Example 1: Constructing a wxString from input in current encoding. @@ -125,16 +124,16 @@ wxCSConv cust(user_encoding); printf("Data: %s\n", (const char*) str.mb_str(cust)); \end{verbatim} -Note: Since mb_str() returns a temporary wxCharBuffer to hold the result +Note: Since mb\_str() returns a temporary wxCharBuffer to hold the result of the conversion, you need to explicitly cast it to const char* if you use it in a vararg context (like with printf). -\subsection{Converting buffers} +\subsection{Converting buffers}\label{convertingbuffers} If you have specialized needs, or just don't want to use wxString, you can also use the conversion methods of the conversion objects directly. This can even be useful if you need to do conversion in a non-Unicode -build of wxWindows; converting a string from UTF-8 to the current +build of wxWidgets; converting a string from UTF-8 to the current encoding should be possible by doing this: \begin{verbatim} @@ -144,7 +143,7 @@ wxString str(wxConvUTF8.cMB2WC(input_data), *wxConvCurrent); Here, cMB2WC of the UTF8 object returns a wxWCharBuffer containing a Unicode string. The wxString constructor then converts it back to an 8-bit character set using the passed conversion object, *wxConvCurrent. (In a Unicode build -of wxWindows, the constructor ignores the passed conversion object and +of wxWidgets, the constructor ignores the passed conversion object and retains the Unicode data.) This could also be done by first making a wxString of the original data: @@ -171,7 +170,7 @@ process_data(tmp_str); \end{verbatim} If a conversion had taken place in cWX2MB (i.e. in a Unicode build), -the buffer will be deallocated as soon as tmp_buf goes out of scope. +the buffer will be deallocated as soon as tmp\_buf goes out of scope. (The macro wxWX2MBbuf reflects the correct return value of cWX2MB (either char* or wxCharBuffer), except for the const.)