Split wxDataViewVirtualModel fork wxDataViewIndexModel to make the code clearer and...

[wxWidgets.git] / interface / stream.h

diff --git a/interface/stream.h b/interface/stream.h
index 6af9c7ff4393648bbbe9f9f8e11164d4335dce1f..db8f227efee187de013142b6363ff411afe90c81 100644 (file)
--- a/interface/stream.h
+++ b/interface/stream.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stream.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stream.h

-// Purpose:     documentation for wxCountingOutputStream class
+// Purpose:     interface of wxCountingOutputStream

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -49,6 +49,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxBufferedInputStream
     @wxheader{stream.h}
 /**
     @class wxBufferedInputStream
     @wxheader{stream.h}


@@ -62,8 +63,7 @@ public:
     @library{wxbase}
     @category{streams}
 
     @library{wxbase}
     @category{streams}
 

-    @seealso
-    wxStreamBuffer, wxInputStream, wxBufferedOutputStream
+    @see wxStreamBuffer, wxInputStream, wxBufferedOutputStream

 */
 class wxBufferedInputStream : public wxFilterInputStream
 {
 */
 class wxBufferedInputStream : public wxFilterInputStream
 {


@@ -72,6 +72,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxStreamBuffer
     @wxheader{stream.h}
 /**
     @class wxStreamBuffer
     @wxheader{stream.h}


@@ -80,8 +81,7 @@ public:
     @library{wxbase}
     @category{streams}
 
     @library{wxbase}
     @category{streams}
 

-    @seealso
-    wxStreamBase
+    @see wxStreamBase

 */
 class wxStreamBuffer
 {
 */
 class wxStreamBuffer
 {


@@ -95,7 +95,7 @@ public:
         buffer continues to be used, trying to call functions in the (destroyed)
         stream. It is advised to use this feature only in very local area of the
         program.
         buffer continues to be used, trying to call functions in the (destroyed)
         stream. It is advised to use this feature only in very local area of the
         program.

-        
+

         @see @ref setbufferio() wxStreamBuffer:SetBufferIO
     */
     wxStreamBuffer(wxStreamBase& stream, BufMode mode);
         @see @ref setbufferio() wxStreamBuffer:SetBufferIO
     */
     wxStreamBuffer(wxStreamBase& stream, BufMode mode);


@@ -119,7 +119,7 @@ public:
         @e flushable. This flag allows (when it has the @false value) or forbids
         (when it has the @true value) the stream buffer to resize dynamically the IO
         buffer.
         @e flushable. This flag allows (when it has the @false value) or forbids
         (when it has the @true value) the stream buffer to resize dynamically the IO
         buffer.

-        
+

         @see SetBufferIO()
     */
     void Fixed(bool fixed);
         @see SetBufferIO()
     */
     void Fixed(bool fixed);


@@ -157,7 +157,7 @@ public:
 
     /**
         Gets a single char from the stream buffer. It acts like the Read call.
 
     /**
         Gets a single char from the stream buffer. It acts like the Read call.

-        
+

         @see Read()
     */
     char GetChar();
         @see Read()
     */
     char GetChar();


@@ -179,7 +179,7 @@ public:
 
     /**
         Puts a single char to the stream buffer.
 
     /**
         Puts a single char to the stream buffer.

-        
+

         @see Read()
     */
     void PutChar(char c);
         @see Read()
     */
     void PutChar(char c);


@@ -189,7 +189,7 @@ public:
         Copies data to @e buffer. The function returns when @a buffer is full or when
         there isn't
         any more data in the current buffer.
         Copies data to @e buffer. The function returns when @a buffer is full or when
         there isn't
         any more data in the current buffer.

-        
+

         @see Write()
     */
     size_t Read(void* buffer, size_t size);
         @see Write()
     */
     size_t Read(void* buffer, size_t size);


@@ -204,19 +204,19 @@ public:
     /**
         Changes the current position.
         @a mode may be one of the following:
     /**
         Changes the current position.
         @a mode may be one of the following:

-        
+

         @b wxFromStart
         @b wxFromStart

-        
+

         The position is counted from the start of the stream.
         The position is counted from the start of the stream.

-        
+

         @b wxFromCurrent
         @b wxFromCurrent

-        
+

         The position is counted from the current position of the stream.
         The position is counted from the current position of the stream.

-        
+

         @b wxFromEnd
         @b wxFromEnd

-        
+

         The position is counted from the end of the stream.
         The position is counted from the end of the stream.

-        
+

         @returns Upon successful completion, it returns the new offset as
                  measured in bytes from the beginning of the stream.
                  Otherwise, it returns wxInvalidOffset.
         @returns Upon successful completion, it returns the new offset as
                  measured in bytes from the beginning of the stream.
                  Otherwise, it returns wxInvalidOffset.


@@ -227,7 +227,7 @@ public:
     /**
         Destroys or invalidates the previous IO buffer and allocates a new one of the
         specified size.
     /**
         Destroys or invalidates the previous IO buffer and allocates a new one of the
         specified size.

-        
+

         @see Fixed(), Flushable()
     */
     void SetBufferIO(char* buffer_start, char* buffer_end);
         @see Fixed(), Flushable()
     */
     void SetBufferIO(char* buffer_start, char* buffer_end);


@@ -255,7 +255,7 @@ public:
         the @e real position in the stream and from the internal buffer position: so
         it gives you the position in the @e real stream counted from the start of
         the stream.
         the @e real position in the stream and from the internal buffer position: so
         it gives you the position in the @e real stream counted from the start of
         the stream.

-        
+

         @returns Returns the current position in the stream if possible,
                  wxInvalidOffset in the other case.
     */
         @returns Returns the current position in the stream if possible,
                  wxInvalidOffset in the other case.
     */


@@ -278,6 +278,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxOutputStream
     @wxheader{stream.h}
 /**
     @class wxOutputStream
     @wxheader{stream.h}


@@ -325,12 +326,12 @@ public:
 
     /**
         Changes the stream current position.
 
     /**
         Changes the stream current position.

-        
+

         @param pos
             Offset to seek to.
         @param mode
             One of wxFromStart, wxFromEnd, wxFromCurrent.
         @param pos
             Offset to seek to.
         @param mode
             One of wxFromStart, wxFromEnd, wxFromCurrent.

-        
+

         @returns The new stream position or wxInvalidOffset on error.
     */
     off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
         @returns The new stream position or wxInvalidOffset on error.
     */
     off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);


@@ -352,6 +353,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxFilterClassFactory
     @wxheader{stream.h}
 /**
     @class wxFilterClassFactory
     @wxheader{stream.h}


@@ -376,8 +378,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
     @library{wxbase}
     @category{FIXME}
 

-    @seealso
-    wxFilterInputStream, wxFilterOutputStream, wxArchiveClassFactory, @ref
+    @see wxFilterInputStream, wxFilterOutputStream, wxArchiveClassFactory, @ref

     overview_wxarc "Archive formats such as zip"
 */
 class wxFilterClassFactory : public wxObject
     overview_wxarc "Archive formats such as zip"
 */
 class wxFilterClassFactory : public wxObject


@@ -407,7 +408,7 @@ public:
     /**
         GetFirst and GetNext can be used to enumerate the available factories.
         For example, to list them:
     /**
         GetFirst and GetNext can be used to enumerate the available factories.
         For example, to list them:

-        
+

         GetFirst()/GetNext() return a pointer to a factory or @NULL if no more
         are available. They do not give away ownership of the factory.
     */
         GetFirst()/GetNext() return a pointer to a factory or @NULL if no more
         are available. They do not give away ownership of the factory.
     */


@@ -471,6 +472,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxFilterOutputStream
     @wxheader{stream.h}
 /**
     @class wxFilterOutputStream
     @wxheader{stream.h}


@@ -483,8 +485,7 @@ public:
     @library{wxbase}
     @category{streams}
 
     @library{wxbase}
     @category{streams}
 

-    @seealso
-    wxFilterClassFactory, wxFilterInputStream
+    @see wxFilterClassFactory, wxFilterInputStream

 */
 class wxFilterOutputStream : public wxOutputStream
 {
 */
 class wxFilterOutputStream : public wxOutputStream
 {


@@ -501,6 +502,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxFilterInputStream
     @wxheader{stream.h}
 /**
     @class wxFilterInputStream
     @wxheader{stream.h}


@@ -514,8 +516,7 @@ public:
     @library{wxbase}
     @category{streams}
 
     @library{wxbase}
     @category{streams}
 

-    @seealso
-    wxFilterClassFactory, wxFilterOutputStream
+    @see wxFilterClassFactory, wxFilterOutputStream

 */
 class wxFilterInputStream : public wxInputStream
 {
 */
 class wxFilterInputStream : public wxInputStream
 {


@@ -532,6 +533,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxBufferedOutputStream
     @wxheader{stream.h}
 /**
     @class wxBufferedOutputStream
     @wxheader{stream.h}


@@ -547,8 +549,7 @@ public:
     @library{wxbase}
     @category{streams}
 
     @library{wxbase}
     @category{streams}
 

-    @seealso
-    wxStreamBuffer, wxOutputStream
+    @see wxStreamBuffer, wxOutputStream

 */
 class wxBufferedOutputStream : public wxFilterOutputStream
 {
 */
 class wxBufferedOutputStream : public wxFilterOutputStream
 {


@@ -577,6 +578,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxInputStream
     @wxheader{stream.h}
 /**
     @class wxInputStream
     @wxheader{stream.h}


@@ -631,7 +633,7 @@ public:
     /**
         Reads data from the input queue and stores it in the specified output stream.
         The data is read until an error is raised by one of the two streams.
     /**
         Reads data from the input queue and stores it in the specified output stream.
         The data is read until an error is raised by one of the two streams.

-        
+

         @returns This function returns a reference on the current object, so the
                  user can test any states of the stream right away.
     */
         @returns This function returns a reference on the current object, so the
                  user can test any states of the stream right away.
     */


@@ -644,12 +646,12 @@ public:
 
     /**
         Changes the stream current position.
 
     /**
         Changes the stream current position.

-        
+

         @param pos
             Offset to seek to.
         @param mode
             One of wxFromStart, wxFromEnd, wxFromCurrent.
         @param pos
             Offset to seek to.
         @param mode
             One of wxFromStart, wxFromEnd, wxFromCurrent.

-        
+

         @returns The new stream position or wxInvalidOffset on error.
     */
     off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
         @returns The new stream position or wxInvalidOffset on error.
     */
     off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);


@@ -670,6 +672,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxStreamBase
     @wxheader{stream.h}
 /**
     @class wxStreamBase
     @wxheader{stream.h}


@@ -681,8 +684,7 @@ public:
     @library{wxbase}
     @category{streams}
 
     @library{wxbase}
     @category{streams}
 

-    @seealso
-    wxStreamBuffer
+    @see wxStreamBuffer

 */
 class wxStreamBase
 {
 */
 class wxStreamBase
 {


@@ -699,21 +701,21 @@ public:
 
     /**
         This function returns the last error.
 
     /**
         This function returns the last error.

-        
+

         @b wxSTREAM_NO_ERROR
         @b wxSTREAM_NO_ERROR

-        
+

         No error occurred.
         No error occurred.

-        
+

         @b wxSTREAM_EOF
         @b wxSTREAM_EOF

-        
+

         An End-Of-File occurred.
         An End-Of-File occurred.

-        
+

         @b wxSTREAM_WRITE_ERROR
         @b wxSTREAM_WRITE_ERROR

-        
+

         A generic error occurred on the last write call.
         A generic error occurred on the last write call.

-        
+

         @b wxSTREAM_READ_ERROR
         @b wxSTREAM_READ_ERROR

-        
+

         A generic error occurred on the last read call.
     */
     wxStreamError GetLastError() const;
         A generic error occurred on the last read call.
     */
     wxStreamError GetLastError() const;


@@ -722,7 +724,8 @@ public:
         Returns the length of the stream in bytes. If the length cannot be determined
         (this is always the case for socket streams for example), returns
         @c wxInvalidOffset.
         Returns the length of the stream in bytes. If the length cannot be determined
         (this is always the case for socket streams for example), returns
         @c wxInvalidOffset.

-        This function is new since wxWidgets version 2.5.4
+
+        @wxsince{2.5.4}

     */
     wxFileOffset GetLength() const;
 
     */
     wxFileOffset GetLength() const;
 


@@ -735,7 +738,7 @@ public:
 
     /**
         Returns @true if no error occurred on the stream.
 
     /**
         Returns @true if no error occurred on the stream.

-        
+

         @see GetLastError()
     */
     virtual bool IsOk() const;
         @see GetLastError()
     */
     virtual bool IsOk() const;


@@ -768,3 +771,4 @@ public:
     */
     size_t OnSysWrite(const void* buffer, size_t bufsize);
 };
     */
     size_t OnSysWrite(const void* buffer, size_t bufsize);
 };

+