X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7f5611433880457cb704eb6c66129f0aeac86ac5..0d93bb5039da4ad5dd7d7b8a7cd539388413c5f5:/docs/latex/wx/tempfile.tex diff --git a/docs/latex/wx/tempfile.tex b/docs/latex/wx/tempfile.tex index 2a196c6432..e7c0c98f68 100644 --- a/docs/latex/wx/tempfile.tex +++ b/docs/latex/wx/tempfile.tex @@ -37,61 +37,102 @@ the modifications. No base class +\wxheading{Include files} + + + \wxheading{See also:} -\helpref{wxFile}{wxfile} +\helpref{wxFile}{wxfile}\\ +\helpref{wxTempFileOutputStream}{wxtempfileoutputstream} \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. +Open the temporary file, returns {\tt true} on success, {\tt false} if an error +occurred. + +{\it strName} is the name of file to be replaced. The temporary file is always +created in the directory where {\it strName} is. In particular, if +{\it strName} doesn't include the path, it is created in the current directory +and the program should have write access to it for the function to succeed. \membersection{wxTempFile::IsOpened}\label{wxtempfileisopened} + \constfunc{bool}{IsOpened}{\void} -Returns TRUE if the file was successfully opened. +Returns {\tt true} if the file was successfully opened. + +\membersection{wxTempFile::Length}\label{wxtempfilelength} + +\constfunc{wxFileOffset}{Length}{\void} + +Returns the length of the file. + +\membersection{wxTempFile::Seek}\label{wxtempfileseek} + +\func{wxFileOffset}{Seek}{\param{wxFileOffset }{ofs}, \param{wxSeekMode }{mode = wxFromStart}} + +Seeks to the specified position. + +\membersection{wxTempFile::Tell}\label{wxtempfiletell} + +\constfunc{wxFileOffset}{Tell}{\void} + +Returns the current position or wxInvalidOffset if file is not opened or if another +error occurred. \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. +Write to the file, return {\tt true} on success, {\tt false} on failure. \membersection{wxTempFile::Write}\label{wxtempfilewrites} -\func{bool}{Write}{\param{const wxString\& }{str}} -Write to the file, return TRUE on success, FALSE on failure. +\func{bool}{Write}{\param{const wxString\& }{str}, \param{wxMBConv\&}{ conv = wxConvLibc}} + +Write to the file, return {\tt true} on success, {\tt false} on failure. + +The second argument is only meaningful in Unicode build of wxWidgets 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 -file to the old name. Returns TRUE if both actions succeeded. If FALSE is +file to the old name. Returns {\tt true} if both actions succeeded. If {\tt false} is returned it may unfortunately mean two quite different things: either that 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