added and documented SplitVolume() and GetPathTerminators(); corrected SetPath()...

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

diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex
index 90873de8f919b8b1930df914501bca5787d4447d..b808b05054d01b2f456cd1460450739722dd3a82 100644 (file)
--- a/docs/latex/wx/outptstr.tex
+++ b/docs/latex/wx/outptstr.tex
@@ -13,26 +13,34 @@ wxOutputStream is an abstract base class which may not be used directly.
 
 <wx/stream.h>
 
 
 <wx/stream.h>
 

+\latexignore{\rtfignore{\wxheading{Members}}}
+

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

+

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

+

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

-\membersection{wxOutputStream::LastWrite}
+
+\membersection{wxOutputStream::LastWrite}\label{wxoutputstreamlastwrite}

 
 \constfunc{size\_t}{LastWrite}{\void}
 
 
 \constfunc{size\_t}{LastWrite}{\void}
 

-Returns the number of bytes written during the last Write().
+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.
+

 
 \membersection{wxOutputStream::PutC}
 
 
 \membersection{wxOutputStream::PutC}
 


@@ -41,24 +49,41 @@ Returns the number of bytes written during the last Write().
 Puts the specified character in the output queue and increments the
 stream position.
 
 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.
 

+\wxheading{Parameters}
+
+\docparam{pos}{Offset to seek to.}
+
+\docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.}
+
+\wxheading{Return value}
+
+The new stream position or wxInvalidOffset on error.
+
+

 \membersection{wxOutputStream::TellO}
 
 \constfunc{off\_t}{TellO}{\void}
 
 Returns the current stream position.
 
 \membersection{wxOutputStream::TellO}
 
 \constfunc{off\_t}{TellO}{\void}
 
 Returns the current stream position.
 

-\membersection{wxOutputStream::Write}
+
+\membersection{wxOutputStream::Write}\label{wxoutputstreamwrite}

 
 \func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
 
 
 \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.


@@ -69,47 +94,3 @@ Reads data from the specified input stream and stores them
 in the current stream. The data is read until an error is raised
 by one of the two streams.
 
 in the current stream. The data is read until an error is raised
 by one of the two streams.
 

-% -----------------------------------------------------------------------------
-% wxCountingOutputStream
-% -----------------------------------------------------------------------------
-\section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream}
-
-wxCountingOutputStream is specialized output stream which does not write any data anyway,
-instead it counts how many bytes would get written if this were a normal stream. This
-can sometimes be useful or required if some data gets serialized to a stream or compressed
-by using stream compression and thus the final size of the stream cannot be known other
-than pretending to write the stream. One case where the resulting size would have to be
-known is if the data has to be written to a piece of memory and the memory has to be
-allocated before writing to it (which is probably always the case when writing to a 
-memory stream).
-
-\wxheading{Derived from}
-
-\helpref{wxOutputStream}{wxoutputstream}
-\helpref{wxStreamBase}{wxstreambase}
-
-\wxheading{Include files}
-
-<wx/stream.h>
-
-% -----------
-% ctor & dtor
-% -----------
-\membersection{wxCountingOutputStream::wxCountingOutputStream}
-
-\func{}{wxCountingOutputStream}{\void}
-
-Creates a wxCountingOutputStream object.
-
-\membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}
-
-\func{}{\destruct{wxCountingOutputStream}}{\void}
-
-Destructor.
-
-\membersection{wxCountingOutputStream::GetSize}
-
-\constfunc{size\_t}{GetSize}{\void}
-
-Returns the current size of the stream.
-