wxPython documentation updates

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

diff --git a/docs/latex/wx/txtstrm.tex b/docs/latex/wx/txtstrm.tex
index 05d6b0a3bf4443a3fa9d92835afa3b5d1521bbee..559209c18264f6bcfcd363c75d3fec3d35f23702 100644 (file)
--- a/docs/latex/wx/txtstrm.tex
+++ b/docs/latex/wx/txtstrm.tex
@@ -6,6 +6,9 @@
 This class provides functions that read text datas using an input stream.
 So, you can read \it{text} floats, integers.
 
+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
@@ -88,19 +91,22 @@ $\backslash$n or $\backslash$r$\backslash$n or $\backslash$r.
 This class provides functions that write text datas using an output stream.
 So, you can write \it{text} floats, integers.
 
-For example:
+You can also simulate the C++ cout class:
 \begin{verbatim}
-  wxFileOutputStream output( "mytext.txt" );
-  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}}
 
@@ -147,3 +153,4 @@ Writes the double {\it f} to the stream using the IEEE format.
 
 Writes {\it string} as a line. Depending on the operating system, it adds
 $\backslash$n or $\backslash$r$\backslash$n.
+