]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/stdpaths.tex
added HasHandlerForPath() (modified patch 1514524)
[wxWidgets.git] / docs / latex / wx / stdpaths.tex
index 172c14cdc9a30626249a9b2b059ccdec32752a13..0b5db675e32a86488dfb53419f4a505d92582992 100644 (file)
@@ -95,6 +95,22 @@ 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}
 \membersection{wxStandardPaths::GetInstallPrefix}\label{wxstandardpathsgetinstallprefix}
 
 \func{wxString}{GetInstallPrefix}{\void}
@@ -134,6 +150,8 @@ In general this is just the same as \arg{lang} subdirectory of
 different for message catalog category under Unix where it returns the standard
 \texttt{\textit{prefix}/share/locale/\arg{lang}/LC\_MESSAGES} directory.
 
 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}
 
 
 \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}