From 96e2aec50abc9d69ecd9b37d0901cb1f021dfe8c Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 18 Oct 2004 22:35:51 +0000
Subject: [PATCH] renamed wxFileLocator to wxStandardPaths

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@29978 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/category.tex                  |  2 +-
 docs/latex/wx/classes.tex                   |  2 +-
 docs/latex/wx/{fileloc.tex => stdpaths.tex} | 43 +++++++++------------
 include/wx/{fileloc.h => stdpaths.h}        |  8 ++--
 4 files changed, 25 insertions(+), 30 deletions(-)
 rename docs/latex/wx/{fileloc.tex => stdpaths.tex} (73%)
 rename include/wx/{fileloc.h => stdpaths.h} (92%)

diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex
index d5542b9a9e..9591db27cb 100644
--- a/docs/latex/wx/category.tex
+++ b/docs/latex/wx/category.tex
@@ -463,7 +463,7 @@ overview}{wxfileoverview} for more details.
 \twocolitem{\helpref{wxFFile}{wxffile}}{Another low-level file input/output class.}
 \twocolitem{\helpref{wxTempFile}{wxtempfile}}{Class to safely replace an existing file}
 \twocolitem{\helpref{wxTextFile}{wxtextfile}}{Class for working with text files as with arrays of lines}
-\twocolitem{\helpref{wxFileLocator}{wxfilelocator}}{Find the locations of standard directories.}
+\twocolitem{\helpref{wxStandardPaths}{wxstandardsaths}}{Paths for standard directories}
 \end{twocollist}
 
 {\large {\bf Stream classes}}
diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex
index 3062fc2ff0..5d60620c62 100644
--- a/docs/latex/wx/classes.tex
+++ b/docs/latex/wx/classes.tex
@@ -104,7 +104,6 @@
 \input fildrptg.tex
 \input filehist.tex
 \input fileistr.tex
-\input fileloc.tex
 \input filename.tex
 \input fileostr.tex
 \input filestrm.tex
@@ -291,6 +290,7 @@
 \input splitevt.tex
 \input splitter.tex
 \input splitpar.tex
+\input stdpaths.tex
 \input statbmp.tex
 \input statbox.tex
 \input sbsizer.tex
diff --git a/docs/latex/wx/fileloc.tex b/docs/latex/wx/stdpaths.tex
similarity index 73%
rename from docs/latex/wx/fileloc.tex
rename to docs/latex/wx/stdpaths.tex
index b5a01ce663..02a9d968eb 100644
--- a/docs/latex/wx/fileloc.tex
+++ b/docs/latex/wx/stdpaths.tex
@@ -1,6 +1,6 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% Name:        fileloc.tex
-%% Purpose:     wxFileLocator documentation
+%% Name:        stdpaths.tex
+%% Purpose:     wxStandardPaths documentation
 %% Author:      Vadim Zeitlin
 %% Modified by:
 %% Created:     2004-10-17
@@ -9,14 +9,14 @@
 %% License:     wxWidgets license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-\section{\class{wxFileLocator}}\label{wxfilelocator}
+\section{\class{wxStandardPaths}}\label{wxstandardsaths}
 
-wxFileLocator returns the standard locations in the file system and should be
+wxStandardPaths returns the standard locations in the file system and should be
 used by the programs to find their data files in a portable way.
 
 Please note that this is not a real class because object of this type are never
 created but more a namespace containing the class methods which are all static,
-so to use wxFileLocator simply call its methods directly.
+so to use wxStandardPaths simply call its methods directly.
 
 In the description of the methods below, the example return values are given
 for the Unix, Windows and Mac OS X systems, however please note that these are
@@ -36,7 +36,7 @@ replaced with the value returned by \helpref{wxApp::GetAppName}{wxappgetappname}
 and the name of the currently logged in user, respectively.
 
 The directories returned by the methods of this class may or may not exist. If
-they don't exist, it's up to the caller to create them, wxFileLocator doesn't
+they don't exist, it's up to the caller to create them, wxStandardPaths doesn't
 do it.
 
 Finally note that under Mac, these functions only work for the bundled
@@ -54,7 +54,7 @@ No base class
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
-\membersection{wxFileLocator::GetConfigDir}\label{wxfilelocatorgetconfigdir}
+\membersection{wxStandardPaths::GetConfigDir}\label{wxstandardsathsgetconfigdir}
 
 \func{static wxString}{GetConfigDir}{\void}
 
@@ -72,7 +72,7 @@ Example return values:
 \helpref{wxFileConfig}{wxfileconfig}
 
 
-\membersection{wxFileLocator::GetDataDir}\label{wxfilelocatorgetdatadir}
+\membersection{wxStandardPaths::GetDataDir}\label{wxstandardsathsgetdatadir}
 
 \func{static wxString}{GetDataDir}{\void}
 
@@ -88,21 +88,21 @@ Example return values:
 
 \wxheading{See also}
 
-\helpref{GetLocalDataDir}{wxfilelocatorgetlocaldatadir}
+\helpref{GetLocalDataDir}{wxstandardsathsgetlocaldatadir}
 
 
-\membersection{wxFileLocator::GetLocalDataDir}\label{wxfilelocatorgetlocaldatadir}
+\membersection{wxStandardPaths::GetLocalDataDir}\label{wxstandardsathsgetlocaldatadir}
 
 \func{static wxString}{GetLocalDataDir}{\void}
 
 Return the location for application data files which are host-specific and
 can't, or shouldn't, be shared with the other machines.
 
-This is the same as \helpref{GetDataDir()}{wxfilelocatorgetdatadir} except
+This is the same as \helpref{GetDataDir()}{wxstandardsathsgetdatadir} except
 under Unix where it returns \texttt{/etc/\textit{appname}}.
 
 
-\membersection{wxFileLocator::GetPluginsDir}\label{wxfilelocatorgetpluginsdir}
+\membersection{wxStandardPaths::GetPluginsDir}\label{wxstandardsathsgetpluginsdir}
 
 \func{static wxString}{GetPluginsDir}{\void}
 
@@ -120,7 +120,7 @@ Example return values:
 \helpref{wxDynamicLibrary}{wxdynamiclibrary}
 
 
-\membersection{wxFileLocator::GetUserConfigDir}\label{wxfilelocatorgetuserconfigdir}
+\membersection{wxStandardPaths::GetUserConfigDir}\label{wxstandardsathsgetuserconfigdir}
 
 \func{static wxString}{GetUserConfigDir}{\void}
 
@@ -132,36 +132,31 @@ Return the directory for the user config files:
 \end{itemize}
 
 Only use this method if you have a single configuration file to put in this
-directory, otherwise \helpref{GetUserDataDir()}{wxfilelocatorgetuserdatadir} is
+directory, otherwise \helpref{GetUserDataDir()}{wxstandardsathsgetuserdatadir} is
 more appropriate.
 
 
-\membersection{wxFileLocator::GetUserDataDir}\label{wxfilelocatorgetuserdatadir}
+\membersection{wxStandardPaths::GetUserDataDir}\label{wxstandardsathsgetuserdatadir}
 
 \func{static wxString}{GetUserDataDir}{\void}
 
 Return the directory for the user-dependent application data files:
 \begin{itemize}
     \item Unix: \texttt{\verb|~|/.\textit{appname}}
-    \item Windows: \texttt{C:$\backslash$Documents and Settings$\backslash$\textit{username}
-                             $\backslash$Application Data
-                             $\backslash$\textit{appname}}
+    \item Windows: \texttt{C:$\backslash$Documents and Settings$\backslash$\textit{username}$\backslash$Application Data$\backslash$\textit{appname}}
     \item Mac: \texttt{\verb|~|/Library/\textit{appname}}
 \end{itemize}
 
 
-\membersection{wxFileLocator::GetUserLocalDataDir}\label{wxfilelocatorgetuserlocaldatadir}
+\membersection{wxStandardPaths::GetUserLocalDataDir}\label{wxstandardsathsgetuserlocaldatadir}
 
 \func{static wxString}{GetUserLocalDataDir}{\void}
 
 Return the directory for user data files which shouldn't be shared with
 the other machines.
 
-This is the same as \helpref{GetUserDataDir()}{wxfilelocatorgetuserdatadir} for
+This is the same as \helpref{GetUserDataDir()}{wxstandardsathsgetuserdatadir} for
 all platforms except Windows where it returns 
-\texttt{C:$\backslash$Documents and Settings$\backslash$\textit{username}
-                             $\backslash$Local Settings
-                             $\backslash$Application Data
-                             $\backslash$\textit{appname}}
+\texttt{C:$\backslash$Documents and Settings$\backslash$\textit{username}$\backslash$Local Settings$\backslash$Application Data$\backslash$\textit{appname}}
 
 
diff --git a/include/wx/fileloc.h b/include/wx/stdpaths.h
similarity index 92%
rename from include/wx/fileloc.h
rename to include/wx/stdpaths.h
index 4e034d3e84..938f0f48b2 100644
--- a/include/wx/fileloc.h
+++ b/include/wx/stdpaths.h
@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        wx/fileloc.h
-// Purpose:     declaration of wxFileLocator class
+// Name:        wx/stdpaths.h
+// Purpose:     declaration of wxStandardPaths class
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     2004-10-17
@@ -13,10 +13,10 @@
 #define _WX_FILELOC_H_
 
 // ----------------------------------------------------------------------------
-// wxFileLocator returns the standard locations in the file system
+// wxStandardPaths returns the standard locations in the file system
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_BASE wxFileLocator
+class WXDLLIMPEXP_BASE wxStandardPaths
 {
 public:
     // return the directory with system config files:
-- 
2.50.0

