]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/stdpaths.h
Removed wxPG_EX_LEGACY_VALIDATORS
[wxWidgets.git] / interface / wx / stdpaths.h
index 8c2769b3c37652eae6b905592be2d649c645219e..590c788532de85666659d699cfc29c2389541aba 100644 (file)
@@ -8,7 +8,6 @@
 
 /**
     @class wxStandardPaths
-    @wxheader{stdpaths.h}
 
     wxStandardPaths returns the standard locations in the file system and should be
     used by applications to find their data files in a portable way.
     This class is MT-safe: its methods may be called concurrently from different
     threads without additional locking.
 
+    Note that you don't allocate an instance of class wxStandardPaths, but retrieve the 
+    global standard paths object using @c wxStandardPaths::Get on which you call the 
+    desired methods.
+
     @library{wxbase}
     @category{file}
 
@@ -60,7 +63,7 @@ public:
 
         @see wxFileConfig
     */
-    wxString GetConfigDir() const;
+    virtual wxString GetConfigDir() const;
 
     /**
         Return the location of the applications global, i.e. not user-specific,
@@ -72,7 +75,7 @@ public:
 
         @see GetLocalDataDir()
     */
-    wxString GetDataDir() const;
+    virtual wxString GetDataDir() const;
 
     /**
         Return the directory containing the current user's documents.
@@ -83,7 +86,7 @@ public:
 
         @since 2.7.0
     */
-    wxString GetDocumentsDir() const;
+    virtual wxString GetDocumentsDir() const;
 
     /**
         Return the directory and the filename for the current executable.
@@ -92,7 +95,7 @@ public:
              - Windows: @c C:\\Programs\\AppFolder\\exename.exe
              - Mac: @c /Programs/exename
     */
-    wxString GetExecutablePath() const;
+    virtual wxString GetExecutablePath() const;
 
     /**
         @note This function is only available under Unix.
@@ -110,7 +113,7 @@ public:
         This is the same as GetDataDir() except
         under Unix where it returns @c /etc/appname.
     */
-    wxString GetLocalDataDir() const;
+    virtual wxString GetLocalDataDir() const;
 
     /**
         Return the localized resources directory containing the resource files of the
@@ -134,7 +137,7 @@ public:
 
         @see wxDynamicLibrary
     */
-    wxString GetPluginsDir() const;
+    virtual wxString GetPluginsDir() const;
 
     /**
         Return the directory where the application resource files are located. The
@@ -151,7 +154,7 @@ public:
 
         @see GetLocalizedResourcesDir()
     */
-    wxString GetResourcesDir() const;
+    virtual wxString GetResourcesDir() const;
 
     /**
         Return the directory for storing temporary files. To create unique temporary
@@ -161,7 +164,7 @@ public:
 
         @since 2.7.2
     */
-    wxString GetTempDir() const;
+    virtual wxString GetTempDir() const;
 
     /**
         Return the directory for the user config files:
@@ -172,23 +175,23 @@ public:
         directory, otherwise GetUserDataDir() is
         more appropriate.
     */
-    wxString GetUserConfigDir() const;
+    virtual wxString GetUserConfigDir() const;
 
     /**
         Return the directory for the user-dependent application data files:
              - Unix: @c ~/.appname
-             - Windows: @c C:\\Documents @c and @c Settings\\username\Application @c Data\appname
+             - Windows: @c C:\\Documents @c and @c Settings\\username\\Application @c Data\\appname
              - Mac: @c ~/Library/Application @c Support/appname
     */
-    wxString GetUserDataDir() const;
+    virtual wxString GetUserDataDir() const;
 
     /**
         Return the directory for user data files which shouldn't be shared with
         the other machines.
         This is the same as GetUserDataDir() for all platforms except Windows where it returns
-        @c C:\\Documents @c and @c Settings\\username\\Local @c Settings\\Application @c Data\appname
+        @c C:\\Documents @c and @c Settings\\username\\Local @c Settings\\Application @c Data\\appname
     */
-    wxString GetUserLocalDataDir() const;
+    virtual wxString GetUserLocalDataDir() const;
 
     /**
         @note This function is only available under Unix.