SetTitle method (internal use only) changed to virtual OnSetTitle, added GetOpenedPag...

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

diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex
index 5bf0c73e250554cf83f86d310906c3d897f95d99..95e166b23a3d8621d506438f23b4c654a690c932 100644 (file)
--- a/docs/latex/wx/stream.tex
+++ b/docs/latex/wx/stream.tex
@@ -4,6 +4,10 @@
 
 None
 
+\wxheading{Include files}
+
+<wx/stream.h>
+
 \wxheading{See also}
 
 \helpref{wxStreamBase}{wxstreambase}
@@ -30,10 +34,11 @@ can call directly wxStreamBuffer::Read without any problems.
 \wxheading{Warning}
 
 All errors and messages linked to the stream are stored in the stream object.
+
 \begin{verbatim}
-   streambuffer.Read(...);
-   streambuffer2.Read(...); /* This one erases previous error messages set by 
-                               ``streambuffer'' */
+  streambuffer.Read(...);
+  streambuffer2.Read(...); /* This one erases previous error messages set by 
+                              ``streambuffer'' */
 \end{verbatim}
 
 \func{}{wxStreamBuffer}{\param{BufMode}{ mode}}
@@ -43,12 +48,13 @@ 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
-functionnalities of a ``normal'' stream.
+functionality of a ``normal'' stream.
 
 \wxheading{Warning}
 
 The "read\_write" mode may not work: it isn't completely finished.
 You can create "memory" streams by this way:
+
 \begin{verbatim}
   wxStreamBuffer *sb = new wxStreamBuffer(wxStreamBuffer::read)
   wxInputStream *input = new wxInputStream(sb);
@@ -57,13 +63,10 @@ You can create "memory" streams by this way:
 
   // input is now a read-only memory stream.
 \end{verbatim}
-But you should care about destroying the stream buffer \it{YOURSELF}.
-
-\wxheading{See also}
 
-\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
@@ -78,6 +81,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.
 
+\wxheading{See also}
+
+\helpref{wxStreamBuffer:SetBufferIO}{wxstreambuffersetbufferio}
+
 \membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}
 
 \func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}
@@ -90,7 +97,7 @@ The "Write-Back" buffer is freed.
 % -----------
 % Filtered IO
 % -----------
-\membersection{wxStreamBuffer::Read}\label{wxstreambufread}
+\membersection{wxStreamBuffer::Read}\label{wxstreambufferread}
 
 \func{size\_t}{Read}{\param{void *}{buffer}, \param{size\_t }{size}}
 
@@ -108,14 +115,14 @@ It returns the real read size. If returned size is different of the specified
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer::WriteBack}{wxstreambufwriteback}
+\helpref{wxStreamBuffer::Write}{wxstreambufferwrite}
 
 \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}}
 
@@ -124,26 +131,7 @@ are cached in a buffer before being sent in one block to the stream.
 
 \func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}}
 
-See \helpref{Read}{wxstreambufreadbuf}
-
-\membersection{wxStreamBuffer::WriteBack}\label{wxstreambufwriteback}
-
-\func{size\_t}{WriteBack}{\param{const char*}{ buffer}, \param{size\_t}{ size}}
-
-This function is only useful in \it{read} mode. It is the manager of the "Write-Back"
-buffer. This buffer acts like a temporary buffer where datas which has to be 
-read during the next read IO call are put. This is useful when you get a big
-block of data which you didn't want to read: you can replace them at the top
-of the input queue by this way.
-
-\wxheading{Return value}
-
-Returns the amount of bytes saved in the Write-Back buffer.
-
-\func{size\_t}{WriteBack}{\param{char }{c}}
-
-This function acts like the previous one except that it takes only one
-character: it is sometimes shorter to use than the generic function.
+See \helpref{Read}{wxstreambufferread}.
 
 \membersection{wxStreamBuffer::GetChar}
 
@@ -157,7 +145,7 @@ You aren't directly notified if an error occured during the IO call.
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer::Read}{wxstreambufread}
+\helpref{wxStreamBuffer::Read}{wxstreambufferread}
 
 \membersection{wxStreamBuffer::PutChar}
 
@@ -171,7 +159,7 @@ You aren't directly notified if an error occured during the IO call.
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer::Read}{wxstreambufwrite}
+\helpref{wxStreamBuffer::Read}{wxstreambufferwrite}
 
 \membersection{wxStreamBuffer::Tell}
 
@@ -216,7 +204,7 @@ the beginning of the stream. Otherwise, it returns wxInvalidOffset.
 
 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}}
 
@@ -235,8 +223,8 @@ it when it is full.
 \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}}
 
@@ -253,8 +241,8 @@ The created IO buffer is growable by the object.
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer::Fixed}{wxstreambuffixed}\\
-\helpref{wxStreamBuffer::Flushable}{wxstreambufflushable}
+\helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
+\helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 
 \membersection{wxStreamBuffer::GetBufferStart}
 
@@ -284,7 +272,12 @@ Returns the current position (counted in bytes) in the stream buffer.
 
 \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}
 
@@ -292,7 +285,7 @@ Sets the current position in the stream buffer.
 
 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}}
 
@@ -302,9 +295,9 @@ Toggles the fixed flag. Usually this flag is toggled at the same time as
 
 \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}}