X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/94e0018723919fe2ca2f5b5f0a42804c16dbf3a1..36a0190ebd5bd9a7302f60f6dcd608b80574e21c:/interface/wx/stdpaths.h diff --git a/interface/wx/stdpaths.h b/interface/wx/stdpaths.h index b4f577662f..2c49a2f574 100644 --- a/interface/wx/stdpaths.h +++ b/interface/wx/stdpaths.h @@ -2,7 +2,6 @@ // Name: stdpaths.h // Purpose: interface of wxStandardPaths // Author: wxWidgets team -// RCS-ID: $Id$ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -115,7 +114,7 @@ public: virtual wxString GetConfigDir() const; /** - Return the location of the applications global, i.e. not user-specific, + Return the location of the applications global, i.e.\ not user-specific, data files. Example return values: @@ -159,13 +158,16 @@ public: virtual wxString GetExecutablePath() const; /** - Return the program installation prefix, e.g. @c /usr, @c /opt or @c /home/zeitlin. + 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 value, otherwise tries to determine it automatically (Linux only right now) and finally returns the default @c /usr/local value if it failed. - @note This function is only available under Unix. + @note This function is only available under Unix platforms (but not limited + to wxGTK mentioned below). + + @onlyfor{wxos2,wxgtk} */ wxString GetInstallPrefix() const; @@ -237,7 +239,8 @@ public: - 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. + directory, otherwise GetUserDataDir() is more appropriate as the latter + adds @c appinfo to the path, unlike this function. */ virtual wxString GetUserConfigDir() const; @@ -334,7 +337,10 @@ public: is set during program configuration if using GNU autotools and so it is enough to pass its value defined in @c config.h to this function. - @note This function is only available under Unix. + @note This function is only available under Unix platforms (but not limited + to wxGTK mentioned below). + + @onlyfor{wxos2,wxgtk} */ void SetInstallPrefix(const wxString& prefix); @@ -356,5 +362,15 @@ public: @since 2.9.0 */ void UseAppInfo(int info); + +protected: + /** + Protected default constructor. + + This constructor is protected in order to prevent creation of objects + of this class as Get() should be used instead to access the unique + global wxStandardPaths object of the correct type. + */ + wxStandardPaths(); };