PDF::Pattern Class Reference

Represents a shading or tiling pattern in a PDF document. More...

#include <pdfsdk/cxx/pattern.h>

Inheritance diagram for PDF::Pattern:

Public Member Functions
Object	GetPdfObject () const
PDEPatternType	GetPatternType () const
	Gets the type of the pattern.
Matrix	GetMatrix () const
	Gets the transformation matrix of the pattern.
void	SetMatrix (const Matrix &matrix)
	Sets the transformation matrix of the pattern.
PDETilingPatternPaintType	GetTilingPaintType () const
	Gets the paint type of the tiling pattern.
void	SetTilingPaintType (PDETilingPatternPaintType paintType)
	Sets the paint type of the tiling pattern.
PDETilingPatternTilingType	GetTilingType () const
	Gets the tiling type of the tiling pattern.
void	SetTilingType (PDETilingPatternTilingType tilingType)
	Sets the tiling type of the tiling pattern.
PDRectF	GetTilingBBox () const
	Gets the bounding box of the tiling pattern.
void	SetTilingBBox (const PDRectF &bbox)
	Sets the bounding box of the tiling pattern.
float	GetTilingXStep () const
	Gets the horizontal step of the tiling pattern.
void	SetTilingXStep (float xstep)
	Sets the horizontal step of the tiling pattern.
float	GetTilingYStep () const
	Gets the vertical step of the tiling pattern.
void	SetTilingYStep (float ystep)
	Sets the vertical step of the tiling pattern.
Content	GetTilingContent () const
	Gets the content of the tiling pattern.
Shading	GetShading () const
	Gets the shading of the pattern.
void	SetShading (const Shading &shading)
	Sets the shading of the pattern.
GState	GetShadingExtGState () const
	Gets the extended graphics state of the shading.
void	SetShadingExtGState (const GState &extGState)
	Sets the extended graphics state of the shading.
	Pattern (PDEPattern handle, bool adopt=false) noexcept
	Pattern (const Pattern &rhs) noexcept
Pattern &	operator= (const Pattern &rhs) noexcept
	Pattern (Pattern &&rhs) noexcept
Pattern &	operator= (Pattern &&rhs) noexcept

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

Detailed Description

Represents a shading or tiling pattern in a PDF document.

ISO 32000-2:2020 - 8.7 Patterns

Member Function Documentation

CreateFromPdfObject()

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

static

Creates a pattern from the specified PDF object.

Parameters

object

The PDF object.

Returns

The pattern.

GetMatrix()

Matrix PDF::Pattern::GetMatrix

(

)

const

Gets the transformation matrix of the pattern.

Returns

The transformation matrix.

GetPatternType()

PDEPatternType PDF::Pattern::GetPatternType

(

)

const

Gets the type of the pattern.

Returns

The type of the pattern.

GetPdfObject()

Object PDF::Pattern::GetPdfObject

(

)

const

Get the PDF object associated with this pattern.

Returns

The PDF object.

GetShading()

Shading PDF::Pattern::GetShading

(

)

const

Gets the shading of the pattern.

Returns

The shading of the pattern.

GetShadingExtGState()

GState PDF::Pattern::GetShadingExtGState

(

)

const

Gets the extended graphics state of the shading.

Returns

The extended graphics state of the shading.

GetTilingBBox()

PDRectF PDF::Pattern::GetTilingBBox

(

)

const

Gets the bounding box of the tiling pattern.

Returns

The bounding box of the tiling pattern.

GetTilingContent()

Content PDF::Pattern::GetTilingContent

(

)

const

Gets the content of the tiling pattern.

Returns

The content of the tiling pattern.

GetTilingPaintType()

PDETilingPatternPaintType PDF::Pattern::GetTilingPaintType

(

)

const

Gets the paint type of the tiling pattern.

Returns

The paint type of the tiling pattern.

GetTilingType()

PDETilingPatternTilingType PDF::Pattern::GetTilingType

(

)

const

Gets the tiling type of the tiling pattern.

Returns

The tiling type of the tiling pattern.

GetTilingXStep()

float PDF::Pattern::GetTilingXStep

(

)

const

Gets the horizontal step of the tiling pattern.

Returns

The horizontal step of the tiling pattern.

GetTilingYStep()

float PDF::Pattern::GetTilingYStep

(

)

const

Gets the vertical step of the tiling pattern.

Returns

The vertical step of the tiling pattern.

SetMatrix()

void PDF::Pattern::SetMatrix

(

const Matrix &

matrix

)

Sets the transformation matrix of the pattern.

Parameters

matrix

The transformation matrix to set.

SetShading()

void PDF::Pattern::SetShading

(

const Shading &

shading

)

Sets the shading of the pattern.

Parameters

shading

The shading to set.

SetShadingExtGState()

void PDF::Pattern::SetShadingExtGState

(

const GState &

extGState

)

Sets the extended graphics state of the shading.

Parameters

extGState

The extended graphics state to set.

SetTilingBBox()

void PDF::Pattern::SetTilingBBox

(

const PDRectF &

bbox

)

Sets the bounding box of the tiling pattern.

Parameters

bbox	The bounding box to set.

SetTilingPaintType()

void PDF::Pattern::SetTilingPaintType

(

PDETilingPatternPaintType

paintType

)

Sets the paint type of the tiling pattern.

Parameters

paintType

The paint type to set.

SetTilingType()

void PDF::Pattern::SetTilingType

(

PDETilingPatternTilingType

tilingType

)

Sets the tiling type of the tiling pattern.

Parameters

tilingType

The tiling type to set.

SetTilingXStep()

void PDF::Pattern::SetTilingXStep

(

float

xstep

)

Sets the horizontal step of the tiling pattern.

Parameters

xstep

The horizontal step to set.

SetTilingYStep()

void PDF::Pattern::SetTilingYStep

(

float

ystep

)

Sets the vertical step of the tiling pattern.

Parameters

ystep

The vertical step to set.

---

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

• include/pdfsdk/cxx/pattern.h