mention that SetItemToolTip() is for wxMSW and wxGTK2 only

[wxWidgets.git] / docs / latex / wx / tmbconv.tex

diff --git a/docs/latex/wx/tmbconv.tex b/docs/latex/wx/tmbconv.tex
index 7a4213f9f5d600b509a9e14cb80ef5097dd7b4d1..4ef2750a27ef12a69eccdd8b5ea53a5f2148cbbe 100644 (file)
--- a/docs/latex/wx/tmbconv.tex
+++ b/docs/latex/wx/tmbconv.tex
@@ -1,26 +1,26 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% Name:        tmbconv.tex
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% 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
 %% 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}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{wxMBConv classes overview}\label{mbconvclasses}
 

-Classes: \helpref{wxMBConv}{wxmbconv}, \helpref{wxMBConvLibc}{wxmbconvlibc}, 
+Classes: \helpref{wxMBConv}{wxmbconv}, wxMBConvLibc, 

 \helpref{wxMBConvUTF7}{wxmbconvutf7}, \helpref{wxMBConvUTF8}{wxmbconvutf8}, 
 \helpref{wxMBConvUTF7}{wxmbconvutf7}, \helpref{wxMBConvUTF8}{wxmbconvutf8}, 

-\helpref{wxCSConv}{wxcsconv},
+\helpref{wxCSConv}{wxcsconv}, 

 \helpref{wxMBConvUTF16}{wxmbconvutf16}, \helpref{wxMBConvUTF32}{wxmbconvutf32}
 
 \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.
 
 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
 
 As programs are becoming more and more globalized, and users exchange documents
 across country boundaries as never before, applications increasingly need to


@@ -40,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.
 
 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
 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


@@ -52,9 +52,9 @@ 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
 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
 
 The base class for all these conversions is the wxMBConv class (which itself
 implements standard libc locale conversion). Derived classes include


@@ -63,10 +63,10 @@ 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.
 
 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}

 
 

-Several of the wxWindows-provided wxMBConv classes have predefined instances
-(wxConvLibc, wxConvFile, wxConvUTF7, wxConvUTF8, wxConvLocal). You can use
+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
 these predefined objects directly, or you can instantiate your own objects.
 
 A variable, wxConvCurrent, points to the conversion object that the user


@@ -74,7 +74,7 @@ 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.
 
 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
 
 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


@@ -85,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.
 
 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
 
 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.
 compile in a non-Unicode build (they just won't convert anything).
 
 Example 1: Constructing a wxString from input in current encoding.


@@ -128,12 +128,12 @@ 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).
 
 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
 
 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}
 encoding should be possible by doing this:
 
 \begin{verbatim}


@@ -143,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
 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:
 retains the Unicode data.)
 
 This could also be done by first making a wxString of the original data: