LayerPDFEdit_Layer
ObjectGeneral

These utility methods simplify tasks, such as setting up graphics information structures and merging resources for a page.



Define Summary
 Define
 IN
 include
 kPDEAfterLast
 kPDEBeforeFirst
 kPDFStateSetAll
 OUT
 _PDFEditReadHFT_IS_BETA
 _PDFEditReadHFT_LAST_BETA_COMPATIBLE_VERSION
 _PDFEditReadHFT_LATEST_VERSION
 PDFEditReadHFT_LATEST_VERSION
 PDFEditReadHFTName
 PDFEditReadHFT_VERSION_10
 PDFEditReadHFT_VERSION_11
 PDFEditReadHFT_VERSION_12
 PDFEditReadHFT_VERSION_13
 PDFEditReadHFT_VERSION_14
 PDFEditReadHFT_VERSION_15
 PDFEditReadHFT_VERSION_4
 PDFEditReadHFT_VERSION_5
 PDFEditReadHFT_VERSION_6
 PDFEditReadHFT_VERSION_8_1
 PDFEditReadHFT_VERSION_9
 _PDFEditWriteHFT_IS_BETA
 _PDFEditWriteHFT_LAST_BETA_COMPATIBLE_VERSION
 _PDFEditWriteHFT_LATEST_VERSION
 PDFEditWriteHFT_LATEST_VERSION
 PDFEditWriteHFTName
 PDFEditWriteHFT_VERSION_10
 PDFEditWriteHFT_VERSION_11
 PDFEditWriteHFT_VERSION_12
 PDFEditWriteHFT_VERSION_13
 PDFEditWriteHFT_VERSION_14
 PDFEditWriteHFT_VERSION_4
 PDFEditWriteHFT_VERSION_5
 PDFEditWriteHFT_VERSION_6
 PDFEditWriteHFT_VERSION_7
 PDFEditWriteHFT_VERSION_7_5
 PDFEditWriteHFT_VERSION_8
 PDFEditWriteHFT_VERSION_9
 PEX1
 PEX2
Typedef Summary
 Typedef
 PDEBlackPointFlt
A structure describing a black point in a calibrated color space.
 PDEColorSpec
 PDEColorSpecP
 PDEColorValue
 PDEColorValueP
 PDEDash
 PDEDashEx
 PDEDashExP
 PDEDashP
 PDEDeviceNColorData
 PDEDoc
A reference to a PDEDoc.
 PDEEmitStateP
A reference to the state of a writer.
 PDEFilterArray
 PDEFilterArrayP
 PDEFilterSpec
 PDEFilterSpecP
 PDEGlyphDescription
 PDEGlyphDescriptionP
 PDEGlyphRun
 PDEGlyphRunP
 PDEGraphicState
 PDEGraphicStateEx
 PDEGraphicStateExP
 PDEGraphicStateP
 PDEGrayCalFlt
 PDEICCBasedColorData
 PDEIndexedColorData
 PDELabCalFlt
 PDEPage
A reference to a PDEPage.
 PDEReader
An object used to read streams of PDEElement objects from page contents.
 PDERGBCalFlt
 PDESeparationColorData
 PDESpanItem
 PDESpanItemP
 PDESpanSet
 PDESpanSetP
 PDEState
A reference to the state of a reader.
 PDEWhitePointFlt
A structure describing a white point in a calibrated color space.
 PDEWriter
An object used to write streams of PDEElement objects to page content.
Enumeration Summary
 Enumeration
  PDEEnumElementsFlags
A bit field for the PDEEnumElements() method.
  PDEGraphicStateWasSetFlags
A structure describing the graphics state that was set.
  PDEType
The types of PDEObject, which is the superclass for PDEContent, PDEElement, PDEClip, and so on.
Structure Summary
 Structure
 _t_PDEColorSpec
A structure describing a color specification.
 _t_PDEColorValue
A structure describing a color value.
 _t_PDEDash
A structure describing a dash specification, as described in Table 4.8 in the PDF Reference. See Section 4.3.2 for more information on line dash patterns.
 _t_PDEDashEx
A structure describing a dash specification, as described in Table 4.8 in the PDF Reference. See Section 4.3.2 for more information on line dash patterns.
 _t_PDEDeviceNColorData
A structure describing a DeviceRGB or DeviceCMYK color space.
 _t_PDEFilterArray
Filter information for streams.
 _t_PDEFilterSpec
The filter element in a filter array.
 _t_PDEGlyphDescription
A data structure used for adding Unicode text.
 _t_PDEGlyphRun
A data structure used for adding Unicode text.
 _t_PDEGraphicState
Attributes of a PDEElement or a PDEText sub-element.
 _t_PDEGraphicStateEx
Attributes of a PDEElement or a PDEText sub-element.
 _t_PDEGrayCalFlt
A structure describing a CalGray color space.
 _t_PDEICCBasedColorData
An ICC-based color space.
 _t_PDEIndexedColorData
A structure describing an indexed color space.
 _t_PDELabCalFlt
A structure describing a Lab color space.
 _t_PDERGBCalFlt
A structure describing a CalRGB color space. It is the same as AGMRGBCalFlt (it is only available as part of the PDF Library SDK).
 _t_PDESeparationColorData
A structure describing a separation color space.
 _t_PDESpanItem
 _t_PDESpanSet
 PDEColorRangeFlt
 PDEXYZColorFlt
Callback Summary
 Callback
 PDEAttrEnumProc
A callback for PDEAttrEnumTable(). It is called once for each attribute in a table.
Method Summary
 Method
 
void PDEDefaultGState(OUTPDEGraphicStateP stateP, INASInt32 stateSize)
Fills out a PDEGraphicStateP structure with the default graphic state.
 
void PDEDefaultGStateEx(OUTPDEGraphicStateExP stateP, INASInt32 stateSize)
Fills out a PDEGraphicStateEx structure which is higher precision alternative of PDEGraphicState structure with the default graphic state.
 
void PDEEnumElements(const CosObj* contents, const CosObj* resources, INASUns32 flags, INPDEElementEnumProc enumProc, IN void* enumProcClientData)
Enumerates all the PDEElements in a given stream. It is similar to PDEContentCreateFromCosObj(), but provides enumeration instead of a list of elements.
 
void PDEMergeResourcesDict(OUTCosObj* resDictP, INCosDoc cosDoc, const CosObj* newResP)
Merges two Resources dictionaries in the same CosDoc; you cannot merge two resource dictionaries from different CosDocs.
 
void PDEPurgeCache(INPDDoc doc)
Clears the PDE Cache of this PDDoc. This method is only of interest to clients.
 
Removes unused objects from the PDFEdit scratch document, which is used to hold representations of PDFEdit resources associated with a specific document.
Defines Detail
_PDFEditReadHFT_IS_BETA 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _PDFEditReadHFT_IS_BETA 0

File: PERCalls.h
Line: 91
_PDFEditReadHFT_LAST_BETA_COMPATIBLE_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _PDFEditReadHFT_LAST_BETA_COMPATIBLE_VERSION 0x000F0000

File: PERCalls.h
Line: 90
_PDFEditReadHFT_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _PDFEditReadHFT_LATEST_VERSION 0x000F0000

File: PERCalls.h
Line: 89
_PDFEditWriteHFT_IS_BETA 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _PDFEditWriteHFT_IS_BETA 0

File: PEWCalls.h
Line: 91
_PDFEditWriteHFT_LAST_BETA_COMPATIBLE_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _PDFEditWriteHFT_LAST_BETA_COMPATIBLE_VERSION 0x000E0000

File: PEWCalls.h
Line: 90
_PDFEditWriteHFT_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _PDFEditWriteHFT_LATEST_VERSION 0x000E0000

File: PEWCalls.h
Line: 89
IN 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define IN

File: PEExpT.h
Line: 69
include 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define include h"

File: PEWCalls.h
Line: 133
kPDEAfterLast 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDEAfterLast (MAXInt32 - 1)

Examples

go to source arrow PDEContentAddElem(pdeContent, kPDEAfterLast, (PDEElement) pdeText);
go to source arrow PDEContentAddElem(pdeContent, kPDEAfterLast, (PDEElement) pdeText);
go to source arrow PDEContentAddElem(pdeContent, kPDEAfterLast, (PDEElement)pdeImage);

more...

File: PEExpT.h
Line: 1535
kPDEBeforeFirst 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDEBeforeFirst ((ASInt32) -1)

Examples

more...

File: PEExpT.h
Line: 1534
kPDFStateSetAll 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDFStateSetAll ((ASUns32) -1)

File: PEExpT.h
Line: 652
OUT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define OUT

File: PEExpT.h
Line: 70
PDFEditReadHFT_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_LATEST_VERSION _PDFEditReadHFT_LATEST_VERSION)

File: PERCalls.h
Line: 94
PDFEditReadHFT_VERSION_10 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_10 0x000A0000

File: PERCalls.h
Line: 101
PDFEditReadHFT_VERSION_11 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_11 0x000B0000

File: PERCalls.h
Line: 102
PDFEditReadHFT_VERSION_12 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_12 0x000C0000

File: PERCalls.h
Line: 103
PDFEditReadHFT_VERSION_13 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_13 0x000D0000

File: PERCalls.h
Line: 104
PDFEditReadHFT_VERSION_14 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_14 0x000E0000

File: PERCalls.h
Line: 105
PDFEditReadHFT_VERSION_15 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_15 PDFEditReadHFT_LATEST_VERSION

File: PERCalls.h
Line: 106
PDFEditReadHFT_VERSION_4 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_4 0x00040000

File: PERCalls.h
Line: 96
PDFEditReadHFT_VERSION_5 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_5 0x00050000

File: PERCalls.h
Line: 97
PDFEditReadHFT_VERSION_6 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_6 0x00060000

File: PERCalls.h
Line: 98
PDFEditReadHFT_VERSION_8_1 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_8_1 0x00080001

File: PERCalls.h
Line: 99
PDFEditReadHFT_VERSION_9 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFT_VERSION_9 0x00090000

File: PERCalls.h
Line: 100
PDFEditReadHFTName 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadHFTName "PDFEditRead"

File: PEVers.h
Line: 24
PDFEditWriteHFT_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_LATEST_VERSION _PDFEditWriteHFT_LATEST_VERSION)

File: PEWCalls.h
Line: 94
PDFEditWriteHFT_VERSION_10 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_10 0x000A0000

File: PEWCalls.h
Line: 103
PDFEditWriteHFT_VERSION_11 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_11 0x000B0000

File: PEWCalls.h
Line: 104
PDFEditWriteHFT_VERSION_12 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_12 0x000C0000

File: PEWCalls.h
Line: 105
PDFEditWriteHFT_VERSION_13 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_13 0x000D0000

File: PEWCalls.h
Line: 106
PDFEditWriteHFT_VERSION_14 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_14 PDFEditWriteHFT_LATEST_VERSION

File: PEWCalls.h
Line: 107
PDFEditWriteHFT_VERSION_4 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_4 0x00040000

File: PEWCalls.h
Line: 96
PDFEditWriteHFT_VERSION_5 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_5 0x00050000

File: PEWCalls.h
Line: 97
PDFEditWriteHFT_VERSION_6 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_6 0x00060000

File: PEWCalls.h
Line: 98
PDFEditWriteHFT_VERSION_7 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_7 0x00070000

File: PEWCalls.h
Line: 99
PDFEditWriteHFT_VERSION_7_5 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_7_5 0x00070005

File: PEWCalls.h
Line: 100
PDFEditWriteHFT_VERSION_8 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_8 0x00080000

File: PEWCalls.h
Line: 101
PDFEditWriteHFT_VERSION_9 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFT_VERSION_9 0x00090000

File: PEWCalls.h
Line: 102
PDFEditWriteHFTName 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditWriteHFTName "PDFEditWrite"

File: PEVers.h
Line: 26
PEX1 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PEX1 ACEX1

File: PEExpT.h
Line: 49
PEX2 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PEX2 ACEX2

File: PEExpT.h
Line: 50

Typedefs Detail
PDEBlackPointFlt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDEXYZColorFlt PDEBlackPointFlt;

A structure describing a black point in a calibrated color space.

See Also


File: PEExpT.h
Line: 2072
PDEColorSpec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEColorSpec PDEColorSpec;

File: PEExpT.h
Line: 532
PDEColorSpecP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEColorSpec PDEColorSpecP;

File: PEExpT.h
Line: 532
PDEColorValue 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEColorValue PDEColorValue;

File: PEExpT.h
Line: 518
PDEColorValueP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEColorValue PDEColorValueP;

File: PEExpT.h
Line: 518
PDEDash 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEDash PDEDash;

File: PEExpT.h
Line: 555
PDEDashEx 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEDashEx PDEDashEx;

File: PEExpT.h
Line: 577
PDEDashExP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEDashEx PDEDashExP;

File: PEExpT.h
Line: 577
PDEDashP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEDash PDEDashP;

File: PEExpT.h
Line: 555
PDEDeviceNColorData 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEDeviceNColorData PDEDeviceNColorData;

File: PEExpT.h
Line: 2244
PDEDoc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDEDoc* PDEDoc;

A reference to a PDEDoc.


File: PEExpT.h
Line: 415
PDEEmitStateP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDEEmitState* PDEEmitStateP;

A reference to the state of a writer.


File: PEExpT.h
Line: 372
PDEFilterArray 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEFilterArray PDEFilterArray;

File: PEExpT.h
Line: 943
PDEFilterArrayP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEFilterArray PDEFilterArrayP;

File: PEExpT.h
Line: 943
PDEFilterSpec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEFilterSpec PDEFilterSpec;

File: PEExpT.h
Line: 923
PDEFilterSpecP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEFilterSpec PDEFilterSpecP;

File: PEExpT.h
Line: 923
PDEGlyphDescription 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEGlyphDescription PDEGlyphDescription;

File: PEExpT.h
Line: 1337
PDEGlyphDescriptionP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEGlyphDescription PDEGlyphDescriptionP;

File: PEExpT.h
Line: 1337
PDEGlyphRun 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEGlyphRun PDEGlyphRun;

File: PEExpT.h
Line: 1356
PDEGlyphRunP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEGlyphRun PDEGlyphRunP;

File: PEExpT.h
Line: 1356
PDEGraphicState 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEGraphicState PDEGraphicState;

File: PEExpT.h
Line: 724
PDEGraphicStateEx 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEGraphicStateEx PDEGraphicStateEx;

File: PEExpT.h
Line: 795
PDEGraphicStateExP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEGraphicStateEx PDEGraphicStateExP;

File: PEExpT.h
Line: 795
PDEGraphicStateP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEGraphicState PDEGraphicStateP;

File: PEExpT.h
Line: 724
PDEGrayCalFlt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEGrayCalFlt PDEGrayCalFlt;

File: PEExpT.h
Line: 2092
PDEICCBasedColorData 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEICCBasedColorData PDEICCBasedColorData;

File: PEExpT.h
Line: 2169
PDEIndexedColorData 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDEIndexedColorData PDEIndexedColorData;

File: PEExpT.h
Line: 2192
PDELabCalFlt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDELabCalFlt PDELabCalFlt;

File: PEExpT.h
Line: 2142
PDEPage 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDEPage* PDEPage;

A reference to a PDEPage.


File: PEExpT.h
Line: 420
PDEReader 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDEReader* PDEReader;

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


File: PEExpT.h
Line: 396
PDERGBCalFlt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDERGBCalFlt PDERGBCalFlt;

File: PEExpT.h
Line: 2122
PDESeparationColorData 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDESeparationColorData PDESeparationColorData;

File: PEExpT.h
Line: 2216
PDESpanItem 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDESpanItem PDESpanItem;

File: PEExpT.h
Line: 1381
PDESpanItemP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDESpanItem PDESpanItemP;

File: PEExpT.h
Line: 1381
PDESpanSet 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDESpanSet PDESpanSet;

File: PEExpT.h
Line: 1392
PDESpanSetP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDESpanSet PDESpanSetP;

File: PEExpT.h
Line: 1392
PDEState 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDEState* PDEState;

A reference to the state of a reader.


File: PEExpT.h
Line: 367
PDEWhitePointFlt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDEXYZColorFlt PDEWhitePointFlt;

A structure describing a white point in a calibrated color space.

See Also


File: PEExpT.h
Line: 2066
PDEWriter 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDEWriter* PDEWriter;

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


File: PEExpT.h
Line: 401

Enumeration Detail
PDEEnumElementsFlags
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDEEnumElementsFlags {
 kPDEContentIgnoreMarkedContent = 0x0001
}

See Also


File: PEExpT.h
Line: 1607

Elements
kPDEContentIgnoreMarkedContent  

Indicates whether Marked Content is ignored in the enumeration. This may be useful when generating elements purely for display purposes.

PDEGraphicStateWasSetFlags 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDEGraphicStateWasSetFlags {
 kPDEFillCSpaceWasSet = 0x0001,
 
 kPDEFillCValueWasSet = 0x0002,
 
 kPDEStrokeCSpaceWasSet = 0x0004,
 
 kPDEStrokeCValueWasSet = 0x0008,
 
 kPDEDashWasSet = 0x0010,
 
 kPDELineWidthWasSet = 0x0020,
 
 kPDEMiterLimitWasSet = 0x0040,
 
 kPDEFlatnessWasSet = 0x0080,
 
 kPDELineCapWasSet = 0x0100,
 
 kPDELineJoinWasSet = 0x0200,
 
 kPDERenderIntentWasSet = 0x0400,
 
 kPDEExtGStateWasSet = 0x0800,
 
 kPDESoftMaskMatrixWasSet = 0x1000
}

See Also


File: PEExpT.h
Line: 583

Elements
kPDEFillCSpaceWasSet  

A fill color space was set corresponding to the cs (setcolorspace) operator.

 
kPDEFillCValueWasSet  

A color fill value was set corresponding to the sc (setcolor) operator.

 
kPDEStrokeCSpaceWasSet  

A color space stroke value was set corresponding to the CS (setcolorspace) operator.

 
kPDEStrokeCValueWasSet  

A color stroke value was set corresponding to the SC (setcolor) operator.

 
kPDEDashWasSet  

A dash specification was set corresponding to the d (setdash) operator.

 
kPDELineWidthWasSet  

The line width was set corresponding to the w (setlinewidth) operator.

 
kPDEMiterLimitWasSet  

The miter limit was set corresponding to the M (setmiterlimit) operator.

 
kPDEFlatnessWasSet  

Line flatness was set corresponding to the i (setflat) operator.

 
kPDELineCapWasSet  

Line cap style was set corresponding to the J (setlinecap) operator.

 
kPDELineJoinWasSet  

Line join style was set corresponding to the j (setlinejoin) operator.

 
kPDERenderIntentWasSet  

A color rendering intent was set corresponding to the Intent key in the image dictionary.

 
kPDEExtGStateWasSet  

An extended graphics state was set corresponding to the gs operator.

 
kPDESoftMaskMatrixWasSet  

The soft mask matrix has been set

PDEType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDEType {
 kPDEContent,
 
 kPDEText,
 
 kPDEPath,
 
 kPDEImage,
 
 kPDEForm,
 
 kPDEPS,
 
 kPDEXObject,
 
 kPDEClip,
 
 kPDEFont,
 
 kPDEColorSpace,
 
 kPDEExtGState,
 
 kPDEPlace,
 
 kPDEContainer,
 
 kPDSysFont,
 
 kPDEPattern,
 
 kPDEDeviceNColors,
 
 kPDEShading,
 
 kPDEGroup,
 
 kPDEUnknown,
 
 kPDEBeginContainer,
 
 kPDEEndContainer,
 
 kPDEBeginGroup,
 
 kPDEEndGroup,
 
 kPDEXGroup,
 
 kPDESoftMask,
 
 kPDSysEncoding,
 
 kPDEDoc,
 
 kPDEPage,
 
 kPDEReader,
 
 kPDEWriter,
 
 kPDETextItem,
 
 kPDEImageFlate,
 
 kPDEImageJPX,
 
 kJPXColorSpace,
 
 kJPXPalette,
 
 kPDELastType
}

See Also


File: PEExpT.h
Line: 1403

Elements
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  

PDEColorSpace object

 
kPDEExtGState  

PDEExtGState object

 
kPDEPlace  

PDEPlace object

 
kPDEContainer  

PDEContainer object

 
kPDSysFont  

PDESysFont object

 
kPDEPattern  

PDEPattern object

 
kPDEDeviceNColors  

PDEDevineNColors object

 
kPDEShading  

PDEShading object

 
kPDEGroup  

PDEGroup object

 
kPDEUnknown  

PDEUnknown object

 
kPDEBeginContainer  

PDEBeginContainer object

 
kPDEEndContainer  

PDEEndContainer object

 
kPDEBeginGroup  

PDEBeginGroup object

 
kPDEEndGroup  

PDEEndGroup object

 
kPDEXGroup  

PDEXGroup object

 
kPDESoftMask  

PDESoftMask object

 
kPDSysEncoding  

PDSysEcoding object

 
kPDEDoc  

PDEDoc object

 
kPDEPage  

PDEPage object

 
kPDEReader  

PDEReader object

 
kPDEWriter  

PDEWriter object

 
kPDETextItem  

PDETextItem object

 
kPDEImageFlate  

PDEImageFlate object

 
kPDEImageJPX  

PDEImageJPX object

 
kJPXColorSpace  

JPXColorSpace object

 
kJPXPalette  

JPXPalette object

 

Structure Detail
_t_PDEColorSpec
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEColorSpec {
 PDEColorSpace space; 
 
 PDEColorValue value; 
}

A structure describing a color specification.


File: PEExpT.h
Line: 525

Elements
space  

The specified PDEColorSpace.

 
value  

The color value.

_t_PDEColorValue 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEColorValue {
 ASFixed color[7]; 
 
 PDEObject colorObj2; 
 
 PDEObject colorObj; 
}

A structure describing a color value.


File: PEExpT.h
Line: 503

Elements
color  

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.

 
colorObj2  

Used if the color space is DeviceN.

 
colorObj  

Used for color spaces whose color values do not have numeric values, such as the Pattern color space.

_t_PDEDash 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEDash {
 ASFixed dashPhase; 
 
 ASInt32 dashLen; 
 
 ASFixed dashes[11]; 
}

A structure describing a dash specification, as described in Table 4.8 in the PDF Reference. See Section 4.3.2 for more information on line dash patterns.


File: PEExpT.h
Line: 541

Elements
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.

 
dashLen  

The number of entries in the dash array, which is an element of the Border array.

 
dashes  

The dash array, which specifies distances in user space for the lengths of dashes and gaps.

_t_PDEDashEx 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEDashEx {
 ASDouble dashPhase; 
 
 ASInt32 dashLen; 
 
 ASDouble dashes[11]; 
}

A structure describing a dash specification, as described in Table 4.8 in the PDF Reference. See Section 4.3.2 for more information on line dash patterns.


File: PEExpT.h
Line: 563

Elements
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.

 
dashLen  

The number of entries in the dash array, which is an element of the Border array.

 
dashes  

The dash array, which specifies distances in user space for the lengths of dashes and gaps.

_t_PDEDeviceNColorData 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEDeviceNColorData {
 ASSize_t size; 
 
 ASAtom names; 
 
 ASUns32 nNames; 
 
 PDEColorSpace alt; 
 
 CosObj tintTransform; 
}

A structure describing a DeviceRGB or DeviceCMYK color space.

See Also


File: PEExpT.h
Line: 2224

Elements
size  

The size of the data structure. It must be set to sizeof(PDEDeviceNColorData).

 
names  

The names of the colorants.

 
nNames  

The number of colorants.

 
alt  

The alternate color space.

 
tintTransform  

The tintTransform dictionary or function. See Section 4.5.5 in the PDF Reference for more information.

_t_PDEFilterArray 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEFilterArray {
 ASInt32 numFilters; 
 
 PDEFilterSpec spec[1]; 
}

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.

See Also


File: PEExpT.h
Line: 936

Elements
numFilters  

The number of filters in the array.

 
spec  

A variable length array of filter specifications.

_t_PDEFilterSpec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEFilterSpec {
 CosObj decodeParms; 
 
 CosObj encodeParms; 
 
 ASAtom name; 
 
 ASInt16 padding; 
}

The filter element in a filter array.

See Also


File: PEExpT.h
Line: 883

Elements
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.

 
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.

 
name  

The filter name. The supported filters are:

  • ASCIIHexDecode

  • ASCII85Decode

  • LZWDecode

  • DCTDecode

  • CCITTFaxDecode

  • RunLengthDecode

  • FlateDecode

 
padding  

Reserved - used to align to 32 bits.

_t_PDEGlyphDescription 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEGlyphDescription {
 ASUns32 glyphID; 
 
 ASInt16 charIndices; 
 
 ASInt32 charIndicesLen; 
 
 ASReal xPosition; 
 
 ASReal yPosition; 
}

A data structure used for adding Unicode text.

See Also


File: PEExpT.h
Line: 1319

Elements
glyphID  

The GlyphID of a glyph being added.

 
charIndices  

An array of indices to Unicode characters, from the uniText member of the PDEGlyphRun struct, represented by this glyph.

 
charIndicesLen  

The count of the indices in the charIndices array.

 
xPosition  

The x position of where to place this glyph.

 
yPosition  

The y position of where to place this glyph.

_t_PDEGlyphRun 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEGlyphRun {
 PDEGlyphDescriptionP glyphs; 
 
 ASInt32 glyphLen; 
 
 ASUTF32Val uniText; 
 
 ASInt32 uniTextLen; 
}

A data structure used for adding Unicode text.

See Also


File: PEExpT.h
Line: 1343

Elements
glyphs  

A pointer to the array of PDEGlyphDescription items.

 
glyphLen  

The count of items in the PDEGlyphDescription array.

 
uniText  

An array of Unicode characters in UTF32HE format.

 
uniTextLen  

The count of characters in uniText array.

_t_PDEGraphicState 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEGraphicState {
 ASUns32 wasSetFlags; 
 
 PDEColorSpec fillColorSpec; 
 
 PDEColorSpec strokeColorSpec; 
 
 PDEDash dash; 
 
 ASFixed lineWidth; 
 
 ASFixed miterLimit; 
 
 ASFixed flatness; 
 
 ASInt32 lineCap; 
 
 ASInt32 lineJoin; 
 
 ASAtom renderIntent; 
 
 PDEExtGState extGState; 
 
 ASFixedMatrix softMaskMatrix; 
}

Attributes of a PDEElement or a PDEText sub-element.

See Also


File: PEExpT.h
Line: 660

Elements
wasSetFlags  

PDEGraphicStateWasSetFlags indicating if an attribute has been set.

 
fillColorSpec  

The fill color specification. The default value is DeviceGray, fixedZero.

 
strokeColorSpec  

The stroke color specification. The default value is DeviceGray, fixedZero.

 
dash  

The dash specification. The default value is [0, 0].

 
lineWidth  

The line width corresponding to the w (setlinewidth) operator. The default value is fixedOne.

 
miterLimit  

The miter limit corresponding to the M (setmiterlimit) operator. The default value is fixedTen.

 
flatness  

The line flatness corresponding to the i (setflat) operator. The default value is fixedZero.

 
lineCap  

The line cap style corresponding to the J (setlinecap) operator. The default value is 0.

 
lineJoin  

Line join style corresponding to the j (setlinejoin) operator. The default value is 0.

 
renderIntent  

A color rendering intent corresponding to the Intent key in the image dictionary. The default value is RelativeColorimetric.

 
extGState  

An extended graphics flag corresponding to the gs operator. The default value is CosObj, NULL.

 
softMaskMatrix  

The CTM at the time soft mask was established. The default value is identity matrix.

_t_PDEGraphicStateEx 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEGraphicStateEx {
 ASUns32 wasSetFlags; 
 
 PDEColorSpec fillColorSpec; 
 
 PDEColorSpec strokeColorSpec; 
 
 PDEDashEx dash; 
 
 ASDouble lineWidth; 
 
 ASDouble miterLimit; 
 
 ASDouble flatness; 
 
 ASInt32 lineCap; 
 
 ASInt32 lineJoin; 
 
 ASAtom renderIntent; 
 
 PDEExtGState extGState; 
 
 ASDoubleMatrix softMaskMatrix; 
}

Attributes of a PDEElement or a PDEText sub-element.

See Also


File: PEExpT.h
Line: 731

Elements
wasSetFlags  

PDEGraphicStateWasSetFlags indicating if an attribute has been set.

 
fillColorSpec  

The fill color specification. The default value is DeviceGray, fixedZero.

 
strokeColorSpec  

The stroke color specification. The default value is DeviceGray, fixedZero.

 
dash  

The dash specification. The default value is [0, 0].

 
lineWidth  

The line width corresponding to the w (setlinewidth) operator. The default value is 1.

 
miterLimit  

The miter limit corresponding to the M (setmiterlimit) operator. The default value is 10.

 
flatness  

The line flatness corresponding to the i (setflat) operator. The default value is 0.

 
lineCap  

The line cap style corresponding to the J (setlinecap) operator. The default value is 0.

 
lineJoin  

Line join style corresponding to the j (setlinejoin) operator. The default value is 0.

 
renderIntent  

A color rendering intent corresponding to the Intent key in the image dictionary. The default value is RelativeColorimetric.

 
extGState  

An extended graphics flag corresponding to the gs operator. The default value is CosObj, NULL.

 
softMaskMatrix  

The CTM at the time soft mask was established. The default value is identity matrix.

_t_PDEGrayCalFlt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEGrayCalFlt {
 PDEWhitePointFlt whitePoint; 
 
 PDEBlackPointFlt blackPoint; 
 
 float gamma; 
}

A structure describing a CalGray color space.

Default value: PDEGrayCalFlt calGray = {{0, 0, 0}, {0, 0, 0}, 1};

See Also


File: PEExpT.h
Line: 2082

_t_PDEICCBasedColorData 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEICCBasedColorData {
 ASSize_t size; 
 
 ASStm iccstream; 
 
 ASUns32 nComps; 
 
 PDEColorSpace altCs; 
}

An ICC-based color space.


File: PEExpT.h
Line: 2156

Elements
size  

Set the size to sizeof(PDEICCColorData).

 
iccstream  

A stream containing an ICC Profile.

 
nComps  

The number of color components (1, 3, or 4).

 
altCs  

(Optional) An alternate color space.

_t_PDEIndexedColorData 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDEIndexedColorData {
 ASSize_t size; 
 
 PDEColorSpace baseCs; 
 
 ASUns16 hival; 
 
 char* lookup; 
 
 ASUns32 lookupLen; 
}

A structure describing an indexed color space.

See Also


File: PEExpT.h
Line: 2176

Elements
size  

Set the size to sizeof(PDEIndexedColorData).

 
baseCs  

The base color space.

 
hival  

The highest color value.

 
lookup  

Indexed color lookup data.

 
lookupLen  

The number of bytes in the lookup data.

_t_PDELabCalFlt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDELabCalFlt {
 PDEWhitePointFlt whitePoint; 
 
 PDEBlackPointFlt blackPoint; 
 
 PDEColorRangeFlt rangeA; 
 
 PDEColorRangeFlt rangeB; 
}

A structure describing a Lab color space.

Default value: {{0, 0, 0}, {0, 0, 0}, {-100, 100}, {-100, 100}};

See Also


File: PEExpT.h
Line: 2132

_t_PDERGBCalFlt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDERGBCalFlt {
 PDEWhitePointFlt whitePoint; 
 
 PDEBlackPointFlt blackPoint; 
 
 float redGamma; 
 
 float greenGamma; 
 
 float blueGamma; 
 
 float matrix[9]; 
}

A structure describing a CalRGB color space. It is the same as AGMRGBCalFlt (it is only available as part of the PDF Library SDK).

Default value: {{0, 0, 0}, {0, 0, 0}, 1, 1, 1, {1, 0, 0, 0, 1, 0, 0, 0, 1}};

See Also


File: PEExpT.h
Line: 2103

_t_PDESeparationColorData 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDESeparationColorData {
 ASSize_t size; 
 
 ASAtom name; 
 
 PDEColorSpace alt; 
 
 CosObj tintTransform; 
}

A structure describing a separation color space.

See Also


File: PEExpT.h
Line: 2199

Elements
size  

The size of the data structure. It must be set to sizeof(PDESeparationColorData).

 
name  

The name of the separation or colorant.

 
alt  

The alternate color space.

 
tintTransform  

The tintTransform dictionary or function. See Section 4.5.5 in the PDF Reference.

_t_PDESpanItem 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDESpanItem {
 ASInt32 firstGlyph; 
 
 ASInt32 nGlyphs; 
 
 ASInt32 firstUniChar; 
 
 ASInt32 nUniChars; 
}


File: PEExpT.h
Line: 1361

Elements
firstGlyph  

The index into the glyphs array in a PDEGlyphRun object.

 
nGlyphs  

The number of glyphs in the span starting from firstGlyph. This can be zero, indicating there are no glyphs for this Unicode string. The firstGlyph indicates the glyph that precedes the Unicode string.

 
firstUniChar  

The index into the uniText array in a PDEGlyphRun object.

 
nUniChars  

The number of Unicode characters in the span starting from firstUniChar. This count can be zero, indicating there are no Unicode values for the range of glyphs.

_t_PDESpanSet 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDESpanSet {
 PDESpanItemP spans; 
 
 ASInt32 spanCount; 
}


File: PEExpT.h
Line: 1383

Elements
spans  

A pointer to array of spans corresponding to the PDEGlyphRun object.

 
spanCount  

The count of spans in the spans array.

PDEColorRangeFlt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDEColorRangeFlt {
 float min; 
 
 float max; 
}


File: PEExpT.h
Line: 2051

PDEXYZColorFlt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDEXYZColorFlt {
 float x; 
 
 float y; 
 
 float z; 
}


File: PEExpT.h
Line: 2056

Callbacks Detail
PDEAttrEnumProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDEAttrEnumProc)(IN void *attrHdrP, IN ASUns32 refCount, IN ASUns16 size, IN void *clientData)

A callback for PDEAttrEnumTable(). It is called once for each attribute in a table.

See Also


File: PEExpT.h
Line: 2045

Method Detail
PDEDefaultGState()
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDEDefaultGState(OUTPDEGraphicStateP stateP, INASInt32 stateSize)

Fills out a PDEGraphicStateP structure with the default graphic state.

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.

Since

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.

Examples

go to source arrow PDEDefaultGState(&pdeGState, sizeof(PDEGraphicState));

File: PERProcs.h
Line: 1629
PDEDefaultGStateEx() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDEDefaultGStateEx(OUTPDEGraphicStateExP stateP, INASInt32 stateSize)

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

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.

Since

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.

File: PERProcs.h
Line: 3694
PDEEnumElements() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDEEnumElements(const CosObj* contents, const CosObj* resources, INASUns32 flags, INPDEElementEnumProc enumProc, IN void* enumProcClientData)

Enumerates all the PDEElements in a given stream. It is similar to PDEContentCreateFromCosObj(), but provides enumeration instead of a list of elements.

If marked content is not ignored, each PDEContainer contains a PDEContent list within itself.

Parameters

contents — 

IN/OUT A Cos object that is the source for the content stream. It may be page contents, a Form XObject, a Type 3 font CharProc, or an appearance object from an annotation.

 
resources — 

IN/OUT The object's Resources dictionary. If the Form or Type 3 font or appearance dictionary contains a Resources dictionary, this dictionary must be passed in resources. Otherwise, it must be the page resources object of the page containing the Form or Type 3 font contents object.

 
flags — 

IN/OUT Flags from PDEEnumElementsFlags.

 
enumProc — 

IN/OUT A user-supplied callback to call once for each top-level element. Note that the element in enumProc may only be valid for this method. Use PDEAcquire() if you need to hold on to the element longer than the scope of enumProc.

 
enumProcClientData — 

IN/OUT A pointer to user-supplied data to pass to enumProc each time it is called.

See Also

Exceptions

peErrWrongPDEObjectType
genErrBadParm
peErrPStackUnderflow
peErrCantGetImageDict

Since


File: PERProcs.h
Line: 1684
PDEMergeResourcesDict() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDEMergeResourcesDict(OUTCosObj* resDictP, INCosDoc cosDoc, const CosObj* newResP)

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 is useful for adding form resources to page resource dictionaries. This is only necessary if creating PDF 1.1 or earlier files for use with Acrobat 2.1 or earlier. This is unnecessary if creating PDF 1.2 or later documents.

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

genErrBadParm

Since

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.

File: PEWProcs.h
Line: 1202
PDEPurgeCache() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDEPurgeCache(INPDDoc doc)

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

Parameters

doc — 

A PDDoc whose cache is purged.

Since

Note

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

File: PEWProcs.h
Line: 1455
PDEScratchDocCleanup() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDEScratchDocCleanup()

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

Since


File: PEWProcs.h
Line: 3462