PoDoFo::PdfExtGState Class Reference

#include <PdfExtGState.h>

Public Member Functions
	PdfExtGState (PdfDocument &doc)
void	SetFillOpacity (double opac)
void	SetStrokeOpacity (double opac)
void	SetBlendMode (const std::string_view &blendMode)
void	SetOverprint (bool enable=true)
void	SetFillOverprint (bool enable=true)
void	SetStrokeOverprint (bool enable=true)
void	SetNonZeroOverprint (bool enable=true)
void	SetRenderingIntent (const std::string_view &intent)
void	SetFrequency (double frequency)
const PdfName &	GetIdentifier () const

Detailed Description

This class wraps the ExtGState object used in the Resource Dictionary of a Content-supporting element (page, Pattern, etc.) The main usage is for transparency, but it also support a variety of prepress features.

Constructor & Destructor Documentation

PdfExtGState()

PdfExtGState::PdfExtGState

(

PdfDocument &

doc

)

Create a new PdfExtGState object which will introduce itself automatically to every page object it is used on.

Parameters

parent

parent document

Member Function Documentation

GetIdentifier()

const PdfName & PoDoFo::PdfExtGState::GetIdentifier ( ) const

inline

Returns the identifier of this ExtGState how it is known in the pages resource dictionary.

Returns

PdfName containing the identifier (e.g. /ExtGS13)

SetBlendMode()

void PdfExtGState::SetBlendMode

(

const std::string_view &

blendMode

)

Sets the transparency blend mode

Parameters

blendMode

one of the predefined blending modes (see PdfDeclarations.h)

SetFillOpacity()

void PdfExtGState::SetFillOpacity

(

double

opac

)

Sets the opacity value to be used for fill operations

Parameters

opac	a floating point value from 0 (transparent) to 1 (opaque)

SetFillOverprint()

void PdfExtGState::SetFillOverprint

(

bool

enable = true

)

Enables/Disables overprinting for Fill operations

Parameters

enable

enable or disable

SetFrequency()

void PdfExtGState::SetFrequency

(

double

frequency

)

Set the frequency for halftones

Parameters

frequency

screen frequency, measured in halftone cells per inch in device space

SetNonZeroOverprint()

void PdfExtGState::SetNonZeroOverprint

(

bool

enable = true

)

Enables/Disables non-zero overprint mode

Parameters

enable

enable or disable

SetOverprint()

void PdfExtGState::SetOverprint

(

bool

enable = true

)

Enables/Disables overprinting for both Fill & Stroke

Parameters

enable

enable or disable

SetRenderingIntent()

void PdfExtGState::SetRenderingIntent

(

const std::string_view &

intent

)

Set the Rendering Intent

Parameters

intent

one of the predefined intents

SetStrokeOpacity()

void PdfExtGState::SetStrokeOpacity

(

double

opac

)

Sets the opacity value to be used for stroking operations

Parameters

opac	a floating point value from 0 (transparent) to 1 (opaque)

SetStrokeOverprint()

void PdfExtGState::SetStrokeOverprint

(

bool

enable = true

)

Enables/Disables overprinting for Stroke operations

Parameters

enable

enable or disable