X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e2a6f23364aefcd5095dc6558e3ab8144363fa96..e602002e27b29b261848ffea89472befceca0ccb:/docs/latex/wx/inputstr.tex diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex index fec1deea18..0b940c020f 100644 --- a/docs/latex/wx/inputstr.tex +++ b/docs/latex/wx/inputstr.tex @@ -7,6 +7,10 @@ \helpref{wxStreamBase}{wxstreambase} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxStreamBuffer}{wxstreambuffer} @@ -31,64 +35,64 @@ stream buffer can point to another stream. Destructor. -% ----------- -% IO function -% ----------- -\membersection{wxInputStream::Peek} - -\func{char}{Peek}{\void} - -Returns the first character in the input queue without removing it. - \membersection{wxInputStream::GetC} \func{char}{GetC}{\void} Returns the first character in the input queue and removes it. +\membersection{wxInputStream::InputStreamBuffer} + +\func{wxStreamBuffer*}{InputStreamBuffer}{\void} + +Returns the stream buffer associated with the input stream. + +\membersection{wxInputStream::LastRead} + +\constfunc{size\_t}{LastRead}{\void} + +Returns the last number of bytes read. + +\membersection{wxInputStream::Peek} + +\func{char}{Peek}{\void} + +Returns the first character in the input queue without removing it. + \membersection{wxInputStream::Read} -\func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size_t}{ size}} +\func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}} Reads the specified amount of bytes and stores the data in \it{buffer}. -\it{WARNING!} The buffer absolutely needs to have at least the specified size. +\wxheading{Warning} + +The buffer absolutely needs to have at least the specified size. + +\wxheading{Return value} This function returns a reference on the current object, so the user can test any states of the stream right away. -\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream_out}} +\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream\_out}} Reads data from the input queue and stores it in the specified output stream. The data is read until an error is raised by one of the two streams. -% ------------------ -% Position functions -% ------------------ +\wxheading{Return value} + +This function returns a reference on the current object, so the user can test +any states of the stream right away. + \membersection{wxInputStream::SeekI} -\func{off_t}{SeekI}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}} +\func{off\_t}{SeekI}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}} Changes the stream current position. \membersection{wxInputStream::TellI} -\constfunc{off_t}{TellI}{\void} +\constfunc{off\_t}{TellI}{\void} Returns the current stream position. -% --------------- -% State functions -% --------------- -\membersection{wxInputStream::InputStreamBuffer} - -\func{wxStreamBuffer*}{InputStreamBuffer}{\void} - -Returns the stream buffer associated with the input stream. - -\membersection{wxInputStream::LastRead} - -\constfunc{size_t}{LastRead}{\void} - -Returns the last number of bytes read. -