X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cdbcf4c286ea989bfb8922a54d9e3f80b3fc9bcb..c3c772fa1c55f30942266cf24ffd0920747aae47:/interface/stdpaths.h diff --git a/interface/stdpaths.h b/interface/stdpaths.h index aaca998e49..8c2769b3c3 100644 --- a/interface/stdpaths.h +++ b/interface/stdpaths.h @@ -17,13 +17,13 @@ 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: the system administrator may change the standard directories locations, i.e. - 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 @e appname and @c @e username should be + 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 @e prefix is only used under Unix and is @c /usr/local by + @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 @@ -42,7 +42,7 @@ @category{file} @see wxFileConfig -*/ + */ class wxStandardPaths { public: @@ -54,9 +54,9 @@ public: /** Return the directory containing the system config files. Example return values: - Unix: @c /etc - Windows: @c C:\Documents and Settings\All Users\Application Data - Mac: @c /Library/Preferences + - Unix: @c /etc + - Windows: @c C:\\Documents @c and @c Settings\\All @c Users\\Application Data + - Mac: @c /Library/Preferences @see wxFileConfig */ @@ -66,9 +66,9 @@ public: Return the location of the applications global, i.e. not user-specific, data files. Example return values: - Unix: @c @e prefix/share/@e appname - Windows: the directory where the executable file is located - Mac: @c @e appname.app/Contents/SharedSupport bundle subdirectory + - Unix: @c prefix/share/appname + - Windows: the directory where the executable file is located + - Mac: @c appname.app/Contents/SharedSupport bundle subdirectory @see GetLocalDataDir() */ @@ -77,20 +77,20 @@ public: /** Return the directory containing the current user's documents. Example return values: - Unix: @c ~ (the home directory) - Windows: @c C:\Documents and Settings\@e username\Documents - Mac: @c ~/Documents + - Unix: @c ~ (the home directory) + - Windows: @c C:\\Documents @c and @c Settings\\username\\Documents + - Mac: @c ~/Documents - @wxsince{2.7.0} + @since 2.7.0 */ wxString GetDocumentsDir() const; /** Return the directory and the filename for the current executable. Example return values: - Unix: @c /usr/local/bin/exename - Windows: @c C:\Programs\AppFolder\exename.exe - Mac: @c /Programs/exename + - Unix: @c /usr/local/bin/exename + - Windows: @c C:\\Programs\\AppFolder\\exename.exe + - Mac: @c /Programs/exename */ wxString GetExecutablePath() const; @@ -98,8 +98,7 @@ public: @note This function is only available under Unix. Return the program installation prefix, e.g. @c /usr, @c /opt or @c /home/zeitlin. - If the prefix had been previously by - SetInstallPrefix(), returns that + If the prefix had been previously by SetInstallPrefix(), returns that value, otherwise tries to determine it automatically (Linux only right now) and finally returns the default @c /usr/local value if it failed. */ @@ -109,7 +108,7 @@ public: Return the location for application data files which are host-specific and can't, or shouldn't, be shared with the other machines. This is the same as GetDataDir() except - under Unix where it returns @c /etc/@e appname. + under Unix where it returns @c /etc/appname. */ wxString GetLocalDataDir() const; @@ -117,12 +116,11 @@ public: Return the localized resources directory containing the resource files of the specified category for the given language. In general this is just the same as @a lang subdirectory of - GetResourcesDir() (or - @c @e lang.lproj under Mac OS X) but is something quite + GetResourcesDir() (or @c lang.lproj under Mac OS X) but is something quite different for message catalog category under Unix where it returns the standard - @c @e prefix/share/locale/@e lang/LC_MESSAGES directory. + @c prefix/share/locale/lang/LC_MESSAGES directory. - @wxsince{2.7.0} + @since 2.7.0 */ wxString GetLocalizedResourcesDir(const wxString& lang, ResourceCat category = ResourceCat_None) const; @@ -130,9 +128,9 @@ public: /** Return the directory where the loadable modules (plugins) live. Example return values: - Unix: @c @e prefix/lib/@e appname - Windows: the directory of the executable file - Mac: @c @e appname.app/Contents/PlugIns bundle subdirectory + - Unix: @c prefix/lib/appname + - Windows: the directory of the executable file + - Mac: @c appname.app/Contents/PlugIns bundle subdirectory @see wxDynamicLibrary */ @@ -145,11 +143,11 @@ public: This function is the same as GetDataDir() for all platforms except Mac OS X. Example return values: - Unix: @c @e prefix/share/@e appname - Windows: the directory where the executable file is located - Mac: @c @e appname.app/Contents/Resources bundle subdirectory + - Unix: @c prefix/share/@e appname + - Windows: the directory where the executable file is located + - Mac: @c appname.app/Contents/Resources bundle subdirectory - @wxsince{2.7.0} + @since 2.7.0 @see GetLocalizedResourcesDir() */ @@ -161,15 +159,15 @@ public: it is best to use wxFileName::CreateTempFileName for correct behaviour when multiple processes are attempting to create temporary files. - @wxsince{2.7.2} + @since 2.7.2 */ wxString GetTempDir() const; /** Return the directory for the user config files: - Unix: @c ~ (the home directory) - Windows: @c C:\Documents and Settings\@e username\Application Data - Mac: @c ~/Library/Preferences + - Unix: @c ~ (the home directory) + - Windows: @c C:\\Documents @c and @c Settings\\username\\Application Data + - Mac: @c ~/Library/Preferences Only use this method if you have a single configuration file to put in this directory, otherwise GetUserDataDir() is more appropriate. @@ -178,20 +176,17 @@ public: /** Return the directory for the user-dependent application data files: - Unix: @c ~/.@e appname - Windows: @c C:\Documents and Settings\@e username\Application Data\@e - appname - Mac: @c ~/Library/Application Support/@e appname + - Unix: @c ~/.appname + - Windows: @c C:\\Documents @c and @c Settings\\username\Application @c Data\appname + - Mac: @c ~/Library/Application @c Support/appname */ wxString GetUserDataDir() const; /** Return the directory for user data files which shouldn't be shared with the other machines. - This is the same as GetUserDataDir() for - all platforms except Windows where it returns - @c C:\Documents and Settings\@e username\Local Settings\Application Data\@e - appname + This is the same as GetUserDataDir() for all platforms except Windows where it returns + @c C:\\Documents @c and @c Settings\\username\\Local @c Settings\\Application @c Data\appname */ wxString GetUserLocalDataDir() const;