Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / stream.h

diff --git a/include/wx/stream.h b/include/wx/stream.h
index 80c81bcbdc0a8f32bd6aeb1de583dee4cb36fd29..b1746b84b5cfe255afd5b19036c7aa02e8c4b448 100644 (file)
--- a/include/wx/stream.h
+++ b/include/wx/stream.h
@@ -128,6 +128,11 @@ public:
     // it means that EOF has been reached.
     virtual wxInputStream& Read(void *buffer, size_t size);
 
     // it means that EOF has been reached.
     virtual wxInputStream& Read(void *buffer, size_t size);
 

+    // Read exactly the given number of bytes, unlike Read(), which may read
+    // less than the requested amount of data without returning an error, this
+    // method either reads all the data or returns false.
+    bool ReadAll(void *buffer, size_t size);
+

     // copy the entire contents of this stream into streamOut, stopping only
     // when EOF is reached or an error occurs
     wxInputStream& Read(wxOutputStream& streamOut);
     // copy the entire contents of this stream into streamOut, stopping only
     // when EOF is reached or an error occurs
     wxInputStream& Read(wxOutputStream& streamOut);


@@ -233,6 +238,12 @@ public:
 
     void PutC(char c);
     virtual wxOutputStream& Write(const void *buffer, size_t size);
 
     void PutC(char c);
     virtual wxOutputStream& Write(const void *buffer, size_t size);

+
+    // This is ReadAll() equivalent for Write(): it either writes exactly the
+    // given number of bytes or returns false, unlike Write() which can write
+    // less data than requested but still return without error.
+    bool WriteAll(const void *buffer, size_t size);
+

     wxOutputStream& Write(wxInputStream& stream_in);
 
     virtual wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart);
     wxOutputStream& Write(wxInputStream& stream_in);
 
     virtual wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart);


@@ -270,16 +281,17 @@ class WXDLLIMPEXP_BASE wxCountingOutputStream : public wxOutputStream
 public:
     wxCountingOutputStream();
 
 public:
     wxCountingOutputStream();
 

-    wxFileOffset GetLength() const;
+    virtual wxFileOffset GetLength() const;

     bool Ok() const { return IsOk(); }
     bool Ok() const { return IsOk(); }

-    bool IsOk() const { return true; }
+    virtual bool IsOk() const { return true; }

 
 protected:
     virtual size_t OnSysWrite(const void *buffer, size_t size);
     virtual wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode);
     virtual wxFileOffset OnSysTell() const;
 
 
 protected:
     virtual size_t OnSysWrite(const void *buffer, size_t size);
     virtual wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode);
     virtual wxFileOffset OnSysTell() const;
 

-    size_t m_currentPos;
+    size_t m_currentPos,
+           m_lastPos;

 
     DECLARE_DYNAMIC_CLASS(wxCountingOutputStream)
     wxDECLARE_NO_COPY_CLASS(wxCountingOutputStream);
 
     DECLARE_DYNAMIC_CLASS(wxCountingOutputStream)
     wxDECLARE_NO_COPY_CLASS(wxCountingOutputStream);