s/wxHyperLinkCtrl/wxHyperlinkCtrl/

[wxWidgets.git] / docs / latex / wx / stdpaths.tex

diff --git a/docs/latex/wx/stdpaths.tex b/docs/latex/wx/stdpaths.tex
index 8e1817a43c6e333ab79cbeede03bbc86a7e33929..0b5db675e32a86488dfb53419f4a505d92582992 100644 (file)
--- a/docs/latex/wx/stdpaths.tex
+++ b/docs/latex/wx/stdpaths.tex
@@ -22,8 +22,8 @@ the Windows directory may be named \texttt{W:$\backslash$Win2003} instead of
 the default \texttt{C:$\backslash$Windows}.
 
 The strings \texttt{\textit{appname}} and \texttt{\textit{username}} should be
-replaced with the value returned by \helpref{wxApp::GetAppName}{wxappgetappname} 
-and the name of the currently logged in user, respectively. The string 
+replaced with the value returned by \helpref{wxApp::GetAppName}{wxappgetappname}
+and the name of the currently logged in user, respectively. The string
 \texttt{\textit{prefix}} is only used under Unix and is \texttt{/usr/local} by
 default but may be changed using \helpref{SetInstallPrefix}{wxstandardpathssetinstallprefix}.
 
@@ -95,16 +95,32 @@ Example return values:
 \helpref{GetLocalDataDir}{wxstandardpathsgetlocaldatadir}
 
 
+\membersection{wxStandardPaths::GetDocumentsDir}\label{wxstandardpathsgetdocumentsdir}
+
+\func{wxString}{GetDocumentsDir}{\void}
+
+Return the directory containing the current user's documents.
+
+Example return values:
+\begin{itemize}
+    \item Unix: \tt{~} (the home directory)
+    \item Windows: \texttt{C:$\backslash$Documents and Settings$\backslash$\textit{username}$\backslash$Documents}
+    \item Mac: \texttt{~/Documents}
+\end{itemize}
+
+\newsince{2.7.0}
+
+
 \membersection{wxStandardPaths::GetInstallPrefix}\label{wxstandardpathsgetinstallprefix}
 
 \func{wxString}{GetInstallPrefix}{\void}
 
 \textbf{Note: } This function is only available under Unix.
 
-Return the program installation prefix, e.g. \texttt{/usr}, \texttt{/opt} or 
+Return the program installation prefix, e.g. \texttt{/usr}, \texttt{/opt} or
 \texttt{/home/zeitlin}.
 
-If the prefix had been previously by 
+If the prefix had been previously by
 \helpref{SetInstallPrefix}{wxstandardpathssetinstallprefix}, returns that
 value, otherwise tries to determine it automatically (Linux only right
 now) and finally returns the default \texttt{/usr/local} value if it failed.
@@ -121,12 +137,51 @@ This is the same as \helpref{GetDataDir()}{wxstandardpathsgetdatadir} except
 under Unix where it returns \texttt{/etc/\textit{appname}}.
 
 
+\membersection{wxStandardPaths::GetLocalizedResourcesDir}\label{wxstandardpathsgetlocalizedresourcesdir}
+
+\func{wxString}{GetLocalizedResourcesDir}{\param{const wxChar*}{ lang}, \param{ResourceCat}{ category = ResourceCat\_None}}
+
+Return the localized resources directory containing the resource files of the
+specified category for the given language.
+
+In general this is just the same as \arg{lang} subdirectory of
+\helpref{GetResourcesDir()}{wxstandardpathsgetresourcesdir} (or
+\texttt{\arg{lang}.lproj} under Mac OS X) but is something quite
+different for message catalog category under Unix where it returns the standard
+\texttt{\textit{prefix}/share/locale/\arg{lang}/LC\_MESSAGES} directory.
+
+\newsince{2.7.0}
+
+
 \membersection{wxStandardPaths::GetPluginsDir}\label{wxstandardpathsgetpluginsdir}
 
 \func{wxString}{GetPluginsDir}{\void}
 
 Return the directory where the loadable modules (plugins) live.
 
+Example return values:
+\begin{itemize}
+    \item Unix: \texttt{\textit{prefix}/share/\textit{appname}}
+    \item Windows: the directory where the executable file is located
+    \item Mac: \texttt{\textit{appname}.app/Contents/Resources} bundle subdirectory
+\end{itemize}
+
+\wxheading{See also}
+
+\helpref{wxDynamicLibrary}{wxdynamiclibrary}
+
+
+\membersection{wxStandardPaths::GetResourcesDir}\label{wxstandardpathsgetresourcesdir}
+
+\func{wxString}{GetResourcesDir}{\void}
+
+Return the directory where the application resource files are located. The
+resources are the auxiliary data files needed for the application to run and
+include, for example, image and sound files it might use.
+
+This function is the same as \helpref{GetDataDir}{wxstandardpathsgetdatadir} for
+all platforms except Mac OS X.
+
 Example return values:
 \begin{itemize}
     \item Unix: \texttt{\textit{prefix}/lib/\textit{appname}}
@@ -134,9 +189,12 @@ Example return values:
     \item Mac: \texttt{\textit{appname}.app/Contents/PlugIns} bundle subdirectory
 \end{itemize}
 
+\newsince{2.7.0}
+
+
 \wxheading{See also}
 
-\helpref{wxDynamicLibrary}{wxdynamiclibrary}
+\helpref{GetLocalizedResourcesDir}{wxstandardpathsgetlocalizedresourcesdir}
 
 
 \membersection{wxStandardPaths::GetUserConfigDir}\label{wxstandardpathsgetuserconfigdir}
@@ -175,7 +233,7 @@ Return the directory for user data files which shouldn't be shared with
 the other machines.
 
 This is the same as \helpref{GetUserDataDir()}{wxstandardpathsgetuserdatadir} for
-all platforms except Windows where it returns 
+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}}
 
 
@@ -186,7 +244,7 @@ all platforms except Windows where it returns
 \textbf{Note:} This function is only available under Unix.
 
 Lets wxStandardPaths know about the real program installation prefix on a Unix
-system. By default, the value returned by 
+system. By default, the value returned by
 \helpref{GetInstallPrefix}{wxstandardpathsgetinstallprefix} is used.
 
 Although under Linux systems the program prefix may usually be determined