/////////////////////////////////////////////////////////////////////////////
// Name: stdpaths.h
-// Purpose: documentation for wxStandardPaths class
+// Purpose: interface of wxStandardPaths
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxbase}
@category{file}
- @seealso
- wxFileConfig
+ @see wxFileConfig
*/
class wxStandardPaths
{
Unix: @c /etc
Windows: @c C:\Documents and Settings\All Users\Application Data
Mac: @c /Library/Preferences
-
+
@see wxFileConfig
*/
- wxString GetConfigDir();
+ wxString GetConfigDir() const;
/**
Return the location of the applications global, i.e. not user-specific,
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
-
+
@see GetLocalDataDir()
*/
- wxString GetDataDir();
+ wxString GetDataDir() const;
/**
Return the directory containing the current user's documents.
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
+
+ @wxsince{2.7.0}
*/
- wxString GetDocumentsDir();
+ wxString GetDocumentsDir() const;
/**
Return the directory and the filename for the current executable.
Windows: @c C:\Programs\AppFolder\exename.exe
Mac: @c /Programs/exename
*/
- wxString GetExecutablePath();
+ wxString GetExecutablePath() const;
/**
@b Note: This function is only available under Unix.
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();
+ wxString GetInstallPrefix() const;
/**
Return the location for application data files which are host-specific and
This is the same as GetDataDir() except
under Unix where it returns @c /etc/@e appname.
*/
- wxString GetLocalDataDir();
+ wxString GetLocalDataDir() const;
/**
Return the localized resources directory containing the resource files of the
@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
+
+ @wxsince{2.7.0}
*/
wxString GetLocalizedResourcesDir(const wxString& lang,
- ResourceCat category = ResourceCat_None);
+ ResourceCat category = ResourceCat_None) const;
/**
Return the directory where the loadable modules (plugins) live.
Unix: @c @e prefix/lib/@e appname
Windows: the directory of the executable file
Mac: @c @e appname.app/Contents/PlugIns bundle subdirectory
-
+
@see wxDynamicLibrary
*/
- wxString GetPluginsDir();
+ wxString GetPluginsDir() const;
/**
Return the directory where the application resource files are located. The
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
-
+
+ @wxsince{2.7.0}
+
@see GetLocalizedResourcesDir()
*/
- wxString GetResourcesDir();
+ wxString GetResourcesDir() const;
/**
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
+
+ @wxsince{2.7.2}
*/
- wxString GetTempDir();
+ wxString GetTempDir() const;
/**
Return the directory for the user config files:
directory, otherwise GetUserDataDir() is
more appropriate.
*/
- wxString GetUserConfigDir();
+ wxString GetUserConfigDir() const;
/**
Return the directory for the user-dependent application data files:
appname
Mac: @c ~/Library/Application Support/@e appname
*/
- wxString GetUserDataDir();
+ wxString GetUserDataDir() const;
/**
Return the directory for user data files which shouldn't be shared with
@c C:\Documents and Settings\@e username\Local Settings\Application Data\@e
appname
*/
- wxString GetUserLocalDataDir();
+ wxString GetUserLocalDataDir() const;
/**
@b Note: This function is only available under Unix.
*/
void UseAppInfo(int info);
};
+