ugh. Nesting the (per class) plugin sentries can require them to

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

diff --git a/docs/latex/wx/strmfile.tex b/docs/latex/wx/strmfile.tex
index c96b0610222471d6c99d12fcdf2321386cffa062..5af7ab2b07915d895cee8f094c9ba8d2f1adee56 100644 (file)
--- a/docs/latex/wx/strmfile.tex
+++ b/docs/latex/wx/strmfile.tex
@@ -3,6 +3,19 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxFileInputStream}}\label{wxfileinputstream}
 
+This class represents data read in from a file. There are actually
+two such groups of classes: this one is based on \helpref{wxFile}{wxfile} 
+whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
+the \helpref{wxFFile}{wxffile} class.
+
+Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
+in one aspect, namely when to report that the end of the file has been
+reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and 
+\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
+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.
+
 \wxheading{Derived from}
 
 \helpref{wxInputStream}{wxinputstream}
@@ -13,7 +26,7 @@
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer}{wxstreamBuffer}
+\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}
 
 % ----------
 % Members
@@ -24,11 +37,11 @@
 
 \func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
 
-Opens the specified file using its \it{ifilename} name in read-only mode.
+Opens the specified file using its {\it ifilename} name in read-only mode.
 
 \func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
 
-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 file I/O object {\it file}.
 
 \func{}{wxFileInputStream}{\param{int}{ fd}}
 
@@ -51,6 +64,19 @@ Returns TRUE if the stream is initialized and ready.
 % -----------------------------------------------------------------------------
 \section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
 
+This class represents data written to a file. There are actually
+two such groups of classes: this one is based on \helpref{wxFile}{wxfile} 
+whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
+the \helpref{wxFFile}{wxffile} class.
+
+Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
+in one aspect, namely when to report that the end of the file has been
+reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and 
+\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
+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.
+
 \wxheading{Derived from}
 
 \helpref{wxOutputStream}{wxoutputstream}
@@ -61,7 +87,7 @@ Returns TRUE if the stream is initialized and ready.
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer}{wxstreamBuffer}
+\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
 
 % ----------
 % Members
@@ -72,16 +98,16 @@ Returns TRUE if the stream is initialized and ready.
 
 \func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
 
-Creates a new file with \it{ofilename} name and initializes the stream in
+Creates a new file with {\it ofilename} name and initializes the stream in
 write-only mode. 
 
-\func{}{wxFileOutputStream}{\param{wxFile&}{ file}}
+\func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
 
-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 I/O object {\it file}.
 
 \func{}{wxFileOutputStream}{\param{int}{ fd}}
 
-Initializes a file stream in write-only mode using the file descriptor \it{fd}.
+Initializes a file stream in write-only mode using the file descriptor {\it fd}.
 
 \membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
 
@@ -102,7 +128,7 @@ Returns TRUE if the stream is initialized and ready.
 
 \wxheading{Derived from}
 
-\helpref{wxFileOutputStream}{wxFileOutputStream}, \helpref{wxFileInputStream}{wxfileinputstream}
+\helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}
 
 \wxheading{Include files}
 
@@ -110,7 +136,7 @@ Returns TRUE if the stream is initialized and ready.
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer}{wxstreamBuffer}
+\helpref{wxStreamBuffer}{wxstreambuffer}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -119,5 +145,156 @@ Returns TRUE if the stream is initialized and ready.
 \func{}{wxFileStream}{\param{const wxString\&}{ iofileName}}
 
 Initializes a new file stream in read-write mode using the specified 
-\it{iofilename} name.
+{\it iofilename} name.
+
+
+% -----------------------------------------------------------------------------
+% wxFFileInputStream
+% -----------------------------------------------------------------------------
+\section{\class{wxFFileInputStream}}\label{wxffileinputstream}
+
+This class represents data read in from a file. There are actually
+two such groups of classes: this one is based on \helpref{wxFFile}{wxffile} 
+whereas \helpref{wxFileInputStream}{wxfileinputstream} is based in
+the \helpref{wxFile}{wxfile} class.
+
+Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
+in one aspect, namely when to report that the end of the file has been
+reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and 
+\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
+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.
+
+\wxheading{Derived from}
+
+\helpref{wxInputStream}{wxinputstream}
+
+\wxheading{Include files}
+
+<wx/wfstream.h>
+
+\wxheading{See also}
+
+\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}
+
+% ----------
+% Members
+% ----------
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxFFileInputStream::wxFFileInputStream}
+
+\func{}{wxFFileInputStream}{\param{const wxString\&}{ ifileName}}
+
+Opens the specified file using its {\it ifilename} name in read-only mode.
+
+\func{}{wxFFileInputStream}{\param{wxFFile\&}{ file}}
+
+Initializes a file stream in read-only mode using the file I/O object {\it file}.
+
+\func{}{wxFFileInputStream}{\param{FILE *}{ fp}}
+
+Initializes a file stream in read-only mode using the specified file pointer {\it fp}.
+
+\membersection{wxFFileInputStream::\destruct{wxFFileInputStream}}
+
+\func{}{\destruct{wxFFileInputStream}}{\void}
+
+Destructor.
+
+\membersection{wxFFileInputStream::Ok}
+
+\constfunc{bool}{Ok}{\void}
+
+Returns TRUE if the stream is initialized and ready.
+
+% -----------------------------------------------------------------------------
+% wxFFileOutputStream
+% -----------------------------------------------------------------------------
+\section{\class{wxFFileOutputStream}}\label{wxffileoutputstream}
+
+This class represents data written to a file. There are actually
+two such groups of classes: this one is based on \helpref{wxFFile}{wxffile} 
+whereas \helpref{wxFileInputStream}{wxffileinputstream} is based in
+the \helpref{wxFile}{wxfile} class.
+
+Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
+in one aspect, namely when to report that the end of the file has been
+reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and 
+\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
+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.
+
+\wxheading{Derived from}
+
+\helpref{wxOutputStream}{wxoutputstream}
+
+\wxheading{Include files}
+
+<wx/wfstream.h>
+
+\wxheading{See also}
+
+\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}, \helpref{wxFileInputStream}{wxfileinputstream}
+
+% ----------
+% Members
+% ----------
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxFFileOutputStream::wxFFileOutputStream}
+
+\func{}{wxFFileOutputStream}{\param{const wxString\&}{ ofileName}}
+
+Creates a new file with {\it ofilename} name and initializes the stream in
+write-only mode. 
+
+\func{}{wxFFileOutputStream}{\param{wxFFile\&}{ file}}
+
+Initializes a file stream in write-only mode using the file I/O object {\it file}.
+
+\func{}{wxFFileOutputStream}{\param{FILE *}{ fp}}
+
+Initializes a file stream in write-only mode using the file descriptor {\it fp}.
+
+\membersection{wxFFileOutputStream::\destruct{wxFFileOutputStream}}
+
+\func{}{\destruct{wxFFileOutputStream}}{\void}
+
+Destructor.
+
+\membersection{wxFFileOutputStream::Ok}
+
+\constfunc{bool}{Ok}{\void}
+
+Returns TRUE if the stream is initialized and ready.
+
+% -----------------------------------------------------------------------------
+% wxFFileStream
+% -----------------------------------------------------------------------------
+\section{\class{wxFFileStream}}
+
+\wxheading{Derived from}
+
+\helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
+
+\wxheading{Include files}
+
+<wx/wfstream.h>
+
+\wxheading{See also}
+
+\helpref{wxStreamBuffer}{wxstreambuffer}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxFFileStream::wxFFileStream}
+
+\func{}{wxFFileStream}{\param{const wxString\&}{ iofileName}}
+
+Initializes a new file stream in read-write mode using the specified 
+{\it iofilename} name.
+