PdsContent Struct Reference

PdsContent class. More...

#include <pdfix.h>

Public Member Functions
virtual PdsText *	AddNewText (int index, PdfFont *font, const PdfMatrix *matrix)=0
	Creates and inserts a text object.
virtual PdsPath *	AddNewPath (int index, const PdfMatrix *matrix)=0
	Creates and inserts an path object.
virtual PdsImage *	AddNewImage (int index, PdsStream *image_xobj, const PdfMatrix *matrix)=0
virtual PdsForm *	AddNewForm (int index, PdsStream *form_xobj, const PdfMatrix *matrix)=0
virtual bool	RemoveObject (PdsPageObject *object)=0
	Removes an object from a PdsContent.
virtual int	GetNumObjects () const =0
	Gets the number of objects.
virtual PdsPageObject *	GetObject (int index)=0
virtual PdsStream *	ToObject (PdfDoc *doc, const PdsContentParams *content_params)=0
	This is the main method for converting a PdsContent into PDF contents and resources.
virtual PdfPage *	GetPage ()=0
	Get the page from which the content is parsser.
virtual PdsForm *	GetForm ()=0
	Get the page from which the content is parsser.
virtual bool	RegisterEvent (PdfEventType type, PdsContentEventProc proc, void *data)=0
	Registers a user-supplied procedure to call when the specified event occurs.
virtual bool	UnregisterEvent (PdfEventType type, PdsContentEventProc proc, void *data)=0

Detailed Description

PdsContent class.

The PdsContent object is contains the modifiable contents of a PdfPage.

A PdsContent is a general object in a PDF page content, which may be of any PdsPageObject object type. The Object layer provides several methods that are not specific to any particular object.

Member Function Documentation

AddNewForm()

virtual PdsForm * PdsContent::AddNewForm ( int index, PdsStream * form_xobj, const PdfMatrix * matrix )

pure virtual

Creates and inserts an form XObject object. The form data are to be specified as a stream.

Parameters

index	A place where to insert new object into the content. Passing a value of kInsertAfterLast adds the object to the end. Passing a value of kInsertBeforeFirst adds the object to the beginning of the content.
form_xobj	The form XObject.
matrix	A pointer to a PdfMatrix structure

Returns

The created PdsImage.

AddNewImage()

virtual PdsImage * PdsContent::AddNewImage ( int index, PdsStream * image_xobj, const PdfMatrix * matrix )

pure virtual

Creates and inserts an image object. The image data are to be specified as a stream.

Parameters

index	A place where to insert new object into the content. Passing a value of kInsertAfterLast adds the object to the end. Passing a value of kInsertBeforeFirst adds the object to the beginning of the content.
image_xobj	The image XObject created with CreateXObjectFromImage.
matrix	A pointer to a PdfMatrix structure

Returns

The created PdsImage.

AddNewPath()

virtual PdsPath * PdsContent::AddNewPath ( int index, const PdfMatrix * matrix )

pure virtual

Creates and inserts an path object.

Parameters

index	A place where to insert new object into the content. Passing a value of kInsertAfterLast adds the object to the end. Passing a value of kInsertBeforeFirst adds the object to the beginning of the content.
matrix	A pointer to a PdfMatrix structure

Returns

The created PdsPath.

AddNewText()

virtual PdsText * PdsContent::AddNewText ( int index, PdfFont * font, const PdfMatrix * matrix )

pure virtual

Creates and inserts a text object.

Parameters

index	A place where to insert new object into the content. Passing a value of kInsertAfterLast adds the object to the end. Passing a value of kInsertBeforeFirst adds the object to the beginning of the content.
font	Font of the text. If font is null, default font (Helvetica) is used.
matrix	Text transformation matrix

Returns

The created PdsText.

GetForm()

virtual PdsForm * PdsContent::GetForm ( )

pure virtual

Get the page from which the content is parsser.

Returns

PdsForm object or null if the content was parsed from a page.

GetNumObjects()

virtual int PdsContent::GetNumObjects ( ) const

pure virtual

Gets the number of objects.

Returns

Number of page objects in the content.

GetObject()

virtual PdsPageObject * PdsContent::GetObject ( int index )

pure virtual

Gets the requested object from a content. NOTE: This method does not copy the object.

Parameters

index

Index of object to obtain.

Returns

The requested object.

GetPage()

virtual PdfPage * PdsContent::GetPage ( )

pure virtual

Get the page from which the content is parsser.

Returns

PdfPage object or null if the content was parsed from an XObject.

RegisterEvent()

virtual bool PdsContent::RegisterEvent ( PdfEventType type, PdsContentEventProc proc, void * data )

pure virtual

Registers a user-supplied procedure to call when the specified event occurs.

Parameters

type	The event type.
proc	A user-supplied callback to call when the event occurs.
data	A pointer to user-supplied data to pass to proc each time it is called.

Returns

true if event was registered, false otherwise. Sample RegisterEvent

RemoveObject()

virtual bool PdsContent::RemoveObject ( PdsPageObject * object )

pure virtual

Removes an object from a PdsContent.

Returns

true if the operation was successful, false otherwise.

ToObject()

virtual PdsStream * PdsContent::ToObject ( PdfDoc * doc, const PdsContentParams * content_params )

pure virtual

This is the main method for converting a PdsContent into PDF contents and resources.

Returns

PdsStream for the resulting contents in PdsContent.

UnregisterEvent()

virtual bool PdsContent::UnregisterEvent ( PdfEventType type, PdsContentEventProc proc, void * data )

pure virtual

Unregisters a user-supplied procedure to call when the specified event occurs. To un-register, you must use same type, proc and data that were used when the event was registered using Pdfix::RegisterEvent.

Parameters

type	The registered event type.
proc	A registered user-supplied callback.
data	A pointer to registered user-supplied data.

Returns

true if event was registered, false otherwise.