Scribus
Open source desktop publishing at your fingertips
CPGFStream Class Referenceabstract

Abstract stream base class. More...

#include <PGFstream.h>

Inheritance diagram for CPGFStream:

Public Member Functions

 CPGFStream ()
 Standard constructor.
 
virtual ~CPGFStream ()
 Standard destructor.
 
virtual void Write (int *count, void *buffer)=0
 
virtual void Read (int *count, void *buffer)=0
 
virtual void SetPos (short posMode, INT64 posOff)=0
 
virtual UINT64 GetPos () const =0
 
virtual bool IsValid () const =0
 

Detailed Description

Abstract stream base class.

Abstract stream base class.

Author
C. Stamm

Member Function Documentation

virtual UINT64 CPGFStream::GetPos ( ) const
pure virtual

Get current stream position.

Returns
Current stream position

Implemented in CPGFMemoryStream, and CPGFFileStream.

virtual bool CPGFStream::IsValid ( ) const
pure virtual

Check stream validity.

Returns
True if stream and current position is valid

Implemented in CPGFMemoryStream, and CPGFFileStream.

virtual void CPGFStream::Read ( int *  count,
void *  buffer 
)
pure virtual

Read some bytes from this stream and stores them into a buffer.

Parameters
countA pointer to a value containing the number of bytes should be read. After this call it contains the number of read bytes.
bufferA memory buffer

Implemented in CPGFMemoryStream, and CPGFFileStream.

virtual void CPGFStream::SetPos ( short  posMode,
INT64  posOff 
)
pure virtual

Set stream position either absolute or relative.

Parameters
posModeA position mode (FSFromStart, FSFromCurrent, FSFromEnd)
posOffA new stream position (absolute positioning) or a position offset (relative positioning)

Implemented in CPGFMemoryStream, and CPGFFileStream.

virtual void CPGFStream::Write ( int *  count,
void *  buffer 
)
pure virtual

Write some bytes out of a buffer into this stream.

Parameters
countA pointer to a value containing the number of bytes should be written. After this call it contains the number of written bytes.
bufferA memory buffer

Implemented in CPGFMemoryStream, and CPGFFileStream.


The documentation for this class was generated from the following file: