added wxMBConv parameter for wxFFile::ReadAll() and documented it (improved patch...

[wxWidgets.git] / docs / latex / wx / ffilestr.tex

diff --git a/docs/latex/wx/ffilestr.tex b/docs/latex/wx/ffilestr.tex
index d686281db847e45f078e3fa76b298db1e5fb1737..5970d5c1dd021a138b4f04e3e27f45640fc7c61d 100644 (file)
--- a/docs/latex/wx/ffilestr.tex
+++ b/docs/latex/wx/ffilestr.tex
@@ -15,6 +15,9 @@ reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
 classes reflects this difference, i.e. wxFileInputStream will report
 wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
 will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
+Related to EOF behavior, note that \helpref{SeekI()}{wxinputstreamseeki} 
+can seek beyond the end of the stream (file) and will thus not return 
+{\it wxInvalidOffset} for that.
 
 \wxheading{Derived from}
 
@@ -33,11 +36,11 @@ will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
 % ----------
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxFFileInputStream::wxFFileInputStream}
+\membersection{wxFFileInputStream::wxFFileInputStream}\label{wxffileinputstreamctor}
 
-\func{}{wxFFileInputStream}{\param{const wxString\&}{ ifileName}}
+\func{}{wxFFileInputStream}{\param{const wxString\&}{ filename}, \param{const wxChar *}{ mode = "rb"}}
 
-Opens the specified file using its {\it ifilename} name in read-only mode.
+Opens the specified file using its {\it filename} name using the specified mode.
 
 \func{}{wxFFileInputStream}{\param{wxFFile\&}{ file}}
 
@@ -47,13 +50,13 @@ Initializes a file stream in read-only mode using the file I/O object {\it file}
 
 Initializes a file stream in read-only mode using the specified file pointer {\it fp}.
 
-\membersection{wxFFileInputStream::\destruct{wxFFileInputStream}}
+\membersection{wxFFileInputStream::\destruct{wxFFileInputStream}}\label{wxffileinputstreamdtor}
 
 \func{}{\destruct{wxFFileInputStream}}{\void}
 
 Destructor.
 
-\membersection{wxFFileInputStream::Ok}
+\membersection{wxFFileInputStream::Ok}\label{wxffileinputstreamok}
 
 \constfunc{bool}{Ok}{\void}
 
@@ -76,6 +79,9 @@ reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
 classes reflects this difference, i.e. wxFileInputStream will report
 wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
 will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
+Related to EOF behavior, note that \helpref{SeekO()}{wxoutputstreamseeko} 
+can seek beyond the end of the stream (file) and will thus not return 
+{\it wxInvalidOffset} for that.
 
 \wxheading{Derived from}
 
@@ -94,12 +100,11 @@ will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
 % ----------
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxFFileOutputStream::wxFFileOutputStream}
+\membersection{wxFFileOutputStream::wxFFileOutputStream}\label{wxffileoutputstreamctor}
 
-\func{}{wxFFileOutputStream}{\param{const wxString\&}{ ofileName}}
+\func{}{wxFFileOutputStream}{\param{const wxString\&}{ filename}, \param{const wxChar *}{ mode="w+b"}}
 
-Creates a new file with {\it ofilename} name and initializes the stream in
-write-only mode. 
+Opens the file with the given {\it filename} name in the specified mode.
 
 \func{}{wxFFileOutputStream}{\param{wxFFile\&}{ file}}
 
@@ -109,13 +114,13 @@ Initializes a file stream in write-only mode using the file I/O object {\it file
 
 Initializes a file stream in write-only mode using the file descriptor {\it fp}.
 
-\membersection{wxFFileOutputStream::\destruct{wxFFileOutputStream}}
+\membersection{wxFFileOutputStream::\destruct{wxFFileOutputStream}}\label{wxffileoutputstreamdtor}
 
 \func{}{\destruct{wxFFileOutputStream}}{\void}
 
 Destructor.
 
-\membersection{wxFFileOutputStream::Ok}
+\membersection{wxFFileOutputStream::Ok}\label{wxffileoutputstreamok}
 
 \constfunc{bool}{Ok}{\void}
 
@@ -124,7 +129,7 @@ Returns true if the stream is initialized and ready.
 % -----------------------------------------------------------------------------
 % wxFFileStream
 % -----------------------------------------------------------------------------
-\section{\class{wxFFileStream}}
+\section{\class{wxFFileStream}}\label{wxffilestream}
 
 \wxheading{Derived from}
 
@@ -140,7 +145,7 @@ Returns true if the stream is initialized and ready.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxFFileStream::wxFFileStream}
+\membersection{wxFFileStream::wxFFileStream}\label{wxffilestreamctor}
 
 \func{}{wxFFileStream}{\param{const wxString\&}{ iofileName}}