docs/latex/wx/outptstr.tex

   1 % -----------------------------------------------------------------------------
   2 % wxOutputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxOutputStream}}\label{wxoutputstream}
   5
   6 wxOutputStream is an abstract base class which may not be used directly.
   7
   8 \wxheading{Derived from}
   9
  10 \helpref{wxStreamBase}{wxstreambase}
  11
  12 \wxheading{Include files}
  13
  14 <wx/stream.h>
  15
  16 % -----------
  17 % ctor & dtor
  18 % -----------
  19 \membersection{wxOutputStream::wxOutputStream}
  20
  21 \func{}{wxOutputStream}{\void}
  22
  23 Creates a dummy wxOutputStream object.
  24
  25 \membersection{wxOutputStream::\destruct{wxOutputStream}}
  26
  27 \func{}{\destruct{wxOutputStream}}{\void}
  28
  29 Destructor.
  30
  31 \membersection{wxOutputStream::LastWrite}
  32
  33 \constfunc{size\_t}{LastWrite}{\void}
  34
  35 Returns the number of bytes written during the last Write().
  36
  37 \membersection{wxOutputStream::PutC}
  38
  39 \func{void}{PutC}{\param{char}{ c}}
  40
  41 Puts the specified character in the output queue and increments the
  42 stream position.
  43
  44 \membersection{wxOutputStream::SeekO}
  45
  46 \func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
  47
  48 Changes the stream current position.
  49
  50 \membersection{wxOutputStream::TellO}
  51
  52 \constfunc{off\_t}{TellO}{\void}
  53
  54 Returns the current stream position.
  55
  56 \membersection{wxOutputStream::Write}
  57
  58 \func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
  59
  60 Writes the specified amount of bytes using the data of {\it buffer}.
  61 {\it WARNING!} The buffer absolutely needs to have at least the specified size.
  62
  63 This function returns a reference on the current object, so the user can test
  64 any states of the stream right away.
  65
  66 \func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream\_in}}
  67
  68 Reads data from the specified input stream and stores them
  69 in the current stream. The data is read until an error is raised
  70 by one of the two streams.
  71
  72 % -----------------------------------------------------------------------------
  73 % wxCountingOutputStream
  74 % -----------------------------------------------------------------------------
  75 \section{\class{wxCountOutputStream}}\label{wxcountingoutputstream}
  76
  77 wxCountingOutputStream is specialized output stream which does not write any data anyway,
  78 instead it counts how many bytes would get written if this were a normal stream. This
  79 can sometimes be useful or required if some data gets serialized to a stream or compressed
  80 by using stream compression and thus the final size of the stream cannot be known other
  81 than pretending to write the stream. One case where the resulting size would have to be
  82 known is if the data has to be written to a piece of memory and the memory has to be
  83 allocated before writing to it (which is probably always the case when writing to a
  84 memory stream).
  85
  86 \wxheading{Derived from}
  87
  88 \helpref{wxOutputStream}{wxstreambase}
  89 \helpref{wxStreamBase}{wxstreambase}
  90
  91 \wxheading{Include files}
  92
  93 <wx/stream.h>
  94
  95 % -----------
  96 % ctor & dtor
  97 % -----------
  98 \membersection{wxCountingOutputStream::wxCountingOutputStream}
  99
 100 \func{}{wxCountingOutputStream}{\void}
 101
 102 Creates a wxCountingOutputStream object.
 103
 104 \membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}
 105
 106 \func{}{\destruct{wxCountingOutputStream}}{\void}
 107
 108 Destructor.
 109
 110 \membersection{wxCountingOutputStream::GetSize}
 111
 112 \constfunc{size\_t}{GetSize}{\void}
 113
 114 Returns the current size of the stream.