Added periods

[wxWidgets.git] / docs / latex / wx / strmbase.tex

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index f35be6e23ca0dc6b50c75645aa679ee8a1b66e71..57f20bf29153274bd94ee8f9bf3ff5705b3c52f0 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -3,10 +3,21 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxStreamBase}}\label{wxstreambase}
 
 % -----------------------------------------------------------------------------
 \section{\class{wxStreamBase}}\label{wxstreambase}
 

+This class is the base class of most stream related classes in wxWidgets. It must
+not be used directly.
+

 \wxheading{Derived from}
 
 None
 
 \wxheading{Derived from}
 
 None
 

+\wxheading{Include files}
+
+<wx/stream.h>
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}
 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}


@@ -20,69 +31,107 @@ None
 % ctor & dtor
 % -----------
 
 % ctor & dtor
 % -----------
 

-\membersection{wxStreamBase::wxStreamBase}
+
+\membersection{wxStreamBase::wxStreamBase}\label{wxstreambasector}

 
 \func{}{wxStreamBase}{\void}
 
 Creates a dummy stream object. It doesn't do anything.
 
 
 \func{}{wxStreamBase}{\void}
 
 Creates a dummy stream object. It doesn't do anything.
 

-\membersection{wxStreamBase::\destruct{wxStreamBase}}
+
+\membersection{wxStreamBase::\destruct{wxStreamBase}}\label{wxstreambasedtor}

 
 \func{}{\destruct{wxStreamBase}}{\void}
 
 Destructor.
 
 
 \func{}{\destruct{wxStreamBase}}{\void}
 
 Destructor.
 

-\membersection{wxStreamBase::LastError}\label{wxstreambaselasterror}

 
 

-\constfunc{wxStreamError}{LastError}{\void}
+\membersection{wxStreamBase::GetLength}\label{wxstreambasegetlength}
+
+\constfunc{wxFileOffset}{GetLength}{\void}
+
+Returns the length of the stream in bytes. If the length cannot be determined
+(this is always the case for socket streams for example), returns 
+\texttt{wxInvalidOffset}.
+
+\newsince{2.5.4}
+
+
+\membersection{wxStreamBase::GetLastError}\label{wxstreambasegetlasterror}
+
+\constfunc{wxStreamError}{GetLastError}{\void}

 
 This function returns the last error.
 
 This function returns the last error.

+

 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt

-\twocolitem{{\bf wxStream_NOERROR}}{No error occured.}
-\twocolitem{{\bf wxStream_EOF}}{An End-Of-File occured.}
-\twocolitem{{\bf wxStream_WRITE_ERR}}{A generic error occured on the last write call.}
-\twocolitem{{\bf wxStream_READ_ERR}}{A generic error occured on the last read call.}
+\twocolitem{{\bf wxSTREAM\_NO\_ERROR}}{No error occurred.}
+\twocolitem{{\bf wxSTREAM\_EOF}}{An End-Of-File occurred.}
+\twocolitem{{\bf wxSTREAM\_WRITE\_ERROR}}{A generic error occurred on the last write call.}
+\twocolitem{{\bf wxSTREAM\_READ\_ERROR}}{A generic error occurred on the last read call.}

 \end{twocollist}
 
 \end{twocollist}
 

-\membersection{wxStreamBase::StreamSize}
-\constfunc{size_t}{StreamSize}{\void}

 
 

-This function returns the size of the stream. For example, for a file it is the size of
-the file).
+\membersection{wxStreamBase::GetSize}\label{wxstreambasegetsize}
+
+\constfunc{size\_t}{GetSize}{\void}
+
+\helpref{GetLength}{wxstreambasegetlength}
+
+This function returns the size of the stream. For example, for a file it is the
+size of the file.

 
 \wxheading{Warning}
 
 There are streams which do not have size by definition, such as socket streams.
 
 \wxheading{Warning}
 
 There are streams which do not have size by definition, such as socket streams.

-In that cases, StreamSize returns an invalid size represented by
-\begin{verbatim}
-~(size_t)0
-\end{verbatim}
+In that cases, GetSize returns $0$ so you should always test its return value.
+
+
+\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
+
+\constfunc{virtual bool}{IsOk}{\void}
+
+Returns true if no error occurred on the stream.
+
+\wxheading{See also}
+
+\helpref{GetLastError}{wxstreambasegetlasterror}
+
+
+\membersection{wxStreamBase::IsSeekable}\label{wxstreambaseisseekable}
+
+\constfunc{bool}{IsSeekable}{\void}
+
+Returns true if the streams supports seeking to arbitrary offsets.
+

 
 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
 
 
 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
 

-\func{size_t}{OnSysRead}{\param{void*}{ buffer}, \param{size_t}{ bufsize}}
+\func{size\_t}{OnSysRead}{\param{void*}{ buffer}, \param{size\_t}{ bufsize}}

 
 

-Internal function. It is called when the stream buffer needs a buffer of the
+Internal function. It is called when the stream wants to read data of the

 specified size. It should return the size that was actually read.
 
 specified size. It should return the size that was actually read.
 

-\membersection{wxStreamBase::OnSysWrite}

 
 

-\func{size_t}{OnSysWrite}{\param{void *}{buffer}, \param{size_t}{ bufsize}}
+\membersection{wxStreamBase::OnSysSeek}\label{wxstreambaseonsysseek}

 
 

-See \helpref{OnSysRead}{wxstreambaseonsysread}.
+\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}

 
 

-\membersection{wxStreamBase::OnSysSeek}
+Internal function. It is called when the stream needs to change the
+current position.

 
 

-\func{off_t}{OnSysSeek}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}

 
 

-Internal function. It is called when the stream buffer needs to change the
-current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambufferseek}
+\membersection{wxStreamBase::OnSysTell}\label{wxstreambaseonsystell}

 
 

-\membersection{wxStreamBase::OnSysTell}
+\constfunc{off\_t}{OnSysTell}{\void}

 
 

-\constfunc{off_t}{OnSysTell}{\void}
+Internal function. Is is called when the stream needs to know the
+real position.

 
 

-Internal function. Is is called when the stream buffer needs to know the
-real position in the stream.
+
+\membersection{wxStreamBase::OnSysWrite}\label{wxstreambaseonsyswrite}
+
+\func{size\_t}{OnSysWrite}{\param{const void *}{buffer}, \param{size\_t}{ bufsize}}
+
+See \helpref{OnSysRead}{wxstreambaseonsysread}.