X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2bf8e4ebcc9d52bcee96e69e7013279a4f2efa37..772c017b2c30f5cb8072d7b22f39da175e101e9a:/docs/latex/wx/stream.tex diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex index d1543a6772..a9f7c711c0 100644 --- a/docs/latex/wx/stream.tex +++ b/docs/latex/wx/stream.tex @@ -24,11 +24,10 @@ None \func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}} -Constructor, creates a new stream buffer using \it{stream} as a parent stream -and \it{mode} as the IO mode. \it{mode} can be: wxStreamBuffer::read, +Constructor, creates a new stream buffer using {\it stream} as a parent stream +and {\it mode} as the IO mode. {\it mode} can be: wxStreamBuffer::read, wxStreamBuffer::write, wxStreamBuffer::read\_write. - One stream can have many stream buffers but only one is used internally to pass IO call (e.g. wxInputStream::Read() -> wxStreamBuffer::Read()), but you can call directly wxStreamBuffer::Read without any problems. Note that @@ -44,7 +43,7 @@ the stream buffers: \func{}{wxStreamBuffer}{\param{BufMode}{ mode}} Constructor, creates a new empty stream buffer which won't flush any data -to a stream. \it{mode} specifies the type of the buffer (read, write, read\_write). +to a stream. {\it mode} specifies the type of the buffer (read, write, read\_write). This stream buffer has the advantage to be stream independent and to 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 @@ -90,13 +89,13 @@ accordingly until all requested data is read. \wxheading{Return value} -It returns the size of the data read. If thereturned size is different of the specified -{\it size}, an error has occured and should be tested using +It returns the size of the data read. If the returned size is different of the specified +{\it size}, an error has occurred and should be tested using \helpref{LastError}{wxstreambaselasterror}. \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}} -Reads a \it{buffer}. The function returns when \it{buffer} is full or when there isn't +Reads a {\it buffer}. The function returns when {\it buffer} is full or when there isn't data anymore in the current buffer. \wxheading{See also} @@ -107,7 +106,7 @@ data anymore in the current buffer. \func{size\_t}{Write}{\param{const void *}{buffer}, \param{size\_t }{size}} -Writes a block of the specified \it{size} using datas of \it{buffer}. The datas +Writes a block of the specified {\it size} using datas of {\it buffer}. The datas are cached in a buffer before being sent in one block to the stream. \func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}} @@ -122,7 +121,7 @@ Gets a single char from the stream buffer. It acts like the Read call. \wxheading{Problem} -You aren't directly notified if an error occured during the IO call. +You aren't directly notified if an error occurred during the IO call. \wxheading{See also} @@ -136,7 +135,7 @@ Puts a single char to the stream buffer. \wxheading{Problem} -You aren't directly notified if an error occured during the IO call. +You aren't directly notified if an error occurred during the IO call. \wxheading{See also} @@ -147,8 +146,8 @@ You aren't directly notified if an error occured during the IO call. \constfunc{off\_t}{Tell}{\void} Gets the current position in the stream. This position is calculated from -the \it{real} position in the stream and from the internal buffer position: so -it gives you the position in the \it{real} stream counted from the start of +the {\it real} position in the stream and from the internal buffer position: so +it gives you the position in the {\it real} stream counted from the start of the stream. \wxheading{Return value} @@ -162,7 +161,7 @@ other case. Changes the current position. -\it{mode} may be one of the following: +{\it mode} may be one of the following: \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt @@ -196,9 +195,9 @@ you create an empty stream buffer (See \helpref{wxStreamBuffer::wxStreamBuffer}{ \wxheading{Remarks} -When you use this function, you'll have to destroy the IO buffers yourself +When you use this function, you will have to destroy the IO buffers yourself after the stream buffer is destroyed or don't use it anymore. -In the case you use it with an empty buffer, the stream buffer will not grow +In the case you use it with an empty buffer, the stream buffer will not resize it when it is full. \wxheading{See also} @@ -271,7 +270,7 @@ Returns the amount of bytes read during the last IO call to the parent stream. \func{void}{Fixed}{\param{bool}{ fixed}} Toggles the fixed flag. Usually this flag is toggled at the same time as -\it{flushable}. This flag allows (when it has the FALSE value) or forbids +{\it flushable}. This flag allows (when it has the FALSE value) or forbids (when it has the TRUE value) the stream buffer to resize dynamically the IO buffer. \wxheading{See also} @@ -282,7 +281,7 @@ Toggles the fixed flag. Usually this flag is toggled at the same time as \func{void}{Flushable}{\param{bool}{ flushable}} -Toggles the flushable flag. If \it{flushable} is disabled, no datas are sent +Toggles the flushable flag. If {\it flushable} is disabled, no datas are sent to the parent stream. \membersection{wxStreamBuffer::FlushBuffer}