use wxChar correctly in wxString docs; mark wx1 compatibility functions

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

diff --git a/docs/latex/wx/strmmem.tex b/docs/latex/wx/strmmem.tex
index ebf0bcaf9df8a51333ee1b9d88dffcae643d553b..64f28a1e5ff6fa275936362a86bc78db742ece99 100644 (file)
--- a/docs/latex/wx/strmmem.tex
+++ b/docs/latex/wx/strmmem.tex
@@ -7,38 +7,45 @@
 
 \helpref{wxInputStream}{wxinputstream}
 
-\wxheading{See also}
-
-\helpref{wxStreamBuffer}{wxstreamBuffer}
+\wxheading{Include files}
 
-\wxheading{Remark}
+<wx/mstream.h>
 
-You can create a similar stream by this way:
-\begin{verbatim}
-  wxStreamBuffer *sb = new wxStreamBuffer(wxStreamBuffer::read);
-  wxInputStream *input = new wxInputStream(sb);
+\wxheading{See also}
 
-  sb->SetBufferIO(data, data\_end);
-\end{verbatim}
+\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxMemoryOutputStream}{wxmemoutputstream}
 
 % ----------
 % Members
 % ----------
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxMemoryInputStream::wxMemoryInputStream}
+\membersection{wxMemoryInputStream::wxMemoryInputStream}\label{wxmemoryinputstreamctor}
 
 \func{}{wxMemoryInputStream}{\param{const char *}{ data}, \param{size\_t}{ len}}
 
 Initializes a new read-only memory stream which will use the specified buffer
-\it{data} of length \it{len}.
+{\it data} of length {\it len}. The stream does not take ownership of the 
+buffer, i.e. the buffer will not be deleted in its destructor.
 
-\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}
+\func{}{wxMemoryInputStream}{\param{const wxMemoryOutputStream&}{ stream}}
 
-\func{}{\destruct{wxFileInputStream}}{\void}
+Creates a new read-only memory stream, initializing it with the
+data from the given output stream \arg{stream}.
+
+\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor}
+
+\func{}{\destruct{wxMemoryInputStream}}{\void}
 
 Destructor.
 
+\membersection{wxMemoryInputStream::GetInputStreamBuffer}\label{wxmemoryinputstreamgetistrmbuf}
+
+\constfunc{wxStreamBuffer *}{GetInputStreamBuffer}{\void}
+
+Returns the pointer to the stream object used as an internal buffer
+for that stream.
+
 % -----------------------------------------------------------------------------
 % wxMemoryOutputStream
 % -----------------------------------------------------------------------------
@@ -48,55 +55,54 @@ Destructor.
 
 \helpref{wxOutputStream}{wxoutputstream}
 
-\wxheading{See also}
-
-\helpref{wxStreamBuffer}{wxstreamBuffer}
-
-
-\wxheading{Remark}
+\wxheading{Include files}
 
-You can create a similar stream by this way:
-\begin{verbatim}
-  wxStreamBuffer *sb = new wxStreamBuffer(wxStreamBuffer::write);
-  wxOutputStream *input = new wxOutputStream(sb);
+<wx/mstream.h>
 
-  // If there are data
-    sb->SetBufferIO(data, data\_end);
-  // Else
-    sb->Fixed(FALSE);
-\end{verbatim}
-
-This way is also useful to create read/write memory stream:
-\begin{verbatim}
-  wxStreamBuffer *sb = new wxStreamBuffer(wxStreamBuffer::read\_write);
-  wxOutputStream *output = new wxOutputStream(sb);
-  wxInputStream *input = new wxInputStream(sb);
+\wxheading{See also}
 
-  // If there are data
-    sb->SetBufferIO(data, data\_end);
-  // Else
-    sb->Fixed(FALSE);
-\end{verbatim}
+\helpref{wxStreamBuffer}{wxstreambuffer}
 
 % ----------
 % Members
 % ----------
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxMemoryOutputStream::wxMemoryOutputStream}
+\membersection{wxMemoryOutputStream::wxMemoryOutputStream}\label{wxmemoryoutputstreamctor}
 
 \func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}}
 
-If \it{data} is NULL, then it will initialize a new empty buffer which will
-grow when it needs.
+If {\it data} is NULL, then it will initialize a new empty buffer which will
+grow if required.
 
 \wxheading{Warning}
 
 If the buffer is created, it will be destroyed at the destruction of the
 stream.
 
-\membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}}
+\membersection{wxMemoryOutputStream::\destruct{wxMemoryOutputStream}}\label{wxmemoryoutputstreamdtor}
 
 \func{}{\destruct{wxMemoryOutputStream}}{\void}
 
 Destructor.
+
+\membersection{wxMemoryOutputStream::CopyTo}\label{wxmemoryoutputstreamcopyto}
+
+\constfunc{size\_t}{CopyTo}{\param{char *}{buffer}, \param{size\_t }{len}}
+
+CopyTo allowed you to transfer data from the internal buffer of
+wxMemoryOutputStream to an external buffer. {\it len} specifies the size of
+the buffer.
+
+\wxheading{Returned value}
+
+CopyTo returns the number of bytes copied to the buffer. Generally it is either
+len or the size of the stream buffer.
+
+\membersection{wxMemoryOutputStream::GetOutputStreamBuffer}\label{wxmemoryoutputstreamgetostrmbuf}
+
+\constfunc{wxStreamBuffer *}{GetOutputStreamBuffer}{\void}
+
+Returns the pointer to the stream object used as an internal buffer
+for that stream.
+