From 2bc566539b775cda57ef226c450527eb9f4da569 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Tue, 13 Jan 2009 18:43:48 +0000 Subject: [PATCH] document operator\! git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58079 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/stream.h | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/interface/wx/stream.h b/interface/wx/stream.h index 6398891aa7..2cb6d47e63 100644 --- a/interface/wx/stream.h +++ b/interface/wx/stream.h @@ -80,6 +80,23 @@ public: */ virtual bool IsSeekable() const; + /** + Returns the opposite of IsOk(). + You can use this function to test the validity of the stream as if + it was a pointer: + + @code + bool DoSomething(wxInputStream& stream) + { + wxInt32 data; + if (!stream.Read(&data, 4)) + return false; + ... + } + @endcode + */ + bool operator!() const; + protected: /** -- 2.45.2