]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/stdpaths.h
several g++ 4 warning fixes
[wxWidgets.git] / interface / stdpaths.h
index 6f4940266d5ad3685bf01e0bd810d262bbde2992..2ca093e6980f6530415b8a6baa5046127015b859 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stdpaths.h
-// Purpose:     documentation for wxStandardPaths class
+// Purpose:     interface of wxStandardPaths
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -41,8 +41,7 @@
     @library{wxbase}
     @category{file}
 
-    @seealso
-    wxFileConfig
+    @see wxFileConfig
 */
 class wxStandardPaths
 {
@@ -58,10 +57,10 @@ public:
              Unix: @c /etc
              Windows: @c C:\Documents and Settings\All Users\Application Data
              Mac: @c /Library/Preferences
-        
+
         @see wxFileConfig
     */
-    wxString GetConfigDir();
+    wxString GetConfigDir() const;
 
     /**
         Return the location of the applications global, i.e. not user-specific,
@@ -70,10 +69,10 @@ public:
              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();
+    wxString GetDataDir() const;
 
     /**
         Return the directory containing the current user's documents.
@@ -81,9 +80,10 @@ public:
              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();
+    wxString GetDocumentsDir() const;
 
     /**
         Return the directory and the filename for the current executable.
@@ -92,7 +92,7 @@ public:
              Windows: @c C:\Programs\AppFolder\exename.exe
              Mac: @c /Programs/exename
     */
-    wxString GetExecutablePath();
+    wxString GetExecutablePath() const;
 
     /**
         @b Note: This function is only available under Unix.
@@ -103,7 +103,7 @@ public:
         value, otherwise tries to determine it automatically (Linux only right
         now) and finally returns the default @c /usr/local value if it failed.
     */
-    wxString GetInstallPrefix();
+    wxString GetInstallPrefix() const;
 
     /**
         Return the location for application data files which are host-specific and
@@ -111,7 +111,7 @@ public:
         This is the same as GetDataDir() except
         under Unix where it returns @c /etc/@e appname.
     */
-    wxString GetLocalDataDir();
+    wxString GetLocalDataDir() const;
 
     /**
         Return the localized resources directory containing the resource files of the
@@ -121,10 +121,11 @@ public:
         @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);
+                                      ResourceCat category = ResourceCat_None) const;
 
     /**
         Return the directory where the loadable modules (plugins) live.
@@ -132,10 +133,10 @@ public:
              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();
+    wxString GetPluginsDir() const;
 
     /**
         Return the directory where the application resource files are located. The
@@ -147,20 +148,22 @@ public:
              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();
+    wxString GetResourcesDir() const;
 
     /**
         Return the directory for storing temporary files. To create unique temporary
         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();
+    wxString GetTempDir() const;
 
     /**
         Return the directory for the user config files:
@@ -171,7 +174,7 @@ public:
         directory, otherwise GetUserDataDir() is
         more appropriate.
     */
-    wxString GetUserConfigDir();
+    wxString GetUserConfigDir() const;
 
     /**
         Return the directory for the user-dependent application data files:
@@ -180,7 +183,7 @@ public:
         appname
              Mac: @c ~/Library/Application Support/@e appname
     */
-    wxString GetUserDataDir();
+    wxString GetUserDataDir() const;
 
     /**
         Return the directory for user data files which shouldn't be shared with
@@ -190,7 +193,7 @@ public:
         @c C:\Documents and Settings\@e username\Local Settings\Application Data\@e
         appname
     */
-    wxString GetUserLocalDataDir();
+    wxString GetUserLocalDataDir() const;
 
     /**
         @b Note: This function is only available under Unix.
@@ -217,3 +220,4 @@ public:
     */
     void UseAppInfo(int info);
 };
+