PDF::Clip Class Reference

Represents a clip in a PDF document. More...

#include <pdfsdk/cxx/clip.h>

Inheritance diagram for PDF::Clip:

Public Member Functions
RectF	GetBBox () const
size_t	GetNumElements () const
Element	GetElement (size_t index) const
void	InsertElement (size_t index, const Element &element)
void	AppendElement (const Element &element)
void	RemoveElement (size_t index)
	Clip (PDEClip handle, bool adopt=false) noexcept
	Clip (const Clip &rhs) noexcept
Clip &	operator= (const Clip &rhs) noexcept
	Clip (Clip &&rhs) noexcept
Clip &	operator= (Clip &&rhs) noexcept

Detailed Description

Represents a clip in a PDF document.

ISO 32000-2:2020 - 8.5.4 Clipping path operators

Member Function Documentation

AppendElement()

void PDF::Clip::AppendElement

(

const Element &

element

)

Append a path element to the end of the clip.

Parameters

element

The element to append.

GetBBox()

RectF PDF::Clip::GetBBox

(

)

const

Get the bounding box of the clip.

Returns

The bounding box of the clip.

GetElement()

Element PDF::Clip::GetElement

(

size_t

index

)

const

Get the path element at the specified index in the clip.

Parameters

index

The index of the element to retrieve.

Returns

The element at the specified index.

GetNumElements()

size_t PDF::Clip::GetNumElements

(

)

const

Get the number of path elements in the clip.

Returns

The number of path elements in the clip.

InsertElement()

void PDF::Clip::InsertElement	(	size_t	index,
		const Element &	element )

Insert a path element at the specified index in the clip.

Parameters

index	The index at which to insert the element.
element	The element to insert.

RemoveElement()

void PDF::Clip::RemoveElement

(

size_t

index

)

Remove the path element at the specified index from the clip.

Parameters

index

The index of the element to remove.

---

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

• include/pdfsdk/cxx/clip.h