PDF::Shading Class Reference

Represents a shading in a PDF document. More...

#include <pdfsdk/cxx/shading.h>

Inheritance diagram for PDF::Shading:

Public Member Functions
Object	GetPdfObject () const
PDEShadingType	GetShadingType () const
ColorSpace	GetColorSpace () const
Color	GetBackground () const
void	SetBackground (const Color &background)
PDRectF	GetBBox () const
void	SetBBox (const PDRectF &bbox)
bool	GetAntiAlias () const
void	SetAntiAlias (bool antiAlias)
	Shading (PDEShading handle, bool adopt=false) noexcept
	Shading (const Shading &rhs) noexcept
Shading &	operator= (const Shading &rhs) noexcept
	Shading (Shading &&rhs) noexcept
Shading &	operator= (Shading &&rhs) noexcept

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

Detailed Description

Represents a shading in a PDF document.

ISO 32000-2:2020 - 8.7.4.3 Shading dictionaries

Member Function Documentation

CreateFromPdfObject()

Shading PDF::Shading::CreateFromPdfObject ( const Object & object )

static

Creates a shading from the specified PDF object.

Parameters

object

The PDF object.

Returns

The shading.

GetAntiAlias()

bool PDF::Shading::GetAntiAlias

(

)

const

Gets whether anti-aliasing is enabled for the shading.

Returns

true if anti-aliasing is enabled, false otherwise.

GetBackground()

Color PDF::Shading::GetBackground

(

)

const

Gets the background color of the shading.

Returns

The background color.

GetBBox()

PDRectF PDF::Shading::GetBBox

(

)

const

Gets the bounding box of the shading.

Returns

The bounding box.

GetColorSpace()

ColorSpace PDF::Shading::GetColorSpace

(

)

const

Gets the color space of the shading.

Returns

The color space.

GetPdfObject()

Object PDF::Shading::GetPdfObject

(

)

const

Get the PDF object associated with this shading.

Returns

The PDF object.

GetShadingType()

PDEShadingType PDF::Shading::GetShadingType

(

)

const

Get the type of the shading.

Returns

The shading type.

SetAntiAlias()

void PDF::Shading::SetAntiAlias

(

bool

antiAlias

)

Sets whether anti-aliasing is enabled for the shading.

Parameters

antiAlias

true to enable anti-aliasing, false to disable it.

SetBackground()

void PDF::Shading::SetBackground

(

const Color &

background

)

Sets the background color of the shading.

Parameters

background

The background color to set.

SetBBox()

void PDF::Shading::SetBBox

(

const PDRectF &

bbox

)

Sets the bounding box of the shading.

Parameters

bbox	The bounding box to set.

---

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

• include/pdfsdk/cxx/shading.h