#include <wx/stdpaths.h>
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, i.e. the Windows directory may be named "W:\Win2003"
instead of the default "C:\Windows"
.
The strings appname
and username
should be replaced with the value returned by wxApp::GetAppName() and the name of the currently logged in user, respectively. The string prefix
is only used under Unix and is /usr/local
by default but may be changed using wxStandardPaths::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, wxStandardPaths 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.
Note that you don't allocate an instance of class wxStandardPaths, but retrieve the global standard paths object using wxStandardPaths::Get
on which you call the desired methods.
Public Member Functions | |
virtual wxString | GetAppDocumentsDir () const |
Return the directory for the document files used by this application. | |
virtual wxString | GetConfigDir () const |
Return the directory containing the system config files. | |
virtual wxString | GetDataDir () const |
Return the location of the applications global, i.e. | |
virtual wxString | GetDocumentsDir () const |
Return the directory containing the current user's documents. | |
virtual wxString | GetExecutablePath () const |
Return the directory and the filename for the current executable. | |
wxString | GetInstallPrefix () const |
Return the program installation prefix, e.g. | |
virtual wxString | GetLocalDataDir () const |
Return the location for application data files which are host-specific and can't, or shouldn't, be shared with the other machines. | |
virtual wxString | GetLocalizedResourcesDir (const wxString &lang, ResourceCat category) const |
Return the localized resources directory containing the resource files of the specified category for the given language. | |
virtual wxString | GetPluginsDir () const |
Return the directory where the loadable modules (plugins) live. | |
virtual wxString | GetResourcesDir () const |
Return the directory where the application resource files are located. | |
virtual wxString | GetTempDir () const |
Return the directory for storing temporary files. | |
virtual wxString | GetUserConfigDir () const |
Return the directory for the user config files:
| |
virtual wxString | GetUserDataDir () const |
Return the directory for the user-dependent application data files:
| |
virtual wxString | GetUserLocalDataDir () const |
Return the directory for user data files which shouldn't be shared with the other machines. | |
void | SetInstallPrefix (const wxString &prefix) |
Lets wxStandardPaths know about the real program installation prefix on a Unix system. | |
void | UseAppInfo (int info) |
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. | |
Static Public Member Functions | |
static wxStandardPathsBase & | Get () |
Returns reference to the unique global standard paths object. |
static wxStandardPathsBase& wxStandardPaths::Get | ( | ) | [static] |
Returns reference to the unique global standard paths object.
virtual wxString wxStandardPaths::GetAppDocumentsDir | ( | ) | const [virtual] |
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:
~/appname
"C:\Documents and Settings\username\My Documents\appname"
~/Documents/appname
virtual wxString wxStandardPaths::GetConfigDir | ( | ) | const [virtual] |
Return the directory containing the system config files.
Example return values:
/etc
"C:\Documents and Settings\All Users\Application Data"
/Library/Preferences
virtual wxString wxStandardPaths::GetDataDir | ( | ) | const [virtual] |
Return the location of the applications global, i.e.
not user-specific, data files. Example return values:
prefix/share/appname
appname.app/Contents/SharedSupport
bundle subdirectory
virtual wxString wxStandardPaths::GetDocumentsDir | ( | ) | const [virtual] |
Return the directory containing the current user's documents.
Example return values:
~
(the home directory)"C:\Documents and Settings\username\My Documents"
~/Documents
virtual wxString wxStandardPaths::GetExecutablePath | ( | ) | const [virtual] |
Return the directory and the filename for the current executable.
Example return values:
/usr/local/bin/exename
"C:\Programs\AppFolder\exename.exe"
/Programs/exename
wxString wxStandardPaths::GetInstallPrefix | ( | ) | const |
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.
virtual wxString wxStandardPaths::GetLocalDataDir | ( | ) | const [virtual] |
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/appname
.
virtual wxString wxStandardPaths::GetLocalizedResourcesDir | ( | const wxString & | lang, | |
ResourceCat | category | |||
) | const [virtual] |
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.
virtual wxString wxStandardPaths::GetPluginsDir | ( | ) | const [virtual] |
Return the directory where the loadable modules (plugins) live.
Example return values:
prefix/lib/appname
appname.app/Contents/PlugIns
bundle subdirectory
virtual wxString wxStandardPaths::GetResourcesDir | ( | ) | const [virtual] |
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:
prefix/share/appname
appname.app/Contents/Resources
bundle subdirectory
virtual wxString wxStandardPaths::GetTempDir | ( | ) | const [virtual] |
Return the directory for storing temporary files.
To create unique temporary files, it is best to use wxFileName::CreateTempFileName for correct behaviour when multiple processes are attempting to create temporary files.
virtual wxString wxStandardPaths::GetUserConfigDir | ( | ) | const [virtual] |
Return the directory for the user config files:
~
(the home directory)"C:\Documents and Settings\username\Application Data"
~/Library/Preferences
. Only use this method if you have a single configuration file to put in this directory, otherwise GetUserDataDir() is more appropriate.
virtual wxString wxStandardPaths::GetUserDataDir | ( | ) | const [virtual] |
Return the directory for the user-dependent application data files:
~/
.appname"C:\Documents and Settings\username\Application Data\appname"
"~/Library/Application Support/appname"
.
virtual wxString wxStandardPaths::GetUserLocalDataDir | ( | ) | const [virtual] |
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\appname"
void wxStandardPaths::SetInstallPrefix | ( | const wxString & | prefix | ) |
Lets wxStandardPaths 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.
void wxStandardPaths::UseAppInfo | ( | int | info | ) |
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
and either one or combination of AppInfo_AppName
and AppInfo_VendorName
. The first one tells this class to not use neither application nor vendor name in the paths.
By default, only the application name is used under Unix systems but both application and vendor names are used under Windows and Mac.
![]() |
[ top ] |