wxPdfStream Class Reference

Class representing a stream object. (For internal use only) More...

#include <pdfobjects.h>

Inheritance diagram for wxPdfStream:

Public Member Functions
	wxPdfStream ()
	Default constructor.
	wxPdfStream (off_t offset)
	Constructor.
virtual	~wxPdfStream ()
	Destructor.
off_t	GetOffset ()
	Get the offset of the stream data.
void	SetDictionary (wxPdfDictionary *dictionary)
	Set the associated stream dictionary.
wxPdfDictionary *	GetDictionary ()
	Get the associated stream dictionary.
void	SetBuffer (wxMemoryOutputStream *buffer)
	Set the stream data buffer.
wxMemoryOutputStream *	GetBuffer ()
	Get the stream data buffer.
wxPdfObject *	Get (const wxString &key)
	Get a value identified by the given key from the associated dictionary.
void	SetHasObjOffsets (bool hasObjOffsets)
	Set flag whether an object stream has already read the object index.
bool	HasObjOffsets ()
	Get flag whether the offsets of objects in an object stream are available.
wxArrayInt *	GetObjOffsets ()
	Get a pointer to the object offsets array.
int	GetObjOffset (int index) const
	Get the offset of an object in the object stream.
Public Member Functions inherited from wxPdfObject
	wxPdfObject (int type)
	Constructor.
virtual	~wxPdfObject ()
	Destructor.
int	GetType ()
	Get the type of the object.
void	SetObjNum (int objNum, int objGen=0)
	Set object and generation number.
int	GetNumber ()
	Get object number.
int	GetGeneration ()
	Get generation number.
void	SetActualId (int actualId)
	Set actual object id.
int	GetActualId ()
void	SetCreatedIndirect (bool indirect)
	Flag this object as created through a indirect reference.
bool	IsCreatedIndirect ()
	Check whether this object was created through a indirect reference.
bool	CanBeInObjStm ()
	Check whether this object can be in an object stream.
bool	IsNull ()
	Checks whether this is a wxPdfNull object.
bool	IsBoolean ()
	Checks whether this is a wxPdfBoolean object.
bool	IsNumber ()
	Checks whether this is a wxPdfNumber object.
bool	IsString ()
	Checks whether this is a wxPdfString object.
bool	IsName ()
	Checks whether this is a wxPdfName object.
bool	IsArray ()
	Checks whether this is a wxPdfArray object.
bool	IsDictionary ()
	Checks whether this is a wxPdfDictionary object.
bool	IsStream ()
	Checks whether this PdfObject is of the type PdfStream.
bool	IsIndirect ()
	Checks if this is an indirect object.

Additional Inherited Members
Protected Attributes inherited from wxPdfObject
int	m_type
	Object type.
int	m_objNum
	Object number.
int	m_objGen
	Object generation.
int	m_actualId
	Actual object id.
bool	m_indirect
	Flag whether created through indirect reference.

Detailed Description

Class representing a stream object. (For internal use only)

Constructor & Destructor Documentation

wxPdfStream() [1/2]

wxPdfStream::wxPdfStream

(

)

Default constructor.

wxPdfStream() [2/2]

wxPdfStream::wxPdfStream

(

off_t

offset

)

Constructor.

~wxPdfStream()

virtual wxPdfStream::~wxPdfStream ( )

virtual

Destructor.

Member Function Documentation

Get()

wxPdfObject * wxPdfStream::Get

(

const wxString &

key

)

Get a value identified by the given key from the associated dictionary.

GetBuffer()

wxMemoryOutputStream * wxPdfStream::GetBuffer ( )

inline

Get the stream data buffer.

GetDictionary()

wxPdfDictionary * wxPdfStream::GetDictionary ( )

inline

Get the associated stream dictionary.

GetObjOffset()

int wxPdfStream::GetObjOffset

(

int

index

)

const

Get the offset of an object in the object stream.

GetObjOffsets()

wxArrayInt * wxPdfStream::GetObjOffsets ( )

inline

Get a pointer to the object offsets array.

GetOffset()

off_t wxPdfStream::GetOffset ( )

inline

Get the offset of the stream data.

HasObjOffsets()

bool wxPdfStream::HasObjOffsets ( )

inline

Get flag whether the offsets of objects in an object stream are available.

SetBuffer()

void wxPdfStream::SetBuffer ( wxMemoryOutputStream * buffer )

inline

Set the stream data buffer.

SetDictionary()

void wxPdfStream::SetDictionary ( wxPdfDictionary * dictionary )

inline

Set the associated stream dictionary.

SetHasObjOffsets()

void wxPdfStream::SetHasObjOffsets ( bool hasObjOffsets )

inline

Set flag whether an object stream has already read the object index.

---

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

• pdfobjects.h