added interface for wxFileLocator class

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

diff --git a/include/wx/fileloc.h b/include/wx/fileloc.h
new file mode 100644 (file)
index 0000000..4e034d3
--- /dev/null
+++ b/include/wx/fileloc.h
@@ -0,0 +1,68 @@
+///////////////////////////////////////////////////////////////////////////////
+// Name:        wx/fileloc.h
+// Purpose:     declaration of wxFileLocator class
+// Author:      Vadim Zeitlin
+// Modified by:
+// Created:     2004-10-17
+// RCS-ID:      $Id$
+// Copyright:   (c) 2004 Vadim Zeitlin <vadim@wxwindows.org>
+// Licence:     wxWindows licence
+///////////////////////////////////////////////////////////////////////////////
+
+#ifndef _WX_FILELOC_H_
+#define _WX_FILELOC_H_
+
+// ----------------------------------------------------------------------------
+// wxFileLocator returns the standard locations in the file system
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxFileLocator
+{
+public:
+    // return the directory with system config files:
+    // /etc under Unix, c:\Windows under Windows, /Library/Preferences for Mac
+    static wxString GetConfigDir();
+
+    // return the directory for the user config files:
+    // $HOME under Unix, c:\Documents and Settings\username under Windows,
+    // ~/Library/Preferences under Mac
+    //
+    // only use this if you have a single file to put there, otherwise
+    // GetUserDataDir() is more appropriate
+    static wxString GetUserConfigDir();
+
+    // return the location of the applications global, i.e. not user-specific,
+    // data files
+    //
+    // /usr/share/appname under Unix, c:\Program Files\appname under Windows,
+    // Contents app bundle directory under Mac
+    static wxString GetDataDir();
+
+    // return the location for application data files which are host-specific
+    //
+    // same as GetDataDir() except under Unix where it is /etc/appname
+    static wxString GetLocalDataDir();
+
+    // return the directory for the user-dependent application data files
+    //
+    // $HOME/.appname under Unix,
+    // c:\Documents and Settings\username\Application Data\appname under Windows
+    // and ~/Library/appname under Mac
+    static wxString GetUserDataDir();
+
+    // return the directory for user data files which shouldn't be shared with
+    // the other machines
+    //
+    // same as GetUserDataDir() for all platforms except Windows where it is
+    // the "Local Settings\Application Data\appname" directory
+    static wxString GetUserLocalDataDir();
+
+    // return the directory where the loadable modules (plugins) live
+    //
+    // /usr/lib/appname under Unix, program directory under Windows and
+    // Contents/Plugins app bundle subdirectory under Mac
+    static wxString GetPluginsDir();
+};
+
+#endif // _WX_FILELOC_H_
+