2 typos corrected

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

diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex
index a2fdd74c09dfa66b584e5c4fd80b69508dc4d2a1..20cf2e72d2764a2ac2b7564293fdbd7747ebe625 100644 (file)
--- a/docs/latex/wx/stream.tex
+++ b/docs/latex/wx/stream.tex
@@ -4,6 +4,10 @@
 
 None
 
 
 None
 

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

 \wxheading{See also}
 
 \helpref{wxStreamBase}{wxstreambase}
 \wxheading{See also}
 
 \helpref{wxStreamBase}{wxstreambase}


@@ -43,17 +47,25 @@ to a stream. \it{mode} specifies the type of the buffer (read, write, read\_writ
 work only on memory buffers but it is still compatible with the rest of the
 wxStream classes. You can write, read to this special stream and it will
 grow (if it is allowed by the user) its internal buffer. Briefly, it has all
 work only on memory buffers but it is still compatible with the rest of the
 wxStream classes. You can write, read to this special stream and it will
 grow (if it is allowed by the user) its internal buffer. Briefly, it has all

-functionnalities of a ``normal'' stream.
+functionality of a ``normal'' stream.

 
 \wxheading{Warning}
 
 The "read\_write" mode may not work: it isn't completely finished.
 
 \wxheading{Warning}
 
 The "read\_write" mode may not work: it isn't completely finished.

+You can create "memory" streams by this way:

 
 

-\wxheading{See also}
+\begin{verbatim}
+  wxStreamBuffer *sb = new wxStreamBuffer(wxStreamBuffer::read)
+  wxInputStream *input = new wxInputStream(sb);
+
+  sb->Fixed(FALSE); // It can change the size of the buffer.
+
+  // input is now a read-only memory stream.
+\end{verbatim}

 
 

-\helpref{wxStreamBuffer:SetBufferIO}{wxstreambufsetbufferio}
+But you should take care when destroying the stream buffer yourself.

 
 

-\func{}{wxStreamBuffer}{\param{const wxStreamBuffer &}{buffer}}
+\func{}{wxStreamBuffer}{\param{const wxStreamBuffer\&}{buffer}}

 
 Constructor. It initializes the stream buffer with the data of the specified
 stream buffer. The new stream buffer is nearly exactly the same as the
 
 Constructor. It initializes the stream buffer with the data of the specified
 stream buffer. The new stream buffer is nearly exactly the same as the


@@ -68,6 +80,10 @@ segmentation violation if the parent is destroyed and the children continues
 operating. It is advised to use this feature only in very local area of the
 program.
 
 operating. It is advised to use this feature only in very local area of the
 program.
 

+\wxheading{See also}
+
+\helpref{wxStreamBuffer:SetBufferIO}{wxstreambuffersetbufferio}
+

 \membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}
 
 \func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}
 \membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}
 
 \func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}


@@ -80,7 +96,7 @@ The "Write-Back" buffer is freed.
 % -----------
 % Filtered IO
 % -----------
 % -----------
 % Filtered IO
 % -----------

-\membersection{wxStreamBuffer::Read}\label{wxstreambufread}
+\membersection{wxStreamBuffer::Read}\label{wxstreambufferread}

 
 \func{size\_t}{Read}{\param{void *}{buffer}, \param{size\_t }{size}}
 
 
 \func{size\_t}{Read}{\param{void *}{buffer}, \param{size\_t }{size}}
 


@@ -98,14 +114,14 @@ It returns the real read size. If returned size is different of the specified
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxStreamBuffer::WriteBack}{wxstreambufwriteback}
+\helpref{wxStreamBuffer::WriteBack}{wxstreambufferwriteback}

 
 \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}
 
 Reads a \it{buffer}. The function returns when \it{buffer} is full or
 when there aren't datas anymore in the current buffer.
 
 
 \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}
 
 Reads a \it{buffer}. The function returns when \it{buffer} is full or
 when there aren't datas anymore in the current buffer.
 

-\membersection{wxStreamBuffer::Write}
+\membersection{wxStreamBuffer::Write}\label{wxstreambufferwrite}

 
 \func{size\_t}{Write}{\param{const void *}{buffer}, \param{size\_t }{size}}
 
 
 \func{size\_t}{Write}{\param{const void *}{buffer}, \param{size\_t }{size}}
 


@@ -114,9 +130,9 @@ are cached in a buffer before being sent in one block to the stream.
 
 \func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}}
 
 
 \func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}}
 

-See \helpref{Read}{wxstreambufreadbuf}
+See \helpref{Read}{wxstreambufferread}.

 
 

-\membersection{wxStreamBuffer::WriteBack}\label{wxstreambufwriteback}
+\membersection{wxStreamBuffer::WriteBack}\label{wxstreambufferwriteback}

 
 \func{size\_t}{WriteBack}{\param{const char*}{ buffer}, \param{size\_t}{ size}}
 
 
 \func{size\_t}{WriteBack}{\param{const char*}{ buffer}, \param{size\_t}{ size}}
 


@@ -147,7 +163,7 @@ You aren't directly notified if an error occured during the IO call.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxStreamBuffer::Read}{wxstreambufread}
+\helpref{wxStreamBuffer::Read}{wxstreambufferread}

 
 \membersection{wxStreamBuffer::PutChar}
 
 
 \membersection{wxStreamBuffer::PutChar}
 


@@ -161,7 +177,7 @@ You aren't directly notified if an error occured during the IO call.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxStreamBuffer::Read}{wxstreambufwrite}
+\helpref{wxStreamBuffer::Read}{wxstreambufferwrite}

 
 \membersection{wxStreamBuffer::Tell}
 
 
 \membersection{wxStreamBuffer::Tell}
 


@@ -206,7 +222,7 @@ the beginning of the stream. Otherwise, it returns wxInvalidOffset.
 
 Resets to the initial state variables concerning the buffer.
 
 
 Resets to the initial state variables concerning the buffer.
 

-\membersection{wxStreamBuffer::SetBufferIO}\label{wxstreambufsetbufferio}
+\membersection{wxStreamBuffer::SetBufferIO}\label{wxstreambuffersetbufferio}

 
 \func{void}{SetBufferIO}{\param{char*}{ buffer\_start}, \param{char*}{ buffer\_end}}
 
 
 \func{void}{SetBufferIO}{\param{char*}{ buffer\_start}, \param{char*}{ buffer\_end}}
 


@@ -225,8 +241,8 @@ it when it is full.
 \wxheading{See also}
 
 \helpref{wxStreamBuffer constructor}{wxstreambufconst}\\
 \wxheading{See also}
 
 \helpref{wxStreamBuffer constructor}{wxstreambufconst}\\

-\helpref{wxStreamBuffer::Fixed}{wxstreambuffixed}\\
-\helpref{wxStreamBuffer::Flushable}{wxstreambufflushable}
+\helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
+\helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}

 
 \func{void}{SetBufferIO}{\param{size\_t}{ bufsize}}
 
 
 \func{void}{SetBufferIO}{\param{size\_t}{ bufsize}}
 


@@ -243,8 +259,8 @@ The created IO buffer is growable by the object.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxStreamBuffer::Fixed}{wxstreambuffixed}\\
-\helpref{wxStreamBuffer::Flushable}{wxstreambufflushable}
+\helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
+\helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}

 
 \membersection{wxStreamBuffer::GetBufferStart}
 
 
 \membersection{wxStreamBuffer::GetBufferStart}
 


@@ -274,7 +290,12 @@ Returns the current position (counted in bytes) in the stream buffer.
 
 \func{void}{SetIntPosition}{\void}
 
 
 \func{void}{SetIntPosition}{\void}
 

-Sets the current position in the stream buffer.
+Sets the current position (in bytes) in the stream buffer.
+
+\wxheading{Warning}
+
+Since it is a very low-level function, there is no check on the position:
+specify an invalid position can induce unexpected results.

 
 \membersection{wxStreamBuffer::GetLastAccess}
 
 
 \membersection{wxStreamBuffer::GetLastAccess}
 


@@ -282,7 +303,7 @@ Sets the current position in the stream buffer.
 
 Returns the amount of bytes read during the last IO call to the parent stream.
 
 
 Returns the amount of bytes read during the last IO call to the parent stream.
 

-\membersection{wxStreamBuffer::Fixed}
+\membersection{wxStreamBuffer::Fixed}\label{wxstreambufferfixed}

 
 \func{void}{Fixed}{\param{bool}{ fixed}}
 
 
 \func{void}{Fixed}{\param{bool}{ fixed}}
 


@@ -292,9 +313,9 @@ Toggles the fixed flag. Usually this flag is toggled at the same time as
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxStreamBuffer::SetBufferIO}{wxstreambufsetbufferio}
+\helpref{wxStreamBuffer::SetBufferIO}{wxstreambuffersetbufferio}

 
 

-\membersection{wxStreamBuffer::Flushable}
+\membersection{wxStreamBuffer::Flushable}\label{wxstreambufferflushable}

 
 \func{void}{Flushable}{\param{bool}{ flushable}}
 
 
 \func{void}{Flushable}{\param{bool}{ flushable}}