Emphasize that wxStandardPaths must not be created directly.

wxStandardPaths::Get() must be used instead as the correct object to use might
have a different type.

See #11239.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@68462 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2011-07-30 17:40:00 +00:00
parent bf8f10225c
commit 75618d57e4

View File

@@ -12,6 +12,13 @@
wxStandardPaths returns the standard locations in the file system and should be wxStandardPaths returns the standard locations in the file system and should be
used by applications to find their data files in a portable way. used by applications to find their data files in a portable way.
Note that you must not create objects of class wxStandardPaths directly,
but use the global standard paths object returned by wxStandardPaths::Get()
(which can be of a type derived from wxStandardPaths and not of exactly
this type) and call the methods you need on it. The object returned by
Get() may be customized by overriding wxAppTraits::GetStandardPaths()
methods.
In the description of the methods below, the example return values are given In the description of the methods below, the example return values are given
for the Unix, Windows and Mac OS X systems, however please note that these are for the Unix, Windows and Mac OS X systems, however please note that these are
just the examples and the actual values may differ. For example, under Windows: just the examples and the actual values may differ. For example, under Windows:
@@ -42,10 +49,6 @@
This class is MT-safe: its methods may be called concurrently from different This class is MT-safe: its methods may be called concurrently from different
threads without additional locking. threads without additional locking.
Note that you don't allocate an instance of class wxStandardPaths, but retrieve the
global standard paths object using @c wxStandardPaths::Get on which you call the
desired methods.
@library{wxbase} @library{wxbase}
@category{file} @category{file}