]>
Commit | Line | Data |
---|---|---|
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/defs.h" | |
16 | ||
17 | #if wxUSE_STDPATHS | |
18 | ||
19 | #include "wx/string.h" | |
20 | #include "wx/filefn.h" | |
21 | ||
22 | // ---------------------------------------------------------------------------- | |
23 | // wxStandardPaths returns the standard locations in the file system | |
24 | // ---------------------------------------------------------------------------- | |
25 | ||
26 | class WXDLLIMPEXP_BASE wxStandardPathsBase | |
27 | { | |
28 | public: | |
29 | // possible resources categorires | |
30 | enum ResourceCat | |
31 | { | |
32 | // no special category | |
33 | ResourceCat_None, | |
34 | ||
35 | // message catalog resources | |
36 | ResourceCat_Messages, | |
37 | ||
38 | // end of enum marker | |
39 | ResourceCat_Max | |
40 | }; | |
41 | ||
42 | ||
43 | // return the global standard paths object | |
44 | static wxStandardPathsBase& Get(); | |
45 | ||
46 | ||
47 | // return the directory with system config files: | |
48 | // /etc under Unix, c:\Documents and Settings\All Users\Application Data | |
49 | // under Windows, /Library/Preferences for Mac | |
50 | virtual wxString GetConfigDir() const = 0; | |
51 | ||
52 | // return the directory for the user config files: | |
53 | // $HOME under Unix, c:\Documents and Settings\username under Windows, | |
54 | // ~/Library/Preferences under Mac | |
55 | // | |
56 | // only use this if you have a single file to put there, otherwise | |
57 | // GetUserDataDir() is more appropriate | |
58 | virtual wxString GetUserConfigDir() const = 0; | |
59 | ||
60 | // return the location of the applications global, i.e. not user-specific, | |
61 | // data files | |
62 | // | |
63 | // prefix/share/appname under Unix, c:\Program Files\appname under Windows, | |
64 | // appname.app/Contents/SharedSupport app bundle directory under Mac | |
65 | virtual wxString GetDataDir() const = 0; | |
66 | ||
67 | // return the location for application data files which are host-specific | |
68 | // | |
69 | // same as GetDataDir() except under Unix where it is /etc/appname | |
70 | virtual wxString GetLocalDataDir() const; | |
71 | ||
72 | // return the directory for the user-dependent application data files | |
73 | // | |
74 | // $HOME/.appname under Unix, | |
75 | // c:\Documents and Settings\username\Application Data\appname under Windows | |
76 | // and ~/Library/Application Support/appname under Mac | |
77 | virtual wxString GetUserDataDir() const = 0; | |
78 | ||
79 | // return the directory for user data files which shouldn't be shared with | |
80 | // the other machines | |
81 | // | |
82 | // same as GetUserDataDir() for all platforms except Windows where it is | |
83 | // the "Local Settings\Application Data\appname" directory | |
84 | virtual wxString GetUserLocalDataDir() const; | |
85 | ||
86 | // return the directory where the loadable modules (plugins) live | |
87 | // | |
88 | // prefix/lib/appname under Unix, program directory under Windows and | |
89 | // Contents/Plugins app bundle subdirectory under Mac | |
90 | virtual wxString GetPluginsDir() const = 0; | |
91 | ||
92 | // get resources directory: resources are auxiliary files used by the | |
93 | // application and include things like image and sound files | |
94 | // | |
95 | // same as GetDataDir() for all platforms except Mac where it returns | |
96 | // Contents/Resources subdirectory of the app bundle | |
97 | virtual wxString GetResourcesDir() const { return GetDataDir(); } | |
98 | ||
99 | // get localized resources directory containing the resource files of the | |
100 | // specified category for the given language | |
101 | // | |
102 | // in general this is just GetResourcesDir()/lang under Windows and Unix | |
103 | // and GetResourcesDir()/lang.lproj under Mac but is something quite | |
104 | // different under Unix for message catalog category (namely the standard | |
105 | // prefix/share/locale/lang/LC_MESSAGES) | |
106 | virtual wxString | |
107 | GetLocalizedResourcesDir(const wxChar *lang, | |
108 | ResourceCat WXUNUSED(category) | |
109 | = ResourceCat_None) const | |
110 | { | |
111 | return GetResourcesDir() + wxFILE_SEP_PATH + lang; | |
112 | } | |
113 | ||
114 | ||
115 | // virtual dtor for the base class | |
116 | virtual ~wxStandardPathsBase(); | |
117 | ||
118 | protected: | |
119 | // append "/appname" suffix if the app name is set (doesn't append the | |
120 | // slash if dir already ends with a slash or dot) | |
121 | static wxString AppendAppName(const wxString& dir); | |
122 | }; | |
123 | ||
124 | #if defined(__WXMSW__) | |
125 | #include "wx/msw/stdpaths.h" | |
126 | // We want CoreFoundation paths on both CarbonLib and Darwin (for all ports) | |
127 | #elif defined(__WXMAC__) || defined(__DARWIN__) | |
128 | #include "wx/mac/corefoundation/stdpaths.h" | |
129 | #elif defined(__OS2__) | |
130 | #include "wx/os2/stdpaths.h" | |
131 | #elif defined(__UNIX__) | |
132 | #include "wx/unix/stdpaths.h" | |
133 | #elif defined(__PALMOS__) | |
134 | #include "wx/palmos/stdpaths.h" | |
135 | #else | |
136 | ||
137 | // ---------------------------------------------------------------------------- | |
138 | // Minimal generic implementation | |
139 | // ---------------------------------------------------------------------------- | |
140 | ||
141 | class WXDLLIMPEXP_BASE wxStandardPaths : public wxStandardPathsBase | |
142 | { | |
143 | public: | |
144 | void SetInstallPrefix(const wxString& prefix) { m_prefix = prefix; } | |
145 | wxString GetInstallPrefix() const { return m_prefix; } | |
146 | virtual wxString GetConfigDir() const { return m_prefix; } | |
147 | virtual wxString GetUserConfigDir() const { return m_prefix; } | |
148 | virtual wxString GetDataDir() const { return m_prefix; } | |
149 | virtual wxString GetLocalDataDir() const { return m_prefix; } | |
150 | virtual wxString GetUserDataDir() const { return m_prefix; } | |
151 | virtual wxString GetPluginsDir() const { return m_prefix; } | |
152 | ||
153 | private: | |
154 | wxString m_prefix; | |
155 | }; | |
156 | ||
157 | #endif | |
158 | ||
159 | #endif // wxUSE_STDPATHS | |
160 | ||
161 | #endif // _WX_STDPATHS_H_ | |
162 |