DL Logo

General Definitions

IN

Header: PEExpT.h

Syntax

#define IN

OUT

Header: PEExpT.h

Syntax

#define OUT

PEX1

Header: PEExpT.h:46

Syntax

#define PEX1 ACCB1

PEX1

Header: PEExpT.h:49

Syntax

#define PEX1 ACEX1

PEX2

Header: PEExpT.h:47

Syntax

#define PEX2 ACCB2

PEX2

Header: PEExpT.h:50

Syntax

#define PEX2 ACEX2

kPDEAfterLast

Header: PEExpT.h:1601

Syntax

#define kPDEAfterLast ( MAXInt32 - 1 )

kPDEBeforeFirst

Header: PEExpT.h:1600

Syntax

#define kPDEBeforeFirst (( ASInt32 ) - 1 )

kPDFStateSetAll

Header: PEExpT.h:699

Syntax

#define kPDFStateSetAll (( ASUns32 ) - 1 )

General Enumerations

PDCodePageOptions

Header: PEExpT.h:2365

Enum Constants

kPDCodePageWinEastEuropeanRoman=1250
kPDCodePageWinCyrillic=1251
kPDCodePageWinGreek=1253
kPDCodePageWinTurkish=1254
kPDCodePageWinHebrew=1255
kPDCodePageWinArabic=1256
kPDCodePageWinBaltic=1257
kPDCodePageMacCentralEuropean=-9994
kPDCodePageMacCroatian=-9993
kPDCodePageMacRomanian=-9992
kPDCodePageMacCyrillic=-9991
kPDCodePageMacUkrainian=-9990
kPDCodePageMacGreek=-9989
kPDCodePageMacTurkish=-9988
kPDCodePageMacHebrew=-9987
kPDCodePageMacArabic=-9986

PDEEnumElementsFlags

Header: PEExpT.h:1682

Description

A bit field for the PDEEnumElements() method.

Related Methods

Enum Constants

kPDEContentIgnoreMarkedContent=0x0001
Indicates whether Marked Content is ignored in the enumeration. This may be useful when generating elements purely for display purposes.
kPDEContentParsingAForm=2

PDEGraphicStateWasSetFlags

Header: PEExpT.h:622

Description

A structure describing the graphics state that was set.

Enum Constants

kPDEFillCSpaceWasSet=0x0001
A fill color space was set corresponding to the cs ( setcolorspace) operator.
kPDEFillCValueWasSet=0x0002
A color fill value was set corresponding to the sc ( setcolor) operator.
kPDEStrokeCSpaceWasSet=0x0004
A color space stroke value was set corresponding to the CS ( setcolorspace) operator.
kPDEStrokeCValueWasSet=0x0008
A color stroke value was set corresponding to the SC ( setcolor) operator.
kPDEDashWasSet=0x0010
A dash specification was set corresponding to the d ( setdash) operator.
kPDELineWidthWasSet=0x0020
The line width was set corresponding to the w ( setlinewidth) operator.
kPDEMiterLimitWasSet=0x0040
The miter limit was set corresponding to the M ( setmiterlimit) operator.
kPDEFlatnessWasSet=0x0080
Line flatness was set corresponding to the i ( setflat) operator.
kPDELineCapWasSet=0x0100
Line cap style was set corresponding to the J ( setlinecap) operator.
kPDELineJoinWasSet=0x0200
Line join style was set corresponding to the j ( setlinejoin) operator.
kPDERenderIntentWasSet=0x0400
A color rendering intent was set corresponding to the Intent key in the image dictionary.
kPDEExtGStateWasSet=0x0800
An extended graphics state was set corresponding to the gs operator.
kPDESoftMaskMatrixWasSet=0x1000
The soft mask matrix has been set
kPDEStateWasSetByPDEParse=0x01000000

PDEType

Header: PEExpT.h:1485

Description

The types of PDEObject, which is the superclass for PDEContent, PDEElement, PDEClip, and so on.

Related Methods

Enum Constants

kPDEContent
PDEContent object
kPDEText
PDEText object
kPDEPath
PDEPath object
kPDEImage
PDEImage object
kPDEForm
PDEForm object
kPDEPS
PDEPS object
kPDEXObject
PDEXObject object
kPDEClip
PDEClip object
kPDEFont
PDEFont object
kPDEColorSpace
kPDEExtGState
PDEExtGState object
kPDEPlace
PDEPlace object
kPDEContainer
PDEContainer object
kPDSysFont
PDSysFont object
kPDEPattern
PDEPattern object
kPDEDeviceNColors
kPDEShading
PDEShading object
kPDEGroup
PDEGroup object
kPDEUnknown
PDEUnknown object
kPDEBeginContainer
kPDEEndContainer
kPDEBeginGroup
kPDEEndGroup
PDEEndGroup object
kPDEXGroup
PDEXGroup object
kPDESoftMask
PDESoftMask object
kPDSysEncoding
kPDEDoc
PDEDoc object
kPDEPage
PDEPage object
kPDEReader
PDEReader object
kPDEWriter
PDEWriter object
kPDETextItem
PDETextItem object
kPDEImageFlate
kPDEImageJPX
PDEImageJPX object
kJPXColorSpace
kJPXPalette
JPXPalette object
kPDEGraphicFont
kPDELastType

General Typedefs

ASFloat

Header: PEExpT.h:63

Syntax

typedef float ASFloat;

Used By

Used In

PDEDoc

Header: PEExpT.h:403

Description

A reference to a PDEDoc.

Syntax

typedef struct _t_PDEDoc *PDEDoc;

PDEEmitStateP

Header: PEExpT.h:366

Description

A reference to the state of a writer.

Syntax

typedef struct _t_PDEEmitState *PDEEmitStateP;

PDEPage

Header: PEExpT.h:407

Description

A reference to a PDEPage.

Syntax

typedef struct _t_PDEPage *PDEPage;

PDEReader

Header: PEExpT.h:387

Description

An object used to read streams of PDEElement objects from page contents.

Syntax

typedef struct _t_PDEReader *PDEReader;

PDEState

Header: PEExpT.h:362

Description

A reference to the state of a reader.

Syntax

typedef struct _t_PDEState *PDEState;

PDEWriter

Header: PEExpT.h:391

Description

An object used to write streams of PDEElement objects to page content.

Syntax

typedef struct _t_PDEWriter *PDEWriter;

General Structures

_t_PDEColorSpec

Header: PEExpT.h:557

Description

A structure describing a color specification.

Syntax

struct _t_PDEColorSpec {
The specified PDEColorSpace.
The color value.
} PDEColorSpec, *PDEColorSpecP;

Used In

_t_PDEColorValue

Header: PEExpT.h:536

Description

A structure describing a color value.

Syntax

struct _t_PDEColorValue {
ASFixed color [7];
Color value components. For example, a Gray color space has one component, an RGB color space has three components, a CMYK has four components, and so on. Use color[0] for the Separation color space.
PDEObject colorObj2;
Used if the color space is DeviceN.
PDEObject colorObj;
Used for color spaces whose color values do not have numeric values, such as the Pattern color space.
} PDEColorValue, *PDEColorValueP;

Used By

Used In

_t_PDEDash

Header: PEExpT.h:576

Description

A structure describing a dash specification. See the description of the dash specification ("D") in the Graphics State Parameter Dictionaries in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 8.10, page 128.

You can find this document on the web store of the International Standards Organization (ISO).

For more information on dash patterns, see table 56, on page 127.

Syntax

struct _t_PDEDash {
ASFixed dashPhase;
The dash phase. The phase is a number that specifies a distance in user space into the dash pattern at which to begin marking the path.
ASInt32 dashLen;
The number of entries in the dash array, which is an element of the Border array.
ASFixed dashes [11];
The dash array, which specifies distances in user space for the lengths of dashes and gaps.
} PDEDash, *PDEDashP;

Used In

_t_PDEDashEx

Header: PEExpT.h:602

Description

A structure describing a dash specification. See the description of the dash specification ("D") in the Graphics State Parameter Dictionaries in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 8.10, page 128.

You can find this document on the web store of the International Standards Organization (ISO).

For more information on dash patterns, see table 56, on page 127.

Syntax

struct _t_PDEDashEx {
ASDouble dashPhase;
The dash phase. The phase is a number that specifies a distance in user space into the dash pattern at which to begin marking the path.
ASInt32 dashLen;
The number of entries in the dash array, which is an element of the Border array.
ASDouble dashes [11];
The dash array, which specifies distances in user space for the lengths of dashes and gaps.
} PDEDashEx, *PDEDashExP;

Used In

_t_PDEFilterArray

Header: PEExpT.h:990

Description

Filter information for streams.

Although the PDEFilterSpec is declared as a one member array in the header file, more members can be added by dynamically allocating the PDEFilterArray with space for as many filters as you would like to add. In practice, there is seldom need for more than two filters.

Syntax

struct _t_PDEFilterArray {
ASInt32 numFilters;
The number of filters in the array.
PDEFilterSpec spec [1];
A variable length array of filter specifications.
} PDEFilterArray, *PDEFilterArrayP;

Used By

_t_PDEFilterSpec

Header: PEExpT.h:938

Description

The filter element in a filter array.

Syntax

struct _t_PDEFilterSpec {
CosObj decodeParms;

Parameters used by the decoding filters specified with the Filter key. It corresponds to the DecodeParms key in the stream dictionary.

It must be set to NULL if PDEFilterSpec is specified but no encode or decode parameters are specified. This can be done by passing CosNewNull for the unused encode and/or decode parameters.

The required decode parameters for DCTDecode are Columns, Rows, and Colors. The parameters should be passed in a CosDict.

CosObj encodeParms;

Parameters used when encoding the stream. It is required for the DCTDecode filter, but is optional for other filters.

It must be set to NULL if PDEFilterSpec is specified but no encode or decode parameters are specified. This can be done by passing CosNewNull for the unused encode and/or decode parameters.

ASAtom name;
    The filter name. The supported filters are:
  • ASCIIHexDecode
  • ASCII85Decode
  • LZWDecode
  • DCTDecode
  • CCITTFaxDecode
  • RunLengthDecode
  • FlateDecode
ASInt16 padding;
Reserved- used to align to 32 bits.
} PDEFilterSpec, *PDEFilterSpecP;

Used In

_t_PDEGlyphDescription

Header: PEExpT.h:1402

Description

A data structure used for adding Unicode text.

Related Methods

Syntax

struct _t_PDEGlyphDescription {
ASUns32 glyphID;
The GlyphID of a glyph being added.
ASInt16 *charIndices;
An array of indices to Unicode characters, from the uniText member of the PDEGlyphRun struct, represented by this glyph.
ASInt32 charIndicesLen;
The count of the indices in the charIndices array.
ASReal xPosition;
The x position of where to place this glyph.
ASReal yPosition;
The y position of where to place this glyph.
} PDEGlyphDescription, *PDEGlyphDescriptionP;

Used In

_t_PDEGlyphRun

Header: PEExpT.h:1426

Description

A data structure used for adding Unicode text.

Syntax

struct _t_PDEGlyphRun {
A pointer to the array of PDEGlyphDescription items.
ASInt32 glyphLen;
The count of items in the PDEGlyphDescription array.
ASUTF32Val *uniText;
An array of Unicode characters in UTF32HE format.
ASInt32 uniTextLen;
The count of characters in uniText array.
} PDEGlyphRun, *PDEGlyphRunP;

Used By

_t_PDEGraphicState

Header: PEExpT.h:706

Description

Attributes of a PDEElement or a PDEText sub-element.

Syntax

struct _t_PDEGraphicState {
ASUns32 wasSetFlags;
PDEGraphicStateWasSetFlags indicating if an attribute has been set.
PDEColorSpec fillColorSpec;
The fill color specification. The default value is DeviceGray, fixedZero.
PDEColorSpec strokeColorSpec;
The stroke color specification. The default value is DeviceGray, fixedZero.
PDEDash dash;
The dash specification. The default value is [0, 0].
ASFixed lineWidth;
The line width corresponding to the w ( setlinewidth) operator. The default value is fixedOne.
ASFixed miterLimit;
The miter limit corresponding to the M ( setmiterlimit) operator. The default value is fixedTen.
ASFixed flatness;
The line flatness corresponding to the i ( setflat) operator. The default value is fixedZero.
ASInt32 lineCap;
The line cap style corresponding to the J ( setlinecap) operator. The default value is 0.
ASInt32 lineJoin;
Line join style corresponding to the j ( setlinejoin) operator. The default value is 0.
ASAtom renderIntent;
A color rendering intent corresponding to the Intent key in the image dictionary. The default value is RelativeColorimetric.
PDEExtGState extGState;
An extended graphics flag corresponding to the gs operator. The default value is CosObj, NULL.
ASFixedMatrix softMaskMatrix;
The CTM at the time soft mask was established. The default value is identity matrix.
} PDEGraphicState, *PDEGraphicStateP;

Used By

_t_PDEGraphicStateEx

Header: PEExpT.h:777

Description

Attributes of a PDEElement or a PDEText sub-element.

Related Methods

Syntax

struct _t_PDEGraphicStateEx {
ASUns32 wasSetFlags;
PDEGraphicStateWasSetFlags indicating if an attribute has been set.
PDEColorSpec fillColorSpec;
The fill color specification. The default value is DeviceGray, fixedZero.
PDEColorSpec strokeColorSpec;
The stroke color specification. The default value is DeviceGray, fixedZero.
PDEDashEx dash;
The dash specification. The default value is [0, 0].
ASDouble lineWidth;
The line width corresponding to the w ( setlinewidth) operator. The default value is 1.
ASDouble miterLimit;
The miter limit corresponding to the M ( setmiterlimit) operator. The default value is 10.
ASDouble flatness;
The line flatness corresponding to the i ( setflat) operator. The default value is 0.
ASInt32 lineCap;
The line cap style corresponding to the J ( setlinecap) operator. The default value is 0.
ASInt32 lineJoin;
Line join style corresponding to the j ( setlinejoin) operator. The default value is 0.
ASAtom renderIntent;
A color rendering intent corresponding to the Intent key in the image dictionary. The default value is RelativeColorimetric.
PDEExtGState extGState;
An extended graphics flag corresponding to the gs operator. The default value is CosObj, NULL.
ASDoubleMatrix softMaskMatrix;
The CTM at the time soft mask was established. The default value is identity matrix.
} PDEGraphicStateEx, *PDEGraphicStateExP;

Used By

General Functions

PDEDefaultGState

Header: PERProcs.h:1480

Description

Fills out a PDEGraphicStateP structure with the default graphic state.

Note: Non-NULL objects in the graphic state, such as the fill and stroke color spaces, have their reference counts incremented by this method. Be sure to release these non- NULL objects when disposing of stateP.

Syntax

void PDEDefaultGState(OUT PDEGraphicStateP stateP, IN ASInt32 stateSize);

Parameters

stateP
(Filled by the method) A pointer to a PDEGraphicState structure with the default graphic state.
stateSize
The size of the stateP structure in bytes.

PDEDefaultGStateEx

Header: PERProcs.h:3356

Description

Fills out a PDEGraphicStateEx structure which is higher precision alternative of PDEGraphicState structure with the default graphic state.

Note: Non-NULL objects in the graphic state, such as the fill and stroke color spaces, have their reference counts incremented by this method. Be sure to release these non- NULL objects when disposing of stateP.

Syntax

void PDEDefaultGStateEx(OUT PDEGraphicStateExP stateP, IN ASInt32 stateSize);

Parameters

stateP
(Filled by the method) A pointer to a PDEGraphicStateEx structure with the default graphic state.
stateSize
The size of the stateP structure in bytes.

PDEMergeResourcesDict

Header: PEWProcs.h:1084

Description

Merges two Resources dictionaries in the same CosDoc; you cannot merge two resource dictionaries from different CosDocs.

Both dictionaries and what they reference must be in cosDoc. The objects referenced by newResP are appended to resDictP.

This method only operates on the Cos dictionaries. It assumes there are no resource name conflicts.

This method was useful for adding form resources to page resource dictionaries, but that is no longer necessary.

Note: Since PDFEdit resolves resource names across PDEContent objects, this routine is safe for using with PDFEdit methods. This method may be unsafe if you modify streams and dictionaries outside of the PDFEdit API.

Syntax

void PDEMergeResourcesDict(OUT CosObj *resDictP, IN CosDoc cosDoc, IN const CosObj *newResP);

Parameters

resDictP
IN/OUT (Filled by the method) The dictionary to which newResP is merged. When the method completes, resDictP is the merged dictionary result.
cosDoc
IN/OUT The CosDoc containing both dictionaries.
newResP
IN/OUT The dictionary to merge with resDictP.

Exceptions

PDEPurgeCache

Header: PEWProcs.h:1325

Description

Clears the PDE Cache of this PDDoc. This method is only of interest to clients.

Note: It is not recommended that you call this method directly; it is provided only for backwards compatibility.

Syntax

void PDEPurgeCache(IN PDDoc doc);

Parameters

doc
A PDDoc whose cache is purged.

PDEScratchDocCleanup

Header: PEWProcs.h:3115

Description

Removes unused objects from the PDFEdit scratch document, which is used to hold representations of PDFEdit resources associated with a specific document.

Syntax

void PDEScratchDocCleanup(void);