Bug 1099143 and more occurences of the same set vs. get mistakes.

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

diff --git a/docs/latex/wx/txtstrm.tex b/docs/latex/wx/txtstrm.tex
index d0a26353dd777a929d9e9cbb2cad30d81fc8a6f5..eb651ebb6f3209d0bd3c2a8c54985d71a306cd0c 100644 (file)
--- a/docs/latex/wx/txtstrm.tex
+++ b/docs/latex/wx/txtstrm.tex
@@ -41,13 +41,12 @@ For example:
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxTextInputStream::wxTextInputStream}\label{wxtextinputstreamconstr}
+\membersection{wxTextInputStream::wxTextInputStream}\label{wxtextinputstreamctor}

 
 \func{}{wxTextInputStream}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ sep=" $\backslash$t"}, 
   \param{wxMBConv\&}{ conv = wxConvUTF8} }
 
 
 \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}
 
 
 \wxheading{Parameters}
 


@@ -58,7 +57,7 @@ be available.
 \docparam{conv}{{\it In Unicode build only:} The encoding converter used to convert the bytes in the
   underlying input stream to characters.}
 
 \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}
 
 
 \func{}{\destruct{wxTextInputStream}}{\void}
 


@@ -78,7 +77,7 @@ 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.
 
 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}}
 
 
 \func{wxInt8}{Read8S}{\param{int}{ base = 10}}
 


@@ -87,7 +86,7 @@ Reads a single signed byte from the stream.
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 
 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}}
 
 
 \func{wxUint16}{Read16}{\param{int}{ base = 10}}
 


@@ -96,7 +95,7 @@ Reads a unsigned 16 bit integer from the stream.
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 
 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}}
 
 
 \func{wxInt16}{Read16S}{\param{int}{ base = 10}}
 


@@ -105,7 +104,7 @@ Reads a signed 16 bit integer from the stream.
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 
 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}}
 
 
 \func{wxUint32}{Read32}{\param{int}{ base = 10}}
 


@@ -114,7 +113,7 @@ Reads a 32 bit unsigned integer from the stream.
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 
 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}}
 
 
 \func{wxInt32}{Read32S}{\param{int}{ base = 10}}
 


@@ -123,7 +122,13 @@ Reads a 32 bit signed integer from the stream.
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 
 See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
 description of the {\it base} parameter.
 

-\membersection{wxTextInputStream::ReadDouble}
+\membersection{wxTextInputStream::GetChar}\label{wxtextinputstreamgetchar}
+
+\func{wxChar}{wxTextInputStream::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}
 
 
 \func{double}{ReadDouble}{\void}
 


@@ -136,7 +141,7 @@ Reads a double (IEEE encoded) from the stream.
 Reads a line from the input stream and returns it (without the end of line
 character).
 
 Reads a line from the input stream and returns it (without the end of line
 character).
 

-\membersection{wxTextInputStream::ReadString}
+\membersection{wxTextInputStream::ReadString}\label{wxtextinputstreamreadstring}

 
 \func{wxString}{wxTextInputStream::ReadString}{\void}
 
 
 \func{wxString}{wxTextInputStream::ReadString}{\void}
 


@@ -190,12 +195,11 @@ and Unix in their native formats (concerning the line ending).
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamconstr}
+\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamctor}

 
 

-\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}}
+\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}, \param{wxMBConv\&}{ conv = wxConvUTF8}}

 
 

-Constructs a text stream object from an output stream. Only write methods will
-be available.
+Constructs a text stream object associated to the given output stream.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -203,49 +207,58 @@ be available.
 
 \docparam{mode}{The end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.}
 
 
 \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.
 
 
 \func{}{\destruct{wxTextOutputStream}}{\void}
 
 Destroys the wxTextOutputStream object.
 

-\membersection{wxTextOutputStream::GetMode}
+\membersection{wxTextOutputStream::GetMode}\label{wxtextoutputstreamgetmode}

 
 \func{wxEOL}{wxTextOutputStream::GetMode}{\void}
 
 Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.
 
 
 \func{wxEOL}{wxTextOutputStream::GetMode}{\void}
 
 Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.
 

-\membersection{wxTextOutputStream::SetMode}
+\membersection{wxTextOutputStream::SetMode}\label{wxtextoutputstreamsetmode}

 
 \func{void}{wxTextOutputStream::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}.
 
 
 \func{void}{wxTextOutputStream::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}
+\membersection{wxTextOutputStream::Write8}\label{wxtextoutputstreamwrite8}

 
 \func{void}{wxTextOutputStream::Write8}{{\param wxUint8 }{i8}}
 
 Writes the single byte {\it i8} to the stream.
 
 
 \func{void}{wxTextOutputStream::Write8}{{\param wxUint8 }{i8}}
 
 Writes the single byte {\it i8} to the stream.
 

-\membersection{wxTextOutputStream::Write16}
+\membersection{wxTextOutputStream::PutChar}\label{wxtextoutputstreamputchar}
+
+\func{void}{wxTextOutputStream::PutChar}{{\param wxChar }{c}}
+
+Writes a character to the stream.
+
+\membersection{wxTextOutputStream::Write16}\label{wxtextoutputstreamwrite16}

 
 \func{void}{wxTextOutputStream::Write16}{{\param wxUint16 }{i16}}
 
 Writes the 16 bit integer {\it i16} to the stream.
 
 
 \func{void}{wxTextOutputStream::Write16}{{\param wxUint16 }{i16}}
 
 Writes the 16 bit integer {\it i16} to the stream.
 

-\membersection{wxTextOutputStream::Write32}
+\membersection{wxTextOutputStream::Write32}\label{wxtextoutputstreamwrite32}

 
 \func{void}{wxTextOutputStream::Write32}{{\param wxUint32 }{i32}}
 
 Writes the 32 bit integer {\it i32} to the stream.
 
 
 \func{void}{wxTextOutputStream::Write32}{{\param wxUint32 }{i32}}
 
 Writes the 32 bit integer {\it i32} to the stream.
 

-\membersection{wxTextOutputStream::WriteDouble}
+\membersection{wxTextOutputStream::WriteDouble}\label{wxtextoutputstreamwritedouble}

 
 \func{virtual void}{wxTextOutputStream::WriteDouble}{{\param double }{f}}
 
 Writes the double {\it f} to the stream using the IEEE format.
 
 
 \func{virtual void}{wxTextOutputStream::WriteDouble}{{\param double }{f}}
 
 Writes the double {\it f} to the stream using the IEEE format.
 

-\membersection{wxTextOutputStream::WriteString}
+\membersection{wxTextOutputStream::WriteString}\label{wxtextoutputstreamwritestring}

 
 \func{virtual void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}}
 
 
 \func{virtual void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}}