docs/latex/wx/strmbfrd.tex

   1 % -----------------------------------------------------------------------------
   2 % wxBufferedInputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxBufferedInputStream}}\label{wxbufferedinputstream}
   5
   6 This stream acts as a cache. It caches the bytes read from the specified
   7 input stream (See \helpref{wxFilterInputStream}{wxfilterinputstream}).
   8 It uses wxStreamBuffer and sets the default in-buffer size to 1024 bytes.
   9 This class may not be used without some other stream to read the data
  10 from (such as a file stream or a memory stream).
  11
  12 \wxheading{Derived from}
  13
  14 \helpref{wxFilterInputStream}{wxfilterinputstream}
  15
  16 \wxheading{Include files}
  17
  18 <wx/stream.h>
  19
  20 \wxheading{Library}
  21
  22 \helpref{wxBase}{librarieslist}
  23
  24 \wxheading{See also}
  25
  26 \helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxInputStream}{wxinputstream},
  27 \helpref{wxBufferedOutputStream}{wxbufferedoutputstream}
  28
  29 % -----------------------------------------------------------------------------
  30 % wxBufferedOutputStream
  31 % -----------------------------------------------------------------------------
  32 \section{\class{wxBufferedOutputStream}}\label{wxbufferedoutputstream}
  33
  34 This stream acts as a cache. It caches the bytes to be written to the specified
  35 output stream (See \helpref{wxFilterOutputStream}{wxfilteroutputstream}). The
  36 data is only written when the cache is full, when the buffered stream is
  37 destroyed or when calling SeekO().
  38
  39 This class may not be used without some other stream to write the data
  40 to (such as a file stream or a memory stream).
  41
  42 \wxheading{Derived from}
  43
  44 \helpref{wxFilterOutputStream}{wxfilteroutputstream}
  45
  46 \wxheading{Include files}
  47
  48 <wx/stream.h>
  49
  50 \wxheading{Library}
  51
  52 \helpref{wxBase}{librarieslist}
  53
  54 \wxheading{See also}
  55
  56 \helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxOutputStream}{wxoutputstream}
  57
  58 % ----------
  59 % Members
  60 % ----------
  61 \latexignore{\rtfignore{\wxheading{Members}}}
  62
  63 \membersection{wxBufferedOutputStream::wxBufferedOutputStream}\label{wxbufferedoutputstreamctor}
  64
  65 \func{}{wxBufferedOutputStream}{\param{const wxOutputStream\&}{ parent}}
  66
  67 Creates a buffered stream using a buffer of a default size of 1024 bytes for cashing
  68 the stream {\it parent}.
  69
  70 \membersection{wxBufferedOutputStream::\destruct{wxBufferedOutputStream}}\label{wxbufferedoutputstreamdtor}
  71
  72 \func{}{\destruct{wxBufferedOutputStream}}{\void}
  73
  74 Destructor. Calls Sync() and destroys the internal buffer.
  75
  76 \membersection{wxBufferedOutputStream::SeekO}\label{wxbufferedoutputstreamseeko}
  77
  78 \func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
  79
  80 Calls Sync() and changes the stream position.
  81
  82 \membersection{wxBufferedOutputStream::Sync}\label{wxbufferedoutputstreamsync}
  83
  84 \func{void}{Sync}{\void}
  85
  86 Flushes the buffer and calls Sync() on the parent stream.
  87
  88
  89