From: Guilhem Lavaux Date: Mon, 1 Feb 1999 18:09:27 +0000 (+0000) Subject: * Someone destroy a part of my previous work. Redocumenting ... X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/f2fc7f71ce3878b0f51c4cfa2f9177175788f8e4 * Someone destroy a part of my previous work. Redocumenting ... git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1563 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 5902315c4e..cfd0d3bfdd 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -37,8 +37,14 @@ Destructor. \constfunc{wxStreamError}{LastError}{\void} This function returns the last error. -% It is of the form: -% TODO +It is of the form: +\twocolwidtha{7cm}% +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf wxStream_NOERROR}}{No error occured.} +\twocolitem{{\bf wxStream_EOF}}{An End Of File exception occured.} +\twocolitem{{\bf wxStream_WRITE_ERR}{Error during the last write call.} +\twocolitem{{\bf wxStream_READ_ERR}{Error during the last read call.} +\end{twocollist}% \membersection{wxStreamBase::StreamSize} \constfunc{size_t}{StreamSize}{\void} @@ -73,3 +79,67 @@ current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambuffe Internal function. Is is called when the stream buffer needs to know the current position in the stream. +% ----------------------------------------------------------------------------- +% wxInputStream +% ----------------------------------------------------------------------------- +\section{\class{wxInputStream}}\label{wxinputstream} + +\wxheading{Derived from} + +\helpref{wxStreamBase}{wxstreambase} + +\wxheading{See also} + +\helpref{wxStreamBuffer}{wxstreambuffer} + +% ----------------------------------------------------------------------------- +% Members +% ----------------------------------------------------------------------------- +\latexignore{\rtfignore{\wxheading{Members}}} + +% ----------- +% ctor & dtor +% ----------- + +\membersection{wxInputStream::wxInputStream} +\func{}{wxInputStream}{\void} + +Initializes a dummy input stream. + +\func{}{wxInputStream}{\param{wxStreamBuffer *}{sbuf}} + +Initializes an input stream linked to the specified stream buffer. + +\membersection{wxInputStream::\destruct{wxInputStream}} +\func{}{\destruct{wxInputStream}{\void} + +Destructor. + +% ------- +% IO call +% ------- + +\membersection{wxInputStream::Peek} +\func{char}{Peek}{\void} + +\membersection{wxInputStream::GetC} +\func{char}{GetC}{\void} + +\membersection{wxInputStream::Read} +\func{wxInputStream&}{Read}{\param{void *}{buffer}, \param{size_t}{ size}} +\func{wxInputStream&}{Read}{\param{wxOutputStream&}{ stream_out}} + +\membersection{wxInputStream::SeekI} +\func{off_t}{SeekI}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}} + +\membersection{wxInputStream::TellI} +\constfunc{off_t}{TellI}{\void} + +% ----- +% State +% ----- +\membersection{wxInputStream::InputStreamBuffer} +\func{wxStreamBuffer *}{InputStreamBuffer}{\void} + +\membersection{wxInputStream::LastRead} +\func{size_t}{LastRead}{\void}