]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/tempfile.tex
Underscore escaping fix from Angel Vidal Veiga
[wxWidgets.git] / docs / latex / wx / tempfile.tex
index 343a3ea55d3aade130d17493ebb21081517cf7d5..e7c0c98f681a8aa142f55293de1fb18af67bdac0 100644 (file)
@@ -43,7 +43,8 @@ No base class
 
 \wxheading{See also:}
 
-\helpref{wxFile}{wxfile}
+\helpref{wxFile}{wxfile}\\
+\helpref{wxTempFileOutputStream}{wxtempfileoutputstream}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -65,7 +66,7 @@ Associates wxTempFile with the file to be replaced and opens it. You should use
 
 \func{bool}{Open}{\param{const wxString\& }{strName}}
 
-Open the temporary file, returns {\tt TRUE} on success, {\tt FALSE} if an error
+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
@@ -77,21 +78,40 @@ and the program should have write access to it for the function to succeed.
 
 \constfunc{bool}{IsOpened}{\void}
 
-Returns {\tt 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 {\tt TRUE} on success, {\tt 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}, \param{wxMBConv\&}{ conv = wxConvLibc}}
 
-Write to the file, return {\tt TRUE} on success, {\tt FALSE} on failure.
+Write to the file, return {\tt true} on success, {\tt false} on failure.
 
-The second argument is only meaningful in Unicode build of wxWindows when
+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}
@@ -99,7 +119,7 @@ The second argument is only meaningful in Unicode build of wxWindows when
 \func{bool}{Commit}{\void}
 
 Validate changes: deletes the old file of name m\_strName and renames the new
-file to the old name. Returns {\tt TRUE} if both actions succeeded. If {\tt 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.