added wxString::EndsWith() (patch 1483049)

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

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index 243e5a48ef01a74d20e6687b967a21c8322db6cc..dc7a184b5112e3622cb374dffb1020ad67cca9d2 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -3,7 +3,7 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxStreamBase}}\label{wxstreambase}
 
-This class is the base class of most stream related classes in wxWindows. It must
+This class is the base class of most stream related classes in wxWidgets. It must
 not be used directly.
 
 \wxheading{Derived from}
@@ -27,31 +27,35 @@ None
 % ctor & dtor
 % -----------
 
-\membersection{wxStreamBase::wxStreamBase}
+
+\membersection{wxStreamBase::wxStreamBase}\label{wxstreambasector}
 
 \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.
 
-\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
 
-\constfunc{wxStreamError}{IsOk}{\void}
+\membersection{wxStreamBase::GetLength}\label{wxstreambasegetlength}
 
-Returns TRUE if no error occurred on the stream.
+\constfunc{wxFileOffset}{GetLength}{\void}
 
-\wxheading{See also}
+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}
 
-\helpref{LastError}{wxstreambaselasterror}
 
-\membersection{wxStreamBase::LastError}\label{wxstreambaselasterror}
+\membersection{wxStreamBase::GetLastError}\label{wxstreambasegetlasterror}
 
-\constfunc{wxStreamError}{LastError}{\void}
+\constfunc{wxStreamError}{GetLastError}{\void}
 
 This function returns the last error.
 
@@ -63,6 +67,40 @@ This function returns the last error.
 \twocolitem{{\bf wxSTREAM\_READ\_ERROR}}{A generic error occurred on the last read call.}
 \end{twocollist}
 
+
+\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.
+In that cases, GetSize returns $0$ so you should always test its return value.
+
+
+\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
+
+\constfunc{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}
 
 \func{size\_t}{OnSysRead}{\param{void*}{ buffer}, \param{size\_t}{ bufsize}}
@@ -70,39 +108,26 @@ This function returns the last error.
 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.
 
-\membersection{wxStreamBase::OnSysSeek}
+
+\membersection{wxStreamBase::OnSysSeek}\label{wxstreambaseonsysseek}
 
 \func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
 
 Internal function. It is called when the stream needs to change the
 current position.
 
-\membersection{wxStreamBase::OnSysTell}
+
+\membersection{wxStreamBase::OnSysTell}\label{wxstreambaseonsystell}
 
 \constfunc{off\_t}{OnSysTell}{\void}
 
 Internal function. Is is called when the stream needs to know the
 real position.
 
-\membersection{wxStreamBase::OnSysWrite}
 
-\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}}
+\membersection{wxStreamBase::OnSysWrite}\label{wxstreambaseonsyswrite}
 
-See \helpref{OnSysRead}{wxstreambaseonsysread}.
+\func{size\_t}{OnSysWrite}{\param{const void *}{buffer}, \param{size\_t}{ bufsize}}
 
-\membersection{wxStreamBase::GetSize}\label{wxstreambasegetsize}
-
-\constfunc{size\_t}{GetSize}{\void}
-
-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.
-In that cases, GetSize returns an invalid size represented by
-
-\begin{verbatim}
-~(size_t)0
-\end{verbatim}
+See \helpref{OnSysRead}{wxstreambaseonsysread}.