X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/17af82fb4c8f830f202567259472645c27724c32..c63312c472c83be6d3b935f0ceeef484a7d611ce:/docs/latex/wx/stdpaths.tex diff --git a/docs/latex/wx/stdpaths.tex b/docs/latex/wx/stdpaths.tex index c765bca647..4ef4821098 100644 --- a/docs/latex/wx/stdpaths.tex +++ b/docs/latex/wx/stdpaths.tex @@ -60,7 +60,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 +78,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 +97,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. @@ -108,10 +108,12 @@ Example return values: \item Mac: \texttt{~/Documents} \end{itemize} +\newsince{2.7.0} + \membersection{wxStandardPaths::GetInstallPrefix}\label{wxstandardpathsgetinstallprefix} -\func{wxString}{GetInstallPrefix}{\void} +\constfunc{wxString}{GetInstallPrefix}{\void} \textbf{Note: } This function is only available under Unix. @@ -126,7 +128,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. @@ -137,7 +139,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 wxChar*}{ lang}, \param{ResourceCat}{ category = ResourceCat\_None}} Return the localized resources directory containing the resource files of the specified category for the given language. @@ -148,10 +150,12 @@ 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. +\newsince{2.7.0} + \membersection{wxStandardPaths::GetPluginsDir}\label{wxstandardpathsgetpluginsdir} -\func{wxString}{GetPluginsDir}{\void} +\constfunc{wxString}{GetPluginsDir}{\void} Return the directory where the loadable modules (plugins) live. @@ -169,7 +173,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 @@ -185,19 +189,31 @@ Example return values: \item Mac: \texttt{\textit{appname}.app/Contents/PlugIns} bundle subdirectory \end{itemize} +\newsince{2.7.0} + + \wxheading{See also} \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} \item Unix: \tt{~} (the home directory) - \item Windows: \tt{C:$\backslash$Documents and Settings$\backslash$\textit{username}} + \item Windows: \tt{C:$\backslash$Documents and Settings$\backslash$\textit{username}$\backslash$Application Data} \item Mac: \tt{~/Library/Preferences} \end{itemize} @@ -208,7 +224,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} @@ -220,7 +236,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. @@ -237,7 +253,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 @@ -245,4 +261,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. -