StandardPaths returns the standard locations in the file system and should be used by applications to find their data files in a portable way.
Note that you must not create objects of class StandardPaths directly, but use the global standard paths object returned by StandardPaths.Get (which can be of a type derived from StandardPaths and not of exactly this type) and call the methods you need on it. The object returned by Get may be customized by overriding AppTraits.GetStandardPaths methods.
In the description of the methods below, the example return values are given for the Unix, Windows and Mac OS X systems, however please note that these are just the examples and the actual values may differ. For example, under Windows: the system administrator may change the standard directories locations, e.g. the Windows directory may be named "W:\Win2003" instead of the default "C:\Windows" .
Notice that in the examples below the string appinfo may be either just the application name (as returned by App.GetAppName ) or a combination of the vendor name ( App.GetVendorName ) and the application name, with a path separator between them. By default, only the application name is used, use UseAppInfo to change this.
The other placeholders should be self-explanatory: the string username should be replaced with the value the name of the currently logged in user. and prefix is only used under Unix and is /usr/local by default but may be changed using StandardPaths.SetInstallPrefix .
The directories returned by the methods of this class may or may not exist. If they don’t exist, it’s up to the caller to create them, StandardPaths doesn’t do it.
Finally note that these functions only work with standardly packaged applications. I.e. under Unix you should follow the standard installation conventions and under Mac you should create your application bundle according to the Apple guidelines. Again, this class doesn’t help you to do it.
This class is MT-safe: its methods may be called concurrently from different threads without additional locking.
See also
Get | Returns reference to the unique global standard paths object. |
GetAppDocumentsDir | Return the directory for the document files used by this application. |
GetConfigDir | Return the directory containing the system config files. |
GetDataDir | Return the location of the applications global, i.e. |
GetDocumentsDir | Return the directory containing the current user’s documents. |
GetExecutablePath | Return the directory and the filename for the current executable. |
GetInstallPrefix | Return the program installation prefix, e.g. |
GetLocalDataDir | Return the location for application data files which are host-specific and can’t, or shouldn’t, be shared with the other machines. |
GetLocalizedResourcesDir | Return the localized resources directory containing the resource files of the specified category for the given language. |
GetPluginsDir | Return the directory where the loadable modules (plugins) live. |
GetResourcesDir | Return the directory where the application resource files are located. |
GetTempDir | Return the directory for storing temporary files. |
GetUserConfigDir | Return the directory for the user config files: |
GetUserDataDir | Return the directory for the user-dependent application data files: |
GetUserLocalDataDir | Return the directory for user data files which shouldn’t be shared with the other machines. |
MSWGetShellDir | Returns location of Windows shell special folder. |
SetInstallPrefix | Lets StandardPaths know about the real program installation prefix on a Unix system. |
UseAppInfo | Controls what application information is used when constructing paths that should be unique to this program, such as the application data directory, the plugins directory on Unix, etc. |
StandardPaths returns the standard locations in the file system and should be used by applications to find their data files in a portable way.
Returns reference to the unique global standard paths object.
Return type: | StandardPaths |
---|
Return the directory for the document files used by this application.
If the application-specific directory doesn’t exist, this function returns GetDocumentsDir .
Example return values:
Return type: | string |
---|
New in version 2.9.0.
See also
Return the directory containing the system config files.
Example return values:
Return type: | string |
---|
See also
Return the location of the applications global, i.e.
not user-specific, data files.
Example return values:
Under Unix (only) it is possible to override the default value returned from this function by setting the value of WX_APPNAME_DATA_DIR environment variable to the directory to use (where APPNAME is the upper-cased value of App.GetAppName ). This is useful in order to be able to run applications using this function without installing them as you can simply set this environment variable to the source directory location to allow the application to find its files there.
Return type: | string |
---|
See also
Return the directory containing the current user’s documents.
Example return values:
Return type: | string |
---|
New in version 2.7.0.
See also
Return the directory and the filename for the current executable.
Example return values:
Return type: | string |
---|
Return the program installation prefix, e.g.
/usr , /opt or /home/zeitlin .
If the prefix had been previously by SetInstallPrefix , returns that value, otherwise tries to determine it automatically (Linux only right now) and finally returns the default /usr/local value if it failed.
Return type: | string |
---|
Availability
Only available for OS2, GTK.
Note
This function is only available under Unix platforms (but not limited to wxGTK mentioned below).
Return the location for application data files which are host-specific and can’t, or shouldn’t, be shared with the other machines.
This is the same as GetDataDir except under Unix where it returns /etc/appinfo .
Return type: | string |
---|
Return the localized resources directory containing the resource files of the specified category for the given language.
In general this is just the same as lang subdirectory of GetResourcesDir (or lang.lproj under Mac OS X) but is something quite different for message catalog category under Unix where it returns the standard prefix/share/locale/lang/LC_MESSAGES directory.
Parameters: |
|
---|---|
Return type: | string |
New in version 2.7.0.
Return the directory where the loadable modules (plugins) live.
Example return values:
Return type: | string |
---|
See also
DynamicLibrary
Return the directory where the application resource files are located.
The resources are the auxiliary data files needed for the application to run and include, for example, image and sound files it might use.
This function is the same as GetDataDir for all platforms except Mac OS X. Example return values:
Return type: | string |
---|
New in version 2.7.0.
See also
Return the directory for storing temporary files.
To create unique temporary files, it is best to use FileName.CreateTempFileName for correct behaviour when multiple processes are attempting to create temporary files.
Return type: | string |
---|
New in version 2.7.2.
Return the directory for the user config files:
Only use this method if you have a single configuration file to put in this directory, otherwise GetUserDataDir is more appropriate as the latter adds appinfo to the path, unlike this function.
Return type: | string |
---|
Return the directory for the user-dependent application data files:
Return type: | string |
---|
Return the directory for user data files which shouldn’t be shared with the other machines.
This is the same as GetUserDataDir for all platforms except Windows where it returns "C:\Documents and Settings\username\Local Settings\Application Data\appinfo"
Return type: | string |
---|
Returns location of Windows shell special folder.
This function is, by definition, MSW-specific. It can be used to access pre-defined shell directories not covered by the existing methods of this class, e.g.:
if wx.Platform == '__WXMSW__':
# get the location of files waiting to be burned on a CD
cdburnArea = wx.StandardPaths.MSWGetShellDir(CSIDL_CDBURN_AREA)
# endif __WXMSW__
Parameters: | csidl (int) – |
---|---|
Return type: | string |
New in version 2.9.1.
Lets StandardPaths know about the real program installation prefix on a Unix system.
By default, the value returned by GetInstallPrefix is used.
Although under Linux systems the program prefix may usually be determined automatically, portable programs should call this function. Usually the prefix is set during program configuration if using GNU autotools and so it is enough to pass its value defined in config.h to this function.
Parameters: | prefix (string) – |
---|
Availability
Only available for OS2, GTK.
Note
This function is only available under Unix platforms (but not limited to wxGTK mentioned below).
Controls what application information is used when constructing paths that should be unique to this program, such as the application data directory, the plugins directory on Unix, etc.
Valid values for info are:
AppInfo_None: don’t use neither application nor vendor name in the paths.
AppInfo_AppName: use the application name in the paths.
AppInfo_VendorName: use the vendor name in the paths, usually used combined with AppInfo_AppName, i.e. as
info = AppInfo_AppName | AppInfo_VendorName
By default, only the application name is used.
Parameters: | info (int) – |
---|
New in version 2.9.0.
See GetConfigDir
See GetDataDir
See GetDocumentsDir
See GetInstallPrefix and SetInstallPrefix
See GetLocalDataDir
See GetPluginsDir
See GetResourcesDir
See GetTempDir
See GetUserConfigDir
See GetUserDataDir