docs/latex/wx/countstr.tex

   1 % -----------------------------------------------------------------------------
   2 % wxCountingOutputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream}
   5
   6 wxCountingOutputStream is a specialized output stream which does not write any data anywhere,
   7 instead it counts how many bytes would get written if this were a normal stream. This
   8 can sometimes be useful or required if some data gets serialized to a stream or compressed
   9 by using stream compression and thus the final size of the stream cannot be known other
  10 than pretending to write the stream. One case where the resulting size would have to be
  11 known is if the data has to be written to a piece of memory and the memory has to be
  12 allocated before writing to it (which is probably always the case when writing to a
  13 memory stream).
  14
  15 \wxheading{Derived from}
  16
  17 \helpref{wxOutputStream}{wxoutputstream}
  18 \helpref{wxStreamBase}{wxstreambase}
  19
  20 \wxheading{Include files}
  21
  22 <wx/stream.h>
  23
  24 \wxheading{Library}
  25
  26 \helpref{wxBase}{librarieslist}
  27
  28 \latexignore{\rtfignore{\wxheading{Members}}}
  29
  30 % -----------
  31 % ctor & dtor
  32 % -----------
  33 \membersection{wxCountingOutputStream::wxCountingOutputStream}\label{wxcountingoutputstreamctor}
  34
  35 \func{}{wxCountingOutputStream}{\void}
  36
  37 Creates a wxCountingOutputStream object.
  38
  39 \membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}\label{wxcountingoutputstreamdtor}
  40
  41 \func{}{\destruct{wxCountingOutputStream}}{\void}
  42
  43 Destructor.
  44
  45 \membersection{wxCountingOutputStream::GetSize}\label{wxcountingoutputstreamgetsize}
  46
  47 \constfunc{size\_t}{GetSize}{\void}
  48
  49 Returns the current size of the stream.
  50