added HasHandlerForPath() (modified patch 1514524)

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

diff --git a/docs/latex/wx/stdpaths.tex b/docs/latex/wx/stdpaths.tex
index 3d4868ceb44391c50a43cafe8667920a30be699d..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
 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}.
 
 \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}
 
 
 \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.
 
 \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}.
 
 \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.
 \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.


@@ -123,17 +139,19 @@ under Unix where it returns \texttt{/etc/\textit{appname}}.
 
 \membersection{wxStandardPaths::GetLocalizedResourcesDir}\label{wxstandardpathsgetlocalizedresourcesdir}
 
 
 \membersection{wxStandardPaths::GetLocalizedResourcesDir}\label{wxstandardpathsgetlocalizedresourcesdir}
 

-\func{wxString}{GetLocalizedResourcesDir}{\param{const wxChar *lang}, \param{ResourceCat }{category = ResourceCat\_None}}
+\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.
 
 
 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 
+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
 \texttt{\arg{lang}.lproj} under Mac OS X) but is something quite

-different for message catalog category under Unix where it returns the standard 
+different for message catalog category under Unix where it returns the standard

 \texttt{\textit{prefix}/share/locale/\arg{lang}/LC\_MESSAGES} directory.
 
 \texttt{\textit{prefix}/share/locale/\arg{lang}/LC\_MESSAGES} directory.
 

+\newsince{2.7.0}
+

 
 \membersection{wxStandardPaths::GetPluginsDir}\label{wxstandardpathsgetpluginsdir}
 
 
 \membersection{wxStandardPaths::GetPluginsDir}\label{wxstandardpathsgetpluginsdir}
 


@@ -171,6 +189,9 @@ Example return values:
     \item Mac: \texttt{\textit{appname}.app/Contents/PlugIns} bundle subdirectory
 \end{itemize}
 
     \item Mac: \texttt{\textit{appname}.app/Contents/PlugIns} bundle subdirectory
 \end{itemize}
 

+\newsince{2.7.0}
+
+

 \wxheading{See also}
 
 \helpref{GetLocalizedResourcesDir}{wxstandardpathsgetlocalizedresourcesdir}
 \wxheading{See also}
 
 \helpref{GetLocalizedResourcesDir}{wxstandardpathsgetlocalizedresourcesdir}


@@ -212,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
 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}}
 
 
 \texttt{C:$\backslash$Documents and Settings$\backslash$\textit{username}$\backslash$Local Settings$\backslash$Application Data$\backslash$\textit{appname}}
 
 


@@ -223,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
 \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
 \helpref{GetInstallPrefix}{wxstandardpathsgetinstallprefix} is used.
 
 Although under Linux systems the program prefix may usually be determined