added format parameter to File/DirName()

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

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index cfd0d3bfdded070db7e3bd964e21353c4bce7923..857394939e2f46e78ca1d2564b1b9df6fecfc411 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -3,10 +3,17 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxStreamBase}}\label{wxstreambase}
 
 % -----------------------------------------------------------------------------
 \section{\class{wxStreamBase}}\label{wxstreambase}
 

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

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

+\wxheading{Include files}
+
+<wx/stream.h>
+

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


@@ -24,7 +31,7 @@ None
 
 \func{}{wxStreamBase}{\void}
 
 
 \func{}{wxStreamBase}{\void}
 

-Creates a dummy stream object.
+Creates a dummy stream object. It doesn't do anything.

 
 \membersection{wxStreamBase::\destruct{wxStreamBase}}
 
 
 \membersection{wxStreamBase::\destruct{wxStreamBase}}
 


@@ -32,114 +39,66 @@ Creates a dummy stream object.
 
 Destructor.
 
 
 Destructor.
 

+\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
+
+\constfunc{wxStreamError}{IsOk}{\void}
+
+Returns true if no error occurred on the stream.
+
+\wxheading{See also}
+
+\helpref{LastError}{wxstreambaselasterror}
+

 \membersection{wxStreamBase::LastError}\label{wxstreambaselasterror}
 
 \constfunc{wxStreamError}{LastError}{\void}
 
 This function returns the last error.
 \membersection{wxStreamBase::LastError}\label{wxstreambaselasterror}
 
 \constfunc{wxStreamError}{LastError}{\void}
 
 This function returns the last error.

-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}

 
 

-This function returns the size of the stream. For example, for a file it is the size of
-the file). Warning! There are streams which do not have size by definition, such as a socket.
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\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}

 
 \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}}
-
-See \helpref{OnSysRead}{wxstreambaseonsysread}.
-

 \membersection{wxStreamBase::OnSysSeek}
 
 \membersection{wxStreamBase::OnSysSeek}
 

-\func{off_t}{OnSysSeek}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
+\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}
+Internal function. It is called when the stream needs to change the
+current position.

 
 \membersection{wxStreamBase::OnSysTell}
 
 
 \membersection{wxStreamBase::OnSysTell}
 

-\constfunc{off_t}{OnSysTell}{\void}
-
-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}
+\constfunc{off\_t}{OnSysTell}{\void}

 
 

-% -----------------------------------------------------------------------------
-% Members
-% -----------------------------------------------------------------------------
-\latexignore{\rtfignore{\wxheading{Members}}} 
+Internal function. Is is called when the stream needs to know the
+real position.

 
 

-% -----------
-% 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.
+\membersection{wxStreamBase::OnSysWrite}

 
 

-% -------
-% IO call
-% -------
+\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}}

 
 

-\membersection{wxInputStream::Peek}
-\func{char}{Peek}{\void}
+See \helpref{OnSysRead}{wxstreambaseonsysread}.

 
 

-\membersection{wxInputStream::GetC}
-\func{char}{GetC}{\void}
+\membersection{wxStreamBase::GetSize}\label{wxstreambasegetsize}

 
 

-\membersection{wxInputStream::Read}
-\func{wxInputStream&}{Read}{\param{void *}{buffer}, \param{size_t}{ size}}
-\func{wxInputStream&}{Read}{\param{wxOutputStream&}{ stream_out}}
+\constfunc{size\_t}{GetSize}{\void}

 
 

-\membersection{wxInputStream::SeekI}
-\func{off_t}{SeekI}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
+This function returns the size of the stream. For example, for a file it is the size of
+the file.

 
 

-\membersection{wxInputStream::TellI}
-\constfunc{off_t}{TellI}{\void}
+\wxheading{Warning}

 
 

-% -----
-% State
-% -----
-\membersection{wxInputStream::InputStreamBuffer}
-\func{wxStreamBuffer *}{InputStreamBuffer}{\void}
+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{wxInputStream::LastRead}
-\func{size_t}{LastRead}{\void}