diff --git a/docs/changes.txt b/docs/changes.txt index 33d547c1b1..8043a1d7b7 100644 --- 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. +- 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. diff --git a/interface/wx/stdpaths.h b/interface/wx/stdpaths.h index 78e1c8c787..8de3c97ae2 100644 --- 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 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 @@ -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. + + @since 2.9.0 */ void UseAppInfo(int info); };