projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 1ee445c7 VZ |
1 | /////////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: wx/fileloc.h | |
| 3 | // Purpose: declaration of wxFileLocator 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_FILELOC_H_ | |
| 13 | #define _WX_FILELOC_H_ | |
| 14 | ||
| 15 | // ---------------------------------------------------------------------------- | |
| 16 | // wxFileLocator returns the standard locations in the file system | |
| 17 | // ---------------------------------------------------------------------------- | |
| 18 | ||
| 19 | class WXDLLIMPEXP_BASE wxFileLocator | |
| 20 | { | |
| 21 | public: | |
| 22 | // return the directory with system config files: | |
| 23 | // /etc under Unix, c:\Windows under Windows, /Library/Preferences for Mac | |
| 24 | static wxString GetConfigDir(); | |
| 25 | ||
| 26 | // return the directory for the user config files: | |
| 27 | // $HOME under Unix, c:\Documents and Settings\username under Windows, | |
| 28 | // ~/Library/Preferences under Mac | |
| 29 | // | |
| 30 | // only use this if you have a single file to put there, otherwise | |
| 31 | // GetUserDataDir() is more appropriate | |
| 32 | static wxString GetUserConfigDir(); | |
| 33 | ||
| 34 | // return the location of the applications global, i.e. not user-specific, | |
| 35 | // data files | |
| 36 | // | |
| 37 | // /usr/share/appname under Unix, c:\Program Files\appname under Windows, | |
| 38 | // Contents app bundle directory under Mac | |
| 39 | static wxString GetDataDir(); | |
| 40 | ||
| 41 | // return the location for application data files which are host-specific | |
| 42 | // | |
| 43 | // same as GetDataDir() except under Unix where it is /etc/appname | |
| 44 | static wxString GetLocalDataDir(); | |
| 45 | ||
| 46 | // return the directory for the user-dependent application data files | |
| 47 | // | |
| 48 | // $HOME/.appname under Unix, | |
| 49 | // c:\Documents and Settings\username\Application Data\appname under Windows | |
| 50 | // and ~/Library/appname under Mac | |
| 51 | static wxString GetUserDataDir(); | |
| 52 | ||
| 53 | // return the directory for user data files which shouldn't be shared with | |
| 54 | // the other machines | |
| 55 | // | |
| 56 | // same as GetUserDataDir() for all platforms except Windows where it is | |
| 57 | // the "Local Settings\Application Data\appname" directory | |
| 58 | static wxString GetUserLocalDataDir(); | |
| 59 | ||
| 60 | // return the directory where the loadable modules (plugins) live | |
| 61 | // | |
| 62 | // /usr/lib/appname under Unix, program directory under Windows and | |
| 63 | // Contents/Plugins app bundle subdirectory under Mac | |
| 64 | static wxString GetPluginsDir(); | |
| 65 | }; | |
| 66 | ||
| 67 | #endif // _WX_FILELOC_H_ | |
| 68 |