docs/latex/wx/stream2.tex

   1 % -----------------------------------------------------------------------------
   2 % wxStreamBase
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxStreamBase}}\label{wxstreambase}
   5
   6 \wxheading{Derived from}
   7
   8 None
   9
  10 \wxheading{See also}
  11
  12 \helpref{wxStreamBuffer}{wxstreambuffer}
  13
  14 % -----------------------------------------------------------------------------
  15 % Members
  16 % -----------------------------------------------------------------------------
  17 \latexignore{\rtfignore{\wxheading{Members}}}
  18
  19 % -----------
  20 % ctor & dtor
  21 % -----------
  22
  23 \membersection{wxStreamBase::wxStreamBase}
  24 \func{}{wxStreamBase}{\void}
  25
  26 Creates a dummy stream object.
  27
  28 \membersection{wxStreamBase::\destruct{wxStreamBase}}
  29 \func{}{\destruct{wxStreamBase}}
  30
  31 Destructor.
  32
  33 \membersection{wxStreamBase::LastError}
  34 \constfunc{wxStreamError}{LastError}{\void}
  35
  36 This function returns the last happened error. It is of the form:
  37 % TODOTODOTODOTODOTODOTODOTODO
  38
  39 \membersection{wxStreamBase::StreamSize}
  40 \constfunc{size_t}{StreamSize}{\void}
  41
  42 This function returns the size of the stream. (E.g. for a file it the size of
  43 the file) Warning ! There are streams which haven't size by definition (E.g.
  44 a socket).
  45
  46 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
  47 \func{size_t}{OnSysRead}{\param{void *}{buffer}, \param{size_t}{ bufsize}}
  48
  49 Internal function. It is called when the stream buffer needs a buffer of the
  50 specified size. It should return the size which was actually read.
  51
  52 \membersection{wxStreamBase::OnSysWrite}
  53 \func{size_t}{OnSysWrite}{\param{void *}{buffer}, \param{size_t}{ bufsize}}
  54
  55 See \helpref{OnSysRead}{wxstreambaseonsysread}.
  56
  57 \membersection{wxStreamBase::OnSysSeek}
  58 \func{off_t}{OnSysSeek}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
  59
  60 Internal function. It is called when the stream buffer needs to change the
  61 current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambufferseek}
  62
  63 \membersection{wxStreamBase::OnSysTell}
  64 \constfunc{off_t}{OnSysTell}{\void}
  65
  66 Internal function. Is is called when the stream buffer needs to know the
  67 current position in the stream.
  68
  69 % -----------------------------------------------------------------------------
  70 % wxInputStream
  71 % -----------------------------------------------------------------------------
  72
  73 \section{\class{wxInputStream}}\label{wxinputstream}
  74
  75 \wxheading{Derived from}
  76
  77 \helpref{wxStreamBase}{wxstreambase}
  78
  79 \wxheading{See also}
  80
  81 \helpref{wxStreamBuffer}{wxstreambuffer}
  82
  83 % -----------
  84 % ctor & dtor
  85 % -----------
  86
  87 \membersection{wxInputStream::wxInputStream}
  88 \func{}{wxInputStream}{\void}
  89
  90 Creates a dummy input stream.
  91
  92 \func{}{wxInputStream}{\param{wxStreamBuffer *}{sbuf}}
  93
  94 Creates an input stream using the specified stream buffer \it{sbuf}. This
  95 stream buffer can point to another stream.
  96
  97 \membersection{wxInputStream::\destruct{wxInputStream}}
  98 \func{}{\destruct{wxInputStream}}
  99
 100 Destructor.
 101
 102 % -----------
 103 % IO function
 104 % -----------
 105
 106 \membersection{wxInputStream::Peek}
 107 \func{char}{Peek}{\void}
 108
 109 \membersection{wxInputStream::GetC}
 110 \func{char}{GetC}{\void}
 111
 112 \membersection{wxInputStream::Read}
 113 \func{wxInputStream&}{Read}{\param{void *}{buffer}, \param{size_t}{ size}}
 114
 115 \func{wxInputStream&}{Read}{\param{wxOutputStream&}{ stream_out}}
 116
 117 % ------------------
 118 % Position functions
 119 % ------------------
 120
 121 \membersection{wxInputStream::SeekI}
 122 \func{off_t}{SeekI}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
 123
 124 \membersection{wxInputStream::TellI}
 125 \constfunc{off_t}{TellI}{\void}
 126
 127 % ---------------
 128 % State functions
 129 % ---------------
 130
 131 \membersection{wxInputStream::InputStreamBuffer}
 132 \func{wxStreamBuffer *}{InputStreamBuffer}{\void}
 133
 134 \membersection{wxInputStream::LastRead}
 135 \constfunc{size_t}{LastRead}{\void}
 136
 137 % -----------------------------------------------------------------------------
 138 % wxOutputStream
 139 % -----------------------------------------------------------------------------
 140
 141 \section{\class{wx0utputStream}}\label{wxoutputstream}
 142
 143 \wxheading{Derived from}
 144
 145 \helpref{wxStreamBase}{wxstreambase}
 146
 147 \wxheading{See also}
 148
 149 \helpref{wxStreamBuffer}{wxstreambuffer}
 150
 151 % -----------
 152 % ctor & dtor
 153 % -----------
 154
 155 \membersection{wxOutputStream::wxInputStream}
 156 \func{}{wxOutputStream}{\void}
 157
 158 \func{}{wxOutputStream}{\param{wxStreamBuffer *}{sbuf}}
 159
 160 \membersection{wxOutputStream::\destruct{wxOutputStream}}
 161 \func{}{\destruct{wxOutputStream}}
 162
 163 % -----------
 164 % IO function
 165 % -----------
 166
 167 \membersection{wxOutputStream::PutC}
 168 \func{char}{PutC}{\void}
 169
 170 \membersection{wxOutputStream::Write}
 171 \func{wxOutputStream&}{Write}{\param{const void *}{buffer}, \param{size_t}{ size}}
 172
 173 \func{wxOutputStream&}{Write}{\param{wxInputStream&}{ stream_in}}
 174
 175 % ------------------
 176 % Position functions
 177 % ------------------
 178
 179 \membersection{wxOutputStream::SeekO}
 180 \func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
 181
 182 \membersection{wxOutputStream::TellO}
 183 \constfunc{off_t}{TellO}{\void}
 184
 185 % ---------------
 186 % State functions
 187 % ---------------
 188
 189 \membersection{wxOutputStream::OutputStreamBuffer}
 190 \func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
 191
 192 \membersection{wxOutputStream::LastWrite}
 193 \constfunc{size_t}{LastWrite}{\void}
 194
 195
 196 % -----------------------------------------------------------------------------
 197 % wxFilterInputStream
 198 % -----------------------------------------------------------------------------
 199
 200 \section{\class{wxFilterInputStream}}\label{wxfilterinputstream}
 201
 202 \wxheading{Derived from}
 203
 204 \helpref{wxInputStream}{wxinputstream}
 205
 206 \wxheading{Note}
 207
 208 The use of this class is exactly the same as of wxInputStream. Only a constructor
 209 differs and it is documented below.
 210
 211 % -----------
 212 % ctor & dtor
 213 % -----------
 214 \membersection{wxFilterInputStream::wxFilterInputStream}
 215 \func{}{wxFilterInputStream}{\param{wxInputStream&}{ stream}}
 216
 217 % -----------------------------------------------------------------------------
 218 % wxFilterOutputStream
 219 % -----------------------------------------------------------------------------
 220
 221 \section{\class{wxFilterOutputStream}}\label{wxfilteroutputstream}
 222
 223 \wxheading{Derived from}
 224
 225 \helpref{wxOutputStream}{wxoutputstream}
 226
 227 \wxheading{Note}
 228
 229 The use of this class is exactly the same as of wxOutputStream. Only a constructor
 230 differs and it is documented below.
 231
 232 % -----------
 233 % ctor & dtor
 234 % -----------
 235 \membersection{wxFilterOutputStream::wxFilterOutputStream}
 236 \func{}{wxFilterOutputStream}{\param{wxOutputStream&}{ stream}}