From 0c2bed825d3b1efb56aab7f0dcddef17185184a5 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Wed, 15 Feb 2012 15:39:49 +0000 Subject: [PATCH] Document wxConvFileName variable, not wxMBConvFile class. The class doesn't exist (and the documentation even says that much) but the global variable does exist, so document it instead. Closes #13982. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70601 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/strconv.h | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/interface/wx/strconv.h b/interface/wx/strconv.h index c5384a8e43..fd0169589c 100644 --- a/interface/wx/strconv.h +++ b/interface/wx/strconv.h @@ -482,22 +482,19 @@ public: /** - @class wxMBConvFile - - This class used to define the class instance @b wxConvFileName, but - nowadays @b wxConvFileName is either of type wxConvLibc (on most platforms) - or wxConvUTF8 (on MacOS X). + Conversion object used for converting file names from their external + representation to the one used inside the program. @b wxConvFileName converts filenames between filesystem multibyte encoding and Unicode. @b 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 + run-time which is used e.g. by wxGTK to use an object which checks the environment variable @b 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 (such as Win32) use Unicode in the filenames, - and others (such as Unix) use multibyte encodings, this class should only + and others (such as Unix) use multibyte encodings, this object should only be used directly if wxMBFILES is defined to 1. A convenience macro, @c wxFNCONV, is defined to @c wxConvFileName->cWX2MB in this case. You could use it like this: @@ -508,7 +505,7 @@ public: @endcode (although it would be better to just use wxFopen(name, "r") in this - particular case, you only need to use this class for functions taking file + particular case, you only need to use this object for functions taking file names not wrapped by wxWidgets.) @library{wxbase} @@ -516,7 +513,4 @@ public: @see @ref overview_mbconv */ -class wxMBConvFile : public wxMBConv -{ -public: -}; +extern wxMBConv* wxConvFileName; -- 2.45.2