docs/latex/wx/txtstrm.tex

   1 % ----------------------------------------------------------------------------
   2 % wxTextInputStream
   3 % ----------------------------------------------------------------------------
   4 \section{\class{wxTextInputStream}}\label{wxtextinputstream}
   5
   6 This class provides functions that read text datas using an input stream.
   7 So, you can read {\it text} floats, integers.
   8
   9 The wxTextInputStream correctly reads text files (or streams) in DOS, Macintosh
  10 and Unix formats and reports a single newline char as a line ending.
  11
  12 Operator >> is overloaded and you can use this class like a standard C++ iostream.
  13 Note, however, that the arguments are the fixed size types wxUint32, wxInt32 etc
  14 and on a typical 32-bit computer, none of these match to the "long" type (wxInt32
  15 is defined as int on 32-bit architectures) so that you cannot use long. To avoid
  16 problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types.
  17
  18 For example:
  19 \begin{verbatim}
  20   wxFileInputStream input( "mytext.txt" );
  21   wxTextInputStream text( input );
  22   wxUint8 i1;
  23   float f2;
  24   wxString line;
  25
  26   text >> i1;       // read a 8 bit integer.
  27   text >> i1 >> f2; // read a 8 bit integer followed by float.
  28   text >> line;     // read a text line
  29 \end{verbatim}
  30
  31 \wxheading{Include files}
  32
  33 <wx/txtstrm.h>
  34
  35 \latexignore{\rtfignore{\wxheading{Members}}}
  36
  37 \membersection{wxTextInputStream::wxTextInputStream}\label{wxtextinputstreamconstr}
  38
  39 \func{}{wxTextInputStream}{\param{wxInputStream\&}{ stream}}
  40
  41 Constructs a text stream object from an input stream. Only read methods will
  42 be available.
  43
  44 \wxheading{Parameters}
  45
  46 \docparam{stream}{The input stream.}
  47
  48 \membersection{wxTextInputStream::\destruct{wxTextInputStream}}
  49
  50 \func{}{\destruct{wxTextInputStream}}{\void}
  51
  52 Destroys the wxTextInputStream object.
  53
  54 \membersection{wxTextInputStream::Read8}
  55
  56 \func{wxUint8}{Read8}{\void}
  57
  58 Reads a single byte from the stream.
  59
  60 \membersection{wxTextInputStream::Read16}
  61
  62 \func{wxUint16}{Read16}{\void}
  63
  64 Reads a 16 bit integer from the stream.
  65
  66 \membersection{wxTextInputStream::Read32}
  67
  68 \func{wxUint16}{Read32}{\void}
  69
  70 Reads a 32 bit integer from the stream.
  71
  72 \membersection{wxTextInputStream::ReadDouble}
  73
  74 \func{double}{ReadDouble}{\void}
  75
  76 Reads a double (IEEE encoded) from the stream.
  77
  78 \membersection{wxTextInputStream::ReadString}
  79
  80 \func{wxString}{wxTextInputStream::ReadString}{\void}
  81
  82 Reads a line from the stream. A line is a string which ends with
  83 $\backslash$n or $\backslash$r$\backslash$n or $\backslash$r.
  84
  85 % ----------------------------------------------------------------------------
  86 % wxTextOutputStream
  87 % ----------------------------------------------------------------------------
  88
  89 \section{\class{wxTextOutputStream}}\label{wxtextoutputstream}
  90
  91 This class provides functions that write text datas using an output stream.
  92 So, you can write {\it text} floats, integers.
  93
  94 You can also simulate the C++ cout class:
  95 \begin{verbatim}
  96   wxFFileOutputStream output( stderr );
  97   wxTextOutputStream cout( output );
  98
  99   cout << "This is a text line" << endl;
 100   cout << 1234;
 101   cout << 1.23456;
 102 \end{verbatim}
 103
 104 The wxTextOutputStream writes text files (or streams) on DOS, Macintosh
 105 and Unix in their native formats (concerning the line ending).
 106
 107 \latexignore{\rtfignore{\wxheading{Members}}}
 108
 109 \membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamconstr}
 110
 111 \func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}}
 112
 113 Constructs a text stream object from an output stream. Only write methods will
 114 be available.
 115
 116 \wxheading{Parameters}
 117
 118 \docparam{stream}{The output stream.}
 119
 120 \docparam{mode}{The end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}.}
 121
 122 \membersection{wxTextOutputStream::\destruct{wxTextOutputStream}}
 123
 124 \func{}{\destruct{wxTextOutputStream}}{\void}
 125
 126 Destroys the wxTextOutputStream object.
 127
 128 \membersection{wxTextOutputStream::GetMode}
 129
 130 \func{wxEOL}{wxTextOutputStream::GetMode}{\void}
 131
 132 Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}.
 133
 134 \membersection{wxTextOutputStream::SetMode}
 135
 136 \func{void}{wxTextOutputStream::SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}}
 137
 138 Set the end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}.
 139
 140 \membersection{wxTextOutputStream::Write8}
 141
 142 \func{void}{wxTextOutputStream::Write8}{{\param wxUint8 }{i8}}
 143
 144 Writes the single byte {\it i8} to the stream.
 145
 146 \membersection{wxTextOutputStream::Write16}
 147
 148 \func{void}{wxTextOutputStream::Write16}{{\param wxUint16 }{i16}}
 149
 150 Writes the 16 bit integer {\it i16} to the stream.
 151
 152 \membersection{wxTextOutputStream::Write32}
 153
 154 \func{void}{wxTextOutputStream::Write32}{{\param wxUint32 }{i32}}
 155
 156 Writes the 32 bit integer {\it i32} to the stream.
 157
 158 \membersection{wxTextOutputStream::WriteDouble}
 159
 160 \func{virtual void}{wxTextOutputStream::WriteDouble}{{\param double }{f}}
 161
 162 Writes the double {\it f} to the stream using the IEEE format.
 163
 164 \membersection{wxTextOutputStream::WriteString}
 165
 166 \func{virtual void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}}
 167
 168 Writes {\it string} as a line. Depending on the end-of-line mode, it adds
 169 $\backslash$n, $\backslash$r or $\backslash$r$\backslash$n.
 170