X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d6f42b1baee29e3f3c1deeaae1f2d702b1a8ebe5..52170c5b4419c63d6e0083df411aad420395ec98:/include/wx/stdpaths.h?ds=inline diff --git a/include/wx/stdpaths.h b/include/wx/stdpaths.h index c4b3cb2b7b..9f6c619f63 100644 --- a/include/wx/stdpaths.h +++ b/include/wx/stdpaths.h @@ -14,20 +14,40 @@ #include "wx/defs.h" -#if wxUSE_STDPATHS - #include "wx/string.h" +#include "wx/filefn.h" // ---------------------------------------------------------------------------- // wxStandardPaths returns the standard locations in the file system // ---------------------------------------------------------------------------- +// NB: This is always compiled in, wxUSE_STDPATHS=0 only disables native +// wxStandardPaths class, but a minimal version is always available 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(); + // 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 @@ -74,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 wxString& 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(); @@ -84,42 +135,53 @@ protected: 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 +#if wxUSE_STDPATHS + #if defined(__WXMSW__) + #include "wx/msw/stdpaths.h" + #define wxHAS_NATIVE_STDPATHS + // We want CoreFoundation paths on both CarbonLib and Darwin (for all ports) + #elif defined(__WXMAC__) || defined(__DARWIN__) + #include "wx/mac/corefoundation/stdpaths.h" + #define wxHAS_NATIVE_STDPATHS + #elif defined(__OS2__) + #include "wx/os2/stdpaths.h" + #define wxHAS_NATIVE_STDPATHS + #elif defined(__UNIX__) + #include "wx/unix/stdpaths.h" + #define wxHAS_NATIVE_STDPATHS + #elif defined(__PALMOS__) + #include "wx/palmos/stdpaths.h" + #define wxHAS_NATIVE_STDPATHS + #endif +#endif // ---------------------------------------------------------------------------- // Minimal generic implementation // ---------------------------------------------------------------------------- +// NB: Note that this minimal implementation is compiled in even if +// wxUSE_STDPATHS=0, so that our code can still use wxStandardPaths. + +#ifndef wxHAS_NATIVE_STDPATHS 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 // !wxHAS_NATIVE_STDPATHS #endif // _WX_STDPATHS_H_