using newer API

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

diff --git a/include/wx/stdpaths.h b/include/wx/stdpaths.h
index 938f0f48b2426158976ba301445875f9bf4d1af8..1be4077d6596bf96a4ae66429b6439f84e608178 100644 (file)
--- a/include/wx/stdpaths.h
+++ b/include/wx/stdpaths.h
@@ -9,19 +9,45 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

-#ifndef _WX_FILELOC_H_
-#define _WX_FILELOC_H_
+#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
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxStandardPaths returns the standard locations in the file system
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_BASE wxStandardPaths
+class WXDLLIMPEXP_BASE wxStandardPathsBase

 {
 public:
 {
 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();
+
+

     // return the directory with system config files:
     // return the directory with system config files:

-    // /etc under Unix, c:\Windows under Windows, /Library/Preferences for Mac
-    static wxString GetConfigDir();
+    // /etc under Unix, c:\Documents and Settings\All Users\Application Data
+    // under Windows, /Library/Preferences for Mac
+    virtual wxString GetConfigDir() const = 0;

 
     // return the directory for the user config files:
     // $HOME under Unix, c:\Documents and Settings\username under Windows,
 
     // return the directory for the user config files:
     // $HOME under Unix, c:\Documents and Settings\username under Windows,


@@ -29,40 +55,115 @@ public:
     //
     // only use this if you have a single file to put there, otherwise
     // GetUserDataDir() is more appropriate
     //
     // only use this if you have a single file to put there, otherwise
     // GetUserDataDir() is more appropriate

-    static wxString GetUserConfigDir();
+    virtual wxString GetUserConfigDir() const = 0;

 
     // return the location of the applications global, i.e. not user-specific,
     // data files
     //
 
     // return the location of the applications global, i.e. not user-specific,
     // data files
     //

-    // /usr/share/appname under Unix, c:\Program Files\appname under Windows,
-    // Contents app bundle directory under Mac
-    static wxString GetDataDir();
+    // prefix/share/appname under Unix, c:\Program Files\appname under Windows,
+    // appname.app/Contents/SharedSupport app bundle directory under Mac
+    virtual wxString GetDataDir() const = 0;

 
     // return the location for application data files which are host-specific
     //
     // same as GetDataDir() except under Unix where it is /etc/appname
 
     // return the location for application data files which are host-specific
     //
     // same as GetDataDir() except under Unix where it is /etc/appname

-    static wxString GetLocalDataDir();
+    virtual wxString GetLocalDataDir() const;

 
     // return the directory for the user-dependent application data files
     //
     // $HOME/.appname under Unix,
     // c:\Documents and Settings\username\Application Data\appname under Windows
 
     // return the directory for the user-dependent application data files
     //
     // $HOME/.appname under Unix,
     // c:\Documents and Settings\username\Application Data\appname under Windows

-    // and ~/Library/appname under Mac
-    static wxString GetUserDataDir();
+    // and ~/Library/Application Support/appname under Mac
+    virtual wxString GetUserDataDir() const = 0;

 
     // return the directory for user data files which shouldn't be shared with
     // the other machines
     //
     // same as GetUserDataDir() for all platforms except Windows where it is
     // the "Local Settings\Application Data\appname" directory
 
     // return the directory for user data files which shouldn't be shared with
     // the other machines
     //
     // same as GetUserDataDir() for all platforms except Windows where it is
     // the "Local Settings\Application Data\appname" directory

-    static wxString GetUserLocalDataDir();
+    virtual wxString GetUserLocalDataDir() const;

 
     // return the directory where the loadable modules (plugins) live
     //
 
     // return the directory where the loadable modules (plugins) live
     //

-    // /usr/lib/appname under Unix, program directory under Windows and
+    // prefix/lib/appname under Unix, program directory under Windows and

     // Contents/Plugins app bundle subdirectory under Mac
     // Contents/Plugins app bundle subdirectory under Mac

-    static wxString GetPluginsDir();
+    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();
+
+protected:
+    // append "/appname" suffix if the app name is set (doesn't append the
+    // slash if dir already ends with a slash or dot)
+    static wxString AppendAppName(const wxString& dir);
+};
+
+#if defined(__WXMSW__)
+    #include "wx/msw/stdpaths.h"
+// We want CoreFoundation paths on both CarbonLib and Darwin (for all ports)
+#elif defined(__WXMAC__) || defined(__DARWIN__)
+    #include "wx/mac/corefoundation/stdpaths.h"
+#elif defined(__OS2__)
+    #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 // _WX_FILELOC_H_
+#endif
+
+#endif // wxUSE_STDPATHS
+
+#endif // _WX_STDPATHS_H_