/////////////////////////////////////////////////////////////////////////////
// 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() const;
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() const;
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() const;
@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) const;
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() const;
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() const;
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() const;
*/
void UseAppInfo(int info);
};
+