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