PoDoFo::PdfCanvas Class Reference

A interface that provides the necessary features for a painter to draw onto a PdfObject. More...

#include <PdfCanvas.h>

Inheritance diagram for PoDoFo::PdfCanvas:

Public Member Functions
virtual	~PdfCanvas ()
	Virtual destructor to avoid compiler warnings.
const PdfObject *	GetContentsObject () const
	Get access to the contents object of this page. More...
PdfObject *	GetContentsObject ()
virtual PdfObjectStream &	GetOrCreateContentsStream (PdfStreamAppendFlags flags)=0
	Get access an object that you can use to ADD drawing to. More...
virtual PdfObjectStream &	ResetContentsStream ()=0
	Reset the contents object and create a new stream for appending.
charbuff	GetContentsCopy () const
void	CopyContentsTo (charbuff &buffer) const
virtual void	CopyContentsTo (OutputStream &stream) const =0
PdfObject *	GetFromResources (PdfResourceType type, const std::string_view &key)
	Get an element from the pages resources dictionary, using a type (category) and a key. More...
const PdfObject *	GetFromResources (PdfResourceType type, const std::string_view &key) const
PdfResources *	GetResources ()
	Get the resource object of this page. More...
const PdfResources *	GetResources () const
PdfDictionaryElement &	GetElement ()
const PdfDictionaryElement &	GetElement () const
virtual PdfResources &	GetOrCreateResources ()=0
	Get or create the resource object of this page. More...
virtual void	EnsureResourcesCreated ()=0
	Ensure resources initialized on this canvas.
virtual Rect	GetRectRaw () const =0
	Get the current canvas size in PDF Units. More...
virtual bool	HasRotation (double &teta) const =0
	Get the current canvas rotation. More...

Protected Member Functions
virtual PdfObject *	getContentsObject ()=0
virtual PdfResources *	getResources ()=0
virtual PdfDictionaryElement &	getElement ()=0

Detailed Description

A interface that provides the necessary features for a painter to draw onto a PdfObject.

Member Function Documentation

CopyContentsTo()

void PdfCanvas::CopyContentsTo

(

charbuff &

buffer

)

const

Remarks

It clears the buffer before copying

GetContentsObject()

const PdfObject * PdfCanvas::GetContentsObject

(

)

const

Get access to the contents object of this page.

If you want to draw onto the page, you have to add drawing commands to the stream of the Contents object.

Returns

a contents object

GetFromResources()

PdfObject* PoDoFo::PdfCanvas::GetFromResources	(	PdfResourceType	type,
		const std::string_view &	key
	)

Get an element from the pages resources dictionary, using a type (category) and a key.

Parameters

type	the type of resource to fetch (e.g. /Font, or /XObject)
key	the key of the resource

Returns

the object of the resource or nullptr if it was not found

GetOrCreateContentsStream()

virtual PdfObjectStream& PoDoFo::PdfCanvas::GetOrCreateContentsStream ( PdfStreamAppendFlags  flags )

pure virtual

Get access an object that you can use to ADD drawing to.

Returns

a contents stream object

GetOrCreateResources()

virtual PdfResources& PoDoFo::PdfCanvas::GetOrCreateResources ( )

pure virtual

Get or create the resource object of this page.

Returns

a resources object

Implemented in PoDoFo::PdfPage.

GetRectRaw()

virtual Rect PoDoFo::PdfCanvas::GetRectRaw ( ) const

pure virtual

Get the current canvas size in PDF Units.

Returns

a Rect containing the page size available for drawing

Implemented in PoDoFo::PdfPage.

GetResources()

PdfResources * PdfCanvas::GetResources

(

)

Get the resource object of this page.

Returns

a resources object

HasRotation()

virtual bool PoDoFo::PdfCanvas::HasRotation ( double &  teta ) const

pure virtual

Get the current canvas rotation.

Parameters

teta	counterclockwise rotation in radians

Returns

true if the canvas has a rotation

Implemented in PoDoFo::PdfPage.

---

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

• src/podofo/main/PdfCanvas.h
• src/podofo/main/PdfCanvas.cpp