docs/latex/wx/datstrm.tex

   1 % ----------------------------------------------------------------------------
   2 % wxDataInputStream
   3 % ----------------------------------------------------------------------------
   4 \section{\class{wxDataInputStream}}\label{wxdatainputstream}
   5
   6 This class provides functions that read data types in a
   7 portable way. So, a file written by an Intel processor can be read by a
   8 Sparc or anything else.
   9
  10 \wxheading{Include files}
  11
  12 <wx/datstrm.h>
  13
  14 \latexignore{\rtfignore{\wxheading{Members}}}
  15
  16 \membersection{wxDataInputStream::wxDataInputStream}\label{wxdatainputstreamconstr}
  17
  18 \func{}{wxDataInputStream}{\param{wxInputStream\&}{ stream}}
  19
  20 Constructs a datastream object from an input stream. Only read methods will
  21 be available.
  22
  23 \wxheading{Parameters}
  24
  25 \docparam{stream}{The input stream.}
  26
  27 \membersection{wxDataInputStream::\destruct{wxDataInputStream}}
  28
  29 \func{}{\destruct{wxDataInputStream}}{\void}
  30
  31 Destroys the wxDataInputStream object.
  32
  33 \membersection{wxDataInputStream::Read8}
  34
  35 \func{unsigned char}{Read8}{\void}
  36
  37 Reads a single byte from the stream.
  38
  39 \membersection{wxDataInputStream::Read16}
  40
  41 \func{unsigned short}{Read16}{\void}
  42
  43 Reads a 16 bit integer from the stream.
  44
  45 \membersection{wxDataInputStream::Read32}
  46
  47 \func{unsigned long}{Read32}{\void}
  48
  49 Reads a 32 bit integer from the stream.
  50
  51 \membersection{wxDataInputStream::ReadDouble}
  52
  53 \func{double}{ReadDouble}{\void}
  54
  55 Reads a double (IEEE encoded) from the stream.
  56
  57 \membersection{wxDataInputStream::ReadString}
  58
  59 \func{wxString}{wxDataInputStream::ReadString}{\void}
  60
  61 Reads a string from a stream. Actually, this function first reads a long integer
  62 specifying the length of the string (without the last null character) and then
  63 reads the string.
  64
  65 % ----------------------------------------------------------------------------
  66 % wxDataOutputStream
  67 % ----------------------------------------------------------------------------
  68
  69 \section{\class{wxDataOutputStream}}\label{wxdataoutputstream}
  70
  71 This class provides functions that write data types in a
  72 portable way. So, a file written by an Intel processor can be read by a
  73 Sparc or anything else.
  74
  75 \latexignore{\rtfignore{\wxheading{Members}}}
  76
  77 \membersection{wxDataOutputStream::wxDataOutputStream}\label{wxdataoutputstreamconstr}
  78
  79 \func{}{wxDataInputStream}{\param{wxOutputStream\&}{ stream}}
  80
  81 Constructs a datastream object from an output stream. Only read methods will
  82 be available.
  83
  84 \wxheading{Parameters}
  85
  86 \docparam{stream}{The output stream.}
  87
  88 \membersection{wxDataOutputStream::\destruct{wxDataOutputStream}}
  89
  90 \func{}{\destruct{wxDataOutputStream}}{\void}
  91
  92 Destroys the wxDataOutputStream object.
  93
  94 \membersection{wxDataOutputStream::Write8}
  95
  96 \func{void}{wxDataOutputStream::Write8}{{\param unsigned char }{i8}}
  97
  98 Writes the single byte {\it i8} to the stream.
  99
 100 \membersection{wxDataOutputStream::Write16}
 101
 102 \func{void}{wxDataOutputStream::Write16}{{\param unsigned short }{i16}}
 103
 104 Writes the 16 bit integer {\it i16} to the stream.
 105
 106 \membersection{wxDataOutputStream::Write32}
 107
 108 \func{void}{wxDataOutputStream::Write32}{{\param unsigned long }{i32}}
 109
 110 Writes the 32 bit integer {\it i32} to the stream.
 111
 112 \membersection{wxDataOutputStream::WriteDouble}
 113
 114 \func{void}{wxDataOutputStream::WriteDouble}{{\param double }{f}}
 115
 116 Writes the double {\it f} to the stream using the IEEE format.
 117
 118 \membersection{wxDataOutputStream::WriteString}
 119
 120 \func{void}{wxDataOutputStream::WriteString}{{\param const wxString\& }{string}}
 121
 122 Writes {\it string} to the stream. Actually, this method writes the size of
 123 the string before writing {\it string} itself.