Document wxStandardPaths vendor-related changes.

The change in the values returned by wxStandardPaths functions is important as
it's incompatible with 2.8 if the application defines a vendor name so must be
mentioned in docs/changes.txt.

Also update the documentation of the class itself and mention UseAppInfo() in
the overview.

Closes #11189.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61883 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/changes.txt b/docs/changes.txt
index 33d547c1b15921c2d44a49c95fb7a27f88d81b5d..8043a1d7b732b57fd240a3ee9916910924bc3167 100644 (file)
--- a/docs/changes.txt
+++ b/docs/changes.txt
@@ -80,6 +80,11 @@ Changes in behaviour not resulting in compilation errors, please read this!
 - Default location of wxFileConfig files has changed under Windows, you will
   need to update your code if you access these files directly.
 
 - Default location of wxFileConfig files has changed under Windows, you will
   need to update your code if you access these files directly.
 

+- Return value of wxStandardPaths::GetUserDataDir() and similar functions has
+  changed if the vendor name is defined as it now includes it by default under
+  Windows and OS X. Call wxStandardPaths::UseAppInfo(AppInfo_AppName) to
+  revert to behaviour compatible with 2.8 version.
+

 - wxWindow::IsEnabled() now returns false if a window parent (and not
   necessarily the window itself) is disabled, new function IsThisEnabled()
   with the same behaviour as old IsEnabled() was added.
 - wxWindow::IsEnabled() now returns false if a window parent (and not
   necessarily the window itself) is disabled, new function IsThisEnabled()
   with the same behaviour as old IsEnabled() was added.

diff --git a/interface/wx/stdpaths.h b/interface/wx/stdpaths.h
index 78e1c8c787406210969103e842735a68a5e0cc58..8de3c97ae219f1a61a7873fd74dbf186edf69304 100644 (file)
--- a/interface/wx/stdpaths.h
+++ b/interface/wx/stdpaths.h
@@ -19,10 +19,16 @@
     the Windows directory may be named @c "W:\Win2003" instead of
     the default @c "C:\Windows".
 
     the Windows directory may be named @c "W:\Win2003" instead of
     the default @c "C:\Windows".
 

-    The strings @c appname and @c username should be replaced with the value
-    returned by wxApp::GetAppName() and the name of the currently logged in user,
-    respectively. The string @c prefix is only used under Unix and is @c /usr/local by
-    default but may be changed using wxStandardPaths::SetInstallPrefix.
+    Notice that in the examples below the string @c appname may be either just
+    the application name (as returned by wxApp::GetAppName()) or a combination
+    of the vendor name (wxApp::GetVendorName()) and the application name, with
+    a path separator between them. By default, the vendor name is used under
+    Windows and OS X but not under other Unix systems, see UseAppInfo().
+
+    The other placeholders should be self-explanatory: the string @c username
+    should be replaced with the value the name of the currently logged in user.
+    and @c prefix is only used under Unix and is @c /usr/local by default but
+    may be changed using wxStandardPaths::SetInstallPrefix().

 
     The directories returned by the methods of this class may or may not exist.
     If they don't exist, it's up to the caller to create them, wxStandardPaths doesn't
 
     The directories returned by the methods of this class may or may not exist.
     If they don't exist, it's up to the caller to create them, wxStandardPaths doesn't


@@ -319,6 +325,8 @@ public:
 
         By default, only the application name is used under Unix systems but both
         application and vendor names are used under Windows and Mac.
 
         By default, only the application name is used under Unix systems but both
         application and vendor names are used under Windows and Mac.

+
+        @since 2.9.0

     */
     void UseAppInfo(int info);
 };
     */
     void UseAppInfo(int info);
 };