X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7f5611433880457cb704eb6c66129f0aeac86ac5..a9249b2eb2a40d8c71f828669045c4ddaa8dc5ff:/docs/latex/wx/tempfile.tex diff --git a/docs/latex/wx/tempfile.tex b/docs/latex/wx/tempfile.tex index 2a196c6432..01a31ffdb2 100644 --- a/docs/latex/wx/tempfile.tex +++ b/docs/latex/wx/tempfile.tex @@ -37,6 +37,10 @@ the modifications. No base class +\wxheading{Include files} + + + \wxheading{See also:} \helpref{wxFile}{wxfile} @@ -44,22 +48,25 @@ No base class \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxTempFile::wxTempFile}\label{wxtempfilewxtempfilector} + \func{}{wxTempFile}{\void} Default constructor - \helpref{Open}{wxtempfileopen} must be used to open the file. \membersection{wxTempFile::wxTempFile}\label{wxtempfilewxtempfile} + \func{}{wxTempFile}{\param{const wxString\& }{strName}} -Associates wxTempFile with the file to be replaced and opens it. You should use +Associates wxTempFile with the file to be replaced and opens it. You should use \helpref{IsOpened}{wxtempfileisopened} to verify if the constructor succeeded. \membersection{wxTempFile::Open}\label{wxtempfileopen} + \func{bool}{Open}{\param{const wxString\& }{strName}} Open the temporary file (strName is the name of file to be replaced), returns -TRUE on success, FALSE if an error occured. +TRUE on success, FALSE if an error occurred. \membersection{wxTempFile::IsOpened}\label{wxtempfileisopened} \constfunc{bool}{IsOpened}{\void} @@ -67,16 +74,22 @@ TRUE on success, FALSE if an error occured. Returns TRUE if the file was successfully opened. \membersection{wxTempFile::Write}\label{wxtempfilewrite} + \func{bool}{Write}{\param{const void }{*p}, \param{size\_t }{n}} Write to the file, return TRUE on success, FALSE on failure. \membersection{wxTempFile::Write}\label{wxtempfilewrites} -\func{bool}{Write}{\param{const wxString\& }{str}} + +\func{bool}{Write}{\param{const wxString\& }{str}, \param{wxMBConv&}{ conv = wxConvLibc}} Write to the file, return TRUE on success, FALSE on failure. +The second argument is only meaningful in Unicode build of wxWindows when +{\it conv} is used to convert {\it str} to multibyte representation. + \membersection{wxTempFile::Commit}\label{wxtempfilecommit} + \func{bool}{Commit}{\void} Validate changes: deletes the old file of name m\_strName and renames the new @@ -86,12 +99,14 @@ either the old file couldn't be deleted or that the new file couldn't be renamed to the old name. \membersection{wxTempFile::Discard}\label{wxtempfilediscard} + \func{void}{Discard}{\void} Discard changes: the old file contents is not changed, temporary file is deleted. \membersection{wxTempFile::\destruct{wxTempFile}}\label{wxtempfiledtor} + \func{}{\destruct{wxTempFile}}{\void} Destructor calls \helpref{Discard()}{wxtempfilediscard} if temporary file