]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/ffilestr.tex
Added periods
[wxWidgets.git] / docs / latex / wx / ffilestr.tex
index 5970d5c1dd021a138b4f04e3e27f45640fc7c61d..d319e0ecb3083c6fdad7f5b47babc45ebdb165ce 100644 (file)
@@ -8,14 +8,7 @@ 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.
 
@@ -27,6 +20,10 @@ can seek beyond the end of the stream (file) and will thus not return
 
 <wx/wfstream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}
@@ -38,7 +35,7 @@ can seek beyond the end of the stream (file) and will thus not return
 
 \membersection{wxFFileInputStream::wxFFileInputStream}\label{wxffileinputstreamctor}
 
-\func{}{wxFFileInputStream}{\param{const wxString\&}{ filename}, \param{const wxChar *}{ mode = "rb"}}
+\func{}{wxFFileInputStream}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode = "rb"}}
 
 Opens the specified file using its {\it filename} name using the specified mode.
 
@@ -56,9 +53,9 @@ Initializes a file stream in read-only mode using the specified file pointer {\i
 
 Destructor.
 
-\membersection{wxFFileInputStream::Ok}\label{wxffileinputstreamok}
+\membersection{wxFFileInputStream::IsOk}\label{wxffileinputstreamisok}
 
-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}
 
 Returns true if the stream is initialized and ready.
 
@@ -72,14 +69,7 @@ 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.
 
@@ -91,6 +81,10 @@ can seek beyond the end of the stream (file) and will thus not return
 
 <wx/wfstream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}, \helpref{wxFileInputStream}{wxfileinputstream}
@@ -102,7 +96,7 @@ can seek beyond the end of the stream (file) and will thus not return
 
 \membersection{wxFFileOutputStream::wxFFileOutputStream}\label{wxffileoutputstreamctor}
 
-\func{}{wxFFileOutputStream}{\param{const wxString\&}{ filename}, \param{const wxChar *}{ mode="w+b"}}
+\func{}{wxFFileOutputStream}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode="w+b"}}
 
 Opens the file with the given {\it filename} name in the specified mode.
 
@@ -120,9 +114,9 @@ Initializes a file stream in write-only mode using the file descriptor {\it fp}.
 
 Destructor.
 
-\membersection{wxFFileOutputStream::Ok}\label{wxffileoutputstreamok}
+\membersection{wxFFileOutputStream::IsOk}\label{wxffileoutputstreamisok}
 
-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}
 
 Returns true if the stream is initialized and ready.
 
@@ -139,6 +133,10 @@ Returns true if the stream is initialized and ready.
 
 <wx/wfstream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}