Small changes

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

diff --git a/docs/latex/wx/txtstrm.tex b/docs/latex/wx/txtstrm.tex
index cf5f519a126977af899a314f08099a5dd45a7936..06a37e88bc3e77cde17a52cb59d33442834a9ed7 100644 (file)
--- a/docs/latex/wx/txtstrm.tex
+++ b/docs/latex/wx/txtstrm.tex
@@ -4,12 +4,20 @@
 \section{\class{wxTextInputStream}}\label{wxtextinputstream}
 
 This class provides functions that read text datas using an input stream.
-So, you can read \it{text} floats, integers.
+So, you can read {\it text} floats, integers.
 
-Operator >> is overloaded and you can use this class a C++ std-iostream.
+The wxTextInputStream correctly reads text files (or streams) in DOS, Macintosh
+and Unix formats and reports a single newline char as a line ending.
+
+Operator >> is overloaded and you can use this class like a standard C++ iostream.
+Note, however, that the arguments are the fixed size types wxUint32, wxInt32 etc
+and on a typical 32-bit computer, none of these match to the "long" type (wxInt32
+is defined as int on 32-bit architectures) so that you cannot use long. To avoid
+problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types.
 
 For example:
 \begin{verbatim}
+  wxFileInputStream input( "mytext.txt" );
   wxTextInputStream text( input );
   wxUint8 i1;
   float f2;
@@ -45,19 +53,19 @@ Destroys the wxTextInputStream object.
 
 \membersection{wxTextInputStream::Read8}
 
-\func{unsigned char}{Read8}{\void}
+\func{wxUint8}{Read8}{\void}
 
 Reads a single byte from the stream.
 
 \membersection{wxTextInputStream::Read16}
 
-\func{unsigned short}{Read16}{\void}
+\func{wxUint16}{Read16}{\void}
 
 Reads a 16 bit integer from the stream.
 
 \membersection{wxTextInputStream::Read32}
 
-\func{unsigned long}{Read32}{\void}
+\func{wxUint16}{Read32}{\void}
 
 Reads a 32 bit integer from the stream.
 
@@ -81,22 +89,26 @@ $\backslash$n or $\backslash$r$\backslash$n or $\backslash$r.
 \section{\class{wxTextOutputStream}}\label{wxtextoutputstream}
 
 This class provides functions that write text datas using an output stream.
-So, you can write \it{text} floats, integers.
+So, you can write {\it text} floats, integers.
 
-For example:
+You can also simulate the C++ cout class:
 \begin{verbatim}
-  wxTextOutputStream text( output );
+  wxFFileOutputStream output( stderr );
+  wxTextOutputStream cout( output );
 
-  output << "This is a text line\n";
-  output << 1234;
-  output << 1.23456;
+  cout << "This is a text line" << endl;
+  cout << 1234;
+  cout << 1.23456;
 \end{verbatim}
 
+The wxTextOutputStream writes text files (or streams) on DOS, Macintosh
+and Unix in their native formats (concerning the line ending).
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxdataoutputstreamconstr}
+\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamconstr}
 
-\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}}
+\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}}
 
 Constructs a text stream object from an output stream. Only write methods will
 be available.
@@ -105,39 +117,54 @@ be available.
 
 \docparam{stream}{The output stream.}
 
+\docparam{mode}{The end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}.}
+
 \membersection{wxTextOutputStream::\destruct{wxTextOutputStream}}
 
 \func{}{\destruct{wxTextOutputStream}}{\void}
 
 Destroys the wxTextOutputStream object.
 
+\membersection{wxTextOutputStream::GetMode}
+
+\func{wxEOL}{wxTextOutputStream::GetMode}{\void}
+
+Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}.
+
+\membersection{wxTextOutputStream::SetMode}
+
+\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} or {\bf wxEOL\_UNIX}.
+
 \membersection{wxTextOutputStream::Write8}
 
-\func{void}{wxTextOutputStream::Write8}{{\param unsigned char }{i8}}
+\func{void}{wxTextOutputStream::Write8}{{\param wxUint8 }{i8}}
 
 Writes the single byte {\it i8} to the stream.
 
 \membersection{wxTextOutputStream::Write16}
 
-\func{void}{wxTextOutputStream::Write16}{{\param unsigned short }{i16}}
+\func{void}{wxTextOutputStream::Write16}{{\param wxUint16 }{i16}}
 
 Writes the 16 bit integer {\it i16} to the stream.
 
 \membersection{wxTextOutputStream::Write32}
 
-\func{void}{wxTextOutputStream::Write32}{{\param unsigned long }{i32}}
+\func{void}{wxTextOutputStream::Write32}{{\param wxUint32 }{i32}}
 
 Writes the 32 bit integer {\it i32} to the stream.
 
 \membersection{wxTextOutputStream::WriteDouble}
 
-\func{void}{wxTextOutputStream::WriteDouble}{{\param double }{f}}
+\func{virtual void}{wxTextOutputStream::WriteDouble}{{\param double }{f}}
 
 Writes the double {\it f} to the stream using the IEEE format.
 
 \membersection{wxTextOutputStream::WriteString}
 
-\func{void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}}
+\func{virtual void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}}
+
+Writes {\it string} as a line. Depending on the end-of-line mode, it adds
+$\backslash$n, $\backslash$r or $\backslash$r$\backslash$n.
 
-Writes {\it string} as a line. Depending on the operating system, it adds
-$\backslash$n or $\backslash$r$\backslash$n.