AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added GetTempDir

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42343 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart 2006-10-24 14:26:00 +00:00
parent f49c76e5d8
commit ecf9559d57
3 changed files with 30 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/latex/wx/stdpaths.tex
View File

@ -60,7 +60,7 @@ Returns reference to the unique global standard paths object.
\membersection{wxStandardPaths::GetConfigDir}\label{wxstandardpathsgetconfigdir} \membersection{wxStandardPaths::GetConfigDir}\label{wxstandardpathsgetconfigdir}
\func{wxString}{GetConfigDir}{\void} \constfunc{wxString}{GetConfigDir}{\void}
Return the directory containing the system config files. Return the directory containing the system config files.
@ -78,7 +78,7 @@ Example return values:
\membersection{wxStandardPaths::GetDataDir}\label{wxstandardpathsgetdatadir} \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, Return the location of the applications global, i.e. not user-specific,
data files. data files.
@ -97,7 +97,7 @@ Example return values:
\membersection{wxStandardPaths::GetDocumentsDir}\label{wxstandardpathsgetdocumentsdir} \membersection{wxStandardPaths::GetDocumentsDir}\label{wxstandardpathsgetdocumentsdir}
\func{wxString}{GetDocumentsDir}{\void} \constfunc{wxString}{GetDocumentsDir}{\void}
Return the directory containing the current user's documents. Return the directory containing the current user's documents.
@ -113,7 +113,7 @@ Example return values:
\membersection{wxStandardPaths::GetInstallPrefix}\label{wxstandardpathsgetinstallprefix} \membersection{wxStandardPaths::GetInstallPrefix}\label{wxstandardpathsgetinstallprefix}
\func{wxString}{GetInstallPrefix}{\void} \constfunc{wxString}{GetInstallPrefix}{\void}
\textbf{Note: } This function is only available under Unix. \textbf{Note: } This function is only available under Unix.
@ -128,7 +128,7 @@ now) and finally returns the default \texttt{/usr/local} value if it failed.
\membersection{wxStandardPaths::GetLocalDataDir}\label{wxstandardpathsgetlocaldatadir} \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 Return the location for application data files which are host-specific and
can't, or shouldn't, be shared with the other machines. can't, or shouldn't, be shared with the other machines.
@ -139,7 +139,7 @@ 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}} \constfunc{wxString}{GetLocalizedResourcesDir}{\param{const wxChar*}{ lang}, \param{ResourceCat}{ category = ResourceCat\_None}}
Return the localized resources directory containing the resource files of the Return the localized resources directory containing the resource files of the
specified category for the given language. specified category for the given language.
@ -155,7 +155,7 @@ different for message catalog category under Unix where it returns the standard
\membersection{wxStandardPaths::GetPluginsDir}\label{wxstandardpathsgetpluginsdir} \membersection{wxStandardPaths::GetPluginsDir}\label{wxstandardpathsgetpluginsdir}
\func{wxString}{GetPluginsDir}{\void} \constfunc{wxString}{GetPluginsDir}{\void}
Return the directory where the loadable modules (plugins) live. Return the directory where the loadable modules (plugins) live.
@ -173,7 +173,7 @@ Example return values:
\membersection{wxStandardPaths::GetResourcesDir}\label{wxstandardpathsgetresourcesdir} \membersection{wxStandardPaths::GetResourcesDir}\label{wxstandardpathsgetresourcesdir}
\func{wxString}{GetResourcesDir}{\void} \constfunc{wxString}{GetResourcesDir}{\void}
Return the directory where the application resource files are located. The Return the directory where the application resource files are located. The
resources are the auxiliary data files needed for the application to run and resources are the auxiliary data files needed for the application to run and
@ -196,10 +196,19 @@ Example return values:
\helpref{GetLocalizedResourcesDir}{wxstandardpathsgetlocalizedresourcesdir} \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} \membersection{wxStandardPaths::GetUserConfigDir}\label{wxstandardpathsgetuserconfigdir}
\func{wxString}{GetUserConfigDir}{\void} \constfunc{wxString}{GetUserConfigDir}{\void}
Return the directory for the user config files: Return the directory for the user config files:
\begin{itemize} \begin{itemize}
@ -215,7 +224,7 @@ more appropriate.
\membersection{wxStandardPaths::GetUserDataDir}\label{wxstandardpathsgetuserdatadir} \membersection{wxStandardPaths::GetUserDataDir}\label{wxstandardpathsgetuserdatadir}
\func{wxString}{GetUserDataDir}{\void} \constfunc{wxString}{GetUserDataDir}{\void}
Return the directory for the user-dependent application data files: Return the directory for the user-dependent application data files:
\begin{itemize} \begin{itemize}
@ -227,7 +236,7 @@ Return the directory for the user-dependent application data files:
\membersection{wxStandardPaths::GetUserLocalDataDir}\label{wxstandardpathsgetuserlocaldatadir} \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 Return the directory for user data files which shouldn't be shared with
the other machines. the other machines.
@ -244,7 +253,7 @@ all platforms except Windows where it returns
\textbf{Note:} This function is only available under Unix. \textbf{Note:} This function is only available under Unix.
Lets wxStandardPaths know about the real program installation prefix on a 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. \helpref{GetInstallPrefix}{wxstandardpathsgetinstallprefix} is used.
Although under Linux systems the program prefix may usually be determined Although under Linux systems the program prefix may usually be determined
@ -252,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 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. to pass its value defined in \texttt{config.h} to this function.

3
include/wx/stdpaths.h
View File

@ -117,6 +117,9 @@ public:
// $HOME under Unix and ~/Documents under Mac // $HOME under Unix and ~/Documents under Mac
virtual wxString GetDocumentsDir() const; virtual wxString GetDocumentsDir() const;
// return the temporary directory for the current user
virtual wxString GetTempDir() const;
// virtual dtor for the base class // virtual dtor for the base class
virtual ~wxStandardPathsBase(); virtual ~wxStandardPathsBase();

6
src/common/stdpbase.cpp
View File

@ -78,6 +78,12 @@ wxString wxStandardPathsBase::GetDocumentsDir() const
return wxFileName::GetHomeDir(); return wxFileName::GetHomeDir();
} }
// return the temporary directory for the current user
wxString wxStandardPathsBase::GetTempDir() const
{
return wxFileName::GetTempDir();
}
/* static */ /* static */
wxString wxStandardPathsBase::AppendAppName(const wxString& dir) wxString wxStandardPathsBase::AppendAppName(const wxString& dir)
{ {