PDF Edit Layer: PDEExtGState

PDEExtGState Typedefs

PDEExtGState

Header: PEExpT.h:345

Description

A reference to an ExtGState resource used on a page in a PDF file. It specifies a PDEElement object's extended graphics state, which is part of its graphics state.

Related Methods

PDERelease

Syntax

typedef struct _t_PDEExtGState *PDEExtGState;

Returned From

Used By

Used In

PDEExtGState Functions

PDEExtGStateAcquireSoftMask: - Acquires the soft mask of the extended graphic state.
PDEExtGStateCreate: - Creates a new PDEExtGState from a Cos object.
PDEExtGStateCreateNew: - Creates a new extended graphics state object.
PDEExtGStateGetAIS: - Returns the value of the Alpha Is Shape (AIS) member of the graphics state.
PDEExtGStateGetBPC: - Returns the value of black point compensation.
PDEExtGStateGetBlendMode: - Returns the blend mode for the color composite for each object painted.
PDEExtGStateGetCosObj: - Gets a Cos object for a PDEExtGState.
PDEExtGStateGetHalfToneOrigin: - Returns HalfTone Co-ordinate point.
PDEExtGStateGetOPFill: - Returns whether overprint is enabled for painting operations other than stroking.
PDEExtGStateGetOPM: - Returns the overprint mode used by this graphics state.
PDEExtGStateGetOPStroke: - Returns whether overprint is enabled for stroke painting operations.
PDEExtGStateGetOpacityFill: - Returns the opacity value for painting operations other than stroking.
PDEExtGStateGetOpacityStroke: - Returns the opacity value for stroke painting operations for paths and glyph outlines.
PDEExtGStateGetSA: - Returns whether stroke adjustment is enabled in the graphics state.
PDEExtGStateGetSoftMaskMatrix: - Gets the softmask matrix from ExtGstate.
PDEExtGStateGetTK: - Returns whether text knockout is enabled in the graphics state.
PDEExtGStateHasSoftMask: - Returns whether the graphics state contains a soft mask.
PDEExtGStateSetAIS: - Specifies if the alpha is to be interpreted as a shape or opacity mask.
PDEExtGStateSetBPC: - Sets the black point compensation.
PDEExtGStateSetBlendMode: - Sets the blend mode for the color composites for each object painted.
PDEExtGStateSetHalfToneOrigin: - Sets HalfTone Co-ordinate point.
PDEExtGStateSetOPFill: - Specifies if overprint is enabled for painting operations other than stroking.
PDEExtGStateSetOPM: - Sets the overprint mode.
PDEExtGStateSetOPStroke: - Specifies if overprint is enabled for stroke operations.
PDEExtGStateSetOpacityFill: - Sets the opacity value for painting operations other than stroking.
PDEExtGStateSetOpacityStroke: - Sets the opacity value for stroke operations.
PDEExtGStateSetSA: - Specifies whether stroke adjustment is enabled in the graphics state.
PDEExtGStateSetSoftMask: - Sets the soft mask of the extended graphics state.
PDEExtGStateSetSoftMaskMatrix: - Sets the softmask matrix in ExtGstate.
PDEExtGStateSetTK: - Specifies whether text knockout is enabled in the graphics state.

PDEExtGStateAcquireSoftMask

Header: PERProcs.h:2187

Description

Acquires the soft mask of the extended graphic state.

Call PDERelease() to dispose of the PDESoftMask when finished with it.

Syntax

PDESoftMask PDEExtGStateAcquireSoftMask(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

The extended graphics state object.

Returns

The soft mask or NULL if the ExtGState dictionary does not contain the SMask key.

Exceptions

`peErrWrongPDEObjectType`	if pdeExtGState is `NULL` or is not of type
kPDEExtGState.

PDEExtGStateCreate

Header: PEWProcs.h:1109

Description

Creates a new PDEExtGState from a Cos object. See the description of Extended Graphic States in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 8.4.5, page 128. You can find this document on the web store of the International Standards Organization (ISO).

Call PDERelease() to dispose of the returned PDEExtGState when finished with it.

Syntax

PDEExtGState PDEExtGStateCreate(IN CosObj *cosObjP);

Parameters

cosObjP

A Cos object for a dictionary of type ExtGState.

Returns

The PDEExtGState for cosObjP.

PDEExtGStateCreateNew

Header: PEWProcs.h:1847

Description

Creates a new extended graphics state object.

Call PDERelease() to dispose of the returned PDEExtGState object when finished with it.

Syntax

PDEExtGState PDEExtGStateCreateNew(IN CosDoc cosDoc);

Parameters

cosDoc

IN/OUT The document within which the object will be used.

Returns

The newly created object.

PDEExtGStateGetAIS

Header: PERProcs.h:2161

Description

Returns the value of the Alpha Is Shape (AIS) member of the graphics state. If AIS is true, the sources of alpha are treated as shape; otherwise they are treated as opacity values. If the value is not set, the default value of false is returned.

Syntax

ASBool PDEExtGStateGetAIS(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

IN/OUT The extended graphics state object.

Returns

See above.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateGetBPC

Header: PERProcs.h:3371

Description

Returns the value of black point compensation. Valid names are ON, OFF and Default. If the value has not been set a value of Default is returned.

Related Methods

PDEExtGStateSetBPC

Syntax

ASAtom PDEExtGStateGetBPC(IN PDEExtGState extGS);

Parameters

extGS

The extended graphics state object.

Returns

ASAtom for BPC value.

Exceptions

genErrBadParm

PDEExtGStateGetBlendMode

Header: PERProcs.h:2146

Description

Compatible
Normal
Multiply
Screen
Difference
Darken
Lighten
ColorDodge
ColorBurn
Exclusion
HardLight
Overlay
SoftLight
Luminosity
Hue
Saturation
Color

Syntax

ASAtom PDEExtGStateGetBlendMode(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

IN/OUT The extended graphics state object.

Returns

If the value has not been set, a value of Compatible is returned. See above.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateGetCosObj

Header: PERProcs.h:1328

Description

Gets a Cos object for a PDEExtGState.

Related Methods

PDEExtGStateCreate

Syntax

void PDEExtGStateGetCosObj(IN PDEExtGState extGState, OUT CosObj *cosObjP);

Parameters

`extGState`	IN/OUT A PDEExtGState whose Cos object is obtained.
`cosObjP`	IN/OUT (Filled by the method) The Cos object for `extGState`.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateGetHalfToneOrigin

Header: PERProcs.h:3227

Description

Returns HalfTone Co-ordinate point.

Related Methods

PDEExtGStateGetHalfToneOrigin

Syntax

ASRealPoint PDEExtGStateGetHalfToneOrigin(IN PDEExtGState extGS);

Parameters

extGS

The extended graphics state object.

Returns

ASRealPoint * for x,y coordinate value of HalfToneOrigin.

Exceptions

genErrBadParm

PDEExtGStateGetOPFill

Header: PERProcs.h:2071

Description

Returns whether overprint is enabled for painting operations other than stroking.

Syntax

ASBool PDEExtGStateGetOPFill(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

IN/OUT The extended graphics state object.

Returns

Returns the value of the / op key in the ExtGState dictionary. If the value is not found, the default value of false is returned.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateGetOPM

Header: PERProcs.h:2057

Description

Returns the overprint mode used by this graphics state.

Syntax

ASInt32 PDEExtGStateGetOPM(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

IN/OUT The extended graphics state object.

Returns

The Cos integer value.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateGetOPStroke

Header: PERProcs.h:2085

Description

Returns whether overprint is enabled for stroke painting operations.

Syntax

ASBool PDEExtGStateGetOPStroke(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

IN/OUT The extended graphics state object.

Returns

Returns the value of the / OP key in the ExtGState dictionary. If the value is not found, the default value of false is returned.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateGetOpacityFill

Header: PERProcs.h:2099

Description

Returns the opacity value for painting operations other than stroking.

Syntax

ASFixed PDEExtGStateGetOpacityFill(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

IN/OUT The extended graphics state object.

Returns

Returns the value of the / ca key in the ExtGState dictionary. If the value is not found, the default value of 1 is returned.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateGetOpacityStroke

Header: PERProcs.h:2113

Description

Returns the opacity value for stroke painting operations for paths and glyph outlines.

Syntax

ASFixed PDEExtGStateGetOpacityStroke(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

IN/OUT The extended graphics state object.

Returns

Returns the value of the / CA key in the ExtGState dictionary. If the value is not found, the default value of 1 is returned.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateGetSA

Header: PERProcs.h:2312

Description

Returns whether stroke adjustment is enabled in the graphics state.

Syntax

ASBool PDEExtGStateGetSA(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

IN/OUT The extended graphics state object.

Returns

Returns the value of the / SA key in the ExtGState dictionary. If the value is not set, the default value of false is returned.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateGetSoftMaskMatrix

Header: PERProcs.h:3478

Description

Gets the softmask matrix from ExtGstate.

Related Methods

PDEExtGStateSetSoftMaskMatrix

Syntax

ASBool PDEExtGStateGetSoftMaskMatrix(IN PDEExtGState extGS, OUT ASDoubleMatrixP matrixP);

Parameters

`extGS`	IN A ExtGstate object.
`matrixP`	OUT A pointer to ASDoubleMatrix

Returns

true if the valid Soft Mask Matrix is present, false otherwise.

PDEExtGStateGetTK

Header: PERProcs.h:2266

Description

Returns whether text knockout is enabled in the graphics state.

Syntax

ASBool PDEExtGStateGetTK(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

IN/OUT The extended graphics state object.

Returns

Returns the value of the / TK key in the ExtGState dictionary. If the value is not found, the default value of true is returned.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateHasSoftMask

Header: PERProcs.h:2174

Description

Returns whether the graphics state contains a soft mask.

Syntax

ASBool PDEExtGStateHasSoftMask(IN PDEExtGState pdeExtGState);

Parameters

pdeExtGState

IN/OUT The extended graphics state object.

Returns

Returns true if the ExtGState dictionary contains the / SMask key; otherwise false is returned.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateSetAIS

Header: PEWProcs.h:1962

Description

Specifies if the alpha is to be interpreted as a shape or opacity mask.

Syntax

void PDEExtGStateSetAIS(IN PDEExtGState pdeExtGState, IN ASBool alphaIsShape);

Parameters

`pdeExtGState`	The extended graphics state object.
`alphaIsShape`	Indicates whether the sources of alpha are to be treated as shape ( `true`) or opacity ( `false`). This determines the interpretation of the constant alpha (ca or CA) and soft mask (SMask) parameters of the graphics state, as well as a soft-mask image (Smask entry) of an image XObject.

PDEExtGStateSetBPC

Header: PEWProcs.h:3838

Description

Sets the black point compensation. Valid names are ON, OFF and Default. An exception will be raised if the name is invalid.

Related Methods

PDEExtGStateGetBPC

Syntax

void PDEExtGStateSetBPC(IN PDEExtGState extGS, IN ASAtom BPC);

Parameters

`extGS`	The extended graphics state object.
`BPC`	New value for BPC

Exceptions

genErrBadParm

PDEExtGStateSetBlendMode

Header: PEWProcs.h:1947

Description

Sets the blend mode for the color composites for each object painted.

The following mode names are valid:

Compatible
Normal
Multiply
Screen
Difference
Darken
Lighten
ColorDodge
ColorBurn
Exclusion
HardLight
Overlay
SoftLight
Luminosity
Hue
Saturation
Color

Syntax

void PDEExtGStateSetBlendMode(IN PDEExtGState pdeExtGState, IN ASAtom blendMode);

Parameters

`pdeExtGState`	IN/OUT The extended graphics state object.
`blendMode`	IN/OUT The new blend mode.

PDEExtGStateSetHalfToneOrigin

Header: PEWProcs.h:3748

Description

Sets HalfTone Co-ordinate point.

Related Methods

PDEExtGStateSetHalfToneOrigin

Syntax

void PDEExtGStateSetHalfToneOrigin(IN PDEExtGState extGS, IN ASRealPoint hto_point);

Parameters

`extGS`	The extended graphics state object.
	ASRealPoint * for x,y coordinate value of HalfToneOrigin.

Exceptions

genErrBadParm

PDEExtGStateSetOPFill

Header: PEWProcs.h:1871

Description

Specifies if overprint is enabled for painting operations other than stroking. It corresponds to the / op key within the ExtGState's dictionary.

Syntax

void PDEExtGStateSetOPFill(IN PDEExtGState pdeExtGState, IN ASBool overprint);

Parameters

`pdeExtGState`	IN/OUT The extended graphics state object.
`overprint`	IN/OUT Pass `true` to enable overprint, `false` to disable overprint.

PDEExtGStateSetOPM

Header: PEWProcs.h:1858

Description

Sets the overprint mode. It corresponds to the / OPM key within the ExtGState's dictionary.

Syntax

void PDEExtGStateSetOPM(IN PDEExtGState pdeExtGState, IN ASInt32 opm);

Parameters

`pdeExtGState`	IN/OUT The extended graphics state object.
`opm`	IN/OUT Overprint mode.

PDEExtGStateSetOPStroke

Header: PEWProcs.h:1884

Description

Specifies if overprint is enabled for stroke operations. It corresponds to the / OP key within the ExtGState's dictionary.

Syntax

void PDEExtGStateSetOPStroke(IN PDEExtGState pdeExtGState, IN ASBool overprint);

Parameters

`pdeExtGState`	IN/OUT The extended graphics state object.
`overprint`	IN/OUT Pass `true` to enable overprint, `false` to disable overprint.

PDEExtGStateSetOpacityFill

Header: PEWProcs.h:1899

Description

Sets the opacity value for painting operations other than stroking. The value must be in the range from 0 to 1 inclusive. It corresponds to the / ca key within the ExtGState's dictionary. The value from 0 to 1 refers to a float number (not an ASFixed value) that should be converted to ASFixed using FloatToASFixed().

Syntax

void PDEExtGStateSetOpacityFill(IN PDEExtGState pdeExtGState, IN ASFixed opacity);

Parameters

`pdeExtGState`	IN/OUT The extended graphics state object.
`opacity`	IN/OUT The new opacity value.

PDEExtGStateSetOpacityStroke

Header: PEWProcs.h:1914

Description

Sets the opacity value for stroke operations. The value must be in the range from 0 to 1 inclusive. It corresponds to the / CA key within the ExtGState's dictionary. The value from 0 to 1 refers to a float number (not an ASFixed value) that should be converted to ASFixed using FloatToASFixed().

Syntax

void PDEExtGStateSetOpacityStroke(IN PDEExtGState pdeExtGState, IN ASFixed opacity);

Parameters

`pdeExtGState`	IN/OUT The extended graphics state object.
`opacity`	IN/OUT The new opacity value.

PDEExtGStateSetSA

Header: PEWProcs.h:2245

Description

Specifies whether stroke adjustment is enabled in the graphics state.

Syntax

void PDEExtGStateSetSA(IN PDEExtGState pdeExtGState, IN ASBool strokeAdjust);

Parameters

`pdeExtGState`	IN/OUT The extended graphics state object.
`strokeAdjust`	IN/OUT Pass `true` to enable stroke adjustment, `false` to disable stroke adjustment.

Exceptions

peErrWrongPDEObjectType

PDEExtGStateSetSoftMask

Header: PEWProcs.h:1972

Description

Sets the soft mask of the extended graphics state.

Syntax

void PDEExtGStateSetSoftMask(IN PDEExtGState pdeExtGState, IN PDESoftMask pdeSoftMask);

Parameters

`pdeExtGState`	IN/OUT The extended graphics state object.
`pdeSoftMask`	IN/OUT The soft mask object.

PDEExtGStateSetSoftMaskMatrix

Header: PEWProcs.h:3875

Description

Sets the softmask matrix in ExtGstate.

Related Methods

PDEExtGStateGetSoftMaskMatrix

Syntax

void PDEExtGStateSetSoftMaskMatrix(IN PDEExtGState extGS, IN ASDoubleMatrixP matrixP);

Parameters

`extGS`	IN A ExtGstate object.
`matrixP`	IN A pointer to ASDoubleMatrix

PDEExtGStateSetTK

Header: PEWProcs.h:2071

Description

Specifies whether text knockout is enabled in the graphics state. This corresponds to the / TK key in the ExtGState's dictionary.

Syntax

void PDEExtGStateSetTK(IN PDEExtGState pdeExtGState, IN ASBool bk);

Parameters

`pdeExtGState`	IN/OUT The extended graphics state object.
`bk`	IN/OUT Pass `true` to enable text knockout, `false` to disable text knockout.