Another typo concerning wxUSE_SASH

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

diff --git a/docs/latex/wx/datstrm.tex b/docs/latex/wx/datstrm.tex
index 6954199eff9851b03abb0e0488754036516fffa0..daafad94922b09e15b38da2a9040104559b24251 100644 (file)
--- a/docs/latex/wx/datstrm.tex
+++ b/docs/latex/wx/datstrm.tex
@@ -1,109 +1,136 @@
-\section{\class{wxDataStream}}\label{wxdatastream}
+\section{\class{wxDataInputStream}}\label{wxdatainputstream}

 
 

-This class provides functions that read and write integers or double in a
+This class provides functions that read data types in a

 portable way. So, a file written by an Intel processor can be read by a
 Sparc or anything else.
 
 portable way. So, a file written by an Intel processor can be read by a
 Sparc or anything else.
 

-\latexignore{\rtfignore{\wxheading{Members}}}
+\wxheading{Derived from}

 
 

-\membersection{wxDataStream::wxDataStream}\label{wxwaveconstr}
+\helpref{wxFilterInputStream}{wxfilterinputstream}\\
+\helpref{wxInputStream}{wxinputstream}\\
+\helpref{wxStreamBase}{wxstreambase}

 
 

-\func{}{wxDataStream}{\param{istream\&}{ stream}}
+\wxheading{Include files}

 
 

-Constructs a datastream object from a C++ input stream. Only read methods will
-be available.
+<wx/datstrm.h>

 
 

-\wxheading{Parameters}
+\latexignore{\rtfignore{\wxheading{Members}}}

 
 

-\docparam{stream}{The C++ input stream.}
+\membersection{wxDataInputStream::wxDataInputStream}\label{wxdatainputstreamconstr}

 
 

-\func{}{wxDataStream}{\param{istream\&}{ stream}}
+\func{}{wxDataInputStream}{\param{wxInputStream\&}{ stream}}

 
 

-Constructs a datastream object from a C++ input stream. Only read methods will
+Constructs a datastream object from an input stream. Only read methods will

 be available.
 
 \wxheading{Parameters}
 
 be available.
 
 \wxheading{Parameters}
 

-\docparam{stream}{The C++ input stream.}
+\docparam{stream}{The input stream.}

 
 

-\membersection{wxDataStream::\destruct{wxDataStream}}
+\membersection{wxDataInputStream::\destruct{wxDataInputStream}}

 
 

-\func{}{\destruct{wxDataStream}}{\void}
+\func{}{\destruct{wxDataInputStream}}{\void}

 
 

-Destroys the wxDataStream object.
+Destroys the wxDataInputStream object.

 
 

-\membersection{wxDataStream::Read8}
+\membersection{wxDataInputStream::Read8}

 
 \func{unsigned char}{Read8}{\void}
 
 Reads a single byte from the stream.
 
 
 \func{unsigned char}{Read8}{\void}
 
 Reads a single byte from the stream.
 

-\membersection{wxDataStream::Read16}
+\membersection{wxDataInputStream::Read16}

 
 \func{unsigned short}{Read16}{\void}
 
 Reads a 16 bit integer from the stream.
 
 
 \func{unsigned short}{Read16}{\void}
 
 Reads a 16 bit integer from the stream.
 

-\membersection{wxDataStream::Read32}
+\membersection{wxDataInputStream::Read32}

 
 \func{unsigned long}{Read32}{\void}
 
 Reads a 32 bit integer from the stream.
 
 
 \func{unsigned long}{Read32}{\void}
 
 Reads a 32 bit integer from the stream.
 

-\membersection{wxDataStream::ReadDouble}
+\membersection{wxDataInputStream::ReadDouble}

 
 \func{double}{ReadDouble}{\void}
 
 Reads a double (IEEE encoded) from the stream.
 
 
 \func{double}{ReadDouble}{\void}
 
 Reads a double (IEEE encoded) from the stream.
 

-\membersection{wxDataStream::ReadString}
+\membersection{wxDataInputStream::ReadLine}
+
+\func{wxString}{wxDataInputStream::ReadLine}{\void}
+
+Reads a line from the stream. A line is a string which ends with \\n or \\r\\n.
+
+\membersection{wxDataInputStream::ReadString}

 
 

-\func{wxString}{wxDataStream::ReadString}{\void}
+\func{wxString}{wxDataInputStream::ReadString}{\void}

 
 

-Reads a string from a stream. Actually, this function first reads a byte
+Reads a string from a stream. Actually, this function first reads a long integer

 specifying the length of the string (without the last null character) and then
 reads the string.
 
 specifying the length of the string (without the last null character) and then
 reads the string.
 

-\membersection{wxDataStream::ReadLine}
+\section{\class{wxDataOutputStream}}\label{wxdataoutputstream}

 
 

-\func{wxString}{wxDataStream::ReadLine}{\void}
+This class provides functions that write data types in a
+portable way. So, a file written by an Intel processor can be read by a
+Sparc or anything else.

 
 

-Reads a line from the stream. A line is a string which ends with \\n or \\r\\n.
+\latexignore{\rtfignore{\wxheading{Members}}}

 
 

-\membersection{wxDataStream::Write8}
+\membersection{wxDataOutputStream::wxDataOutputStream}\label{wxdataoutputstreamconstr}

 
 

-\func{void}{wxDataStream::Write8}{{\param unsigned char }{i8}}
+\func{}{wxDataInputStream}{\param{wxOutputStream\&}{ stream}}
+
+Constructs a datastream object from an output stream. Only read methods will
+be available.
+
+\wxheading{Parameters}
+
+\docparam{stream}{The output stream.}
+
+\membersection{wxDataOutputStream::\destruct{wxDataOutputStream}}
+
+\func{}{\destruct{wxDataOutputStream}}{\void}
+
+Destroys the wxDataOutputStream object.
+
+\membersection{wxDataOutputStream::Write8}
+
+\func{void}{wxDataOutputStream::Write8}{{\param unsigned char }{i8}}

 
 Writes the single byte {\it i8} to the stream.
 
 
 Writes the single byte {\it i8} to the stream.
 

-\membersection{wxDataStream::Write16}
+\membersection{wxDataOutputStream::Write16}

 
 

-\func{void}{wxDataStream::Write16}{{\param unsigned short }{i16}}
+\func{void}{wxDataOutputStream::Write16}{{\param unsigned short }{i16}}

 
 Writes the 16 bit integer {\it i16} to the stream.
 
 
 Writes the 16 bit integer {\it i16} to the stream.
 

-\membersection{wxDataStream::Write32}
+\membersection{wxDataOutputStream::Write32}

 
 

-\func{void}{wxDataStream::Write32}{{\param unsigned long }{i32}}
+\func{void}{wxDataOutputStream::Write32}{{\param unsigned long }{i32}}

 
 Writes the 32 bit integer {\it i32} to the stream.
 
 
 Writes the 32 bit integer {\it i32} to the stream.
 

-\membersection{wxDataStream::WriteDouble}
+\membersection{wxDataOutputStream::WriteDouble}

 
 

-\func{void}{wxDataStream::WriteDouble}{{\param double }{f}}
+\func{void}{wxDataOutputStream::WriteDouble}{{\param double }{f}}

 
 Writes the double {\it f} to the stream using the IEEE format.
 
 
 Writes the double {\it f} to the stream using the IEEE format.
 

-\membersection{wxDataStream::WriteString}
+\membersection{wxDataOutputStream::WriteLine}

 
 

-\func{void}{wxDataStream::WriteString}{{\param const wxString& }{string}}
+\func{void}{wxDataOutputStream::WriteLine}{{\param const wxString\& }{string}}

 
 

-Writes {\it string} to the stream. Actually, this method writes the size of
-the string before writing {\it string} itself.
+Writes {\it string} as a line. Depending on the operating system, it adds
+$\backslash$n or $\backslash$r$\backslash$n.

 
 

-\membersection{wxDataStream::WriteLine}
+\membersection{wxDataOutputStream::WriteString}

 
 

-\func{void}{wxDataStream::WriteLine}{{\param const wxString& }{string}}
+\func{void}{wxDataOutputStream::WriteString}{{\param const wxString\& }{string}}
+
+Writes {\it string} to the stream. Actually, this method writes the size of
+the string before writing {\it string} itself.

 
 

-Writes {\it string} as a line. Depending on the operating system, it adds
-\\n or \\r\\n.