]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/strmmem.tex
many wxItemContainer-related changes:
[wxWidgets.git] / docs / latex / wx / strmmem.tex
index 920ad7b36e3b181bd62181e33374f0fddbcfaee0..c2b85338cbfc5027d2501af365062ed37d09d2e4 100644 (file)
 % ----------
 \latexignore{\rtfignore{\wxheading{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}. The stream does not take ownership of the 
 
 \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}. The stream does not take ownership of the 
-buffer, i.e. that it will not delete in its destructor.
+buffer, i.e. the buffer will not be deleted in its destructor.
 
 
-\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}
+\func{}{wxMemoryInputStream}{\param{const wxMemoryOutputStream&}{ stream}}
+
+Creates a new read-only memory stream, initializing it with the
+data from the given output stream \arg{stream}.
+
+\func{}{wxMemoryInputStream}{\param{wxInputStream\&}{ stream}, \param{wxFileOffset}{ len = wxInvalidOffset}}
+
+Creates a new read-only memory stream, initializing it with the
+data from the given input stream \arg{stream}.
+
+The \arg{len} argument specifies the amount of data to read from
+the \arg{stream}. Setting it to {\it wxInvalidOffset} means that
+the \arg{stream} is to be read entirely (i.e. till the EOF is reached).
+
+
+\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor}
 
 \func{}{\destruct{wxMemoryInputStream}}{\void}
 
 Destructor.
 
 
 \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
 % -----------------------------------------------------------------------------
 % -----------------------------------------------------------------------------
 % wxMemoryOutputStream
 % -----------------------------------------------------------------------------
@@ -56,7 +78,7 @@ Destructor.
 % ----------
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 % ----------
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxMemoryOutputStream::wxMemoryOutputStream}
+\membersection{wxMemoryOutputStream::wxMemoryOutputStream}\label{wxmemoryoutputstreamctor}
 
 \func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}}
 
 
 \func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}}
 
@@ -68,13 +90,13 @@ grow if required.
 If the buffer is created, it will be destroyed at the destruction of the
 stream.
 
 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.
 
 
 \func{}{\destruct{wxMemoryOutputStream}}{\void}
 
 Destructor.
 
-\membersection{wxMemoryOutputStream::CopyTo}
+\membersection{wxMemoryOutputStream::CopyTo}\label{wxmemoryoutputstreamcopyto}
 
 \constfunc{size\_t}{CopyTo}{\param{char *}{buffer}, \param{size\_t }{len}}
 
 
 \constfunc{size\_t}{CopyTo}{\param{char *}{buffer}, \param{size\_t }{len}}
 
@@ -87,3 +109,10 @@ the buffer.
 CopyTo returns the number of bytes copied to the buffer. Generally it is either
 len or the size of the stream buffer.
 
 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.
+