Bug 1099143 and more occurences of the same set vs. get mistakes.

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

diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex
index 543c3e4b53a844a0051f4788a391c437cb42614c..1c61a7c606455d6b8a72d333df5029d2984a41a4 100644 (file)
--- a/docs/latex/wx/outptstr.tex
+++ b/docs/latex/wx/outptstr.tex
@@ -3,6 +3,8 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxOutputStream}}\label{wxoutputstream}
 
 % -----------------------------------------------------------------------------
 \section{\class{wxOutputStream}}\label{wxoutputstream}
 

+wxOutputStream is an abstract base class which may not be used directly.
+

 \wxheading{Derived from}
 
 \helpref{wxStreamBase}{wxstreambase}
 \wxheading{Derived from}
 
 \helpref{wxStreamBase}{wxstreambase}


@@ -11,70 +13,95 @@
 
 <wx/stream.h>
 
 
 <wx/stream.h>
 

-\wxheading{See also}
-
-\helpref{wxStreamBuffer}{wxstreambuffer}
+\latexignore{\rtfignore{\wxheading{Members}}}

 
 % -----------
 % ctor & dtor
 % -----------
 
 % -----------
 % ctor & dtor
 % -----------

-\membersection{wxOutputStream::wxOutputStream}
+
+\membersection{wxOutputStream::wxOutputStream}\label{wxoutputstreamctor}

 
 \func{}{wxOutputStream}{\void}
 
 Creates a dummy wxOutputStream object.
 
 
 \func{}{wxOutputStream}{\void}
 
 Creates a dummy wxOutputStream object.
 

-\func{}{wxOutputStream}{\param{wxStreamBuffer*}{ sbuf}}

 
 

-Creates an input stream using the specified stream buffer \it{sbuf}. This
-stream buffer can point to another stream.
-
-\membersection{wxOutputStream::\destruct{wxOutputStream}}
+\membersection{wxOutputStream::\destruct{wxOutputStream}}\label{wxoutputstreamdtor}

 
 \func{}{\destruct{wxOutputStream}}{\void}
 
 Destructor.
 
 
 \func{}{\destruct{wxOutputStream}}{\void}
 
 Destructor.
 

-\membersection{wxOutputStream::OutputStreamBuffer}

 
 

-\func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
+\membersection{wxOutputStream::Close}\label{wxoutputstreamclose}
+
+\func{bool}{Close}{\void}
+
+Closes the stream, returning {\tt false} if an error occurs. The
+stream is closed implicitly in the destructor if Close() is not
+called explicitly.
+
+If this stream wraps another stream or some other resource such
+as a file, then the underlying resource is closed too if it is owned
+by this stream, or left open otherwise.
+
+
+\membersection{wxOutputStream::LastWrite}\label{wxoutputstreamlastwrite}

 
 

-Returns the stream buffer associated with the output stream.
+\constfunc{size\_t}{LastWrite}{\void}

 
 

-\membersection{wxOutputStream::LastWrite}
+Returns the number of bytes written during the last 
+\helpref{Write()}{wxoutputstreamwrite}. It may return $0$ even if there is no
+error on the stream if it is only temporarily impossible to write to it.

 
 

-\constfunc{size_t}{LastWrite}{\void}

 
 

-\membersection{wxOutputStream::PutC}
+\membersection{wxOutputStream::PutC}\label{wxoutputstreamputc}

 
 \func{void}{PutC}{\param{char}{ c}}
 
 Puts the specified character in the output queue and increments the
 stream position.
 
 
 \func{void}{PutC}{\param{char}{ c}}
 
 Puts the specified character in the output queue and increments the
 stream position.
 

-\membersection{wxOutputStream::SeekO}

 
 

-\func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
+\membersection{wxOutputStream::SeekO}\label{wxoutputstreamseeko}
+
+\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}

 
 Changes the stream current position.
 
 
 Changes the stream current position.
 

-\membersection{wxOutputStream::TellO}
+\wxheading{Parameters}
+
+\docparam{pos}{Offset to seek to.}
+
+\docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.}
+
+\wxheading{Return value}

 
 

-\constfunc{off_t}{TellO}{\void}
+The new stream position or wxInvalidOffset on error.
+
+
+\membersection{wxOutputStream::TellO}\label{wxoutputstreamtello}
+
+\constfunc{off\_t}{TellO}{\void}

 
 Returns the current stream position.
 
 
 Returns the current stream position.
 

-\membersection{wxOutputStream::Write}

 
 

-\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size_t}{ size}}
+\membersection{wxOutputStream::Write}\label{wxoutputstreamwrite}
+
+\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}

 
 

-Writes the specified amount of bytes using the data of \it{buffer}. 
-\it{WARNING!} The buffer absolutely needs to have at least the specified size.
+Writes up to the specified amount of bytes using the data of {\it buffer}. Note
+that not all data can always be written so you must check the number of bytes
+really written to the stream using \helpref{LastWrite()}{wxoutputstreamlastwrite} 
+when this function returns. In some cases (for example a write end of a pipe
+which is currently full) it is even possible that there is no errors and zero
+bytes have been written.

 
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.
 
 
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.
 

-\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream_in}}
+\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream\_in}}

 
 Reads data from the specified input stream and stores them 
 in the current stream. The data is read until an error is raised
 
 Reads data from the specified input stream and stores them 
 in the current stream. The data is read until an error is raised