Added wxWrapSizer (modified patch: [1826950] Wrapping Sizer) from Arne Steinarson

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

diff --git a/docs/latex/wx/ffilestr.tex b/docs/latex/wx/ffilestr.tex
index ca3eb09639dea2497493607090e9e73b97f94cdf..7dc8029ce22879af2bb3d7470324588d0f08dcf0 100644 (file)
--- 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.
 
 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}
 
 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}
 
 <wx/wfstream.h>
 
 
 \wxheading{Include files}
 
 <wx/wfstream.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}
 \wxheading{See also}
 
 \helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}


@@ -38,9 +36,9 @@ can seek beyond the end of the stream (file) and will thus not return
 
 \membersection{wxFFileInputStream::wxFFileInputStream}\label{wxffileinputstreamctor}
 
 
 \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}}
 
 
 \func{}{wxFFileInputStream}{\param{wxFFile\&}{ file}}
 


@@ -56,9 +54,9 @@ Initializes a file stream in read-only mode using the specified file pointer {\i
 
 Destructor.
 
 
 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.
 
 
 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.
 
 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}
 
 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}
 
 <wx/wfstream.h>
 
 
 \wxheading{Include files}
 
 <wx/wfstream.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}, \helpref{wxFileInputStream}{wxfileinputstream}
 \wxheading{See also}
 
 \helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}, \helpref{wxFileInputStream}{wxfileinputstream}


@@ -102,10 +98,9 @@ can seek beyond the end of the stream (file) and will thus not return
 
 \membersection{wxFFileOutputStream::wxFFileOutputStream}\label{wxffileoutputstreamctor}
 
 
 \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}}
 
 
 \func{}{wxFFileOutputStream}{\param{wxFFile\&}{ file}}
 


@@ -121,9 +116,9 @@ Initializes a file stream in write-only mode using the file descriptor {\it fp}.
 
 Destructor.
 
 
 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.
 
 
 Returns true if the stream is initialized and ready.
 


@@ -134,12 +129,18 @@ Returns true if the stream is initialized and ready.
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
+\helpref{wxFFileOutputStream}{wxffileoutputstream}\\
+\helpref{wxOutputStream}{wxoutputstream}\\
+\helpref{wxStreamBase}{wxstreambase}

 
 \wxheading{Include files}
 
 <wx/wfstream.h>
 
 
 \wxheading{Include files}
 
 <wx/wfstream.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}
 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}