]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/filestrm.tex
Correct typos, minor wording improvements
[wxWidgets.git] / docs / latex / wx / filestrm.tex
index 74e2b5fcc039066ba8a386054cd441fbfb752c3a..da813afc32e6e4384ef46640c2ad52d00778b167 100644 (file)
@@ -1,127 +1,7 @@
-\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}
-
-\wxheading{Include files}
-
-<wx/wfstream.h>
-
-\wxheading{See also}
-
-\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}
-
-% ----------
-% Members
-% ----------
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-\membersection{wxFileInputStream::wxFileInputStream}
-
-\func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
-
-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}.
-
-\func{}{wxFileInputStream}{\param{int}{ fd}}
-
-Initializes a file stream in read-only mode using the specified file descriptor.
-
-\membersection{wxFileInputStream::\destruct{wxFileInputStream}}
-
-\func{}{\destruct{wxFileInputStream}}{\void}
-
-Destructor.
-
-\membersection{wxFileInputStream::Ok}
-
-\constfunc{bool}{Ok}{\void}
-
-Returns TRUE if the stream is initialized and ready.
-
-% -----------------------------------------------------------------------------
-% wxFileOutputStream
-% -----------------------------------------------------------------------------
-\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}
-
-\wxheading{Include files}
-
-<wx/wfstream.h>
-
-\wxheading{See also}
-
-\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
-
-% ----------
-% Members
-% ----------
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-\membersection{wxFileOutputStream::wxFileOutputStream}
-
-\func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
-
-Creates a new file with {\it ofilename} name and initializes the stream in
-write-only mode. 
-
-\func{}{wxFileOutputStream}{\param{wxFile\&}{ 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}.
-
-\membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
-
-\func{}{\destruct{wxFileOutputStream}}{\void}
-
-Destructor.
-
-\membersection{wxFileOutputStream::Ok}
-
-\constfunc{bool}{Ok}{\void}
-
-Returns TRUE if the stream is initialized and ready.
-
 % -----------------------------------------------------------------------------
 % wxFileStream
 % -----------------------------------------------------------------------------
-\section{\class{wxFileStream}}
+\section{\class{wxFileStream}}\label{wxfilestream}
 
 \wxheading{Derived from}
 
@@ -137,7 +17,7 @@ Returns TRUE if the stream is initialized and ready.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxFileStream::wxFileStream}
+\membersection{wxFileStream::wxFileStream}\label{wxfilestreamctor}
 
 \func{}{wxFileStream}{\param{const wxString\&}{ iofileName}}