| | 1 | /////////////////////////////////////////////////////////////////////////////// |
| | 2 | // Name: wx/stdpaths.h |
| | 3 | // Purpose: declaration of wxStandardPaths class |
| | 4 | // Author: Vadim Zeitlin |
| | 5 | // Modified by: |
| | 6 | // Created: 2004-10-17 |
| | 7 | // RCS-ID: $Id$ |
| | 8 | // Copyright: (c) 2004 Vadim Zeitlin <vadim@wxwindows.org> |
| | 9 | // Licence: wxWindows licence |
| | 10 | /////////////////////////////////////////////////////////////////////////////// |
| | 11 | |
| | 12 | #ifndef _WX_STDPATHS_H_ |
| | 13 | #define _WX_STDPATHS_H_ |
| | 14 | |
| | 15 | #include "wx/string.h" |
| | 16 | |
| | 17 | class WXDLLIMPEXP_BASE wxStandardPaths; |
| | 18 | |
| | 19 | // ---------------------------------------------------------------------------- |
| | 20 | // wxStandardPaths returns the standard locations in the file system |
| | 21 | // ---------------------------------------------------------------------------- |
| | 22 | |
| | 23 | class WXDLLIMPEXP_BASE wxStandardPathsBase |
| | 24 | { |
| | 25 | public: |
| | 26 | // return the global standard paths object |
| | 27 | static wxStandardPaths& Get(); |
| | 28 | |
| | 29 | |
| | 30 | // return the directory with system config files: |
| | 31 | // /etc under Unix, c:\Documents and Settings\All Users\Application Data |
| | 32 | // under Windows, /Library/Preferences for Mac |
| | 33 | virtual wxString GetConfigDir() const = 0; |
| | 34 | |
| | 35 | // return the directory for the user config files: |
| | 36 | // $HOME under Unix, c:\Documents and Settings\username under Windows, |
| | 37 | // ~/Library/Preferences under Mac |
| | 38 | // |
| | 39 | // only use this if you have a single file to put there, otherwise |
| | 40 | // GetUserDataDir() is more appropriate |
| | 41 | virtual wxString GetUserConfigDir() const = 0; |
| | 42 | |
| | 43 | // return the location of the applications global, i.e. not user-specific, |
| | 44 | // data files |
| | 45 | // |
| | 46 | // prefix/share/appname under Unix, c:\Program Files\appname under Windows, |
| | 47 | // appname.app/Contents/SharedSupport app bundle directory under Mac |
| | 48 | virtual wxString GetDataDir() const = 0; |
| | 49 | |
| | 50 | // return the location for application data files which are host-specific |
| | 51 | // |
| | 52 | // same as GetDataDir() except under Unix where it is /etc/appname |
| | 53 | virtual wxString GetLocalDataDir() const; |
| | 54 | |
| | 55 | // return the directory for the user-dependent application data files |
| | 56 | // |
| | 57 | // $HOME/.appname under Unix, |
| | 58 | // c:\Documents and Settings\username\Application Data\appname under Windows |
| | 59 | // and ~/Library/Application Support/appname under Mac |
| | 60 | virtual wxString GetUserDataDir() const = 0; |
| | 61 | |
| | 62 | // return the directory for user data files which shouldn't be shared with |
| | 63 | // the other machines |
| | 64 | // |
| | 65 | // same as GetUserDataDir() for all platforms except Windows where it is |
| | 66 | // the "Local Settings\Application Data\appname" directory |
| | 67 | virtual wxString GetUserLocalDataDir() const; |
| | 68 | |
| | 69 | // return the directory where the loadable modules (plugins) live |
| | 70 | // |
| | 71 | // prefix/lib/appname under Unix, program directory under Windows and |
| | 72 | // Contents/Plugins app bundle subdirectory under Mac |
| | 73 | virtual wxString GetPluginsDir() const = 0; |
| | 74 | |
| | 75 | |
| | 76 | // virtual dtor for the base class |
| | 77 | virtual ~wxStandardPathsBase(); |
| | 78 | |
| | 79 | protected: |
| | 80 | // append "/appname" suffix if the app name is set (doesn't append the |
| | 81 | // slash if dir already ends with a slash or dot) |
| | 82 | static wxString AppendAppName(const wxString& dir); |
| | 83 | }; |
| | 84 | |
| | 85 | #if defined(__WXMSW__) |
| | 86 | #include "wx/msw/stdpaths.h" |
| | 87 | #elif defined(__WXMAC_OSX__) || defined(__WXCOCOA__) |
| | 88 | #include "wx/mac/stdpaths.h" |
| | 89 | #elif defined(__UNIX__) |
| | 90 | #include "wx/unix/stdpaths.h" |
| | 91 | #endif |
| | 92 | |
| | 93 | #endif // _WX_STDPATHS_H_ |
| | 94 | |
projects / wxWidgets.git / blame_incremental