added null pointer check and assert

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

diff --git a/docs/latex/wx/stdpaths.tex b/docs/latex/wx/stdpaths.tex
index b7f08e9bf335ab5d6bade9ac161788337c47e3b6..6d5da635e88da2d427a1c9ff590a7d23e1b959fc 100644 (file)
--- a/docs/latex/wx/stdpaths.tex
+++ b/docs/latex/wx/stdpaths.tex
@@ -47,6 +47,10 @@ No base class
 
 <wx/stdpaths.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -60,7 +64,7 @@ Returns reference to the unique global standard paths object.
 
 \membersection{wxStandardPaths::GetConfigDir}\label{wxstandardpathsgetconfigdir}
 
-\func{wxString}{GetConfigDir}{\void}
+\constfunc{wxString}{GetConfigDir}{\void}
 
 Return the directory containing the system config files.
 
@@ -78,7 +82,7 @@ Example return values:
 
 \membersection{wxStandardPaths::GetDataDir}\label{wxstandardpathsgetdatadir}
 
-\func{wxString}{GetDataDir}{\void}
+\constfunc{wxString}{GetDataDir}{\void}
 
 Return the location of the applications global, i.e. not user-specific,
 data files.
@@ -97,7 +101,7 @@ Example return values:
 
 \membersection{wxStandardPaths::GetDocumentsDir}\label{wxstandardpathsgetdocumentsdir}
 
-\func{wxString}{GetDocumentsDir}{\void}
+\constfunc{wxString}{GetDocumentsDir}{\void}
 
 Return the directory containing the current user's documents.
 
@@ -111,9 +115,24 @@ Example return values:
 \newsince{2.7.0}
 
 
+\membersection{wxStandardPaths::GetExecutablePath}\label{wxstandardpathsgetexecutablepath}
+
+\constfunc{wxString}{GetExecutablePath}{\void}
+
+Return the directory and the filename for the current executable.
+
+Example return values:
+\begin{itemize}
+    \item Unix: \texttt{/usr/local/bin/exename}
+    \item Windows: \texttt{C:$\backslash$Programs$\backslash$AppFolder$\backslash$exename.exe}
+    \item Mac: \texttt{/Programs/exename}
+\end{itemize}
+
+
+
 \membersection{wxStandardPaths::GetInstallPrefix}\label{wxstandardpathsgetinstallprefix}
 
-\func{wxString}{GetInstallPrefix}{\void}
+\constfunc{wxString}{GetInstallPrefix}{\void}
 
 \textbf{Note: } This function is only available under Unix.
 
@@ -128,7 +147,7 @@ now) and finally returns the default \texttt{/usr/local} value if it failed.
 
 \membersection{wxStandardPaths::GetLocalDataDir}\label{wxstandardpathsgetlocaldatadir}
 
-\func{wxString}{GetLocalDataDir}{\void}
+\constfunc{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.
@@ -139,7 +158,7 @@ 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}}
+\constfunc{wxString}{GetLocalizedResourcesDir}{\param{const wxString\&}{ lang}, \param{ResourceCat}{ category = ResourceCat\_None}}
 
 Return the localized resources directory containing the resource files of the
 specified category for the given language.
@@ -155,15 +174,15 @@ different for message catalog category under Unix where it returns the standard
 
 \membersection{wxStandardPaths::GetPluginsDir}\label{wxstandardpathsgetpluginsdir}
 
-\func{wxString}{GetPluginsDir}{\void}
+\constfunc{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
+    \item Unix: \texttt{\textit{prefix}/lib/\textit{appname}}
+    \item Windows: the directory of the executable file
+    \item Mac: \texttt{\textit{appname}.app/Contents/PlugIns} bundle subdirectory
 \end{itemize}
 
 \wxheading{See also}
@@ -173,7 +192,7 @@ Example return values:
 
 \membersection{wxStandardPaths::GetResourcesDir}\label{wxstandardpathsgetresourcesdir}
 
-\func{wxString}{GetResourcesDir}{\void}
+\constfunc{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
@@ -184,9 +203,9 @@ all platforms except Mac OS X.
 
 Example return values:
 \begin{itemize}
-    \item Unix: \texttt{\textit{prefix}/lib/\textit{appname}}
-    \item Windows: the directory of the executable file
-    \item Mac: \texttt{\textit{appname}.app/Contents/PlugIns} bundle subdirectory
+    \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}
 
 \newsince{2.7.0}
@@ -196,10 +215,19 @@ Example return values:
 
 \helpref{GetLocalizedResourcesDir}{wxstandardpathsgetlocalizedresourcesdir}
 
+\membersection{wxStandardPaths::GetTempDir}\label{wxstandardpathsgettempdir}
+
+\constfunc{wxString}{GetTempDir}{\void}
+
+Return the directory for storing temporary files. To create unique temporary files,
+it is best to use \helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename} for correct behaviour when
+multiple processes are attempting to create temporary files.
+
+\newsince{2.7.2}
 
 \membersection{wxStandardPaths::GetUserConfigDir}\label{wxstandardpathsgetuserconfigdir}
 
-\func{wxString}{GetUserConfigDir}{\void}
+\constfunc{wxString}{GetUserConfigDir}{\void}
 
 Return the directory for the user config files:
 \begin{itemize}
@@ -215,7 +243,7 @@ more appropriate.
 
 \membersection{wxStandardPaths::GetUserDataDir}\label{wxstandardpathsgetuserdatadir}
 
-\func{wxString}{GetUserDataDir}{\void}
+\constfunc{wxString}{GetUserDataDir}{\void}
 
 Return the directory for the user-dependent application data files:
 \begin{itemize}
@@ -227,7 +255,7 @@ Return the directory for the user-dependent application data files:
 
 \membersection{wxStandardPaths::GetUserLocalDataDir}\label{wxstandardpathsgetuserlocaldatadir}
 
-\func{wxString}{GetUserLocalDataDir}{\void}
+\constfunc{wxString}{GetUserLocalDataDir}{\void}
 
 Return the directory for user data files which shouldn't be shared with
 the other machines.
@@ -252,4 +280,3 @@ automatically, portable programs should call this function. Usually the prefix
 is set during program configuration if using GNU autotools and so it is enough
 to pass its value defined in \texttt{config.h} to this function.
 
-