X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c7d9131ae533ccecb10f4dcebcb820a7e062a11c..86b79b93fbbb0c2e90e6595f7fea0f979b80881c:/docs/latex/wx/outptstr.tex?ds=sidebyside diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex index af0d1c54d0..5ebf899fa5 100644 --- a/docs/latex/wx/outptstr.tex +++ b/docs/latex/wx/outptstr.tex @@ -3,6 +3,8 @@ % ----------------------------------------------------------------------------- \section{\class{wxOutputStream}}\label{wxoutputstream} +wxOutputStream is an abstract base class which may not be used directly. + \wxheading{Derived from} \helpref{wxStreamBase}{wxstreambase} @@ -11,6 +13,8 @@ +\latexignore{\rtfignore{\wxheading{Members}}} + % ----------- % ctor & dtor % ----------- @@ -30,6 +34,8 @@ Destructor. \constfunc{size\_t}{LastWrite}{\void} +Returns the number of bytes written during the last Write(). + \membersection{wxOutputStream::PutC} \func{void}{PutC}{\param{char}{ c}} @@ -37,12 +43,22 @@ Destructor. 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} @@ -53,8 +69,8 @@ Returns the current stream position. \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 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.