added wxRegEx::GetMatchCount (patch 938995)

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

diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex
index eae660ae4241fa08f217f4605769d960b789ad47..5ebf899fa5a291c4e0c30fda176b69c8475fc0f1 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,9 +13,7 @@
 
 <wx/stream.h>
 
 
 <wx/stream.h>
 

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

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


@@ -24,20 +24,18 @@
 
 Creates a dummy wxOutputStream object.
 
 
 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}}
 
 \func{}{\destruct{wxOutputStream}}{\void}
 
 Destructor.
 
 \membersection{wxOutputStream::\destruct{wxOutputStream}}
 
 \func{}{\destruct{wxOutputStream}}{\void}
 
 Destructor.
 

-% -----------
-% IO function
-% -----------
+\membersection{wxOutputStream::LastWrite}
+
+\constfunc{size\_t}{LastWrite}{\void}
+
+Returns the number of bytes written during the last Write().
+

 \membersection{wxOutputStream::PutC}
 
 \func{void}{PutC}{\param{char}{ c}}
 \membersection{wxOutputStream::PutC}
 
 \func{void}{PutC}{\param{char}{ c}}


@@ -45,47 +43,41 @@ Destructor.
 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::Write}
+\membersection{wxOutputStream::SeekO}\label{wxoutputstreamseeko}

 
 

-\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size_t}{ size}}
+\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}

 
 

-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.
-
-This function returns a reference on the current object, so the user can test
-any states of the stream right away.
+Changes the stream current position.

 
 

-\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream_in}}
+\wxheading{Parameters}

 
 

-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.
+\docparam{pos}{Offset to seek to.}

 
 

-% ------------------
-% Position functions
-% ------------------
-\membersection{wxOutputStream::SeekO}
+\docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.}

 
 

-\func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
+\wxheading{Return value}

 
 

-Changes the stream current position.
+The new stream position or wxInvalidOffset on error.

 
 \membersection{wxOutputStream::TellO}
 
 
 \membersection{wxOutputStream::TellO}
 

-\constfunc{off_t}{TellO}{\void}
+\constfunc{off\_t}{TellO}{\void}

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

-% ---------------
-% State functions
-% ---------------
-\membersection{wxOutputStream::OutputStreamBuffer}
+\membersection{wxOutputStream::Write}

 
 

-\func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
+\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}

 
 

-Returns the stream buffer associated with the output stream.
+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.

 
 

-\membersection{wxOutputStream::LastWrite}
+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}}

 
 

-\constfunc{size_t}{LastWrite}{\void}
+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.