added and documented wxDEFINE_SCOPED_PTR_TYPE; improved docs a bit

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

diff --git a/docs/latex/wx/tnoneng.tex b/docs/latex/wx/tnoneng.tex
index a002c8ca92575d75be368b6fbfac61dd646b3664..a11bf9cc7bddf50c20a2c296aa858da4c84ef088 100644 (file)
--- a/docs/latex/wx/tnoneng.tex
+++ b/docs/latex/wx/tnoneng.tex
@@ -5,7 +5,8 @@ user in language other than English. Unfortunately many languages use
 different charsets under Unix and Windows (and other platforms, to make
 situation even more complicated). These charsets usually differ in so
 many characters it is impossible to use same texts under all platforms.
 different charsets under Unix and Windows (and other platforms, to make
 situation even more complicated). These charsets usually differ in so
 many characters it is impossible to use same texts under all platforms.

-wxWindows provide mechanism that helps you avoid distributing many
+
+wxWindows library provides mechanism that helps you avoid distributing many

 identical, only differently encoded, packages with your application 
 (e.g. help files and menu items in iso8859-13 and windows-1257). Thanks
 to this mechanism you can, for example, distribute only iso8859-13 data 
 identical, only differently encoded, packages with your application 
 (e.g. help files and menu items in iso8859-13 and windows-1257). Thanks
 to this mechanism you can, for example, distribute only iso8859-13 data 


@@ -31,7 +32,6 @@ A standard .po file begins with a header like this:
 # Copyright (C) YEAR Free Software Foundation, Inc.
 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
 #
 # Copyright (C) YEAR Free Software Foundation, Inc.
 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
 #

-#, fuzzy

 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"


@@ -44,19 +44,17 @@ msgstr ""
 "Content-Transfer-Encoding: ENCODING\n"
 \end{verbatim}
 
 "Content-Transfer-Encoding: ENCODING\n"
 \end{verbatim}
 

-Notice these two lines:
+Note this particular line:

 
 \begin{verbatim}
 
 \begin{verbatim}

-#, fuzzy

 "Content-Type: text/plain; charset=CHARSET\n"
 \end{verbatim}
 
 "Content-Type: text/plain; charset=CHARSET\n"
 \end{verbatim}
 

-The first tells the {\it msgfmt} compiler not to include "" (the empty string)
-in compiled .mo catalog. The second one specifies the charset used to write
-translated messages.
+It specifies the charset used by the catalog. All strings in the catalog
+are encoded using this charset.

 
 

-You have to do two things: fill in proper charset information and delete
-the {\tt fuzzy} line. Your .po file may look like this after doing so:
+You have to fill in proper charset information. Your .po file may look like this
+after doing so: 

 
 \begin{verbatim}
 # SOME DESCRIPTIVE TITLE.
 
 \begin{verbatim}
 # SOME DESCRIPTIVE TITLE.


@@ -72,49 +70,42 @@ msgstr ""
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=iso8859-2\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=iso8859-2\n"

-"Content-Transfer-Encoding: ENCODING\n"
+"Content-Transfer-Encoding: 8bit\n"

 \end{verbatim}
 
 \end{verbatim}
 

+(Make sure that the header is {\bf not} marked as {\it fuzzy}.)
+

 wxWindows is able to use this catalog under any supported platform
 wxWindows is able to use this catalog under any supported platform

-(although iso8859-2 is a Unix encoding and is not understood by Windows).
+(although iso8859-2 is a Unix encoding and is normally not understood by
+Windows).

 
 How is this done? When you tell the wxLocale class to load a message catalog that
 
 How is this done? When you tell the wxLocale class to load a message catalog that

-contains the header (msgid ""; normal .mo catalogs do {\bf not} contain it,
-you must remove the line with {\it fuzzy}!), it checks the charset. If the
-charset is "alien" on the platform the program is currently running (e.g.
-any of ISO encodings under Windows or CP12XX under Unix) it uses 
-\helpref{wxEncodingConverter::GetPlatformEquivalents}{wxencodingconvertergetplatformequivalents}
-to obtain an encoding that is more common on this platform and converts
-the message catalog to this encoding. Note that it does {\bf not} check
-for presence of this encoding! It only assumes that it is always better to
-have strings in platform native encoding than in an encoding that is rarely
-(if ever) used.
-
-The behaviour described above is disabled by default.
-You must set {\it bConvertEncoding} to TRUE in 
-\helpref{wxLocale constructor}{wxlocaledefctor} in order to enable
-runtime encoding conversion.
+contains correct header, it checks the charset. The catalog is then converted
+to the charset used (see
+\helpref{wxLocale::GetSystemEncoding}{wxlocalegetsystemencoding} and
+\helpref{wxLocale::GetSystemEncodingName}{wxlocalegetsystemencodingname}) by
+user's operating system. This is default behaviour of the
+\helpref{wxLocale}{wxlocale} class; you can disable it by {\bf not} passing
+{\tt wxLOCALE\_CONV\_ENCODING} to \helpref{wxLocale::Init}{wxlocaleinit}.

 
 \wxheading{Font mapping}
 
 
 \wxheading{Font mapping}
 

-You can use \helpref{wxEncodingConverter}{wxencodingconverter} and 
+You can use \helpref{wxMBConv classes}{mbconvclasses} and 

 \helpref{wxFontMapper}{wxfontmapper} to display text:
 
 \begin{verbatim}
 \helpref{wxFontMapper}{wxfontmapper} to display text:
 
 \begin{verbatim}

-if (!wxTheFontMapper->IsEncodingAvailable(enc, facename))
+if (!wxFontMapper::Get()->IsEncodingAvailable(enc, facename))

 {
    wxFontEncoding alternative;
 {
    wxFontEncoding alternative;

-   if (wxTheFontMapper->GetAltForEncoding(enc, &alternative, 
-                                          facename, FALSE))
+   if (wxFontMapper::Get()->GetAltForEncoding(enc, &alternative,
+                                              facename, false))

    {
    {

-       wxEncodingConverted encconv;
-       if (!encconv.Init(enc, alternative))
-           ...failure...
-       else
-           text = encconv.Convert(text);
+       wxCSConv convFrom(wxFontMapper::Get()->GetEncodingName(enc));
+       wxCSConv convTo(wxFontMapper::Get()->GetEncodingName(alternative));
+       text = wxString(text.mb_str(convFrom), convTo);

    }
    else
    }
    else

-       ...failure...
+       ...failure (or we may try iso8859-1/7bit ASCII)...

 }
 ...display text...
 \end{verbatim}
 }
 ...display text...
 \end{verbatim}


@@ -122,8 +113,10 @@ if (!wxTheFontMapper->IsEncodingAvailable(enc, facename))
 \wxheading{Converting data}
 
 You may want to store all program data (created documents etc.) in
 \wxheading{Converting data}
 
 You may want to store all program data (created documents etc.) in

-the same encoding, let's say windows1250. Obviously, the best way would
-be to use \helpref{wxEncodingConverter}{wxencodingconverter}.
+the same encoding, let's say {\tt utf-8}. You can use
+\helpref{wxCSConv}{wxcsconv} class to convert data to encoding used by the
+system your application is running on (see
+\helpref{wxLocale::GetSystemEncoding}{wxlocalegetsystemencoding}).

 
 \wxheading{Help files}
 
 
 \wxheading{Help files}
 


@@ -132,7 +125,7 @@ no problem at all. You must only make sure that all the HTML files contain
 the META tag, e.g.
 
 \begin{verbatim}
 the META tag, e.g.
 
 \begin{verbatim}

-<meta http-equiv="Content-Type" content="iso8859-2">
+<meta http-equiv="Content-Type" content="text/html; charset=iso8859-2">

 \end{verbatim}
 
 and that the hhp project file contains one additional line in the {\tt OPTIONS}
 \end{verbatim}
 
 and that the hhp project file contains one additional line in the {\tt OPTIONS}