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{See also}
  11
  12 \helpref{wxStreamBuffer}{wxstreambuffer}
  13
  14 % -----------
  15 % ctor & dtor
  16 % -----------
  17 \membersection{wxOutputStream::wxOutputStream}
  18
  19 \func{}{wxOutputStream}{\void}
  20
  21 Creates a dummy wxOutputStream object.
  22
  23 \func{}{wxOutputStream}{\param{wxStreamBuffer*}{ sbuf}}
  24
  25 Creates an input stream using the specified stream buffer \it{sbuf}. This
  26 stream buffer can point to another stream.
  27
  28 \membersection{wxOutputStream::\destruct{wxOutputStream}}
  29
  30 \func{}{\destruct{wxOutputStream}}{\void}
  31
  32 Destructor.
  33
  34 % -----------
  35 % IO function
  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::Write}
  45
  46 \func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size_t}{ size}}
  47
  48 Writes the specified amount of bytes using the data of \it{buffer}.
  49 \it{WARNING!} The buffer absolutely needs to have at least the specified size.
  50
  51 This function returns a reference on the current object, so the user can test
  52 any states of the stream right away.
  53
  54 \func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream_in}}
  55
  56 Reads data from the specified input stream and stores them
  57 in the current stream. The data is read until an error is raised
  58 by one of the two streams.
  59
  60 % ------------------
  61 % Position functions
  62 % ------------------
  63 \membersection{wxOutputStream::SeekO}
  64
  65 \func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
  66
  67 Changes the stream current position.
  68
  69 \membersection{wxOutputStream::TellO}
  70
  71 \constfunc{off_t}{TellO}{\void}
  72
  73 Returns the current stream position.
  74
  75 % ---------------
  76 % State functions
  77 % ---------------
  78 \membersection{wxOutputStream::OutputStreamBuffer}
  79
  80 \func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
  81
  82 Returns the stream buffer associated with the output stream.
  83
  84 \membersection{wxOutputStream::LastWrite}
  85
  86 \constfunc{size_t}{LastWrite}{\void}
  87