]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/stdpaths.h
Generate code using IsOk() instead of Ok() in stc.cpp.
[wxWidgets.git] / include / wx / stdpaths.h
index f32d6ee95833e2ea95b8193348e25955b36b44d0..eac35d3957af580dabbb076571904144217bcf8c 100644 (file)
@@ -17,6 +17,8 @@
 #include "wx/string.h"
 #include "wx/filefn.h"
 
+class WXDLLIMPEXP_FWD_BASE wxStandardPaths;
+
 // ----------------------------------------------------------------------------
 // wxStandardPaths returns the standard locations in the file system
 // ----------------------------------------------------------------------------
@@ -26,7 +28,7 @@
 class WXDLLIMPEXP_BASE wxStandardPathsBase
 {
 public:
-    // possible resources categorires
+    // possible resources categories
     enum ResourceCat
     {
         // no special category
@@ -50,7 +52,7 @@ public:
 
 
     // return the global standard paths object
-    static wxStandardPathsBase& Get();
+    static wxStandardPaths& Get();
 
     // return the path (directory+filename) of the running executable or
     // wxEmptyString if it couldn't be determined.
@@ -127,10 +129,15 @@ public:
 
     // return the "Documents" directory for the current user
     //
-    // C:\Documents and Settings\username\Documents under Windows,
+    // C:\Documents and Settings\username\My Documents under Windows,
     // $HOME under Unix and ~/Documents under Mac
     virtual wxString GetDocumentsDir() const;
 
+    // return the directory for the documents files used by this application:
+    // it's a subdirectory of GetDocumentsDir() constructed using the
+    // application name/vendor if it exists or just GetDocumentsDir() otherwise
+    virtual wxString GetAppDocumentsDir() const;
+
     // return the temporary directory for the current user
     virtual wxString GetTempDir() const;
 
@@ -151,8 +158,8 @@ public:
 
 
 protected:
-    // append the path component, with a leading path seperator if a
-    // path seperator or dot (.) is not already at the end of dir
+    // append the path component, with a leading path separator if a
+    // path separator or dot (.) is not already at the end of dir
     static wxString AppendPathComponent(const wxString& dir, const wxString& component);
 
     // append application information determined by m_usedAppInfo to dir