docs/latex/wx/inputstr.tex

   1 % -----------------------------------------------------------------------------
   2 % wxInputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxInputStream}}\label{wxinputstream}
   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{wxInputStream::wxInputStream}
  22
  23 \func{}{wxInputStream}{\void}
  24
  25 Creates a dummy input stream.
  26
  27 \func{}{wxInputStream}{\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{wxInputStream::\destruct{wxInputStream}}
  33
  34 \func{}{\destruct{wxInputStream}}{\void}
  35
  36 Destructor.
  37
  38 \membersection{wxInputStream::GetC}
  39
  40 \func{char}{GetC}{\void}
  41
  42 Returns the first character in the input queue and removes it.
  43
  44 \membersection{wxInputStream::InputStreamBuffer}
  45
  46 \func{wxStreamBuffer*}{InputStreamBuffer}{\void}
  47
  48 Returns the stream buffer associated with the input stream.
  49
  50 \membersection{wxInputStream::LastRead}
  51
  52 \constfunc{size\_t}{LastRead}{\void}
  53
  54 Returns the last number of bytes read.
  55
  56 \membersection{wxInputStream::Peek}
  57
  58 \func{char}{Peek}{\void}
  59
  60 Returns the first character in the input queue without removing it.
  61
  62 \membersection{wxInputStream::Read}
  63
  64 \func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}}
  65
  66 Reads the specified amount of bytes and stores the data in \it{buffer}.
  67
  68 \wxheading{Warning}
  69
  70 The buffer absolutely needs to have at least the specified size.
  71
  72 \wxheading{Return value}
  73
  74 This function returns a reference on the current object, so the user can test
  75 any states of the stream right away.
  76
  77 \func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream\_out}}
  78
  79 Reads data from the input queue and stores it in the specified output stream.
  80 The data is read until an error is raised by one of the two streams.
  81
  82 \wxheading{Return value}
  83
  84 This function returns a reference on the current object, so the user can test
  85 any states of the stream right away.
  86
  87 \membersection{wxInputStream::SeekI}
  88
  89 \func{off\_t}{SeekI}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
  90
  91 Changes the stream current position.
  92
  93 \membersection{wxInputStream::TellI}
  94
  95 \constfunc{off\_t}{TellI}{\void}
  96
  97 Returns the current stream position.
  98