No docs yet, just the bare interace so we can get XML for Phoenix.

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

diff --git a/interface/wx/stdpaths.h b/interface/wx/stdpaths.h
index 22a36bdb308bbc8dbd94e593bc004babecf484d2..4d251364135683aa9b886c183729f567ce4d8bd5 100644 (file)
--- a/interface/wx/stdpaths.h
+++ b/interface/wx/stdpaths.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxStandardPaths
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -22,8 +22,8 @@
     Notice that in the examples below the string @c appinfo may be either just
     the application name (as returned by wxApp::GetAppName()) or a combination
     of the vendor name (wxApp::GetVendorName()) and the application name, with
-    a path separator between them. By default, the vendor name is used under
-    Windows and OS X but not under other Unix systems, see UseAppInfo().
+    a path separator between them. By default, only the application name is
+    used, use UseAppInfo() to change this.
 
     The other placeholders should be self-explanatory: the string @c username
     should be replaced with the value the name of the currently logged in user.
@@ -54,6 +54,17 @@
 class wxStandardPaths
 {
 public:
+    /// Possible values for category parameter of GetLocalizedResourcesDir().
+    enum ResourceCat
+    {
+        /// No special category, this is the default.
+        ResourceCat_None,
+
+        /// Message catalog resources category.
+        ResourceCat_Messages
+    };
+
+
     /**
         MSW-specific function undoing the effect of IgnoreAppSubDir() calls.
 
@@ -103,11 +114,20 @@ public:
     /**
         Return the location of the applications global, i.e. not user-specific,
         data files.
+
         Example return values:
         - Unix: @c prefix/share/appinfo
         - Windows: the directory where the executable file is located
         - Mac: @c appinfo.app/Contents/SharedSupport bundle subdirectory
 
+        Under Unix (only) it is possible to override the default value returned
+        from this function by setting the value of @c WX_APPNAME_DATA_DIR
+        environment variable to the directory to use (where @c APPNAME is the
+        upper-cased value of wxApp::GetAppName()). This is useful in order to
+        be able to run applications using this function without installing them
+        as you can simply set this environment variable to the source directory
+        location to allow the application to find its files there.
+
         @see GetLocalDataDir()
     */
     virtual wxString GetDataDir() const;
@@ -131,7 +151,7 @@ public:
         Example return values:
         - Unix: @c /usr/local/bin/exename
         - Windows: @c "C:\Programs\AppFolder\exename.exe"
-        - Mac: @c /Programs/exename
+        - Mac: @c /Applications/exename.app/Contents/MacOS/exename
     */
     virtual wxString GetExecutablePath() const;
 
@@ -165,8 +185,9 @@ public:
 
         @since 2.7.0
     */
-    virtual wxString GetLocalizedResourcesDir(const wxString& lang,
-                                              ResourceCat category) const;
+    virtual wxString
+    GetLocalizedResourcesDir(const wxString& lang,
+                             ResourceCat category = ResourceCat_None) const;
 
     /**
         Return the directory where the loadable modules (plugins) live.
@@ -327,8 +348,7 @@ public:
             used combined with AppInfo_AppName, i.e. as @code AppInfo_AppName |
             AppInfo_VendorName @endcode
 
-        By default, only the application name is used under Unix systems but both
-        application and vendor names are used under Windows and Mac.
+        By default, only the application name is used.
 
         @since 2.9.0
     */