X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e2a6f23364aefcd5095dc6558e3ab8144363fa96..6dbb903bb9410e2a2a977ad349ba7b4b3b12ac78:/docs/latex/wx/outptstr.tex?ds=sidebyside diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex index 7966a2c97d..0eb87f886e 100644 --- a/docs/latex/wx/outptstr.tex +++ b/docs/latex/wx/outptstr.tex @@ -3,13 +3,17 @@ % ----------------------------------------------------------------------------- \section{\class{wxOutputStream}}\label{wxoutputstream} +wxOutputStream is an abstract base class which may not be used directly. + \wxheading{Derived from} \helpref{wxStreamBase}{wxstreambase} -\wxheading{See also} +\wxheading{Include files} + + -\helpref{wxStreamBuffer}{wxstreambuffer} +\latexignore{\rtfignore{\wxheading{Members}}} % ----------- % ctor & dtor @@ -20,20 +24,18 @@ 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. -% ----------- -% 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}} @@ -41,47 +43,31 @@ Destructor. Puts the specified character in the output queue and increments the stream position. -\membersection{wxOutputStream::Write} - -\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. - -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}} - -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. - -% ------------------ -% Position functions -% ------------------ \membersection{wxOutputStream::SeekO} -\func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}} +\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}} Changes the stream current position. \membersection{wxOutputStream::TellO} -\constfunc{off_t}{TellO}{\void} +\constfunc{off\_t}{TellO}{\void} 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.