]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/inputstr.tex
Further decorations in changes chapter. Missed methods in their base location.
[wxWidgets.git] / docs / latex / wx / inputstr.tex
index eb2c5f2249668d69d304ed0e8514b8ebd10f1e2b..7f48f40df427f422a07c4c8572b5382f82f24ff4 100644 (file)
@@ -18,19 +18,26 @@ wxInputStream is an abstract base class which may not be used directly.
 % -----------
 % ctor & dtor
 % -----------
-\membersection{wxInputStream::wxInputStream}
+\membersection{wxInputStream::wxInputStream}\label{wxinputstreamctor}
 
 \func{}{wxInputStream}{\void}
 
 Creates a dummy input stream.
 
-\membersection{wxInputStream::\destruct{wxInputStream}}
+\membersection{wxInputStream::\destruct{wxInputStream}}\label{wxinputstreamdtor}
 
 \func{}{\destruct{wxInputStream}}{\void}
 
 Destructor.
 
-\membersection{wxInputStream::GetC}
+\membersection{wxInputStream::CanRead}\label{wxinputstreamcanread}
+
+\constfunc{bool}{CanRead}{\void}
+
+Returns true if some data is available in the stream right now, so that
+calling \helpref{Read()}{wxinputstreamread} wouldn't block.
+
+\membersection{wxInputStream::GetC}\label{wxinputstreamgetc}
 
 \func{char}{GetC}{\void}
 
@@ -43,7 +50,7 @@ If EOF, return value is undefined and LastRead() will return 0 and not 1.
 
 \membersection{wxInputStream::Eof}\label{wxinputstreameof}
 
-\constfunc{wxInputStream}{Eof}{\void}
+\constfunc{bool}{Eof}{\void}
 
 Returns true if the end of stream has been reached.
 
@@ -61,7 +68,7 @@ a non-zero number of bytes have been read.
 
 Returns the last number of bytes read.
 
-\membersection{wxInputStream::Peek}
+\membersection{wxInputStream::Peek}\label{wxinputstreampeek}
 
 \func{char}{Peek}{\void}
 
@@ -73,7 +80,7 @@ Blocks until something appears in the stream if necessary, if nothing
 ever does (i.e. EOF) LastRead() will return 0 (and the return value is
 undefined), otherwise LastRead() returns 1.
 
-\membersection{wxInputStream::Read}
+\membersection{wxInputStream::Read}\label{wxinputstreamread}
 
 \func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}}
 
@@ -114,7 +121,7 @@ Changes the stream current position.
 
 The new stream position or wxInvalidOffset on error.
 
-\membersection{wxInputStream::TellI}
+\membersection{wxInputStream::TellI}\label{wxinputstreamtelli}
 
 \constfunc{off\_t}{TellI}{\void}