Mini doc update for wxConvFileName.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@33164 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling 2005-03-29 23:33:16 +00:00
parent 9c3d92c56b
commit a7d34a619b

View File

@ -5,13 +5,23 @@
\section{\class{wxMBConvFile}}\label{wxmbconvfile}
This class converts file names between filesystem multibyte encoding and
Unicode. It has one predefined instance, {\bf wxConvFileName}.
This class used to be used for defining the class instance
{\bf wxConvFileName}, but nowadays {\bf wxConvFileName} is
either of type wxConvLibc (on most platforms) or wxConvUTF8
(on MacOS X). {\bf wxConvFileName} converts filenames between
filesystem multibyte encoding and Unicode. {\bf wxConvFileName}
can also be set to a something else at run-time which is used
e.g. by wxGTK to use a class which checks the environment
variable {\bf G_FILESYSTEM_ENCODING} indicating that filenames
should not be interpreted as UTF8 and also for converting
invalid UTF8 characters (e.g. if there is a filename in iso8859_1)
to strings with octal values.
Since some platforms (e.g. Win32) use Unicode in the filenames,
and others (e.g. Unix) use multibyte encodings, this class should only
be used directly if wxMBFILES is defined to 1. A convenience macro,
wxFNCONV, is defined to wxConvFile.cWX2MB in this case. You could use it
like this:
wxFNCONV, is defined to wxConvFileName->cWX2MB in this case. You could
use it like this:
\begin{verbatim}
wxChar *name = wxT("rawfile.doc");