X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3b01b1fe4cb656f39290bf7f3891667855abe601..670048b2f09d543de2ecba4800f2428fbad743e8:/include/wx/stdpaths.h diff --git a/include/wx/stdpaths.h b/include/wx/stdpaths.h index dba20f0284..7828b69e62 100644 --- a/include/wx/stdpaths.h +++ b/include/wx/stdpaths.h @@ -12,14 +12,12 @@ #ifndef _WX_STDPATHS_H_ #define _WX_STDPATHS_H_ -#include "wx/string.h" +#include "wx/defs.h" -#if defined(__WXMAC__) -class WXDLLIMPEXP_BASE wxStandardPathsCF; -#define wxStandardPaths wxStandardPathsCF -#else -class WXDLLIMPEXP_BASE wxStandardPaths; -#endif +#if wxUSE_STDPATHS + +#include "wx/string.h" +#include "wx/filefn.h" // ---------------------------------------------------------------------------- // wxStandardPaths returns the standard locations in the file system @@ -28,9 +26,28 @@ class WXDLLIMPEXP_BASE wxStandardPaths; 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 wxStandardPaths& Get(); + static wxStandardPathsBase& Get(); + // return the path (directory+filename) of the running executable or + // wxEmptyString if it couldn't be determined. + // The path is returned as an absolute path whenever possible. + // Default implementation only try to use wxApp->argv[0]. + virtual wxString GetExecutablePath() const; // return the directory with system config files: // /etc under Unix, c:\Documents and Settings\All Users\Application Data @@ -77,6 +94,37 @@ 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; + + // return the temporary directory for the current user + virtual wxString GetTempDir() const; + // virtual dtor for the base class virtual ~wxStandardPathsBase(); @@ -89,11 +137,43 @@ protected: #if defined(__WXMSW__) #include "wx/msw/stdpaths.h" -#elif defined(__WXMAC__) || defined(__WXCOCOA__) +// 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 GetExecutablePath() 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_