X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2348a84293e52b9a701891bcdd801b3e8e541642..5769347356c1114f2350d8f23b00406b6ea94fdb:/docs/latex/wx/txtstrm.tex

diff --git a/docs/latex/wx/txtstrm.tex b/docs/latex/wx/txtstrm.tex
index 32004defb3..70afd2cca0 100644
--- a/docs/latex/wx/txtstrm.tex
+++ b/docs/latex/wx/txtstrm.tex
@@ -41,13 +41,13 @@ For example:
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxTextInputStream::wxTextInputStream}\label{wxtextinputstreamconstr}
 
-\func{}{wxTextInputStream}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ sep=wxT(" \t")}, 
+\membersection{wxTextInputStream::wxTextInputStream}\label{wxtextinputstreamctor}
+
+\func{}{wxTextInputStream}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ sep=" $\backslash$t"}, 
   \param{wxMBConv\&}{ conv = wxConvUTF8} }
 
-Constructs a text stream object from an input stream. Only read methods will
-be available.
+Constructs a text stream associated to the given input stream.
 
 \wxheading{Parameters}
 
@@ -58,12 +58,14 @@ be available.
 \docparam{conv}{{\it In Unicode build only:} The encoding converter used to convert the bytes in the
   underlying input stream to characters.}
 
-\membersection{wxTextInputStream::\destruct{wxTextInputStream}}
+
+\membersection{wxTextInputStream::\destruct{wxTextInputStream}}\label{wxtextinputstreamdtor}
 
 \func{}{\destruct{wxTextInputStream}}{\void}
 
 Destroys the wxTextInputStream object.
 
+
 \membersection{wxTextInputStream::Read8}\label{wxtextinputstreamread8}
 
 \func{wxUint8}{Read8}{\param{int}{ base = 10}}
@@ -78,7 +80,8 @@ that you may not want to specify the base $0$ if you are parsing the numbers
 which may have leading zeroes as they can yield unexpected (to the user not
 familiar with C) results.
 
-\membersection{wxTextInputStream::Read8S}
+
+\membersection{wxTextInputStream::Read8S}\label{wxtextinputstreamread8s}
 
 \func{wxInt8}{Read8S}{\param{int}{ base = 10}}
 
@@ -87,7 +90,8 @@ Reads a single signed byte from the stream.
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 
-\membersection{wxTextInputStream::Read16}
+
+\membersection{wxTextInputStream::Read16}\label{wxtextinputstreamread16}
 
 \func{wxUint16}{Read16}{\param{int}{ base = 10}}
 
@@ -96,7 +100,8 @@ Reads a unsigned 16 bit integer from the stream.
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 
-\membersection{wxTextInputStream::Read16S}
+
+\membersection{wxTextInputStream::Read16S}\label{wxtextinputstreamread16s}
 
 \func{wxInt16}{Read16S}{\param{int}{ base = 10}}
 
@@ -105,7 +110,8 @@ Reads a signed 16 bit integer from the stream.
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 
-\membersection{wxTextInputStream::Read32}
+
+\membersection{wxTextInputStream::Read32}\label{wxtextinputstreamread32}
 
 \func{wxUint32}{Read32}{\param{int}{ base = 10}}
 
@@ -114,7 +120,8 @@ Reads a 32 bit unsigned integer from the stream.
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 
-\membersection{wxTextInputStream::Read32S}
+
+\membersection{wxTextInputStream::Read32S}\label{wxtextinputstreamread32s}
 
 \func{wxInt32}{Read32S}{\param{int}{ base = 10}}
 
@@ -123,31 +130,42 @@ Reads a 32 bit signed integer from the stream.
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 
-\membersection{wxTextInputStream::ReadDouble}
+
+\membersection{wxTextInputStream::GetChar}\label{wxtextinputstreamgetchar}
+
+\func{wxChar}{GetChar}{\void}
+
+Reads a character, returns $0$ if there are no more characters in the stream.
+
+
+\membersection{wxTextInputStream::ReadDouble}\label{wxtextinputstreamreaddouble}
 
 \func{double}{ReadDouble}{\void}
 
 Reads a double (IEEE encoded) from the stream.
 
+
 \membersection{wxTextInputStream::ReadLine}\label{wxtextinputstreamreadline}
 
-\func{wxString}{wxTextInputStream::ReadLine}{\void}
+\func{wxString}{ReadLine}{\void}
 
 Reads a line from the input stream and returns it (without the end of line
 character).
 
-\membersection{wxTextInputStream::ReadString}
 
-\func{wxString}{wxTextInputStream::ReadString}{\void}
+\membersection{wxTextInputStream::ReadString}\label{wxtextinputstreamreadstring}
+
+\func{wxString}{ReadString}{\void}
 
 {\bf NB:} This method is deprecated, use \helpref{ReadLine}{wxtextinputstreamreadline} 
 or \helpref{ReadWord}{wxtextinputstreamreadword} instead.
 
 Same as \helpref{ReadLine}{wxtextinputstreamreadline}.
 
+
 \membersection{wxTextInputStream::ReadWord}\label{wxtextinputstreamreadword}
 
-\func{wxString}{wxTextInputStream::ReadWord}{\void}
+\func{wxString}{ReadWord}{\void}
 
 Reads a word (a sequence of characters until the next separator) from the
 input stream.
@@ -156,6 +174,7 @@ input stream.
 
 \helpref{SetStringSeparators}{wxtextinputstreamsetstringseparators}
 
+
 \membersection{wxTextInputStream::SetStringSeparators}\label{wxtextinputstreamsetstringseparators}
 
 \func{void}{SetStringSeparators}{\param{const wxString\& }{sep}}
@@ -188,14 +207,18 @@ You can also simulate the C++ cout class:
 The wxTextOutputStream writes text files (or streams) on DOS, Macintosh
 and Unix in their native formats (concerning the line ending).
 
+\wxheading{Include files}
+
+<wx/txtstrm.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamconstr}
 
-\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}}
+\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamctor}
 
-Constructs a text stream object from an output stream. Only write methods will
-be available.
+\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}, \param{wxMBConv\&}{ conv = wxConvUTF8}}
+
+Constructs a text stream object associated to the given output stream.
 
 \wxheading{Parameters}
 
@@ -203,54 +226,71 @@ be available.
 
 \docparam{mode}{The end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.}
 
-\membersection{wxTextOutputStream::\destruct{wxTextOutputStream}}
+\docparam{conv}{{\it In Unicode build only:} The object used to convert
+Unicode text into ASCII characters written to the output stream.}
+
+
+\membersection{wxTextOutputStream::\destruct{wxTextOutputStream}}\label{wxtextoutputstreamdtor}
 
 \func{}{\destruct{wxTextOutputStream}}{\void}
 
 Destroys the wxTextOutputStream object.
 
-\membersection{wxTextOutputStream::GetMode}
 
-\func{wxEOL}{wxTextOutputStream::GetMode}{\void}
+\membersection{wxTextOutputStream::GetMode}\label{wxtextoutputstreamgetmode}
+
+\func{wxEOL}{GetMode}{\void}
 
 Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.
 
-\membersection{wxTextOutputStream::SetMode}
 
-\func{void}{wxTextOutputStream::SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}}
+\membersection{wxTextOutputStream::PutChar}\label{wxtextoutputstreamputchar}
+
+\func{void}{PutChar}{{\param wxChar }{c}}
+
+Writes a character to the stream.
+
+
+\membersection{wxTextOutputStream::SetMode}\label{wxtextoutputstreamsetmode}
+
+\func{void}{SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}}
 
 Set the end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.
 
-\membersection{wxTextOutputStream::Write8}
 
-\func{void}{wxTextOutputStream::Write8}{{\param wxUint8 }{i8}}
+\membersection{wxTextOutputStream::Write8}\label{wxtextoutputstreamwrite8}
+
+\func{void}{Write8}{{\param wxUint8 }{i8}}
 
 Writes the single byte {\it i8} to the stream.
 
-\membersection{wxTextOutputStream::Write16}
 
-\func{void}{wxTextOutputStream::Write16}{{\param wxUint16 }{i16}}
+\membersection{wxTextOutputStream::Write16}\label{wxtextoutputstreamwrite16}
+
+\func{void}{Write16}{{\param wxUint16 }{i16}}
 
 Writes the 16 bit integer {\it i16} to the stream.
 
-\membersection{wxTextOutputStream::Write32}
 
-\func{void}{wxTextOutputStream::Write32}{{\param wxUint32 }{i32}}
+\membersection{wxTextOutputStream::Write32}\label{wxtextoutputstreamwrite32}
+
+\func{void}{Write32}{{\param wxUint32 }{i32}}
 
 Writes the 32 bit integer {\it i32} to the stream.
 
-\membersection{wxTextOutputStream::WriteDouble}
 
-\func{virtual void}{wxTextOutputStream::WriteDouble}{{\param double }{f}}
+\membersection{wxTextOutputStream::WriteDouble}\label{wxtextoutputstreamwritedouble}
+
+\func{virtual void}{WriteDouble}{{\param double }{f}}
 
 Writes the double {\it f} to the stream using the IEEE format.
 
-\membersection{wxTextOutputStream::WriteString}
 
-\func{virtual void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}}
+\membersection{wxTextOutputStream::WriteString}\label{wxtextoutputstreamwritestring}
+
+\func{virtual void}{WriteString}{{\param const wxString\& }{string}}
 
 Writes {\it string} as a line. Depending on the end-of-line mode the end of
 line ('$\backslash$n') characters in the string are converted to the correct
 line ending terminator.
 
-