Document wxKill(wxSIGTERM) reliance on having an open window in wxMSW.

[wxWidgets.git] / include / wx / stdpaths.h

diff --git a/include/wx/stdpaths.h b/include/wx/stdpaths.h
index f32d6ee95833e2ea95b8193348e25955b36b44d0..55c0b785f8da46579b0d26b9f2fbeb1ea4f1ecfe 100644 (file)
--- a/include/wx/stdpaths.h
+++ b/include/wx/stdpaths.h
@@ -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,17 +129,19 @@ 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;
 
 
-    // ctor for the base class
-    wxStandardPathsBase();
-
     // virtual dtor for the base class
     virtual ~wxStandardPathsBase();
 
@@ -151,8 +155,12 @@ 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
+    // Ctor is protected as this is a base class which should never be created
+    // directly.
+    wxStandardPathsBase();
+
+    // 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
@@ -164,7 +172,7 @@ protected:
 };
 
 #if wxUSE_STDPATHS
-    #if defined(__WXMSW__)
+    #if defined(__WINDOWS__)
         #include "wx/msw/stdpaths.h"
         #define wxHAS_NATIVE_STDPATHS
     // We want CoreFoundation paths on both CarbonLib and Darwin (for all ports)
@@ -177,9 +185,6 @@ protected:
     #elif defined(__UNIX__)
         #include "wx/unix/stdpaths.h"
         #define wxHAS_NATIVE_STDPATHS
-    #elif defined(__PALMOS__)
-        #include "wx/palmos/stdpaths.h"
-        #define wxHAS_NATIVE_STDPATHS
     #endif
 #endif
 
@@ -206,6 +211,12 @@ public:
     virtual wxString GetPluginsDir() const { return m_prefix; }
     virtual wxString GetDocumentsDir() const { return m_prefix; }
 
+protected:
+    // Ctor is protected because wxStandardPaths::Get() should always be used
+    // to access the global wxStandardPaths object of the correct type instead
+    // of creating one of a possibly wrong type yourself.
+    wxStandardPaths() { }
+
 private:
     wxString m_prefix;
 };