wxHSCROLL works in GTK2, changed description to indicate no effect only on wxGTK1

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

diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex
index f33416983626bb0536c5a96b9cdb7c47fe932d72..c48821a94f71950df0bd7e56745e2e9b19bffc7b 100644 (file)
--- a/docs/latex/wx/stream.tex
+++ b/docs/latex/wx/stream.tex
@@ -20,7 +20,7 @@ None
 % -----------
 % ctor & dtor
 % -----------
 % -----------
 % ctor & dtor
 % -----------

-\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufconst}
+\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufferctor}

 
 \func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
 
 
 \func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
 


@@ -28,7 +28,6 @@ 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.
 
 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
 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


@@ -53,7 +52,7 @@ functionality of a ``normal'' stream.
 
 \wxheading{Warning}
 
 
 \wxheading{Warning}
 

-The "read\_write" mode may not work: it isn't completely finished.
+The "read\_write" mode doesn't currently work for standalone stream buffers.

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


@@ -69,7 +68,7 @@ program.
 
 \helpref{wxStreamBuffer:SetBufferIO}{wxstreambuffersetbufferio}
 
 
 \helpref{wxStreamBuffer:SetBufferIO}{wxstreambuffersetbufferio}
 

-\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}
+\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}\label{wxstreambufferdtor}

 
 \func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}
 
 
 \func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}
 


@@ -91,8 +90,8 @@ accordingly until all requested data is read.
 \wxheading{Return value}
 
 It returns the size of the data read. If the returned size is different of the specified 
 \wxheading{Return value}
 
 It returns the size of the data read. If the returned size is different of the specified 

-{\it size}, an error has occured and should be tested using 
-\helpref{LastError}{wxstreambaselasterror}.
+{\it size}, an error has occurred and should be tested using 
+\helpref{GetLastError}{wxstreambasegetlasterror}.

 
 \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}
 
 
 \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}
 


@@ -107,14 +106,14 @@ data anymore in the current buffer.
 
 \func{size\_t}{Write}{\param{const void *}{buffer}, \param{size\_t }{size}}
 
 
 \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 data of {\it buffer}. The data

 are cached in a buffer before being sent in one block to the stream.
 
 \func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}}
 
 See \helpref{Read}{wxstreambufferread}.
 
 are cached in a buffer before being sent in one block to the stream.
 
 \func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}}
 
 See \helpref{Read}{wxstreambufferread}.
 

-\membersection{wxStreamBuffer::GetChar}
+\membersection{wxStreamBuffer::GetChar}\label{wxstreambuffergetchar}

 
 \func{char}{GetChar}{\void}
 
 
 \func{char}{GetChar}{\void}
 


@@ -122,13 +121,13 @@ Gets a single char from the stream buffer. It acts like the Read call.
 
 \wxheading{Problem}
 
 
 \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}
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferread}
 
 
 \wxheading{See also}
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferread}
 

-\membersection{wxStreamBuffer::PutChar}
+\membersection{wxStreamBuffer::PutChar}\label{wxstreambufferputchar}

 
 \func{void}{PutChar}{\param{char }{c}}
 
 
 \func{void}{PutChar}{\param{char }{c}}
 


@@ -136,13 +135,13 @@ Puts a single char to the stream buffer.
 
 \wxheading{Problem}
 
 
 \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}
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferwrite}
 
 
 \wxheading{See also}
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferwrite}
 

-\membersection{wxStreamBuffer::Tell}
+\membersection{wxStreamBuffer::Tell}\label{wxstreambuffertell}

 
 \constfunc{off\_t}{Tell}{\void}
 
 
 \constfunc{off\_t}{Tell}{\void}
 


@@ -179,7 +178,7 @@ the beginning of the stream. Otherwise, it returns wxInvalidOffset.
 % --------------
 % Buffer control
 % --------------
 % --------------
 % Buffer control
 % --------------

-\membersection{wxStreamBuffer::ResetBuffer}
+\membersection{wxStreamBuffer::ResetBuffer}\label{wxstreambufferresetbuffer}

 
 \func{void}{ResetBuffer}{\void}
 
 
 \func{void}{ResetBuffer}{\void}
 


@@ -192,18 +191,18 @@ Resets to the initial state variables concerning the buffer.
 Specifies which pointers to use for stream buffering. You need to pass a pointer on the
 start of the buffer end and another on the end. The object will use this buffer
 to cache stream data. It may be used also as a source/destination buffer when
 Specifies which pointers to use for stream buffering. You need to pass a pointer on the
 start of the buffer end and another on the end. The object will use this buffer
 to cache stream data. It may be used also as a source/destination buffer when

-you create an empty stream buffer (See \helpref{wxStreamBuffer::wxStreamBuffer}{wxstreambufconst}).
+you create an empty stream buffer (See \helpref{wxStreamBuffer::wxStreamBuffer}{wxstreambufferctor}).

 
 \wxheading{Remarks}
 
 
 \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 resize
 it when it is full.
 
 \wxheading{See also}
 
 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 resize
 it when it is full.
 
 \wxheading{See also}
 

-\helpref{wxStreamBuffer constructor}{wxstreambufconst}\\
+\helpref{wxStreamBuffer constructor}{wxstreambufferctor}\\

 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 
 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 


@@ -225,42 +224,42 @@ The created IO buffer is growable by the object.
 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 
 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 

-\membersection{wxStreamBuffer::GetBufferStart}
+\membersection{wxStreamBuffer::GetBufferStart}\label{wxstreambuffergetbufferstart}

 
 \constfunc{char *}{GetBufferStart}{\void}
 
 Returns a pointer on the start of the stream buffer.
 
 
 \constfunc{char *}{GetBufferStart}{\void}
 
 Returns a pointer on the start of the stream buffer.
 

-\membersection{wxStreamBuffer::GetBufferEnd}
+\membersection{wxStreamBuffer::GetBufferEnd}\label{wxstreambuffergetbufferend}

 
 \constfunc{char *}{GetBufferEnd}{\void}
 
 Returns a pointer on the end of the stream buffer.
 
 
 \constfunc{char *}{GetBufferEnd}{\void}
 
 Returns a pointer on the end of the stream buffer.
 

-\membersection{wxStreamBuffer::GetBufferPos}
+\membersection{wxStreamBuffer::GetBufferPos}\label{wxstreambuffergetbufferpos}

 
 \constfunc{char *}{GetBufferPos}{\void}
 
 Returns a pointer on the current position of the stream buffer.
 
 
 \constfunc{char *}{GetBufferPos}{\void}
 
 Returns a pointer on the current position of the stream buffer.
 

-\membersection{wxStreamBuffer::GetIntPosition}
+\membersection{wxStreamBuffer::GetIntPosition}\label{wxstreambuffergetintposition}

 
 \constfunc{off\_t}{GetIntPosition}{\void}
 
 Returns the current position (counted in bytes) in the stream buffer.
 
 
 \constfunc{off\_t}{GetIntPosition}{\void}
 
 Returns the current position (counted in bytes) in the stream buffer.
 

-\membersection{wxStreamBuffer::SetIntPosition}
+\membersection{wxStreamBuffer::SetIntPosition}\label{wxstreambuffersetintposition}

 
 

-\func{void}{SetIntPosition}{\void}
+\func{void}{SetIntPosition}{\param{size\_t}{ pos}}

 
 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:
 
 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.
+specifying an invalid position can induce unexpected results.

 
 

-\membersection{wxStreamBuffer::GetLastAccess}
+\membersection{wxStreamBuffer::GetLastAccess}\label{wxstreambuffergetlastaccess}

 
 \constfunc{size\_t}{GetLastAccess}{\void}
 
 
 \constfunc{size\_t}{GetLastAccess}{\void}
 


@@ -271,8 +270,8 @@ 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 
 \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
-(when it has the TRUE value) the stream buffer to resize dynamically the IO buffer.
+{\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}
 
 
 \wxheading{See also}
 


@@ -282,31 +281,31 @@ Toggles the fixed flag. Usually this flag is toggled at the same time as
 
 \func{void}{Flushable}{\param{bool}{ flushable}}
 
 
 \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 data are sent

 to the parent stream.
 
 to the parent stream.
 

-\membersection{wxStreamBuffer::FlushBuffer}
+\membersection{wxStreamBuffer::FlushBuffer}\label{wxstreambufferflushbuffer}

 
 \func{bool}{FlushBuffer}{\void}
 
 Flushes the IO buffer.
 
 
 \func{bool}{FlushBuffer}{\void}
 
 Flushes the IO buffer.
 

-\membersection{wxStreamBuffer::FillBuffer}
+\membersection{wxStreamBuffer::FillBuffer}\label{wxstreambufferfillbuffer}

 
 \func{bool}{FillBuffer}{\void}
 
 Fill the IO buffer.
 
 
 \func{bool}{FillBuffer}{\void}
 
 Fill the IO buffer.
 

-\membersection{wxStreamBuffer::GetDataLeft}
+\membersection{wxStreamBuffer::GetDataLeft}\label{wxstreambuffergetdataleft}

 
 \func{size\_t}{GetDataLeft}{\void}
 
 
 \func{size\_t}{GetDataLeft}{\void}
 

-Returns the amount of available datas in the buffer.
+Returns the amount of available data in the buffer.

 
 % --------------
 % Administration
 % --------------
 
 % --------------
 % Administration
 % --------------

-\membersection{wxStreamBuffer::Stream}
+\membersection{wxStreamBuffer::Stream}\label{wxstreambufferstream}

 
 \func{wxStreamBase*}{Stream}{\void}
 
 
 \func{wxStreamBase*}{Stream}{\void}