docs/latex/wx/strmbase.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
  25 \func{}{wxStreamBase}{\void}
  26
  27 Creates a dummy stream object. It doesn't do anything.
  28
  29 \membersection{wxStreamBase::\destruct{wxStreamBase}}
  30
  31 \func{}{\destruct{wxStreamBase}}{\void}
  32
  33 Destructor.
  34
  35 \membersection{wxStreamBase::LastError}\label{wxstreambaselasterror}
  36
  37 \constfunc{wxStreamError}{LastError}{\void}
  38
  39 This function returns the last error.
  40 \twocolwidtha{5cm}
  41 \begin{twocollist}\itemsep=0pt
  42 \twocolitem{{\bf wxStream_NOERROR}}{No error occured.}
  43 \twocolitem{{\bf wxStream_EOF}}{An End-Of-File occured.}
  44 \twocolitem{{\bf wxStream_WRITE_ERR}}{A generic error occured on the last write call.}
  45 \twocolitem{{\bf wxStream_READ_ERR}}{A generic error occured on the last read call.}
  46 \end{twocollist}
  47
  48 \membersection{wxStreamBase::StreamSize}
  49 \constfunc{size_t}{StreamSize}{\void}
  50
  51 This function returns the size of the stream. For example, for a file it is the size of
  52 the file).
  53
  54 \wxheading{Warning}
  55
  56 There are streams which do not have size by definition, such as socket streams.
  57 In that cases, StreamSize returns an invalid size represented by
  58 \begin{verbatim}
  59 ~(size_t)0
  60 \end{verbatim}
  61
  62 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
  63
  64 \func{size_t}{OnSysRead}{\param{void*}{ buffer}, \param{size_t}{ bufsize}}
  65
  66 Internal function. It is called when the stream buffer needs a buffer of the
  67 specified size. It should return the size that was actually read.
  68
  69 \membersection{wxStreamBase::OnSysWrite}
  70
  71 \func{size_t}{OnSysWrite}{\param{void *}{buffer}, \param{size_t}{ bufsize}}
  72
  73 See \helpref{OnSysRead}{wxstreambaseonsysread}.
  74
  75 \membersection{wxStreamBase::OnSysSeek}
  76
  77 \func{off_t}{OnSysSeek}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
  78
  79 Internal function. It is called when the stream buffer needs to change the
  80 current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambufferseek}
  81
  82 \membersection{wxStreamBase::OnSysTell}
  83
  84 \constfunc{off_t}{OnSysTell}{\void}
  85
  86 Internal function. Is is called when the stream buffer needs to know the
  87 real position in the stream.
  88