docs/latex/wx/outptstr.tex

   1 % -----------------------------------------------------------------------------
   2 % wxOutputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxOutputStream}}\label{wxoutputstream}
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxStreamBase}{wxstreambase}
   9
  10 \wxheading{Include files}
  11
  12 <wx/stream.h>
  13
  14 \wxheading{See also}
  15
  16 \helpref{wxStreamBuffer}{wxstreambuffer}
  17
  18 % -----------
  19 % ctor & dtor
  20 % -----------
  21 \membersection{wxOutputStream::wxOutputStream}
  22
  23 \func{}{wxOutputStream}{\void}
  24
  25 Creates a dummy wxOutputStream object.
  26
  27 \func{}{wxOutputStream}{\param{wxStreamBuffer*}{ sbuf}}
  28
  29 Creates an input stream using the specified stream buffer \it{sbuf}. This
  30 stream buffer can point to another stream.
  31
  32 \membersection{wxOutputStream::\destruct{wxOutputStream}}
  33
  34 \func{}{\destruct{wxOutputStream}}{\void}
  35
  36 Destructor.
  37
  38 % -----------
  39 % IO function
  40 % -----------
  41 \membersection{wxOutputStream::PutC}
  42
  43 \func{void}{PutC}{\param{char}{ c}}
  44
  45 Puts the specified character in the output queue and increments the
  46 stream position.
  47
  48 \membersection{wxOutputStream::Write}
  49
  50 \func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size_t}{ size}}
  51
  52 Writes the specified amount of bytes using the data of \it{buffer}.
  53 \it{WARNING!} The buffer absolutely needs to have at least the specified size.
  54
  55 This function returns a reference on the current object, so the user can test
  56 any states of the stream right away.
  57
  58 \func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream_in}}
  59
  60 Reads data from the specified input stream and stores them
  61 in the current stream. The data is read until an error is raised
  62 by one of the two streams.
  63
  64 % ------------------
  65 % Position functions
  66 % ------------------
  67 \membersection{wxOutputStream::SeekO}
  68
  69 \func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
  70
  71 Changes the stream current position.
  72
  73 \membersection{wxOutputStream::TellO}
  74
  75 \constfunc{off_t}{TellO}{\void}
  76
  77 Returns the current stream position.
  78
  79 % ---------------
  80 % State functions
  81 % ---------------
  82 \membersection{wxOutputStream::OutputStreamBuffer}
  83
  84 \func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
  85
  86 Returns the stream buffer associated with the output stream.
  87
  88 \membersection{wxOutputStream::LastWrite}
  89
  90 \constfunc{size_t}{LastWrite}{\void}
  91