PDF::XObject Class Reference

Represents an XObject in a PDF document. More...

#include <pdfsdk/cxx/xobject.h>

Inheritance diagram for PDF::XObject:

Public Member Functions
Object	GetPdfObject () const
PDEXObjectType	GetXObjectType () const
OCMembership	GetOCMembership () const
void	SetOCMembership (const OCMembership &ocmd)
SizeI	GetImageSize () const
int	GetImageBitsPerComponent () const
bool	ImageIsMask () const
ColorSpace	GetImageColorSpace () const
bool	GetImageInterpolate () const
void	SetImageInterpolate (bool interpolate)
std::optional< PDERenderingIntent >	GetImageRenderingIntent () const
void	SetImageRenderingIntent (std::optional< PDERenderingIntent > intent)
XObject	GetImageMask () const
void	SetImageMask (const XObject &mask)
XObject	GetImageSMask () const
void	SetImageSMask (const XObject &smask)
PDAtom	GetImageCompressionFilter () const
XObject	FormCopy () const
RectF	GetFormBBox () const
void	SetFormBBox (const RectF &bbox)
Matrix	GetFormMatrix () const
void	SetFormMatrix (const Matrix &matrix)
Content	GetFormContent () const
void	SetFormContent (const Content &content)
XGroup	GetFormXGroup () const
void	SetFormXGroup (const XGroup &xgroup)
void	SetFormADBECompoundType (const char *compoundType) const
void	SetFormADBECompoundType (const std::string &compoundType) const
	XObject (PDEXObject handle, bool adopt=false) noexcept
	XObject (const XObject &rhs) noexcept
XObject &	operator= (const XObject &rhs) noexcept
	XObject (XObject &&rhs) noexcept
XObject &	operator= (XObject &&rhs) noexcept

Static Public Member Functions
static XObject	CreateFromPdfObject (const Object &object)

Detailed Description

Represents an XObject in a PDF document.

ISO 32000-2:2020 - 8.8 External objects

Member Function Documentation

CreateFromPdfObject()

static XObject PDF::XObject::CreateFromPdfObject ( const Object & object )

static

Creates an XObject from the specified PDF object.

Parameters

object

The PDF object.

Returns

The XObject.

FormCopy()

XObject PDF::XObject::FormCopy

(

)

const

Create a copy of the form XObject.

Returns

The copied form XObject.

GetFormBBox()

RectF PDF::XObject::GetFormBBox

(

)

const

Get the bounding box of the form XObject.

Returns

The bounding box.

GetFormContent()

Content PDF::XObject::GetFormContent

(

)

const

Get the content of the form XObject.

Returns

The content.

GetFormMatrix()

Matrix PDF::XObject::GetFormMatrix

(

)

const

Get the matrix of the form XObject.

Returns

The matrix.

GetFormXGroup()

XGroup PDF::XObject::GetFormXGroup

(

)

const

Get the XGroup of the form XObject.

Returns

The XGroup.

GetImageBitsPerComponent()

int PDF::XObject::GetImageBitsPerComponent

(

)

const

Get the number of bits per component of the image XObject.

Returns

The number of bits per component.

GetImageColorSpace()

ColorSpace PDF::XObject::GetImageColorSpace

(

)

const

Get the color space of the image XObject.

Returns

The color space.

GetImageCompressionFilter()

PDAtom PDF::XObject::GetImageCompressionFilter

(

)

const

Get the compression filter of the image XObject.

Returns

The compression filter.

GetImageInterpolate()

bool PDF::XObject::GetImageInterpolate

(

)

const

Get the interpolation flag of the image XObject.

Returns

The interpolation flag.

GetImageMask()

XObject PDF::XObject::GetImageMask

(

)

const

Get the image mask XObject associated with this image XObject.

Returns

The image mask XObject.

GetImageRenderingIntent()

std::optional< PDERenderingIntent > PDF::XObject::GetImageRenderingIntent

(

)

const

Get the rendering intent of the image XObject.

Returns

The rendering intent.

GetImageSize()

SizeI PDF::XObject::GetImageSize

(

)

const

Get the size of the image XObject.

Returns

The size of the image.

GetImageSMask()

XObject PDF::XObject::GetImageSMask

(

)

const

Get the soft mask XObject associated with this image XObject.

Returns

The soft mask XObject.

GetOCMembership()

OCMembership PDF::XObject::GetOCMembership

(

)

const

Get the optional content membership dictionary associated with this XObject.

Returns

The OCMembership dictionary.

GetPdfObject()

Object PDF::XObject::GetPdfObject

(

)

const

Get the PDF object associated with this XObject.

Returns

The PDF object.

GetXObjectType()

PDEXObjectType PDF::XObject::GetXObjectType

(

)

const

Get the type of this XObject.

Returns

The XObject type.

ImageIsMask()

bool PDF::XObject::ImageIsMask

(

)

const

Check if the image XObject is a mask.

Returns

True if the image is a mask, false otherwise.

SetFormADBECompoundType() [1/2]

void PDF::XObject::SetFormADBECompoundType

(

const char *

compoundType

)

const

Set the ADBE compound type of the form XObject.

Parameters

compoundType

The ADBE compound type to set.

SetFormADBECompoundType() [2/2]

void PDF::XObject::SetFormADBECompoundType

(

const std::string &

compoundType

)

const

Set the ADBE compound type of the form XObject.

Parameters

compoundType

The ADBE compound type to set.

SetFormBBox()

void PDF::XObject::SetFormBBox

(

const RectF &

bbox

)

Set the bounding box of the form XObject.

Parameters

bbox	The bounding box to set.

SetFormContent()

void PDF::XObject::SetFormContent

(

const Content &

content

)

Set the content of the form XObject.

Parameters

content

The content to set.

SetFormMatrix()

void PDF::XObject::SetFormMatrix

(

const Matrix &

matrix

)

Set the matrix of the form XObject.

Parameters

matrix

The matrix to set.

SetFormXGroup()

void PDF::XObject::SetFormXGroup

(

const XGroup &

xgroup

)

Set the XGroup of the form XObject.

Parameters

xgroup

The XGroup to set.

SetImageInterpolate()

void PDF::XObject::SetImageInterpolate

(

bool

interpolate

)

Set the interpolation flag of the image XObject.

Parameters

interpolate

The interpolation flag to set.

SetImageMask()

void PDF::XObject::SetImageMask

(

const XObject &

mask

)

Set the image mask XObject for this image XObject.

Parameters

mask	The image mask XObject to set.

SetImageRenderingIntent()

void PDF::XObject::SetImageRenderingIntent

(

std::optional< PDERenderingIntent >

intent

)

Set the rendering intent of the image XObject.

Parameters

intent

The rendering intent to set.

SetImageSMask()

void PDF::XObject::SetImageSMask

(

const XObject &

smask

)

Set the soft mask XObject for this image XObject.

Parameters

smask

The soft mask XObject to set.

SetOCMembership()

void PDF::XObject::SetOCMembership

(

const OCMembership &

ocmd

)

Set the optional content membership dictionary for this XObject.

Parameters

ocmd	The OCMembership dictionary to set.

---

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

• include/pdfsdk/cxx/xobject.h