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 \latexignore{\rtfignore{\wxheading{Members}}}
  17
  18 % -----------
  19 % ctor & dtor
  20 % -----------
  21 \membersection{wxOutputStream::wxOutputStream}
  22
  23 \func{}{wxOutputStream}{\void}
  24
  25 Creates a dummy wxOutputStream object.
  26
  27 \membersection{wxOutputStream::\destruct{wxOutputStream}}
  28
  29 \func{}{\destruct{wxOutputStream}}{\void}
  30
  31 Destructor.
  32
  33 \membersection{wxOutputStream::LastWrite}
  34
  35 \constfunc{size\_t}{LastWrite}{\void}
  36
  37 Returns the number of bytes written during the last Write().
  38
  39 \membersection{wxOutputStream::PutC}
  40
  41 \func{void}{PutC}{\param{char}{ c}}
  42
  43 Puts the specified character in the output queue and increments the
  44 stream position.
  45
  46 \membersection{wxOutputStream::SeekO}\label{wxoutputstreamseeko}
  47
  48 \func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
  49
  50 Changes the stream current position.
  51
  52 \wxheading{Parameters}
  53
  54 \docparam{pos}{Offset to seek to.}
  55
  56 \docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.}
  57
  58 \wxheading{Return value}
  59
  60 The new stream position or wxInvalidOffset on error.
  61
  62 \membersection{wxOutputStream::TellO}
  63
  64 \constfunc{off\_t}{TellO}{\void}
  65
  66 Returns the current stream position.
  67
  68 \membersection{wxOutputStream::Write}
  69
  70 \func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
  71
  72 Writes the specified amount of bytes using the data of {\it buffer}.
  73 {\it WARNING!} The buffer absolutely needs to have at least the specified size.
  74
  75 This function returns a reference on the current object, so the user can test
  76 any states of the stream right away.
  77
  78 \func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream\_in}}
  79
  80 Reads data from the specified input stream and stores them
  81 in the current stream. The data is read until an error is raised
  82 by one of the two streams.
  83