X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/569ef72a4d64a01a995053670c1f2abf3f6fd601..15f7c30516facfb272fc116aec4d3f9c3a9de085:/docs/latex/wx/ffilestr.tex diff --git a/docs/latex/wx/ffilestr.tex b/docs/latex/wx/ffilestr.tex index f0b087ffc3..7dc8029ce2 100644 --- a/docs/latex/wx/ffilestr.tex +++ b/docs/latex/wx/ffilestr.tex @@ -8,25 +8,23 @@ 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. -Related to EOF behavior, note that \helpref{SeekI()}{wxinputstreamseeki} +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} -\helpref{wxInputStream}{wxinputstream} +\helpref{wxInputStream}{wxinputstream}\\ +\helpref{wxStreamBase}{wxstreambase} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream} @@ -36,11 +34,11 @@ can seek beyond the end of the stream (file) and will thus not return % ---------- \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 wxString\&}{ 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}} @@ -50,15 +48,15 @@ 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::IsOk}\label{wxffileinputstreamisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} Returns true if the stream is initialized and ready. @@ -72,25 +70,23 @@ 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. -Related to EOF behavior, note that \helpref{SeekO()}{wxoutputstreamseeko} +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} -\helpref{wxOutputStream}{wxoutputstream} +\helpref{wxOutputStream}{wxoutputstream}\\ +\helpref{wxStreamBase}{wxstreambase} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}, \helpref{wxFileInputStream}{wxfileinputstream} @@ -100,12 +96,11 @@ can seek beyond the end of the stream (file) and will thus not return % ---------- \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 wxString\&}{ 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}} @@ -115,15 +110,15 @@ 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::IsOk}\label{wxffileoutputstreamisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} Returns true if the stream is initialized and ready. @@ -134,19 +129,25 @@ Returns true if the stream is initialized and ready. \wxheading{Derived from} -\helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream} +\helpref{wxFFileOutputStream}{wxffileoutputstream}\\ +\helpref{wxOutputStream}{wxoutputstream}\\ +\helpref{wxStreamBase}{wxstreambase} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxStreamBuffer}{wxstreambuffer} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxFFileStream::wxFFileStream} +\membersection{wxFFileStream::wxFFileStream}\label{wxffilestreamctor} \func{}{wxFFileStream}{\param{const wxString\&}{ iofileName}}