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 % -----------
  39 % IO function
  40 % -----------
  41 \membersection{wxInputStream::Peek}
  42
  43 \func{char}{Peek}{\void}
  44
  45 Returns the first character in the input queue without removing it.
  46
  47 \membersection{wxInputStream::GetC}
  48
  49 \func{char}{GetC}{\void}
  50
  51 Returns the first character in the input queue and removes it.
  52
  53 \membersection{wxInputStream::Read}
  54
  55 \func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size_t}{ size}}
  56
  57 Reads the specified amount of bytes and stores the data in \it{buffer}.
  58
  59 \wxheading{Warning}
  60
  61 The buffer absolutely needs to have at least the specified size.
  62
  63 \wxheading{Return value}
  64
  65 This function returns a reference on the current object, so the user can test
  66 any states of the stream right away.
  67
  68 \func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream_out}}
  69
  70 Reads data from the input queue and stores it in the specified output stream.
  71 The data is read until an error is raised by one of the two streams.
  72
  73 \wxheading{Return value}
  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 % ------------------
  79 % Position functions
  80 % ------------------
  81 \membersection{wxInputStream::SeekI}
  82
  83 \func{off_t}{SeekI}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
  84
  85 Changes the stream current position.
  86
  87 \membersection{wxInputStream::TellI}
  88
  89 \constfunc{off_t}{TellI}{\void}
  90
  91 Returns the current stream position.
  92
  93 % ---------------
  94 % State functions
  95 % ---------------
  96 \membersection{wxInputStream::InputStreamBuffer}
  97
  98 \func{wxStreamBuffer*}{InputStreamBuffer}{\void}
  99
 100 Returns the stream buffer associated with the input stream.
 101
 102 \membersection{wxInputStream::LastRead}
 103
 104 \constfunc{size_t}{LastRead}{\void}
 105
 106 Returns the last number of bytes read.
 107