PdsStream Struct Reference

PdsStream class. More...

#include <pdfix.h>

Inheritance diagram for PdsStream:

Public Member Functions
virtual PdsDictionary *	GetStreamDict ()=0
	Gets the stream dictionary object.
virtual int	GetRawDataSize () const =0
	Gets the stream raw data size.
virtual bool	IsEof () const =0
	Checks if the current position is end of stream.
virtual int	GetSize () const =0
	Gets the current size of a stream.
virtual bool	Read (int offset, uint8_t *buffer, int size) const =0
	Reads data from PsStream into memory.
virtual int	GetPos () const =0
Public Member Functions inherited from PdsObject
virtual PdfObjectType	GetObjectType () const =0
	Gets the type of an object.
virtual int	GetId () const =0
	Gets the object number.
virtual int	GetGenId () const =0
	Gets the generation number.
virtual PdfDoc *	GetDoc () const =0
	Gets a reference to a document.
virtual PdsObject *	Clone (bool clone_indirect)=0
	Clone the object.
virtual bool	RegisterEvent (PdfEventType type, PdsObjectEventProc proc, void *data)=0
	Registers a user-supplied procedure to call when the specified event occurs.
virtual bool	UnregisterEvent (PdfEventType type, PdsObjectEventProc proc, void *data)=0

Detailed Description

PdsStream class.

Member Function Documentation

GetPos()

virtual int PdsStream::GetPos ( ) const

pure virtual

Gets the current seek position in a stream. This is the position at which the next read or write will begin.

Returns

The current seek position.

GetRawDataSize()

virtual int PdsStream::GetRawDataSize ( ) const

pure virtual

Gets the stream raw data size.

Returns

The stream's dictionary

GetSize()

virtual int PdsStream::GetSize ( ) const

pure virtual

Gets the current size of a stream.

Returns

The size of the stream.

GetStreamDict()

virtual PdsDictionary * PdsStream::GetStreamDict ( )

pure virtual

Gets the stream dictionary object.

Returns

The stream's dictionary

IsEof()

virtual bool PdsStream::IsEof ( ) const

pure virtual

Checks if the current position is end of stream.

Returns

The size of the stream.

See also

PsStream::Read

Read()

virtual bool PdsStream::Read ( int offset, uint8_t * buffer, int size ) const

pure virtual

Reads data from PsStream into memory.

Parameters

buffer	(Filled by the method) A buffer into which data is written.
offset	The position to start read from.
size	The number of bytes to read.

Returns

true if the operation was successful, false otherwise.