Represents the graphics state of a PDF document. More...

#include <pdfsdk/cxx/gstate.h>

Inheritance diagram for PDF::GState:

Public Member Functions
GState	Copy () const

Color	GetFillColor () const

ColorSpace	GetFillColorSpace () const

std::vector< float >	GetFillColorComponents () const

Pattern	GetFillColorPattern () const

void	SetFillColor (const Color &color)

void	SetFillColorSpace (const ColorSpace &colorSpace)

void	SetFillColorComponents (const std::vector< float > &components)

void	SetFillColorComponents (const std::vector< float > &components, const Pattern &pattern)

void	SetFillColorValue (PDColorValue colorValue)

Color	GetStrokeColor () const

ColorSpace	GetStrokeColorSpace () const

std::vector< float >	GetStrokeColorComponents () const

Pattern	GetStrokeColorPattern () const

void	SetStrokeColor (const Color &color)

void	SetStrokeColorSpace (const ColorSpace &colorSpace)

void	SetStrokeColorComponents (const std::vector< float > &components)

void	SetStrokeColorComponents (const std::vector< float > &components, const Pattern &pattern)

void	SetStrokeColorValue (PDColorValue colorValue)

float	GetLineWidth () const

void	SetLineWidth (float lineWidth)

PDELineCap	GetLineCap () const

void	SetLineCap (PDELineCap lineCap)

PDELineJoin	GetLineJoin () const

void	SetLineJoin (PDELineJoin lineJoin)

float	GetMiterLimit () const

void	SetMiterLimit (float miterLimit)

PDEDash	GetDash () const

void	SetDash (const PDEDash &dash)

PDERenderingIntent	GetIntent () const

void	SetIntent (PDERenderingIntent intent)

bool	GetStrokeAdjustment () const

void	SetStrokeAdjustment (bool adjustStrokes)

PDEBlendMode	GetBlendMode () const

void	SetBlendMode (PDEBlendMode blendMode)

SoftMask	GetSoftMask () const

void	SetSoftMask (const SoftMask &softMask)

Matrix	GetSoftMaskMatrix () const

void	SetSoftMaskMatrix (const Matrix &softMaskMatrix)

float	GetFillAlpha () const

void	SetFillAlpha (float fillAlpha)

float	GetStrokeAlpha () const

void	SetStrokeAlpha (float strokeAlpha)

bool	GetAlphaIsShape () const

void	SetAlphaIsShape (bool alphaIsShape)

bool	GetFillOverprint () const

void	SetFillOverprint (bool fillOverprint)

bool	GetStrokeOverprint () const

void	SetStrokeOverprint (bool strokeOverprint)

int	GetOverprintMode () const

void	SetOverprintMode (int overprintMode)

float	GetFlatness () const

void	SetFlatness (float flatness)

float	GetSmoothness () const

void	SetSmoothness (float smoothness)

PDEGStateFlags	GetChangeFlags () const

	GState (PDEGState handle, bool adopt=false) noexcept

	GState (const GState &rhs) noexcept

GState &	operator= (const GState &rhs) noexcept

	GState (GState &&rhs) noexcept

GState &	operator= (GState &&rhs) noexcept

Static Public Member Functions
static GState	Create ()

Detailed Description

Represents the graphics state of a PDF document.

ISO 32000-2:2020 - 8.4 Graphics state

Member Function Documentation

◆ Copy()

GState PDF::GState::Copy ( ) const

Creates a copy of the GState object.

Returns: A copy of the GState object.

◆ Create()

static GState PDF::GState::Create ( )

static

Creates a new GState object.

Returns: The newly created GState object.

◆ GetAlphaIsShape()

bool PDF::GState::GetAlphaIsShape ( ) const

Gets the alpha is shape flag of the graphics state.

Returns: The alpha is shape flag.

◆ GetBlendMode()

PDEBlendMode PDF::GState::GetBlendMode ( ) const

Gets the blend mode of the graphics state.

Returns: The blend mode.

◆ GetChangeFlags()

PDEGStateFlags PDF::GState::GetChangeFlags ( ) const

Gets the change flags of the graphics state.

Returns: The flags that indicate which properties are changed.

◆ GetDash()

PDEDash PDF::GState::GetDash ( ) const

Gets the dash pattern of the graphics state.

Returns: The dash pattern.

◆ GetFillAlpha()

float PDF::GState::GetFillAlpha ( ) const

Gets the fill alpha value of the graphics state.

Returns: The fill alpha value.

◆ GetFillColor()

Color PDF::GState::GetFillColor ( ) const

Gets the fill color of the graphics state.

Returns: The fill color.

◆ GetFillColorComponents()

std::vector< float > PDF::GState::GetFillColorComponents ( ) const

Gets the fill color components of the graphics state.

Returns: The fill color components.

◆ GetFillColorPattern()

Pattern PDF::GState::GetFillColorPattern ( ) const

Gets the fill color pattern of the graphics state.

Returns: The fill color pattern.

◆ GetFillColorSpace()

ColorSpace PDF::GState::GetFillColorSpace ( ) const

Gets the fill color space of the graphics state.

Returns: The fill color space.

◆ GetFillOverprint()

bool PDF::GState::GetFillOverprint ( ) const

Gets the fill overprint flag of the graphics state.

Returns: The fill overprint flag.

◆ GetFlatness()

float PDF::GState::GetFlatness ( ) const

Gets the flatness value of the graphics state.

Returns: The flatness value.

◆ GetIntent()

PDERenderingIntent PDF::GState::GetIntent ( ) const

Gets the rendering intent of the graphics state.

Returns: The rendering intent.

◆ GetLineCap()

PDELineCap PDF::GState::GetLineCap ( ) const

Gets the line cap style of the graphics state.

Returns: The line cap style.

◆ GetLineJoin()

PDELineJoin PDF::GState::GetLineJoin ( ) const

Gets the line join style of the graphics state.

Returns: The line join style.

◆ GetLineWidth()

float PDF::GState::GetLineWidth ( ) const

Gets the line width of the graphics state.

Returns: The line width.

◆ GetMiterLimit()

float PDF::GState::GetMiterLimit ( ) const

Gets the miter limit of the graphics state.

Returns: The miter limit.

◆ GetOverprintMode()

int PDF::GState::GetOverprintMode ( ) const

Gets the overprint mode of the graphics state.

Returns: The overprint mode.

◆ GetSmoothness()

float PDF::GState::GetSmoothness ( ) const

Gets the smoothness value of the graphics state.

Returns: The smoothness value.

◆ GetSoftMask()

SoftMask PDF::GState::GetSoftMask ( ) const

Gets the soft mask of the graphics state.

Returns: The soft mask.

◆ GetSoftMaskMatrix()

Matrix PDF::GState::GetSoftMaskMatrix ( ) const

Gets the soft mask matrix of the graphics state.

Returns: The soft mask matrix.

◆ GetStrokeAdjustment()

bool PDF::GState::GetStrokeAdjustment ( ) const

Gets the stroke adjustment flag of the graphics state.

Returns: The stroke adjustment flag.

◆ GetStrokeAlpha()

float PDF::GState::GetStrokeAlpha ( ) const

Gets the stroke alpha value of the graphics state.

Returns: The stroke alpha value.

◆ GetStrokeColor()

Color PDF::GState::GetStrokeColor ( ) const

Gets the stroke color of the graphics state.

Returns: The stroke color.

◆ GetStrokeColorComponents()

std::vector< float > PDF::GState::GetStrokeColorComponents ( ) const

Gets the stroke color components of the graphics state.

Returns: The stroke color components.

◆ GetStrokeColorPattern()

Pattern PDF::GState::GetStrokeColorPattern ( ) const

Gets the stroke color pattern of the graphics state.

Returns: The stroke color pattern.

◆ GetStrokeColorSpace()

ColorSpace PDF::GState::GetStrokeColorSpace ( ) const

Gets the stroke color space of the graphics state.

Returns: The stroke color space.

◆ GetStrokeOverprint()

bool PDF::GState::GetStrokeOverprint ( ) const

Gets the stroke overprint flag of the graphics state.

Returns: The stroke overprint flag.

◆ SetAlphaIsShape()

void PDF::GState::SetAlphaIsShape ( bool alphaIsShape )

Sets the alpha is shape flag of the graphics state.

Parameters

alphaIsShape The alpha is shape flag to set.

◆ SetBlendMode()

void PDF::GState::SetBlendMode ( PDEBlendMode blendMode )

Sets the blend mode of the graphics state.

Parameters

blendMode The blend mode to set.

◆ SetDash()

void PDF::GState::SetDash ( const PDEDash & dash )

Sets the dash pattern of the graphics state.

Parameters

dash	The dash pattern to set.

◆ SetFillAlpha()

void PDF::GState::SetFillAlpha ( float fillAlpha )

Sets the fill alpha value of the graphics state.

Parameters

fillAlpha The fill alpha value to set.

◆ SetFillColor()

void PDF::GState::SetFillColor ( const Color & color )

Sets the fill color of the graphics state.

Parameters

color The fill color to set.

◆ SetFillColorComponents() [1/2]

void PDF::GState::SetFillColorComponents ( const std::vector< float > & components )

Sets the fill color components of the graphics state.

Parameters

components The fill color components to set.

◆ SetFillColorComponents() [2/2]

void PDF::GState::SetFillColorComponents	(	const std::vector< float > &	components,
		const Pattern &	pattern )

Sets the fill color components of the graphics state.

Parameters

components	The fill color components to set.
pattern	The fill color pattern to set.

◆ SetFillColorSpace()

void PDF::GState::SetFillColorSpace ( const ColorSpace & colorSpace )

Sets the fill color space of the graphics state.

Parameters

colorSpace The color space to set.

◆ SetFillColorValue()

void PDF::GState::SetFillColorValue ( PDColorValue colorValue )

Sets the fill color of the graphics state using a color value.

Parameters

colorValue The color value to set.

◆ SetFillOverprint()

void PDF::GState::SetFillOverprint ( bool fillOverprint )

Sets the fill overprint flag of the graphics state.

Parameters

fillOverprint The fill overprint flag to set.

◆ SetFlatness()

void PDF::GState::SetFlatness ( float flatness )

Sets the flatness value of the graphics state.

Parameters

flatness The flatness value to set.

◆ SetIntent()

void PDF::GState::SetIntent ( PDERenderingIntent intent )

Sets the rendering intent of the graphics state.

Parameters

intent The rendering intent to set.

◆ SetLineCap()

void PDF::GState::SetLineCap ( PDELineCap lineCap )

Sets the line cap style of the graphics state.

Parameters

lineCap The line cap style to set.

◆ SetLineJoin()

void PDF::GState::SetLineJoin ( PDELineJoin lineJoin )

Sets the line join style of the graphics state.

Parameters

lineJoin The line join style to set.

◆ SetLineWidth()

void PDF::GState::SetLineWidth ( float lineWidth )

Sets the line width of the graphics state.

Parameters

lineWidth The line width to set.

◆ SetMiterLimit()

void PDF::GState::SetMiterLimit ( float miterLimit )

Sets the miter limit of the graphics state.

Parameters

miterLimit The miter limit to set.

◆ SetOverprintMode()

void PDF::GState::SetOverprintMode ( int overprintMode )

Sets the overprint mode of the graphics state.

Parameters

overprintMode The overprint mode to set.

◆ SetSmoothness()

void PDF::GState::SetSmoothness ( float smoothness )

Sets the smoothness value of the graphics state.

Parameters

smoothness The smoothness value to set.

◆ SetSoftMask()

void PDF::GState::SetSoftMask ( const SoftMask & softMask )

Sets the soft mask of the graphics state.

Parameters

softMask The soft mask to set.

◆ SetSoftMaskMatrix()

void PDF::GState::SetSoftMaskMatrix ( const Matrix & softMaskMatrix )

Sets the soft mask matrix of the graphics state.

Parameters

softMaskMatrix The soft mask matrix to set.

◆ SetStrokeAdjustment()

void PDF::GState::SetStrokeAdjustment ( bool adjustStrokes )

Sets the stroke adjustment flag of the graphics state.

Parameters

adjustStrokes The stroke adjustment flag to set.

◆ SetStrokeAlpha()

void PDF::GState::SetStrokeAlpha ( float strokeAlpha )

Sets the stroke alpha value of the graphics state.

Parameters

strokeAlpha The stroke alpha value to set.

◆ SetStrokeColor()

void PDF::GState::SetStrokeColor ( const Color & color )

Sets the stroke color of the graphics state.

Parameters

color The stroke color to set.

◆ SetStrokeColorComponents() [1/2]

void PDF::GState::SetStrokeColorComponents ( const std::vector< float > & components )

Sets the stroke color components of the graphics state.

Parameters

components The stroke color components to set.

◆ SetStrokeColorComponents() [2/2]

void PDF::GState::SetStrokeColorComponents	(	const std::vector< float > &	components,
		const Pattern &	pattern )

Sets the stroke color components of the graphics state.

Parameters

components	The stroke color components to set.
pattern	The stroke color pattern to set.

◆ SetStrokeColorSpace()

void PDF::GState::SetStrokeColorSpace ( const ColorSpace & colorSpace )

Sets the stroke color space of the graphics state.

Parameters

colorSpace The color space to set.

◆ SetStrokeColorValue()

void PDF::GState::SetStrokeColorValue ( PDColorValue colorValue )

Sets the stroke color of the graphics state using a color value.

Parameters

colorValue The color value to set.

◆ SetStrokeOverprint()

void PDF::GState::SetStrokeOverprint ( bool strokeOverprint )

Sets the stroke overprint flag of the graphics state.

Parameters

strokeOverprint The stroke overprint flag to set.

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

include/pdfsdk/cxx/gstate.h

PDF SDK Documentation

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ Copy()

◆ Create()

◆ GetAlphaIsShape()

◆ GetBlendMode()

◆ GetChangeFlags()

◆ GetDash()

◆ GetFillAlpha()

◆ GetFillColor()

◆ GetFillColorComponents()

◆ GetFillColorPattern()

◆ GetFillColorSpace()

◆ GetFillOverprint()

◆ GetFlatness()

◆ GetIntent()

◆ GetLineCap()

◆ GetLineJoin()

◆ GetLineWidth()

◆ GetMiterLimit()

◆ GetOverprintMode()

◆ GetSmoothness()

◆ GetSoftMask()

◆ GetSoftMaskMatrix()

◆ GetStrokeAdjustment()

◆ GetStrokeAlpha()

◆ GetStrokeColor()

◆ GetStrokeColorComponents()

◆ GetStrokeColorPattern()

◆ GetStrokeColorSpace()

◆ GetStrokeOverprint()

◆ SetAlphaIsShape()

◆ SetBlendMode()

◆ SetDash()

◆ SetFillAlpha()

◆ SetFillColor()

◆ SetFillColorComponents() [1/2]

◆ SetFillColorComponents() [2/2]

◆ SetFillColorSpace()

◆ SetFillColorValue()

◆ SetFillOverprint()

◆ SetFlatness()

◆ SetIntent()

◆ SetLineCap()

◆ SetLineJoin()

◆ SetLineWidth()

◆ SetMiterLimit()

◆ SetOverprintMode()

◆ SetSmoothness()

◆ SetSoftMask()

◆ SetSoftMaskMatrix()

◆ SetStrokeAdjustment()

◆ SetStrokeAlpha()

◆ SetStrokeColor()

◆ SetStrokeColorComponents() [1/2]

◆ SetStrokeColorComponents() [2/2]

◆ SetStrokeColorSpace()

◆ SetStrokeColorValue()

◆ SetStrokeOverprint()