23324ae1c7
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
249 lines
8.9 KiB
Objective-C
249 lines
8.9 KiB
Objective-C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: stdpaths.h
|
|
// Purpose: documentation for wxStandardPaths class
|
|
// Author: wxWidgets team
|
|
// RCS-ID: $Id$
|
|
// Licence: wxWindows license
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
@class wxStandardPaths
|
|
@wxheader{stdpaths.h}
|
|
|
|
wxStandardPaths returns the standard locations in the file system and should be
|
|
used by applications to find their data files in a portable way.
|
|
|
|
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 @c W:\Win2003 instead of
|
|
the default @c C:\Windows.
|
|
|
|
The strings @c @e appname and @c @e username should be
|
|
replaced with the value returned by wxApp::GetAppName
|
|
and the name of the currently logged in user, respectively. The string
|
|
@c @e prefix is only used under Unix and is @c /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.
|
|
|
|
@library{wxbase}
|
|
@category{file}
|
|
|
|
@seealso
|
|
wxFileConfig
|
|
*/
|
|
class wxStandardPaths
|
|
{
|
|
public:
|
|
/**
|
|
Returns reference to the unique global standard paths object.
|
|
*/
|
|
#define static wxStandardPathsBase Get() /* implementation is private */
|
|
|
|
/**
|
|
Return the directory containing the system config files.
|
|
|
|
Example return values:
|
|
|
|
Unix: @c /etc
|
|
Windows: @c C:\Documents and Settings\All Users\Application Data
|
|
Mac: @c /Library/Preferences
|
|
|
|
@sa wxFileConfig
|
|
*/
|
|
wxString GetConfigDir();
|
|
|
|
/**
|
|
Return the location of the applications global, i.e. not user-specific,
|
|
data files.
|
|
|
|
Example return values:
|
|
|
|
Unix: @c @e prefix/share/@e appname
|
|
Windows: the directory where the executable file is located
|
|
Mac: @c @e appname.app/Contents/SharedSupport bundle subdirectory
|
|
|
|
@sa GetLocalDataDir()
|
|
*/
|
|
wxString GetDataDir();
|
|
|
|
/**
|
|
Return the directory containing the current user's documents.
|
|
|
|
Example return values:
|
|
|
|
Unix: @c ~ (the home directory)
|
|
Windows: @c C:\Documents and Settings\@e username\Documents
|
|
Mac: @c ~/Documents
|
|
|
|
This function is new since wxWidgets version 2.7.0
|
|
*/
|
|
wxString GetDocumentsDir();
|
|
|
|
/**
|
|
Return the directory and the filename for the current executable.
|
|
|
|
Example return values:
|
|
|
|
Unix: @c /usr/local/bin/exename
|
|
Windows: @c C:\Programs\AppFolder\exename.exe
|
|
Mac: @c /Programs/exename
|
|
*/
|
|
wxString GetExecutablePath();
|
|
|
|
/**
|
|
@b Note: This function is only available under Unix.
|
|
|
|
Return the program installation prefix, e.g. @c /usr, @c /opt or
|
|
@c /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 @c /usr/local value if it failed.
|
|
*/
|
|
wxString GetInstallPrefix();
|
|
|
|
/**
|
|
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 @c /etc/@e appname.
|
|
*/
|
|
wxString GetLocalDataDir();
|
|
|
|
/**
|
|
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 @e lang subdirectory of
|
|
GetResourcesDir() (or
|
|
@c @e lang.lproj under Mac OS X) but is something quite
|
|
different for message catalog category under Unix where it returns the standard
|
|
@c @e prefix/share/locale/@e lang/LC_MESSAGES directory.
|
|
|
|
This function is new since wxWidgets version 2.7.0
|
|
*/
|
|
wxString GetLocalizedResourcesDir(const wxString& lang,
|
|
ResourceCat category = ResourceCat_None);
|
|
|
|
/**
|
|
Return the directory where the loadable modules (plugins) live.
|
|
|
|
Example return values:
|
|
|
|
Unix: @c @e prefix/lib/@e appname
|
|
Windows: the directory of the executable file
|
|
Mac: @c @e appname.app/Contents/PlugIns bundle subdirectory
|
|
|
|
@sa wxDynamicLibrary
|
|
*/
|
|
wxString GetPluginsDir();
|
|
|
|
/**
|
|
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:
|
|
|
|
Unix: @c @e prefix/share/@e appname
|
|
Windows: the directory where the executable file is located
|
|
Mac: @c @e appname.app/Contents/Resources bundle subdirectory
|
|
|
|
This function is new since wxWidgets version 2.7.0
|
|
|
|
@sa GetLocalizedResourcesDir()
|
|
*/
|
|
wxString GetResourcesDir();
|
|
|
|
/**
|
|
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.
|
|
|
|
This function is new since wxWidgets version 2.7.2
|
|
*/
|
|
wxString GetTempDir();
|
|
|
|
/**
|
|
Return the directory for the user config files:
|
|
|
|
Unix: @c ~ (the home directory)
|
|
Windows: @c C:\Documents and Settings\@e username\Application Data
|
|
Mac: @c ~/Library/Preferences
|
|
|
|
Only use this method if you have a single configuration file to put in this
|
|
directory, otherwise GetUserDataDir() is
|
|
more appropriate.
|
|
*/
|
|
wxString GetUserConfigDir();
|
|
|
|
/**
|
|
Return the directory for the user-dependent application data files:
|
|
|
|
Unix: @c ~/.@e appname
|
|
Windows: @c C:\Documents and Settings\@e username\Application Data\@e
|
|
appname
|
|
Mac: @c ~/Library/Application Support/@e appname
|
|
*/
|
|
wxString GetUserDataDir();
|
|
|
|
/**
|
|
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 C:\Documents and Settings\@e username\Local Settings\Application Data\@e
|
|
appname
|
|
*/
|
|
wxString GetUserLocalDataDir();
|
|
|
|
/**
|
|
@b Note: This function is only available under Unix.
|
|
|
|
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 @c config.h to this function.
|
|
*/
|
|
void SetInstallPrefix(const wxString& prefix);
|
|
|
|
/**
|
|
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 @e info are @c AppInfo_None and either one or
|
|
combination of @c AppInfo_AppName and @c 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.
|
|
*/
|
|
void UseAppInfo(int info);
|
|
};
|