Corrected library association

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

diff --git a/interface/wx/stream.h b/interface/wx/stream.h
index 2bd4b85282b14ea698d682395aa04fa1a554a9c6..828fad13746ffbe18f15e0bc474a81f8873add48 100644 (file)
--- a/interface/wx/stream.h
+++ b/interface/wx/stream.h
@@ -32,7 +32,7 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxCountingOutputStream();
+    virtual ~wxCountingOutputStream();

 
     /**
         Returns the current size of the stream.
 
     /**
         Returns the current size of the stream.


@@ -115,6 +115,7 @@ public:
     /**
         Constructor; creates a new empty stream buffer which won't flush any data
         to a stream. mode specifies the type of the buffer (read, write, read_write).
     /**
         Constructor; creates a new empty stream buffer which won't flush any data
         to a stream. mode specifies the type of the buffer (read, write, read_write).

+

         This stream buffer has the advantage to be stream independent and to work
         only on memory buffers but it is still compatible with the rest of the
         wxStream classes. You can write, read to this special stream and it will
         This stream buffer has the advantage to be stream independent and to work
         only on memory buffers but it is still compatible with the rest of the
         wxStream classes. You can write, read to this special stream and it will


@@ -129,7 +130,9 @@ public:
     wxStreamBuffer(BufMode mode);
 
     /**
     wxStreamBuffer(BufMode mode);
 
     /**

-        Constructor. It initializes the stream buffer with the data of the specified
+        Constructor.
+
+        This method initializes the stream buffer with the data of the specified

         stream buffer. The new stream buffer has the same attributes, size, position
         and they share the same buffer. This will cause problems if the stream to
         which the stream buffer belong is destroyed and the newly cloned stream
         stream buffer. The new stream buffer has the same attributes, size, position
         and they share the same buffer. This will cause problems if the stream to
         which the stream buffer belong is destroyed and the newly cloned stream


@@ -199,7 +202,7 @@ public:
 
         @see Read()
     */
 
         @see Read()
     */

-    char GetChar();
+    virtual char GetChar();

 
     /**
         Returns the amount of available data in the buffer.
 
     /**
         Returns the amount of available data in the buffer.


@@ -209,7 +212,7 @@ public:
     /**
         Returns the current position (counted in bytes) in the stream buffer.
     */
     /**
         Returns the current position (counted in bytes) in the stream buffer.
     */

-    off_t GetIntPosition() const;
+    wxFileOffset GetIntPosition() const;

 
     /**
         Returns the amount of bytes read during the last IO call to the parent stream.
 
     /**
         Returns the amount of bytes read during the last IO call to the parent stream.


@@ -224,7 +227,7 @@ public:
 
         @see Read()
     */
 
         @see Read()
     */

-    void PutChar(char c);
+    virtual void PutChar(char c);

 
     /**
         Reads a block of the specified size and stores the data in buffer.
 
     /**
         Reads a block of the specified size and stores the data in buffer.


@@ -236,7 +239,7 @@ public:
                 different of the specified size, an error has occurred and
                 should be tested using GetLastError().
     */
                 different of the specified size, an error has occurred and
                 should be tested using GetLastError().
     */

-    size_t Read(void* buffer, size_t size);
+    virtual size_t Read(void* buffer, size_t size);

 
     /**
         Copies data to @a buffer.
 
     /**
         Copies data to @a buffer.


@@ -264,7 +267,7 @@ public:
                 measured in bytes from the beginning of the stream.
                 Otherwise, it returns wxInvalidOffset.
     */
                 measured in bytes from the beginning of the stream.
                 Otherwise, it returns wxInvalidOffset.
     */

-    off_t Seek(off_t pos, wxSeekMode mode);
+    virtual wxFileOffset Seek(wxFileOffset pos, wxSeekMode mode);

 
     /**
         Specifies which pointers to use for stream buffering.
 
     /**
         Specifies which pointers to use for stream buffering.


@@ -320,7 +323,7 @@ public:
         @return Returns the current position in the stream if possible,
                 wxInvalidOffset in the other case.
     */
         @return Returns the current position in the stream if possible,
                 wxInvalidOffset in the other case.
     */

-    off_t Tell() const;
+    virtual wxFileOffset Tell() const;

 
     /**
         Truncates the buffer to the current position.
 
     /**
         Truncates the buffer to the current position.


@@ -334,7 +337,7 @@ public:
         Writes a block of the specified size using data of buffer.
         The data are cached in a buffer before being sent in one block to the stream.
     */
         Writes a block of the specified size using data of buffer.
         The data are cached in a buffer before being sent in one block to the stream.
     */

-    size_t Write(const void* buffer, size_t size);
+    virtual size_t Write(const void* buffer, size_t size);

 
     /**
         See Read().
 
     /**
         See Read().


@@ -363,7 +366,7 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxOutputStream();
+    virtual ~wxOutputStream();

 
     /**
         Closes the stream, returning @false if an error occurs.
 
     /**
         Closes the stream, returning @false if an error occurs.


@@ -374,14 +377,14 @@ public:
         as a file, then the underlying resource is closed too if it is owned
         by this stream, or left open otherwise.
     */
         as a file, then the underlying resource is closed too if it is owned
         by this stream, or left open otherwise.
     */

-    bool Close();
+    virtual bool Close();

 
     /**
         Returns the number of bytes written during the last Write().
         It may return 0 even if there is no error on the stream if it is
         only temporarily impossible to write to it.
     */
 
     /**
         Returns the number of bytes written during the last Write().
         It may return 0 even if there is no error on the stream if it is
         only temporarily impossible to write to it.
     */

-    size_t LastWrite() const;
+    virtual size_t LastWrite() const;

 
     /**
         Puts the specified character in the output queue and increments the
 
     /**
         Puts the specified character in the output queue and increments the


@@ -399,12 +402,12 @@ public:
 
         @return The new stream position or wxInvalidOffset on error.
     */
 
         @return The new stream position or wxInvalidOffset on error.
     */

-    off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
+    virtual wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart);

 
     /**
         Returns the current stream position.
     */
 
     /**
         Returns the current stream position.
     */

-    off_t TellO() const;
+    virtual wxFileOffset TellO() const;

 
     /**
         Writes up to the specified amount of bytes using the data of buffer.
 
     /**
         Writes up to the specified amount of bytes using the data of buffer.


@@ -450,7 +453,7 @@ enum wxStreamProtocolType
     handle it and create a stream to decompress it:
 
     @code
     handle it and create a stream to decompress it:
 
     @code

-    factory = wxFilterClassFactory::Find(filename, wxSTREAM_FILEEXT);
+        factory = wxFilterClassFactory::Find(filename, wxSTREAM_FILEEXT);

         if (factory)
             stream = factory-NewStream(new wxFFileInputStream(filename));
     @endcode
         if (factory)
             stream = factory-NewStream(new wxFFileInputStream(filename));
     @endcode


@@ -534,7 +537,7 @@ public:
             list << *p << _T("\n");
         @endcode
     */
             list << *p << _T("\n");
         @endcode
     */

-    const wxChar* const* GetProtocols(wxStreamProtocolType type = wxSTREAM_PROTOCOL) const;
+    virtual const wxChar * const* GetProtocols(wxStreamProtocolType type = wxSTREAM_PROTOCOL) const = 0;

 
     //@{
     /**
 
     //@{
     /**


@@ -708,19 +711,19 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxInputStream();
+    virtual ~wxInputStream();

 
     /**
         Returns @true if some data is available in the stream right now, so that
         calling Read() wouldn't block.
     */
 
     /**
         Returns @true if some data is available in the stream right now, so that
         calling Read() wouldn't block.
     */

-    bool CanRead() const;
+    virtual bool CanRead() const;

 
     /**
         Returns @true after an attempt has been made to read past the end of the
         stream.
     */
 
     /**
         Returns @true after an attempt has been made to read past the end of the
         stream.
     */

-    bool Eof() const;
+    virtual bool Eof() const;

 
     /**
         Returns the first character in the input queue and removes it,
 
     /**
         Returns the first character in the input queue and removes it,


@@ -731,12 +734,12 @@ public:
     /**
         Returns the last number of bytes read.
     */
     /**
         Returns the last number of bytes read.
     */

-    size_t LastRead() const;
+    virtual size_t LastRead() const;

 
     /**
         Returns the first character in the input queue without removing it.
     */
 
     /**
         Returns the first character in the input queue without removing it.
     */

-    char Peek();
+    virtual char Peek();

 
     /**
         Reads the specified amount of bytes and stores the data in buffer.
 
     /**
         Reads the specified amount of bytes and stores the data in buffer.


@@ -768,12 +771,12 @@ public:
 
         @return The new stream position or wxInvalidOffset on error.
     */
 
         @return The new stream position or wxInvalidOffset on error.
     */

-    off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
+    virtual wxFileOffset SeekI(wxFileOffset pos, wxSeekMode mode = wxFromStart);

 
     /**
         Returns the current stream position.
     */
 
     /**
         Returns the current stream position.
     */

-    off_t TellI() const;
+    virtual wxFileOffset TellI() const;

 
     /**
         This function is only useful in read mode.
 
     /**
         This function is only useful in read mode.


@@ -835,7 +838,7 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxStreamBase();
+    virtual ~wxStreamBase();

 
     /**
         This function returns the last error.
 
     /**
         This function returns the last error.


@@ -849,7 +852,7 @@ public:
 
         @since 2.5.4
     */
 
         @since 2.5.4
     */

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

 
     /**
         This function returns the size of the stream.
 
     /**
         This function returns the size of the stream.


@@ -860,7 +863,7 @@ public:
         streams. In that cases, GetSize returns 0 so you should always test its
         return value.
     */
         streams. In that cases, GetSize returns 0 so you should always test its
         return value.
     */

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

 
     /**
         Returns @true if no error occurred on the stream.
 
     /**
         Returns @true if no error occurred on the stream.


@@ -872,7 +875,7 @@ public:
     /**
         Returns @true if the streams supports seeking to arbitrary offsets.
     */
     /**
         Returns @true if the streams supports seeking to arbitrary offsets.
     */

-    bool IsSeekable() const;
+    virtual bool IsSeekable() const;

 
     /**
         Internal function. It is called when the stream wants to read data of the
 
     /**
         Internal function. It is called when the stream wants to read data of the


@@ -881,20 +884,23 @@ public:
     size_t OnSysRead(void* buffer, size_t bufsize);
 
     /**
     size_t OnSysRead(void* buffer, size_t bufsize);
 
     /**

-        Internal function.
-        It is called when the stream needs to change the current position.
+        See OnSysRead().

     */
     */

-    off_t OnSysSeek(off_t pos, wxSeekMode mode);
+    size_t OnSysWrite(const void* buffer, size_t bufsize);
+
+
+protected:

 
     /**
         Internal function.
 
     /**
         Internal function.

-        It is called when the stream needs to know the real position.
+        It is called when the stream needs to change the current position.

     */
     */

-    off_t OnSysTell() const;
+    virtual wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode);

 
     /**
 
     /**

-        See OnSysRead().
+        Internal function.
+        It is called when the stream needs to know the real position.

     */
     */

-    size_t OnSysWrite(const void* buffer, size_t bufsize);
+    virtual wxFileOffset OnSysTell() const;

 };
 
 };