X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9000c6246f539bcffcf2bb6432ef37f9f6df7ac8..b19d7524fc5787218b54cc28dc23bf319e413b4a:/docs/latex/wx/outptstr.tex?ds=sidebyside diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex index b397dfdf12..5ebf899fa5 100644 --- a/docs/latex/wx/outptstr.tex +++ b/docs/latex/wx/outptstr.tex @@ -13,6 +13,8 @@ wxOutputStream is an abstract base class which may not be used directly. +\latexignore{\rtfignore{\wxheading{Members}}} + % ----------- % ctor & dtor % ----------- @@ -41,12 +43,22 @@ Returns the number of bytes written during the last Write(). Puts the specified character in the output queue and increments the stream position. -\membersection{wxOutputStream::SeekO} +\membersection{wxOutputStream::SeekO}\label{wxoutputstreamseeko} -\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}} +\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}} 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} @@ -69,46 +81,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. -% ----------------------------------------------------------------------------- -% 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} - - - -% ----------- -% 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.