Added GetTempDir

[wxWidgets.git] / include / wx / stdpaths.h

diff --git a/include/wx/stdpaths.h b/include/wx/stdpaths.h
index 5877ca4450d6de49dcd35dd85cbc8c5e39298082..1be4077d6596bf96a4ae66429b6439f84e608178 100644 (file)
--- a/include/wx/stdpaths.h
+++ b/include/wx/stdpaths.h
@@ -12,7 +12,12 @@
 #ifndef _WX_STDPATHS_H_
 #define _WX_STDPATHS_H_
 
+#include "wx/defs.h"
+
+#if wxUSE_STDPATHS
+
 #include "wx/string.h"
+#include "wx/filefn.h"
 
 // ----------------------------------------------------------------------------
 // wxStandardPaths returns the standard locations in the file system
@@ -21,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();
 
@@ -70,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();
@@ -89,7 +136,34 @@ protected:
     #include "wx/os2/stdpaths.h"
 #elif defined(__UNIX__)
     #include "wx/unix/stdpaths.h"
+#elif defined(__PALMOS__)
+    #include "wx/palmos/stdpaths.h"
+#else
+
+// ----------------------------------------------------------------------------
+// Minimal generic implementation
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxStandardPaths : public wxStandardPathsBase
+{
+public:
+    void SetInstallPrefix(const wxString& prefix) { m_prefix = prefix; }
+    wxString GetInstallPrefix() const { return m_prefix; }
+    virtual wxString GetConfigDir() const { return m_prefix; }
+    virtual wxString GetUserConfigDir() const { return m_prefix; }
+    virtual wxString GetDataDir() const { return m_prefix; }
+    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;
+};
+
 #endif
 
+#endif // wxUSE_STDPATHS
+
 #endif // _WX_STDPATHS_H_