X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4701dc09838c3da46a8bc2836265a7dffee541ee..5b88a837ba75928cd3835a6b97ae2bf5ad983a6e:/interface/wx/stdpaths.h?ds=sidebyside diff --git a/interface/wx/stdpaths.h b/interface/wx/stdpaths.h index ee4c21030e..af4dac1d29 100644 --- a/interface/wx/stdpaths.h +++ b/interface/wx/stdpaths.h @@ -51,7 +51,24 @@ public: /** Returns reference to the unique global standard paths object. */ - static wxStandardPathsBase Get(); + static wxStandardPathsBase& Get(); + + /** + Return the directory for the document files used by this application. + + If the application-specific directory doesn't exist, this function + returns GetDocumentsDir(). + + Example return values: + - Unix: @c ~/appname + - Windows: @c "C:\Documents and Settings\username\My Documents\appname" + - Mac: @c ~/Documents/appname + + @since 2.9.0 + + @see GetAppDocumentsDir() + */ + virtual wxString GetAppDocumentsDir() const; /** Return the directory containing the system config files. @@ -78,12 +95,15 @@ public: /** Return the directory containing the current user's documents. + Example return values: - Unix: @c ~ (the home directory) - Windows: @c "C:\Documents and Settings\username\My Documents" - Mac: @c ~/Documents @since 2.7.0 + + @see GetAppDocumentsDir() */ virtual wxString GetDocumentsDir() const; @@ -126,8 +146,8 @@ public: @since 2.7.0 */ - wxString GetLocalizedResourcesDir(const wxString& lang, - ResourceCat category = ResourceCat_None) const; + virtual wxString GetLocalizedResourcesDir(const wxString& lang, + ResourceCat category) const; /** Return the directory where the loadable modules (plugins) live.