Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improved wxStandardPaths docs.

Browse Source
This commit is contained in:
Catalin
2015-05-29 16:46:33 +03:00
parent 0508087ce2
commit e606d83e88
1 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
interface/wx/stdpaths.h
View File

@@ -93,7 +93,8 @@ public:
Example return values: Example return values:
- Unix: @c ~/appinfo - Unix: @c ~/appinfo
- Windows: @c "C:\Documents and Settings\username\My Documents\appinfo" - Windows: @c "C:\Users\username\Documents\appinfo" or
@c "C:\Documents and Settings\username\My Documents\appinfo"
- Mac: @c ~/Documents/appinfo - Mac: @c ~/Documents/appinfo
@since 2.9.0 @since 2.9.0
@@ -104,9 +105,13 @@ public:
Return the directory containing the system config files. Return the directory containing the system config files.
Example return values: Example return values:
- Unix: @c /etc - Unix: @c /etc
- Windows: @c "C:\Documents and Settings\All Users\Application Data" - Windows: @c "C:\ProgramData\appinfo" or
@c "C:\Documents and Settings\All Users\Application Data\appinfo"
- Mac: @c /Library/Preferences - Mac: @c /Library/Preferences
@note Under Windows this includes @c appinfo which makes it inconsistent
with other ports.
@see wxFileConfig @see wxFileConfig
*/ */
virtual wxString GetConfigDir() const; virtual wxString GetConfigDir() const;
@@ -137,7 +142,8 @@ public:
Example return values: Example return values:
- Unix: @c ~ (the home directory) - Unix: @c ~ (the home directory)
- Windows: @c "C:\Documents and Settings\username\My Documents" - Windows: @c "C:\Users\username\Documents" or
@c "C:\Documents and Settings\username\My Documents"
- Mac: @c ~/Documents - Mac: @c ~/Documents
@since 2.7.0 @since 2.7.0
@@ -233,7 +239,8 @@ public:
/** /**
Return the directory for the user config files: Return the directory for the user config files:
- Unix: @c ~ (the home directory) - Unix: @c ~ (the home directory)
- Windows: @c "C:\Documents and Settings\username\Application Data" - Windows: @c "C:\Users\username\AppData\Roaming" or
@c "C:\Documents and Settings\username\Application Data"
- Mac: @c ~/Library/Preferences - Mac: @c ~/Library/Preferences
Only use this method if you have a single configuration file to put in this Only use this method if you have a single configuration file to put in this
@@ -245,7 +252,8 @@ public:
/** /**
Return the directory for the user-dependent application data files: Return the directory for the user-dependent application data files:
- Unix: @c ~/.appinfo - Unix: @c ~/.appinfo
- Windows: @c "C:\Documents and Settings\username\Application Data\appinfo" - Windows: @c "C:\Users\username\AppData\Roaming\appinfo" or
@c "C:\Documents and Settings\username\Application Data\appinfo"
- Mac: @c "~/Library/Application Support/appinfo" - Mac: @c "~/Library/Application Support/appinfo"
*/ */
virtual wxString GetUserDataDir() const; virtual wxString GetUserDataDir() const;
@@ -255,6 +263,7 @@ public:
the other machines. the other machines.
This is the same as GetUserDataDir() for all platforms except Windows where it returns This is the same as GetUserDataDir() for all platforms except Windows where it returns
@c "C:\Users\username\AppData\Local\appinfo" or
@c "C:\Documents and Settings\username\Local Settings\Application Data\appinfo" @c "C:\Documents and Settings\username\Local Settings\Application Data\appinfo"
*/ */
virtual wxString GetUserLocalDataDir() const; virtual wxString GetUserLocalDataDir() const;