Fix wxWebView documentation warnings.

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

diff --git a/interface/wx/stream.h b/interface/wx/stream.h
index e5fb42d385072d6b05becede5320dfbf7d804f58..51b983dd8ad9a1edab64fa7289a74252df3ff566 100644 (file)
--- a/interface/wx/stream.h
+++ b/interface/wx/stream.h
@@ -150,6 +150,13 @@ protected:
 class wxStreamBuffer
 {
 public:
 class wxStreamBuffer
 {
 public:

+    /** BufMode flags */
+    enum BufMode
+    {
+        read,
+        write,
+        read_write
+    };

 
     /**
         Constructor, creates a new stream buffer using @a stream as a parent stream
 
     /**
         Constructor, creates a new stream buffer using @a stream as a parent stream


@@ -241,7 +248,7 @@ public:
         Destructor.
         It finalizes all IO calls and frees all internal buffers if necessary.
     */
         Destructor.
         It finalizes all IO calls and frees all internal buffers if necessary.
     */

-    wxStreamBuffer();
+    ~wxStreamBuffer();

 
     /**
         Fill the IO buffer.
 
     /**
         Fill the IO buffer.


@@ -530,6 +537,20 @@ public:
     */
     wxOutputStream& Write(wxInputStream& stream_in);
 
     */
     wxOutputStream& Write(wxInputStream& stream_in);
 

+    /**
+        Writes exactly the specified number of bytes from the buffer.
+
+        Returns @true if exactly @a size bytes were written. Otherwise, returns
+        @false and LastWrite() should be used to retrieve the exact amount of
+        the data written if necessary.
+
+        This method uses repeated calls to Write() (which may return writing
+        only part of the data) if necessary.
+
+        @since 2.9.5
+    */
+    bool WriteAll(const void* buffer, size_t size);
+

 protected:
     /**
         Internal function. It is called when the stream wants to write data of the
 protected:
     /**
         Internal function. It is called when the stream wants to write data of the


@@ -622,6 +643,23 @@ public:
     */
     wxInputStream& Read(wxOutputStream& stream_out);
 
     */
     wxInputStream& Read(wxOutputStream& stream_out);
 

+    /**
+        Reads exactly the specified number of bytes into the buffer.
+
+        Returns @true only if the entire amount of data was read, otherwise
+        @false is returned and the number of bytes really read can be retrieved
+        using LastRead(), as with Read().
+
+        This method uses repeated calls to Read() (which may return after
+        reading less than the requested number of bytes) if necessary.
+
+        @warning
+        The buffer absolutely needs to have at least the specified size.
+
+        @since 2.9.5
+    */
+    bool ReadAll(void* buffer, size_t size);
+

     /**
         Changes the stream current position.
 
     /**
         Changes the stream current position.
 


@@ -715,9 +753,11 @@ public:
     virtual ~wxCountingOutputStream();
 
     /**
     virtual ~wxCountingOutputStream();
 
     /**

-        Returns the current size of the stream.
+        Returns the current length of the stream.
+
+        This is the amount of data written to the stream so far, in bytes.

     */
     */

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

 };
 
 
 };
 
 


@@ -1059,3 +1099,57 @@ public:
 };
 
 
 };
 
 

+/**
+    @class wxWrapperInputStream
+
+    A wrapper input stream is a kind of filter stream which forwards all the
+    operations to its base stream. This is useful to build utility classes such
+    as wxFSInputStream.
+
+    @note
+    The interface of this class is the same as that of wxInputStream.
+    Only a constructor differs and it is documented below.
+
+    @library{wxbase}
+    @category{streams}
+
+    @see wxFSInputStream, wxFilterInputStream
+    @since 2.9.4
+*/
+class wxWrapperInputStream : public wxFilterInputStream
+{
+public:
+    //@{
+    /**
+        Initializes a wrapper stream.
+
+        If the parent stream is passed as a pointer then the new wrapper stream
+        takes ownership of it. If it is passed by reference then it does not.
+    */
+    wxWrapperInputStream(wxInputStream& stream);
+    wxWrapperInputStream(wxInputStream* stream);
+    //@}
+
+protected:
+    /**
+        Default constructor, use InitParentStream() to finish initialization.
+
+        This constructor can be used by the derived classes from their own
+        constructors when the parent stream can't be specified immediately.
+        The derived class must call InitParentStream() later to do it.
+     */
+    wxWrapperInputStream();
+
+    //@{
+    /**
+        Set up the wrapped stream for an object initialized using the default
+        constructor.
+
+        The ownership logic is the same as for the non-default constructor,
+        i.e. this object takes ownership of the stream if it's passed by
+        pointer but not if it's passed by reference.
+     */
+    void InitParentStream(wxInputStream& stream);
+    void InitParentStream(wxInputStream* stream);
+    //@}
+};