X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/46a2827311c50a8184bb98e2c1c049d17968fb5d..4ff28c37c8201f104df0fffefb8d269bd327d88d:/include/wx/stdpaths.h

diff --git a/include/wx/stdpaths.h b/include/wx/stdpaths.h
index 928bd38348..1be4077d65 100644
--- a/include/wx/stdpaths.h
+++ b/include/wx/stdpaths.h
@@ -17,6 +17,7 @@
 #if wxUSE_STDPATHS
 
 #include "wx/string.h"
+#include "wx/filefn.h"
 
 // ----------------------------------------------------------------------------
 // wxStandardPaths returns the standard locations in the file system
@@ -25,6 +26,20 @@
 class WXDLLIMPEXP_BASE wxStandardPathsBase
 {
 public:
+    // possible resources categorires
+    enum ResourceCat
+    {
+        // no special category
+        ResourceCat_None,
+
+        // message catalog resources
+        ResourceCat_Messages,
+
+        // end of enum marker
+        ResourceCat_Max
+    };
+
+
     // return the global standard paths object
     static wxStandardPathsBase& Get();
 
@@ -74,6 +89,34 @@ public:
     // Contents/Plugins app bundle subdirectory under Mac
     virtual wxString GetPluginsDir() const = 0;
 
+    // get resources directory: resources are auxiliary files used by the
+    // application and include things like image and sound files
+    //
+    // same as GetDataDir() for all platforms except Mac where it returns
+    // Contents/Resources subdirectory of the app bundle
+    virtual wxString GetResourcesDir() const { return GetDataDir(); }
+
+    // get localized resources directory containing the resource files of the
+    // specified category for the given language
+    //
+    // in general this is just GetResourcesDir()/lang under Windows and Unix
+    // and GetResourcesDir()/lang.lproj under Mac but is something quite
+    // different under Unix for message catalog category (namely the standard
+    // prefix/share/locale/lang/LC_MESSAGES)
+    virtual wxString
+    GetLocalizedResourcesDir(const wxChar *lang,
+                             ResourceCat WXUNUSED(category)
+                                = ResourceCat_None) const
+    {
+        return GetResourcesDir() + wxFILE_SEP_PATH + lang;
+    }
+
+    // return the "Documents" directory for the current user
+    //
+    // C:\Documents and Settings\username\Documents under Windows,
+    // $HOME under Unix and ~/Documents under Mac
+    virtual wxString GetDocumentsDir() const;
+
 
     // virtual dtor for the base class
     virtual ~wxStandardPathsBase();
@@ -98,7 +141,7 @@ protected:
 #else
 
 // ----------------------------------------------------------------------------
-// Minimal generic implemenatation
+// Minimal generic implementation
 // ----------------------------------------------------------------------------
 
 class WXDLLIMPEXP_BASE wxStandardPaths : public wxStandardPathsBase
@@ -112,6 +155,7 @@ public:
     virtual wxString GetLocalDataDir() const { return m_prefix; }
     virtual wxString GetUserDataDir() const { return m_prefix; }
     virtual wxString GetPluginsDir() const { return m_prefix; }
+    virtual wxString GetDocumentsDir() const { return m_prefix; }
 
 private:
     wxString m_prefix;