PDFix SDK  6.5.0
PdsContent Struct Referenceabstract

PdsContent class. More...

Public Member Functions

virtual PdsPathAddNewPath (PdfMatrix *matrix)=0
 Creates and inserts an path object. More...
 
virtual PdsImageAddNewImage (PdsStream *image_xobj, PdfMatrix *matrix)=0
 
virtual bool RemoveObject (PdsPageObject *object)=0
 Removes an object from a PdsContent. More...
 
virtual int GetNumObjects ()=0
 Gets the number of objects. More...
 
virtual PdsPageObjectGetObject (int index)=0
 
virtual PdsStreamToObject (PdfDoc *doc, PdsContentParams *content_params)=0
 This is the main method for converting a PdsContent into PDF contents and resources. More...
 

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

◆ AddNewImage()

virtual PdsImage* PdsContent::AddNewImage ( PdsStream image_xobj,
PdfMatrix matrix 
)
pure virtual

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

Parameters
image_xobjThe image XObject created with CreateXObjectFromImage.
matrixA pointer to a PdfMatrix structure
Returns
The created PdsImage.

◆ AddNewPath()

virtual PdsPath* PdsContent::AddNewPath ( PdfMatrix matrix)
pure virtual

Creates and inserts an path object.

Parameters
matrixA pointer to a PdfMatrix structure
Returns
The created PdsPath.

◆ GetNumObjects()

virtual int PdsContent::GetNumObjects ( )
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
indexIndex of object to obtain.
Returns
The requested object.

◆ 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,
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.