5 items
void PDEAttrEnumTable(IN PDEAttrEnumProc enumProc, IN void *clientData)Enumerates the table of attributes. This method enumerates the shared resource objects. It is useful when looking for orphaned attributes.
enumProc: IN PDEAttrEnumProcIN/OUT A callback to call for each attribute.
clientData: IN void *IN/OUT A pointer to user-supplied data to pass to enumProc each time it is called.
voidvoid PDELogDump(IN PDEObjectDumpProc proc, IN void *clientData)Enumerates the PDEObject objects. This is useful when looking for orphaned objects.
proc: IN PDEObjectDumpProcA callback to call once for each PDEObject.
clientData: IN void *A pointer to user-supplied data to pass to proc each time it is called.
voidvoid PDEObjectDump(IN PDEObject obj, IN ASInt32 levels, IN PDEObjectDumpProc proc, IN void *clientData)The object, its children and attributes are dumped. The dump contains information about each individual object. The output for child elements is indented with respect to their parents. The information for each object is char* - the string describing Object Type. (See PDEObjectGetType()). The number representing Object Type. (See PEExpT.h : PDEType enum ). The object reference count. The memory location for the object.
obj: IN PDEObjectThe PDEObject to dump.
levels: IN ASInt32The depth of children to dump.
proc: IN PDEObjectDumpProcA callback with the dump information; it may be called more than once per object.
clientData: IN void *Provided by the caller as the parameter of the same name for proc .
voidtypedef ASBool(* PDEAttrEnumProc) (IN void *attrHdrP, IN ASUns32 refCount, IN ASUns16 size, IN void *clientData))(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.
typedef void(* PDEObjectDumpProc) (IN PDEObject obj, IN const char *dumpInfo, IN void *clientData))(IN PDEObject obj, IN const char *dumpInfo, IN void *clientData)A callback for PDELogDump() or PDEObjectDump(). It is called once for each PDEObject, its children, and their attributes for the specified number of levels.
22 items
void PDEDefaultGState(OUT PDEGraphicStateP stateP, IN ASInt32 stateSize)Fills out a PDEGraphicStateP structure with the default graphic state. 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 .
stateP: OUT PDEGraphicStateP(Filled by the method) A pointer to a PDEGraphicState structure with the default graphic state.
stateSize: IN ASInt32The size of the stateP structure in bytes.
voidvoid PDEDefaultGStateEx(OUT PDEGraphicStateExP stateP, IN ASInt32 stateSize)Fills out a PDEGraphicStateEx structure which is higher precision alternative of PDEGraphicState structure with the default graphic state. 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 .
stateP: OUT PDEGraphicStateExP(Filled by the method) A pointer to a PDEGraphicStateEx structure with the default graphic state.
stateSize: IN ASInt32The size of the stateP structure in bytes.
voidMerges 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. 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.
resDictP: OUT CosObj *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 CosDocIN/OUT The CosDoc containing both dictionaries.
newResP: IN const CosObj *IN/OUT The dictionary to merge with resDictP .
voidvoid PDEPurgeCache(IN PDDoc doc)Clears the PDE Cache of this PDDoc. This method is only of interest to clients. It is not recommended that you call this method directly; it is provided only for backwards compatibility.
doc: IN PDDocA PDDoc whose cache is purged.
voidvoid PDEScratchDocCleanup(void)Removes unused objects from the PDFEdit scratch document, which is used to hold representations of PDFEdit resources associated with a specific document.
: voidvoidtypedef struct _t_PDEEmitState* PDEEmitStatePA reference to the state of a writer.
Indicates whether Marked Content is ignored in the enumeration. This may be useful when generating elements purely for display purposes.
A fill color space was set corresponding to the cs ( setcolorspace ) operator.
A color fill value was set corresponding to the sc ( setcolor ) operator.
A color space stroke value was set corresponding to the CS ( setcolorspace ) operator.
A color stroke value was set corresponding to the SC ( setcolor ) operator.
A dash specification was set corresponding to the d ( setdash ) operator.
The line width was set corresponding to the w ( setlinewidth ) operator.
The miter limit was set corresponding to the M ( setmiterlimit ) operator.
Line flatness was set corresponding to the i ( setflat ) operator.
Line cap style was set corresponding to the J ( setlinecap ) operator.
Line join style was set corresponding to the j ( setlinejoin ) operator.
A color rendering intent was set corresponding to the Intent key in the image dictionary.
An extended graphics state was set corresponding to the gs operator.
The soft mask matrix has been set
The types of PDEObject, which is the superclass for PDEContent, PDEElement, PDEClip, and so on.
PDEContent object
PDEText object
PDEPath object
PDEImage object
PDEForm object
PDEPS object
PDEXObject object
PDEClip object
PDEFont object
PDEColorSpace object
PDEExtGState object
PDEPlace object
PDEContainer object
PDSysFont object
PDEPattern object
PDEDeviceNColors object
PDEShading object
PDEGroup object
PDEUnknown object
PDEBeginContainer object
PDEEndContainer object
PDEBeginGroup object
PDEEndGroup object
PDEXGroup object
PDESoftMask object
PDSysEncoding object
PDEDoc object
PDEPage object
PDEReader object
PDEWriter object
PDETextItem object
PDEImageFlate object
PDEImageJPX object
JPXColorSpace object
JPXPalette object
6 items
JPXColorSpace JPXColorSpaceAcquireNext(IN JPXColorSpace jpxColorSpace)Acquires the next JPX color space defined with the JPX encoded image in the link list, if one exists. This object is acquired and must be released using PDERelease() when it is no longer in use.
jpxColorSpace: IN JPXColorSpaceASBool JPXColorSpaceGetEnumAttrs(IN JPXColorSpace jpxColorSpace, OUT JPXCSEnumAttrsP jpxCSEnumAttrsP)Gets the attributes of an enumerated color space. It returns false if the color space is not kJPXCSEnumerated.
jpxColorSpace: IN JPXColorSpacejpxCSEnumAttrsP: OUT JPXCSEnumAttrsPtrue if the JPX color space is kJPXCSEnumerated
ASInt32 JPXColorSpaceGetProfile(IN JPXColorSpace jpxColorSpace, OUT ASUns8 *profile, IN ASInt32 profileLength)Gets the color profile of an ICC-based JPX color space. If profile is 0 , it returns the length of the profile in bytes; otherwise it returns the number of bytes copied to profile .
jpxColorSpace: IN JPXColorSpaceprofile: OUT ASUns8 *profileLength: IN ASInt32JPXColorSpaceType JPXColorSpaceGetType(IN JPXColorSpace jpxColorSpace)Returns the type of JPX color space: kJPXCSUnknown kJPXCSEnumerated kJPXCSRestrictedICC kJPXCSAnyICC kJPXCSVenderColor
jpxColorSpace: IN JPXColorSpacetypedef struct _t_JPXColorSpace* JPXColorSpaceA reference to a JPXColorSpace.
5 items
void JPXPaletteGetBitDepths(IN JPXPalette jpxPalette, OUT ASInt32 *bitDepths)Returns the bit depths of the color values represented in the palette. The length of the array must be at least the number of components.
jpxPalette: IN JPXPalettebitDepths: OUT ASInt32 *voidASInt32 JPXPaletteGetNumComponents(IN JPXPalette jpxPalette)Returns the number of color components represented by the palette.
jpxPalette: IN JPXPaletteASInt32 JPXPaletteGetNumEntries(IN JPXPalette jpxPalette)Returns the number of palette entries.
jpxPalette: IN JPXPaletteASStm JPXPaletteGetTable(IN JPXPalette jpxPalette, OUT ASInt32 *paletteLength)Returns the palette data as a read only non-seekable ASStm. The returned ASStm should be read with ASStmRead(). Each component entry in the palette is represented by the number of bytes needed to contain the bit depth for that component.
jpxPalette: IN JPXPalettepaletteLength: OUT ASInt32 *6 items
PDEBeginContainer PDEBeginContainerCreate(IN ASAtom mcTag, IN CosObj *cosObjP, IN ASBool isInline)Creates a new PDEBeginContainer object. Call PDERelease to dispose of the returned PDEBeginContainer object when finished with it. Call PDERelease() to dispose of the returned PDEBeginContainer object when finished with it.
mcTag: IN ASAtomIN/OUT The tag name for the marked-content sequence.
cosObjP: IN CosObj *IN/OUT (May be NULL ) A CosDict object containing the property list for the sequence.
isInline: IN ASBoolIf true , it emits the container's dictionary into the content stream inline. If false , then the dictionary is emitted outside of the content stream and referenced by name. See the Property Lists section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 14.6.2, page 554. This document is provided on the web site of the International Standards Organization (ISO).
The newly created object.
ASBool PDEBeginContainerGetDict(IN PDEBeginContainer pdeBeginContainer, OUT CosObj *dictP, OUT ASBool *isInlineP)Gets the property list dictionary associated with a PDEBeginContainer object. The property list is stored in a Cos dictionary.
pdeBeginContainer: IN PDEBeginContainerdictP: OUT CosObj *isInlineP: OUT ASBool *ASAtom PDEBeginContainerGetMCTag(IN PDEBeginContainer pdeBeginContainer)Gets the marked content tag associated with a PDEBeginContainer object.
pdeBeginContainer: IN PDEBeginContainerIN/OUT A PDEBeginContainer object.
The mark content tag.
void PDEBeginContainerSetDict(IN PDEBeginContainer pdeBeginContainer, IN CosObj *pdeBeginContainerDictP, IN ASBool isInline)Sets the property list for a PDEBeginContainer. The property list is passed as a Cos dictionary that can be emitted inline or referenced from the \\Properties key in the \\Resources dictionary of the containing stream. To learn about Property Lists for isInline, see the ISO 32000-:2008 document (1.7). This document is provided on the web site of the International Standards Organization (ISO). @note If cosObjP is NULL, the property list is cleared.
pdeBeginContainer: IN PDEBeginContainerpdeBeginContainerDictP: IN CosObj *isInline: IN ASBoolIf true , it emits the container's dictionary into the content stream inline. If false , then the dictionary is emitted outside of the content stream and referenced by name. See the Property Lists section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 14.6.2, page 554.
voidvoid PDEBeginContainerSetMCTag(IN PDEBeginContainer pdeBeginContainer, IN ASAtom mcTag)Sets the marked content tag for a PDEBeginContainer.
pdeBeginContainer: IN PDEBeginContainerIN/OUT The PDEBeginContainer object.
mcTag: IN ASAtomIN/OUT The tag name.
voidtypedef struct _t_PDEBeginContainer* PDEBeginContainerThe PDFEdit representation of the opening bracket of a marked-content sequence. Elements of this type must be paired with elements of type PDEEndContainer.
2 items
Creates a new begin group object. Call PDERelease() to dispose of the returned PDEBeginGroup object when finished with it.
The newly created object.
typedef struct _t_PDEBeginGroup* PDEBeginGroupA group of PDEElement objects on a page in a PDF file.
9 items
void PDEClipAddElem(IN PDEClip clip, IN ASInt32 addAfterIndex, IN PDEElement pdeElement)Adds an element to a clip path. This method increments the reference count of pdeElement .
clip: IN PDEClipIN/OUT The clip path to which an element is added.
addAfterIndex: IN ASInt32IN/OUT The index after which to add pdeElement . Use kPDEBeforeFirst to insert an element at the beginning of the clip object.
pdeElement: IN PDEElementIN/OUT The element added, which may be a PDEPath, a PDEText, a PDEContainer, a PDEGroup, or a PDEPlace object.
voidPDEClip PDEClipCopy(IN PDEClip srcClip)Makes a deep copy of a PDEClip object. Call PDERelease() to dispose of the returned clip object when finished with it. It raises an exception if it is unable to allocate memory.
srcClip: IN PDEClipIN/OUT The clipping path to copy.
The deep copy of srcClip .
PDEClip PDEClipCreate(void)Creates an empty clip object. This represents a clipping object that has no effect on elements that refer to it. Call PDERelease() to dispose of the returned clip object when finished with it. It raises an exception if it is unable to allocate memory.
: voidThe newly created clip object.
ASBool PDEClipFlattenedEnumElems(IN PDEClip clip, IN PDEClipEnumProc enumProc, IN void *enumProcClientData)For a given PDEClip, this enumerates all of the PDEElement objects in a flattened manner. In other words, PDEContainer objects and PDEGroup objects nested in the PDEClip will not be handed back, but any PDEPath objects and PDEText objects nested in them will be. Additionally, PDEPlace objects inside the PDEClip are not returned.
clip: IN PDEClipThe PDEClip to enumerate.
enumProc: IN PDEClipEnumProcCalled with each flattened element. Enumeration continues until all elements have been enumerated, or until enumProc returns false .
enumProcClientData: IN void *A pointer to user-supplied data to pass to enumProc each time it is called.
Returns the value of enumProc . It returns true if successful, false otherwise.
PDEElement PDEClipGetElem(IN PDEClip clip, IN ASInt32 index)Gets an element from a clip object. This method does not change the reference count of the returned PDEElement.
clip: IN PDEClipIN/OUT The clip object from which an element is obtained.
index: IN ASInt32IN/OUT The index of the element to get from clip .
The element from the clip object.
ASInt32 PDEClipGetNumElems(IN PDEClip clip)Gets the number of top-level elements in a clip object. Top-level elements may be a path or charpath, a marked content container or place, or a group. Paths are represented as PDEPath objects; charpaths are represented as PDEText objects. PDEGroup is not a persistent object. You cannot save to PDF and re-get group objects.
clip: IN PDEClipIN/OUT The clip object to examine.
The number of path and charpath elements in clip. If clip contains PDEGroup objects, this method returns the top-level PDEPath, PDEText, PDEContainer, PDEGroup, or PDEPlace object. Use PDEClipFlattenedEnumElems() to see only the PDEPath and PDEText objects.
Removes one or more elements from a clip object. This method decrements the reference count of each of the elements.
clip: IN PDEClipIN/OUT The clip object from which an element is removed.
index: IN ASInt32IN/OUT The first element to remove.
count: IN ASInt32IN/OUT The number of elements to remove.
voidtypedef ASBool(* PDEClipEnumProc) (IN PDEElement elem, IN void *clientData))(IN PDEElement elem, IN void *clientData)A callback for PDEClipFlattenedEnumElems(), which enumerates all of a PDEClip object's PDEElement objects in a flattened manner.
typedef struct _t_PDEClip* PDEClipA list of PDEElement objects containing a list of PDEPath objects and PDEText objects that describe a clip state. PDEClip objects can be created and built up with PDEClip methods. Any PDEElement object can have PDEClip associated with it. PDEClip objects can contain PDEContainer objects and PDEGroup objects to an arbitrary level of nesting. This allows PDEContainer objects to be used to mark clip objects. PDEGroup objects inside PDEClip objects that contain at least one PDEText and no PDEPath objects have a special meaning. All PDEText objects contained in such a PDEGroup are considered to be part of the same BT/ET block. This means that the union of these PDEText objects makes up a single clipping path, as opposed to the intersection of the PDEText objects.
16 items
PDEColorSpace PDEColorSpaceCreate(ASAtom family, PDEColorSpaceStruct *csStruct)Creates a new color space object of the specified type. Call PDERelease() to dispose of the returned color space object when finished with it. Type of names Names Device-dependent names DeviceCMYK DeviceGray DeviceN DeviceRGB Device-independent names CalGray CalRGB Lab ICCBased Special names Indexed Pattern Separation
family: ASAtomIN/OUT Supports all PDF 1.3 color spaces, which include:
csStruct: PDEColorSpaceStruct *IN/OUT Data for the type of color space you want to create.
The newly created color space object.
PDEColorSpace PDEColorSpaceCreateFromCosObj(IN const CosObj *cosObjP)Creates a new color space object from a Cos object. Call PDERelease() to dispose of the returned color space object when finished with it. Type of names Names Device-dependent names DeviceCMYK DeviceGray DeviceN DeviceRGB Device-independent names CalGray CalRGB Lab ICCBased Special names Indexed Pattern Separation
cosObjP: IN const CosObj *IN/OUT Supports all PDF 1.3 color spaces, which include:
The newly created color space object.
Creates a new color space object. Call PDERelease() to dispose of the returned color space object when finished with it.
name: IN ASAtomIN/OUT The ASAtom for the name of the color space created. The name must be one of the following: DeviceCMYK, DeviceGray, or DeviceRGB.
The newly created color space object.
PDEColorSpace PDEColorSpaceCreateInCosDoc(IN ASAtom family, IN PDEColorSpaceStruct *csStruct, IN CosDoc cosDoc)Creates a color space object like PDEColorSpaceCreate(), except that the client can specify the CosDoc in which the color space object is created. Call PDERelease() to dispose of the returned color space object when finished with it. Type of names Names Device-dependent names DeviceCMYK DeviceGray DeviceN DeviceRGB Device-independent names CalGray CalRGB Lab ICCBased Special names Indexed Pattern Separation
family: IN ASAtomIN/OUT Supports all PDF 1.3 color spaces, which include:
csStruct: IN PDEColorSpaceStruct *IN/OUT Data for the type of color space you want to create.
cosDoc: IN CosDocIN/OUT The document in which to put the Cos representation of resource. It may be NULL .
The newly created color space object.
ASAtom PDEColorSpaceGetBase(IN PDEColorSpace colorSpace)Gets the name of the base color space. This is a helper routine for indexed color spaces. Call this method to obtain the base color space and color values for an uncolored pattern in PDFEdit. Note that the base color values are in the color array in the PDEColorValue field for stroke and fill of a PDEGraphicStateP. Or, they are in the colorObj2 object if the base color space is DeviceN. To get the color values, a client gets the base color space, determines the type and number of components of the value, and looks them up in the PDEColorValue field.
colorSpace: IN PDEColorSpaceThe base color space.
The ASAtom for the name of the base color space. Use ASAtomGetString() to obtain a C string for the ASAtom.
ASInt32 PDEColorSpaceGetBaseNumComps(IN PDEColorSpace colorSpace)Gets the number of components in the base color space of an indexed color space. For example, for [/ Indexed / DeviceRGB...] , the number of components is 3 .
colorSpace: IN PDEColorSpaceIN/OUT The indexed color space.
The number of components in colorSpace .
void PDEColorSpaceGetCTable(IN PDEColorSpace colorSpace, OUT ASUns8 *colorTableP)Gets the component information for an indexed color space.
colorSpace: IN PDEColorSpaceIN/OUT The color space whose component information table is obtained.
colorTableP: OUT ASUns8 *IN/OUT (Filled by the method) The color lookup table, which is numComps * (hiVal + 1) bytes long, where numComps is the number of components in the base colorSpace . Each entry in the table contains numComps bytes, and the table is indexed from 0 to hiVal , where hiVal is the highest index in the color table. The table is indexed from 0 to hival , thus the table contains hival + 1 entries.
voidvoid PDEColorSpaceGetCosObj(IN PDEColorSpace colorSpace, OUT CosObj *cosObjP)Gets the CosObj representation of the color space object. For image masks, use PDEElementGetGState() to obtain color information.
colorSpace: IN PDEColorSpaceIN/OUT The color space whose Cos object is obtained.
cosObjP: OUT CosObj *IN/OUT (Filled by the method) The Cos object for the color space.
voidThe Cos object for colorSpace . Any color space that is in the Resources dictionary of the page is returned as a Cos object.
ASInt32 PDEColorSpaceGetHiVal(IN PDEColorSpace colorSpace)Gets the highest index for the color lookup table for an indexed color space. Since the color table is indexed from zero to hiVal , the actual number of entries is hiVal + 1 .
colorSpace: IN PDEColorSpaceIN/OUT An indexed color space.
The highest index ( hiVal ) in the color lookup table.
ASAtom PDEColorSpaceGetName(IN PDEColorSpace colorSpace)Gets the name of a color space object. Type of names Names Device-dependent names DeviceCMYK DeviceGray DeviceN DeviceRGB Device-independent names CalGray CalRGB Lab ICCBased Special names Indexed Pattern Separation
colorSpace: IN PDEColorSpaceIN/OUT A color space object.
The color space object's name. It supports all PDF 1.3 color spaces, which include:
ASInt32 PDEColorSpaceGetNumComps(IN PDEColorSpace colorSpace)Calculates the number of components in a color space. Color space Return value DeviceGray 1 CalGray 1 Separation 1 DeviceRGB 3 CalRGB 3 DeviceCMYK 4 Lab 4 DeviceN The number of components dependent on the specific color space object. ICCBased The number of components dependent on the specific color space object. Indexed 1 Call PDEColorSpaceGetBaseNumComps() to get the number of components in the base color space.
colorSpace: IN PDEColorSpaceIN/OUT A color space object.
The number of components in colorSpace :
void PDEColorSpaceGetStruct(IN PDEColorSpace cs, OUT PDEColorSpaceStruct *pdeColorSpaceStruct)Retrieves a from a PDEColorSpace . It supports all PDF version 1.3 color spaces except the Pattern color space. It is the responsibility of the caller to free the and the underlying allocations.
cs: IN PDEColorSpaceIN/OUT The PDEColorSpace for which the structure is required.
pdeColorSpaceStruct: OUT PDEColorSpaceStruct *IN/OUT The created for the color space.
voidtypedef PDEXYZColorFlt PDEBlackPointFltA structure describing a black point in a calibrated color space.
typedef PDEColorSpace PDEPatternColorSpaceA PDEColorSpace that describes a Pattern color space.
typedef PDEXYZColorFlt PDEWhitePointFltA structure describing a white point in a calibrated color space.
typedef struct _t_PDEColorSpace* PDEColorSpaceA reference to a color space used on a page in a PDF file. The color space is part of the graphics state attributes of a PDEElement.
8 items
PDEContainer PDEContainerCreate(IN ASAtom mcTag, IN CosObj *cosObjP, IN ASBool isInline)Creates a container object. Call PDERelease() to dispose of the returned container object when finished with it.
mcTag: IN ASAtomIN/OUT The tag name for the container.
cosObjP: IN CosObj *IN/OUT An optional Marked Content dictionary for the container.
isInline: IN ASBoolIf true , it emits the container's dictionary into the content stream inline. If false , then the dictionary is emitted outside of the content stream and referenced by name. See the Property Lists section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 14.6.2, page 554. This document is provided on the web site of the International Standards Organization (ISO).
The newly created container object.
PDEContent PDEContainerGetContent(IN PDEContainer pdeContainer)Gets the PDEContent for a PDEContainer. This method does not change the reference count of the returned PDEContent.
pdeContainer: IN PDEContainerIN/OUT The container whose content is obtained.
The PDEContent for the pdeContainer .
ASBool PDEContainerGetDict(IN PDEContainer pdeContainer, OUT CosObj *placeDictP, OUT ASBool *isInline)Gets the Marked Content dictionary for a container.
pdeContainer: IN PDEContainerplaceDictP: OUT CosObj *isInline: OUT ASBool *IN/OUT (Filled by the method) true if the dictionary is inline, false otherwise. It is undefined if pdeContainer has no Marked Content dictionary.
true if pdeContainer has a Marked Content dictionary, false otherwise.
ASAtom PDEContainerGetMCTag(IN PDEContainer pdeContainer)Gets the Marked Content tag for a container.
pdeContainer: IN PDEContainerIN/OUT A container.
The Marked Content tag of pdeContainer . It returns ASAtomNull if pdeContainer has no Marked Content tag.
void PDEContainerSetContent(IN PDEContainer pdeContainer, IN PDEContent pdeContent)Sets the content for a container. The existing PDEContent is released by this method. This method decrements the reference count of the previous content of the container and increments the reference count of the new PDEContent.
pdeContainer: IN PDEContainerIN/OUT A container.
pdeContent: IN PDEContentIN/OUT The content of pdeContainer .
voidvoid PDEContainerSetDict(IN PDEContainer pdeContainer, IN CosObj *placeDictP, IN ASBool isInline)Sets the Marked Content dictionary for a PDEContainer. The dictionary can be emitted inline or referenced from the \Properties key in the \Resources dictionary of the containing stream.
pdeContainer: IN PDEContainerThe container whose dictionary is changed.
placeDictP: IN CosObj *The Marked Content dictionary being set into pdeContainer .
isInline: IN ASBoolIf true , it emits the container's dictionary into the content stream inline. If false , then the dictionary is emitted outside of the content stream and referenced by name. See the Property Lists section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 14.6.2, page 554. This document is provided on the web site of the International Standards Organization (ISO).
voidvoid PDEContainerSetMCTag(IN PDEContainer pdeContainer, IN ASAtom mcTag)Sets the Marked Content tag for a PDEContainer.
pdeContainer: IN PDEContainerIN/OUT The container to tag.
mcTag: IN ASAtomIN/OUT The Marked Content tag.
voidtypedef struct _t_PDEContainer* PDEContainerA group of PDEElement objects on a page in a PDF file. In the PDF file, containers are delimited by Marked Content BMC/EMC or BDC/EMC pairs. Every PDEContainer has a Marked Content tag associated with it. In addition to grouping a set of elements, a BDC/EMC pair specifies a property list to be associated with the grouping. Thus, a PDEContainer corresponding to a BDC/EMC pair also has a property list dictionary associated with it.
24 items
void PDEContentAddElem(IN PDEContent pdeContent, IN ASInt32 addAfterIndex, IN PDEElement pdeElement)Inserts an element into a PDEContent. This method increments the reference count of pdeElement .
pdeContent: IN PDEContentThe content to which pdeElement is added.
addAfterIndex: IN ASInt32The location after which pdeElement is added. It should be kPDEBeforeFirst to add to the beginning of the display list.
pdeElement: IN PDEElementThe element to add to pdeContent . The reference count of pdeElement is incremented.
voidvoid PDEContentAddPage(OUT PDEContent theContent, IN ASInt32 insertAfterIndex, IN CosDoc containerDoc, IN PDPage srcPage, IN ASFixedMatrix *dstMatrix, IN ASAtom annotTypes[], IN ASInt32 flags, IN ASFixedRect *bbox)Superseded by PDEContentAddPageEx() in Acrobat 10.0. Adds the specfied PDPage to the PDEContent as an Xobject form. It adds a reference to the Xobject form at the indicated index in the PDE Content; the index may be less than 0 , which indicates the object is to be appended to the content.
theContent: OUT PDEContentThe content to set for the page.
insertAfterIndex: IN ASInt32The index indicates the location after which the specified element is to be added. The index should be kPDBeforeFirst to add to the beginning of the display list.
containerDoc: IN CosDocThe CosDoc in which the page is contained.
srcPage: IN PDPageThe page that will be inserted at insertAfterIndex in theContent .
dstMatrix: IN ASFixedMatrix *(May be NULL ) The matrix applied to the default matrix of the PDPage that is inserted into the CosDoc.
annotTypes: IN ASAtomIf the page contains annotations, the annotTypes list is used to determine which annotation types are pumped into the page contents of the CosDoc. This list is a list of atoms of the subtypes of annotations to be included. When the list is NULL, all Annotations are excluded. NOTE: The annotations included will not be included AS annotations. Rather, visible Annotations will be included in content.
flags: IN ASInt32(May be 0 ) - may be one of:
Value
Description
kAnnotAll
Copy all annotation types. If this is not set, then the annotTypes list will be consulted.
kDoNotMergeFonts
Do not merge duplicate fonts when copying.
bbox: IN ASFixedRect *(May be NULL ) specifies the destination BBox for the page being inserted. If it is NULL , the new page's media box is used.
voidvoid PDEContentAddPageEx(OUT PDEContent theContent, IN ASInt32 insertAfterIndex, IN CosDoc containerDoc, IN PDPage srcPage, IN ASDoubleMatrix *dstMatrix, IN ASAtom annotTypes[], IN ASInt32 flags, IN ASDoubleRect *bbox)Adds the specfied PDPage to the PDEContent as an Xobject form. Supersedes PDEContentAddPage() in Acrobat 10.0. It adds a reference to the Xobject form at the indicated index in the PDE Content; the index may be less than 0 , which indicates the object is to be appended to the content.
theContent: OUT PDEContentThe content to set for the page.
insertAfterIndex: IN ASInt32The index indicates the location after which the specified element is to be added. The index should be kPDBeforeFirst to add to the beginning of the display list.
containerDoc: IN CosDocThe CosDoc in which the page is contained.
srcPage: IN PDPageThe page that will be inserted at insertAfterIndex in theContent .
dstMatrix: IN ASDoubleMatrix *(May be NULL ) The matrix applied to the default matrix of the PDPage that is inserted into the CosDoc.
annotTypes: IN ASAtomIf the page contains annotations, the annotTypes list is used to determine which annotation types are pumped into the page contents of the CosDoc. This list is a list of atoms of the subtypes of annotations to be included. When the list is NULL, all Annotations are excluded. NOTE: The annotations included will not be included AS annotations. Rather, visible Annotations will be included in content.
flags: IN ASInt32(May be 0 ) - may be one of:
Value
Description
kAnnotAll
Copy all annotation types. If this is not set, then the annotTypes list will be consulted.
kDoNotMergeFonts
Do not merge duplicate fonts when copying.
bbox: IN ASDoubleRect *(May be NULL ) specifies the destination BBox for the page being inserted. If it is NULL , the new page's media box is used.
voidvoid PDEContentCopyResTable(PDEContent src, PDEContent dst)Copies ResTable indexes count from source PDEContent to destination PDEContent. PDFEditReadHFT_VERSION_10
src: PDEContentdst: PDEContentvoidNone
PDFEditReadHFT_VERSION_10PDEContent PDEContentCreate(void)Creates an empty content object. Call PDERelease() to dispose of the returned content object when finished with it. Do not use this method to create a PDEContent to be put into a PDPage. Instead, call PDPageAcquirePDEContent().
: voidAn empty content object.
PDEContent PDEContentCreateFromCosObj(const CosObj *contents, const CosObj *resources)Creates a content object from a Cos object. This is the main method for obtaining a PDEContent object. Call PDERelease() to dispose of the returned content object when finished with it.
contents: const CosObj *IN/OUT A Cos object that is the source for the content. It may be page contents, a Form XObject, a Type 3 font CharProc, or an appearance dictionary for an annotation.
resources: const CosObj *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.
The content from the Cos object.
ASBool PDEContentFlattenOC(PDEContent content, PDOCContext context)Flattens the content, removing any PDEElement objects that are not visible in the given optional-content context, and removing the optional-content information from any visible PDFElement objects.
content: PDEContentThe content to be modified.
context: PDOCContextThe optional-content context in which content is checked for visibility.
true if the operation is successful, false otherwise.
void PDEContentGetAttrs(IN PDEContent pdeContent, OUT PDEContentAttrsP attrsP, IN ASUns32 attrsSize)Gets the attributes of a content.
pdeContent: IN PDEContentIN/OUT A content object.
attrsP: OUT PDEContentAttrsPIN/OUT (Filled by the method) A pointer to a PDEContentAttrs structure containing the attributes of the content.
attrsSize: IN ASUns32IN/OUT The size of the attrsP buffer in bytes.
voidPDEColorSpace PDEContentGetDefaultColorSpace(IN PDEContent pdeContent, IN ASAtom colorSpaceName)Gets a default color space from a PDEContent object.
See the "Default Color Spaces" section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, under "CIE-Based Color Spaces" in section 8.6.5.6, page 152. You can find this document on the web store of the International Standards Organization (ISO).
@note This method does not change the reference count of the returned PDEColorSpace.pdeContent: IN PDEContentcolorSpaceName: IN ASAtomPDEElement PDEContentGetElem(IN PDEContent pdeContent, IN ASInt32 index)Gets the requested element from a content. This method does not change the reference count of the element. This method does not copy the element.
pdeContent: IN PDEContentIN/OUT A content object.
index: IN ASInt32IN/OUT The index of element to obtain.
The requested element.
pdeContent: IN PDEContentASInt32 PDEContentGetNumElems(IN PDEContent pdeContent)Gets the number of elements in a PDEContent object.
pdeContent: IN PDEContentIN/OUT A content object.
The number of elements in pdeContent .
ASInt32 PDEContentGetResources(IN PDEContent pdeContent, IN ASInt32 type, OUT PDEObject *resourcesP)Gets the number of resources of the specified type and, optionally, gets the pointers to the resource objects.
pdeContent: IN PDEContentIN/OUT A content object.
type: IN ASInt32IN/OUT The type of resources to query or obtain: PDEFont, PDEXGroup, or PDEColorSpace. It must be one of PDEContentGetResourceFlags.
resourcesP: OUT PDEObject *IN/OUT (Filled by the method) If non- NULL , it must point to an array of PDEObject pointers. On return, the array contains pointers to the requested resources. If resourcesP is NULL , only the number of resources of type is returned. Note that the object in resourcesP may only be valid for this method. Use PDEAcquire() if you need to hold on to the object longer than the scope of resourcesP .
The number of resources of type returned in resourcesP .
void PDEContentRemoveElem(IN PDEContent pdeContent, IN ASInt32 index)Removes an element from a PDEContent. This decrements the reference count of the element removed.
pdeContent: IN PDEContentIN/OUT A content object.
index: IN ASInt32IN/OUT The index in pdeContent of the element to remove whose reference count is decremented.
voidvoid PDEContentSetContainingStream(IN PDEContent pdeContent, IN CosObj containingStm)Sets the containing stream and owner stream for any marked content reference handles attached to containers within the content. This call should not be used when the content is being directly added to a page. If the content is set with PDPageSetPDEContent(), PDEFormSetContent(), or PDEGroupSetContent(), this step occurs automatically.
pdeContent: IN PDEContentThe content stream within which to update marked content references.
containingStm: IN CosObjThe containing stream object for the content stream.
voidvoid PDEContentSetDefaultColorSpace_PEWCalls_(IN PDEContent pdeContent, IN ASAtom colorSpaceName, IN PDEColorSpace colorSpace)Sets the default color space in a PDEContent object. The reference count on any existing default color space is decremented, and the reference count on the new color space is incremented. Note that the new color space can be NULL , indicating that there is no default color space. See the "Default Color Spaces" section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, under "CIE-Based Color Spaces" in section 8.6.5.6, page 152. You can find this document on the web store of the International Standards Organization (ISO).
pdeContent: IN PDEContentIN A content object.
colorSpaceName: IN ASAtomIN An ASAtom for the name of the desired color space. It must be an ASAtom for one of the following:
DefaultRGB
DefaultCMYK
DefaultGray
colorSpace: IN PDEColorSpaceIN The color space to use as the default.
voidvoid PDEContentSetElemsStatus(IN PDEContent pdeContent, IN ASUns32 status)pdeContent: IN PDEContentstatus: IN ASUns32voidvoid PDEContentSetPage(IN PDEContent pdeContent, IN CosObj pageObj)Sets the page on which marked content is drawn upon for any marked content reference handles attached to containers within the content. If content is set with PDPageSetPDEContent(), PDEFormSetContent(), or PDEGroupSetContent(), this step occurs automatically. This call should only be used when the content is being directly added to a page.
pdeContent: IN PDEContentThe content stream whose marked content reference handles should be updated.
pageObj: IN CosObjThe page object upon which contents are drawn.
voidvoid PDEContentSetStreamOwner(IN PDEContent pdeContent, IN CosObj streamOwner)Sets the stream owner for any marked content reference handles attached to containers within the content. This call should not be used when the content is being directly added to a page. If content is set with PDPageSetPDEContent(), PDEFormSetContent(), or PDEGroupSetContent(), this step occurs automatically.
pdeContent: IN PDEContentThe content stream within which to update marked content references.
streamOwner: IN CosObjThe owner object for any references attached to the content.
voidvoid PDEContentToCosObj(IN PDEContent pdeContent, IN ASUns32 flags, IN PDEContentAttrsP attrs, IN ASUns32 attrsSize, IN CosDoc cosDoc, IN PDEFilterArrayP filtersP, OUT CosObj *contentsP, OUT CosObj *resourcesP)This is the main method for converting a PDEContent into PDF contents and resources.
This method does not change the PDEContent object or its reference count.
The caller of this function is responsible for adding the contents and the resources returned from this method to the Page Object.
Do not use this method to put a PDEContent into a PDPage. Instead, call PDPageSetPDEContent().pdeContent: IN PDEContentflags: IN ASUns32attrs: IN PDEContentAttrsPattrsSize: IN ASUns32cosDoc: IN CosDocfiltersP: IN PDEFilterArrayPcontentsP: OUT CosObj *IN/OUT (Filled by the method) The Cos object for the resulting contents in pdeContent .
resourcesP: OUT CosObj *IN/OUT (Filled by the method) The Cos object for the resulting resources in pdeContent . Note that the client is responsible for putting the resourcesP dictionary into the contentsP stream for non-page objects. The client must do this for XObject Forms and appearance dictionaries in annotations. For Type 3 fonts, the resource dictionaries must be merged and put into the Type 3 font dictionary. For a page, the contents and resources must be put into the page object.
voidtypedef struct _t_PDEContent* PDEContentContains the modifiable contents of a PDPage. A PDEContent object may be obtained from an existing page, from a Form XObject, or from a Type 3 CharProc. You can create an empty PDEContent object. A PDEContent object contains PDEElement objects. In addition, a PDEContent object may have attributes such as a Form matrix and setcachedevice parameters.
If set, cacheDevice contains 6 cache device values.
If set, cacheDevice contains 2 charwidth values.
If set, formMatrix contains a valid matrix.
Obtain font resources.
Obtain Xobject resources.
Obtain color space resources.
A bit field for the PDEContentToCosObj() method, indicating the type of object to create and how it is created. To learn about color operators, see the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, page 171. You can find this document on the web store of the International Standards Organization (ISO).
Create page contents.
Create a form.
Create charprocs.
Currently unused.
Currently unused.
Currently unused.
Emit calibrated RGB and gray information using the PDF 1.0 compatible mechanism. In this case, generate rg and k page operators and place DefaultGray and DefaultRGB color space arrays in the Resources dictionary. See the Color Operators section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 8.6.8, page 171.
Prevents the emission of the content compatibility operators, BX/EX, which cause issues for some versions of PDF/A or PDF/X.
By default 3 digit precision after decimal point is used for floating point values. Using this flag increases precision from 3 digits to 5 digits after decimal point.
Use a space character as the EOL character in the content stream to make the Flate compressor more effective.
Emit a gstate or textstate parameter for any element, only if the corresponding WasSetFlag is set.
Setting this flag will skip optimization of bounding box of form XObject.
Setting this flag will skip resetting of ResTable in PDEContent and it also skips creating new resource dictionary in document and uses resource dictionary from input.
Note that this form content was created from a page, and should never inherit any state from the calling code, nor allow any state to leak from the form
3 items
PDEDeviceNColors PDEDeviceNColorsCreate(IN ASFixed *pColorValues, IN ASInt32 numValues)Creates an object that can be used to store n color components when in a DeviceN color space. Call PDERelease() to dispose of the returned PDEDeviceNColors object when finished with it.
pColorValues: IN ASFixed *IN/OUT A pointer to an array of ASFixed values.
numValues: IN ASInt32IN/OUT The length of the array.
An object containing values specifying a color in a PDEDeviceNColors color space.
ASFixed PDEDeviceNColorsGetColorValue(IN PDEDeviceNColors colors, IN ASInt32 index)Gets the value of a color component of a PDEDeviceNColors color space.
colors: IN PDEDeviceNColorsIN/OUT A PDEDeviceNColors object returned by PDEDeviceNColorsCreate().
index: IN ASInt32IN/OUT The index of the color component to return.
The value of the requested color component.
typedef struct _t_PDEDeviceNColors* PDEDeviceNColorsA color space with a variable number of device-dependent components. It is usually used to store multiple spot colors in a single color space.
25 items
PDEElement PDEElementCopy(IN PDEElement pdeElement, IN ASUns32 flags)Makes a copy of an element. The caller is responsible for releasing the copy with PDERelease().
pdeElement: IN PDEElementIN/OUT The element to copy.
flags: IN ASUns32IN/OUT A bit field of PDEElementCopyFlags.
A copy of pdeElement .
ASUns32 PDEElementGetAllVisibilities(PDEElement elem, PDEContent content, PDOCContext ocContext, ASBool *visibilities, ASUns32 capacity)Tests whether all occurrences of the element are visible in a given content and optional-content context. It traverses the content to find each occurrence of the element, in the supplied content and in all nested contents. To find the visibility of a content element without considering its parent, use PDEElementIsCurrentlyVisible(). It returns the number of occurrences and an array of boolean values containing true for each occurrence of the element that is visible in the context, taking into account the context's NonOCDrawing and PDOCDrawEnumType values.
elem: PDEElementThe element for which to obtain visibilities.
content: PDEContentThe content containing the element.
ocContext: PDOCContextThe optional-content context in which the element is tested.
visibilities: ASBool *(Filled by the method) An array of boolean values containing true for each occurrence of the element that is visible in the context.
capacity: ASUns32The size of the visibilities array.
The number of occurrences of the element in the content.
void PDEElementGetBBox(IN PDEElement pdeElement, OUT ASFixedRectP bboxP)Gets the bounding box for an element. The returned bounding box is guaranteed to encompass the element, but is not guaranteed to be the smallest box that could contain the element. For example, for an arc, bboxP encloses the bezier control points, and not just the curve itself.
pdeElement: IN PDEElementIN/OUT An element whose bounding box is obtained.
bboxP: OUT ASFixedRectPIN/OUT (Filled by the method) A pointer to a ASFixedRect structure specifying the bounding box of pdeElement , specified in user space coordinates.
voidPDEClip PDEElementGetClip(IN PDEElement pdeElement)Gets the current clip for an element. The current clipping path is part of the graphics state. Element types that are not graphics elements (for example, PDEContainer and PDEPlace) do not have an associated gstate and should not be expected to return valid results. This method does not change the reference count of the clip object.
pdeElement: IN PDEElementIN/OUT An element whose clip is obtained. Note that a clip may be shared by many elements. Use care when modifying a clip. Copy it first if you want to modify the clip for a specific element.
The clip object for pdeElement .
void PDEElementGetGState(IN PDEElement pdeElement, OUT PDEGraphicStateP stateP, IN ASUns32 stateSize)Gets the graphics state information for an element. This method is only valid for PDEForm, PDEImage, PDEPath, and PDEShading elements.
pdeElement: IN PDEElementAn element whose graphics state is obtained.
stateP: OUT PDEGraphicStateP(Filled by the method) A pointer to a PDEGraphicState structure that contains graphics state information for pdeElement . This PDEGraphicStateP may contain PDEObjects for color spaces or an ExtGState. They are not acquired by this method. Note that for a PDEImage, only the ExtGState value is used for images. For indexed images, the fill color space and values are categorized in the PDEImage object.
stateSize: IN ASUns32The size of the stateP buffer in bytes.
voidvoid PDEElementGetGStateEx(IN PDEElement pdeElement, OUT PDEGraphicStateExP stateP, IN ASUns32 stateSize)Gets the graphics state information for an element. This method fills PDEGraphicStateEx as output which is higher precision alternative of PDEGraphicState structure.
This method is only valid for PDEForm, PDEImage, PDEPath, and PDEShading elements.
pdeElement: IN PDEElementstateP: OUT PDEGraphicStateExPstateSize: IN ASUns32voidvoid PDEElementGetMatrix(IN PDEElement pdeElement, OUT ASFixedMatrixP matrixP)Superseded by PDEElementGetMatrixEx() in Acrobat 10.0. Gets the transformation matrix for an element. This matrix provides the transformation from user space to device space for the element. If there is no cm ( concatmatrix ) operator in the page stream, the matrix is the identity matrix.
pdeElement: IN PDEElementAn element whose transformation matrix is obtained.
matrixP: OUT ASFixedMatrixP(Filled by the method) A pointer to ASFixedMatrix that holds a transformation matrix for pdeElement . If pdeElement is a text object, it returns the identity matrix.
voidvoid PDEElementGetMatrixEx(IN PDEElement pdeElement, OUT ASDoubleMatrixP matrixP)Supersedes PDEElementGetMatrix() in Acrobat 10.0. Gets the transformation matrix for an element. This matrix provides the transformation from user space to device space for the element. If there is no cm ( concatmatrix ) operator in the page stream, the matrix is the identity matrix.
pdeElement: IN PDEElementAn element whose transformation matrix is obtained.
matrixP: OUT ASDoubleMatrixP(Filled by the method) A pointer to ASDoubleMatrix that holds a transformation matrix for pdeElement . If pdeElement is a text object, it returns the identity matrix.
voidGets an optional-content membership dictionary (OCMD) object associated with the element. The element must be a PDEForm, PDEImage (XObject image), or PDEContainer. If it is not one of these, the method returns NULL . If the element is a PDEForm or PDEImage, the method returns the dictionary attached to the element's Cos XObject dictionary. If the element is a PDEContainer, and it is for optional content, the method returns the dictionary. If it is not for optional content, the method returns NULL .
elem: PDEElementThe element from which the dictionary is obtained.
The dictionary object, or NULL if the element is not a PDEForm, PDEImage (XObject image), or PDEContainer, or if it is a container that is not for optional content.
ASBool PDEElementHasGState(IN PDEElement pdeElement, OUT PDEGraphicStateP stateP, IN ASUns32 stateSize)Gets the graphics state information for an element.
pdeElement: IN PDEElementThe PDEElement whose graphics state is to be obtained.
stateP: OUT PDEGraphicStateP(Filled by the method) A pointer to a PDEGraphicState structure that contains graphics state information for pdeElement .
stateSize: IN ASUns32The size of the stateP buffer. Set it to sizeof(PDEGraphicState) .
true if the element has a graphics state, false otherwise.
ASBool PDEElementHasGStateEx(IN PDEElement pdeElement, OUT PDEGraphicStateExP stateP, IN ASUns32 stateSize)Gets the graphics state information for an element. This method fills PDEGraphicStateEx as output which is higher precision alternative of PDEGraphicState structure.
pdeElement: IN PDEElementstateP: OUT PDEGraphicStateExPstateSize: IN ASUns32ASBool PDEElementIsAtPoint(IN PDEElement elem, IN ASFixedPoint point)Tests whether a point is on an element.
elem: IN PDEElementIN/OUT The element to test. If PDEElement is a PDEText or PDEImage, it uses the bounding box of the PDEElement to make the check. If the PDEElement is a PDEPath and it is stroked, it checks if the point is on the path. If the PDEElement is a PDEPath and it is filled, it checks if the point is in the fill area, taking into consideration whether it is filled using the non-zero winding number rule or the even-odd rule.
point: IN ASFixedPointIN/OUT The point, specified in user space coordinates.
true if the point is on the element, false otherwise.
ASBool PDEElementIsAtRect(IN PDEElement elem, IN ASFixedRect rect)Tests whether any part of a rectangle is on an element.
elem: IN PDEElementIN/OUT The element to test. If PDEElement is a PDEText or PDEImage, it uses the bounding box of the PDEElement to make the check. If the PDEElement is a PDEPath and it is stroked, it checks if the rectangle is on the path. If the PDEElement is a PDEPath and it is filled, it checks if the rectangle is in the fill area, taking into consideration whether it is filled using the non-zero winding number rule or the even-odd rule.
rect: IN ASFixedRectIN/OUT The rectangle, specified in user space coordinates.
true if any part of the rectangle is on the element, false otherwise.
ASBool PDEElementIsCurrentlyVisible(PDEElement elem, PDEContent content, PDOCContext ocContext)Tests whether an element is visible in a given content and optional-content context. It traverses the content to find the first occurrence of the element, in the supplied content and in all nested contents. It returns true if the first occurrence of the element is visible in the context, taking into account the context's NonOCDrawing and PDOCDrawEnumType values. The content can be NULL . In this case: If the element is a PDEForm, PDEImage, or PDEContainer, the method checks the object to see if it has an optional-content membership dictionary (OCMD) attached to it. If so, the method returns true if the object is visible, without considering whether the PDEContent that the element belongs to is visible. If the element is not one of these types, the method returns true .
elem: PDEElementThe element to test.
content: PDEContentThe content containing the element.
ocContext: PDOCContextThe optional-content context in which the element is tested.
Returns true if the element is visible in the given content and context, false if it is hidden.
ASBool PDEElementMakeVisible(PDEElement elem, PDEContent content, PDOCContext ocContext)Makes an element visible in a given content and optional-content context, by manipulating the ON-OFF states of the optional-content groups.
elem: PDEElementThe element for which to set the visibility state.
content: PDEContentThe content containing the element.
ocContext: PDOCContextThe optional-content context in which the element is made visible.
true if the element is successfully made visible in the given content and context, false otherwise.
void PDEElementRemoveOCMD(PDEElement elem)Dissociates an optional-content membership dictionary (OCMD) object from the element. The element must be a PDEForm, a PDEImage (XObject image), or a PDEContainer. If it is not one of these, nothing happens: If the element is a PDEForm or PDEImage, the method removes the dictionary from the element's Cos XObject dictionary. If the element is a PDEContainer for optional content, the method removes the dictionary, but does not destroy the container.
elem: PDEElementThe element for which to remove the dictionary.
voidvoid PDEElementSetClip(IN PDEElement pdeElement, IN PDEClip pdeClip)Sets the current clip for an element. The pdeElement parameter's previous clip's reference count is decremented (if it had one), and the pdeClip parameter's reference count is incremented.
pdeElement: IN PDEElementIN/OUT An element whose clip is set.
pdeClip: IN PDEClipIN/OUT The clip to set for pdeContent .
voidvoid PDEElementSetGState(IN PDEElement pdeElement, IN PDEGraphicStateP stateP, IN ASUns32 stateSize)Sets the graphics state information for an element. This method is valid only for PDEForm, PDEImage, PDEPath, and PDEShading elements. This method causes any of the stateP parameter's color space or ExtGState objects to have their reference count incremented, and previous graphic state objects to be decremented.
pdeElement: IN PDEElementAn element whose graphics state is set.
stateP: IN PDEGraphicStatePA pointer to a PDEGraphicState structure with graphics state information to set for pdeContent . Any of the stateP parameter's color space or ExtGState objects have their reference count incremented.
stateSize: IN ASUns32The size of the stateP buffer in bytes.
voidvoid PDEElementSetGStateEx(IN PDEElement pdeElement, IN PDEGraphicStateExP stateP, IN ASUns32 stateSize)Sets the graphics state information for an element. This method takes pointer to PDEGraphicStateEx as input which is higher precision alternative of PDEGraphicState structure.
This method is valid only for PDEForm, PDEImage, PDEPath, and PDEShading elements.
pdeElement: IN PDEElementstateP: IN PDEGraphicStateExPstateSize: IN ASUns32voidvoid PDEElementSetMatrix(IN PDEElement pdeElement, IN ASFixedMatrixP matrixP)Superseded by PDEElementSetMatrixEx() in Acrobat 10.0. Sets the transformation matrix for an element. The element may not be a PDEContainer, a PDEGroup, a PDEPlace, or a PDEText.
pdeElement: IN PDEElementIN/OUT An element whose transformation matrix is set.
matrixP: IN ASFixedMatrixPIN/OUT A pointer to an ASFixedMatrix that holds the transformation matrix to set for pdeContent .
voidvoid PDEElementSetMatrixEx(IN PDEElement pdeElement, IN ASDoubleMatrixP matrixP)Sets the transformation matrix for an element. Supersedes PDEElementSetMatrix() in Acrobat 10.0. The element may not be a PDEContainer, a PDEGroup, a PDEPlace, or a PDEText.
pdeElement: IN PDEElementIN/OUT An element whose transformation matrix is set.
matrixP: IN ASDoubleMatrixPIN/OUT A pointer to an ASDoubleMatrix that holds the transformation matrix to set for pdeContent .
voidvoid PDEElementSetOCMD(PDEElement elem, PDOCMD pdOCMD)Associates an optional-content membership dictionary (OCMD) object with the element. The element must be a PDEForm, a PDEImage (XObject image), or a PDEContainer. If it is not one of these, nothing happens: If the element is a PDEForm or PDEImage, the method attaches the dictionary to the element's Cos XObject dictionary. If the element is a PDEContainer, and it is already for optional content, the optional-content information is replaced. If it is not already for optional content, a new PDEContainer for optional content is created and nested inside the specified container.
elem: PDEElementThe element for which to set the dictionary.
pdOCMD: PDOCMDThe new dictionary.
voidtypedef ASBool(* PDEElementEnumProc) (IN PDEElement elem, IN void *clientData))(IN PDEElement elem, IN void *clientData)A callback for PDEEnumElements(). It is called once for each PDEElement in a page's Contents Stream or Resources dictionary.
typedef struct _t_PDEElement* PDEElementThe base class for elements of a page display list (PDEContent) and for clip objects. The general PDEElement methods allow you to get and set general element properties.
The copied element does not need gstate or clip .
Acquire the clip path and put it in the copied object.
1 items
void PDEEnumElements(IN const CosObj *contents, IN const CosObj *resources, IN ASUns32 flags, IN PDEElementEnumProc 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.
contents: IN const CosObj *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 const CosObj *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 ASUns32IN/OUT Flags from PDEEnumElementsFlags.
enumProc: IN PDEElementEnumProcIN/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 void *IN/OUT A pointer to user-supplied data to pass to enumProc each time it is called.
void2 items
Creates a new PDEEndContainer object. Call PDERelease to dispose of the returned PDEEndContainer object when finished with it. Call PDERelease() to dispose of the returned PDEEndContainer object when finished with it.
The newly created object.
typedef struct _t_PDEEndContainer* PDEEndContainerThe PDFEdit representation of the closing bracket of a marked-content sequence. Elements of this type must be paired with elements of type PDEBeginContainer.
2 items
Creates a new end group object. Call PDERelease() to dispose of the returned PDEEndGroup object when finished with it.
The newly created object.
typedef struct _t_PDEEndGroup* PDEEndGroupA group of PDEElement objects on a page in a PDF file.
31 items
PDESoftMask PDEExtGStateAcquireSoftMask(IN PDEExtGState pdeExtGState)Acquires the soft mask of the extended graphic state. Call PDERelease() to dispose of the PDESoftMask when finished with it.
pdeExtGState: IN PDEExtGStateThe extended graphics state object.
The soft mask or NULL if the ExtGState dictionary does not contain the SMask key.
PDEExtGState PDEExtGStateCreate(IN CosObj *cosObjP)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.
cosObjP: IN CosObj *A Cos object for a dictionary of type ExtGState.
The PDEExtGState for cosObjP .
PDEExtGState PDEExtGStateCreateNew(IN CosDoc cosDoc)Creates a new extended graphics state object. Call PDERelease() to dispose of the returned PDEExtGState object when finished with it.
cosDoc: IN CosDocIN/OUT The document within which the object will be used.
The newly created object.
ASBool PDEExtGStateGetAIS(IN PDEExtGState pdeExtGState)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.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
See above.
ASAtom PDEExtGStateGetBPC(IN PDEExtGState extGS)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.
extGS: IN PDEExtGStateThe extended graphics state object.
ASAtom for BPC value.
ASAtom PDEExtGStateGetBlendMode(IN PDEExtGState pdeExtGState)Returns the blend mode for the color composite for each object painted. The following are valid names: Compatible Normal Multiply Screen Difference Darken Lighten ColorDodge ColorBurn Exclusion HardLight Overlay SoftLight Luminosity Hue Saturation Color
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
If the value has not been set, a value of Compatible is returned. See above.
void PDEExtGStateGetCosObj(IN PDEExtGState extGState, OUT CosObj *cosObjP)Gets a Cos object for a PDEExtGState.
extGState: IN PDEExtGStateIN/OUT A PDEExtGState whose Cos object is obtained.
cosObjP: OUT CosObj *IN/OUT (Filled by the method) The Cos object for extGState .
voidASRealPoint PDEExtGStateGetHalfToneOrigin(IN PDEExtGState extGS)Returns HalfTone Co-ordinate point.
extGS: IN PDEExtGStateThe extended graphics state object.
ASRealPointASRealPoint* for x,y coordinate value of HalfToneOrigin.
ASBool PDEExtGStateGetOPFill(IN PDEExtGState pdeExtGState)Returns whether overprint is enabled for painting operations other than stroking.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
Returns the value of the / op key in the ExtGState dictionary. If the value is not found, the default value of false is returned.
ASInt32 PDEExtGStateGetOPM(IN PDEExtGState pdeExtGState)Returns the overprint mode used by this graphics state.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
The Cos integer value.
ASBool PDEExtGStateGetOPStroke(IN PDEExtGState pdeExtGState)Returns whether overprint is enabled for stroke painting operations.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
Returns the value of the / OP key in the ExtGState dictionary. If the value is not found, the default value of false is returned.
ASFixed PDEExtGStateGetOpacityFill(IN PDEExtGState pdeExtGState)Returns the opacity value for painting operations other than stroking.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
Returns the value of the / ca key in the ExtGState dictionary. If the value is not found, the default value of 1 is returned.
ASFixed PDEExtGStateGetOpacityStroke(IN PDEExtGState pdeExtGState)Returns the opacity value for stroke painting operations for paths and glyph outlines.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
Returns the value of the / CA key in the ExtGState dictionary. If the value is not found, the default value of 1 is returned.
ASBool PDEExtGStateGetSA(IN PDEExtGState pdeExtGState)Returns whether stroke adjustment is enabled in the graphics state.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
Returns the value of the / SA key in the ExtGState dictionary. If the value is not set, the default value of false is returned.
ASBool PDEExtGStateGetSoftMaskMatrix(IN PDEExtGState extGS, OUT ASDoubleMatrixP matrixP)Gets the softmask matrix from ExtGstate.
extGS: IN PDEExtGStatematrixP: OUT ASDoubleMatrixPASBool PDEExtGStateGetTK(IN PDEExtGState pdeExtGState)Returns whether text knockout is enabled in the graphics state.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
Returns the value of the / TK key in the ExtGState dictionary. If the value is not found, the default value of true is returned.
ASBool PDEExtGStateHasSoftMask(IN PDEExtGState pdeExtGState)Returns whether the graphics state contains a soft mask.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
Returns true if the ExtGState dictionary contains the / SMask key; otherwise false is returned.
void PDEExtGStateSetAIS(IN PDEExtGState pdeExtGState, IN ASBool alphaIsShape)Specifies if the alpha is to be interpreted as a shape or opacity mask.
pdeExtGState: IN PDEExtGStateThe extended graphics state object.
alphaIsShape: IN ASBoolIndicates 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.
voidvoid PDEExtGStateSetBPC(IN PDEExtGState extGS, IN ASAtom BPC)Sets the black point compensation. Valid names are ON, OFF and Default. An exception will be raised if the name is invalid.
extGS: IN PDEExtGStateThe extended graphics state object.
BPC: IN ASAtomNew value for BPC
voidvoid PDEExtGStateSetBlendMode(IN PDEExtGState pdeExtGState, IN ASAtom blendMode)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
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
blendMode: IN ASAtomIN/OUT The new blend mode.
voidvoid PDEExtGStateSetHalfToneOrigin(IN PDEExtGState extGS, IN ASRealPoint hto_point)Sets HalfTone Co-ordinate point.
extGS: IN PDEExtGStateThe extended graphics state object.
hto_point: IN ASRealPointvoidvoid PDEExtGStateSetOPFill(IN PDEExtGState pdeExtGState, IN ASBool overprint)Specifies if overprint is enabled for painting operations other than stroking. It corresponds to the / op key within the ExtGState's dictionary.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
overprint: IN ASBoolIN/OUT Pass true to enable overprint, false to disable overprint.
voidvoid PDEExtGStateSetOPM(IN PDEExtGState pdeExtGState, IN ASInt32 opm)Sets the overprint mode. It corresponds to the / OPM key within the ExtGState's dictionary.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
opm: IN ASInt32IN/OUT Overprint mode.
voidvoid PDEExtGStateSetOPStroke(IN PDEExtGState pdeExtGState, IN ASBool overprint)Specifies if overprint is enabled for stroke operations. It corresponds to the / OP key within the ExtGState's dictionary.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
overprint: IN ASBoolIN/OUT Pass true to enable overprint, false to disable overprint.
voidvoid PDEExtGStateSetOpacityFill(IN PDEExtGState pdeExtGState, IN ASFixed opacity)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().
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
opacity: IN ASFixedIN/OUT The new opacity value.
voidvoid PDEExtGStateSetOpacityStroke(IN PDEExtGState pdeExtGState, IN ASFixed opacity)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().
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
opacity: IN ASFixedIN/OUT The new opacity value.
voidvoid PDEExtGStateSetSA(IN PDEExtGState pdeExtGState, IN ASBool strokeAdjust)Specifies whether stroke adjustment is enabled in the graphics state.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
strokeAdjust: IN ASBoolIN/OUT Pass true to enable stroke adjustment, false to disable stroke adjustment.
voidvoid PDEExtGStateSetSoftMask(IN PDEExtGState pdeExtGState, IN PDESoftMask pdeSoftMask)Sets the soft mask of the extended graphics state.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
pdeSoftMask: IN PDESoftMaskIN/OUT The soft mask object.
voidvoid PDEExtGStateSetSoftMaskMatrix(IN PDEExtGState extGS, IN ASDoubleMatrixP matrixP)Sets the softmask matrix in ExtGstate.
extGS: IN PDEExtGStateIN A ExtGstate object.
matrixP: IN ASDoubleMatrixPIN A pointer to ASDoubleMatrix
voidvoid PDEExtGStateSetTK(IN PDEExtGState pdeExtGState, IN ASBool bk)Specifies whether text knockout is enabled in the graphics state. This corresponds to the / TK key in the ExtGState's dictionary.
pdeExtGState: IN PDEExtGStateIN/OUT The extended graphics state object.
bk: IN ASBoolIN/OUT Pass true to enable text knockout, false to disable text knockout.
voidtypedef struct _t_PDEExtGState* PDEExtGStateA 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.
39 items
Adds glyphs to a PDEFont object for embedding a PDEFont. This is used by clients that use PDEFEdit calls to embed the font but create their own content stream. The glyphs added by this routine will be included in the font when PDEFontSubsetNow() is called. It is up to the client to ensure that the encoding used by the PDEFont matches the character codes used in the string arguments to the text operators in the content stream. This routine is used to specify which glyphs should be included in the font when embedded. Additionally, it specifies the mapping from the GlyphIDs to Unicode values. This mapping will be used to create the ToUnicode entry in the embedded font object. In the cases where the ToUnicode table cannot accurately reproduce the Unicode string in the PDEGlyphRun structure, this routine will return an array of spans that describe the contents of the ActualText spans that must be included in the content stream. Each span indicates a contiguous range of glyphs and a corresponding contiguous range of Unicode values that correspond to the glyphs. For example, the following ActualText span replace two glyphs with three Unicode values. /Span<</ActualText(U+vvvvU+xxxU+yyyy)>> BDC [Giii Gjjj] TJ EMC Note that the routine must be called with the PDEGlyphRuns in display order.
pdeFont: IN PDEFontThe font for the element.
glyphRun: IN PDEGlyphRunPA pointer to a PDEGlyphRun structure with Unicode data, GlyphIDs and their correspondence. Note that the xPosition and yPosition fields in the PDEGlyphDescription structure are ignored.
flags: IN ASUns32Unused, reserved for later use.
PDESpanSetPA pointer to a PDESpanSet . The span can be released with PDEReleaseSpan().
PDEFont PDEFontCreate(IN PDEFontAttrsP attrsP, IN ASUns32 attrsSize, IN ASInt32 firstChar, IN ASInt32 lastChar, IN ASInt16 *widthsP, IN char **encoding, IN ASAtom encodingBaseName, IN ASStm fontStm, IN ASInt32 len1, IN ASInt32 len2, IN ASInt32 len3)Creates a new PDEFont from the specified parameters.
The PDEFont may be represented as an embedded font (a FontFile entry in the font descriptor of the PDF file). To create a PDEFont that is stored as an embedded font, the FontFile stream may be passed in fontStm, and the len1, len2, and len3 parameters contain the Length1, Length2, and Length3 values of the FontFile stream attributes dictionary. See the description of Embedded Font Programs in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 9.9, page 288. You can find this document on the web store of the International Standards Organization (ISO).
The caller must close fontStm with ASStmClose() after invoking PDEFontCreate().
Call PDERelease() to dispose of the returned font object when finished with it.
attrsP: IN PDEFontAttrsPattrsSize: IN ASUns32firstChar: IN ASInt32lastChar: IN ASInt32widthsP: IN ASInt16 *encoding: IN char **encodingBaseName: IN ASAtomfontStm: IN ASStmThe stream with font information.
len1: IN ASInt32The length in bytes of the ASCII portion of the Type 1 font file after it has been decoded. For other font formats, such as TrueType or CFF, only len1 is used, and it is the size of the font.
len2: IN ASInt32The length in bytes of the encrypted portion of the Type 1 font file after it has been decoded.
len3: IN ASInt32The length in bytes of the portion of the Type 1 font file that contains the 512 zeros, plus the cleartomark operator, plus any following data.
The specified PDEFont.
PDEFont PDEFontCreateFromCosObj(const CosObj *cosObjP)Creates a PDEFont corresponding to a Cos object of type Font. Call PDERelease() to dispose of the returned font object when finished with it.
cosObjP: const CosObj *IN/OUT The Cos object for which a PDEFont is created.
The PDEFont created from cosObjP.
PDEFont PDEFontCreateFromSysFont(IN PDSysFont sysFont, IN ASUns32 flags)Gets a PDEFont corresponding to a font in the system. Call PDERelease() to dispose of the returned font object when finished with it. The PDEFontCreateFlags flags kPDEFontCreateEmbedded and kPDEFontWillSubset must both be set in order to subset a font. If you create a PDEFont that is a subset, call PDEFontSubsetNow() on this font afterwards. If you want to use WinAnsiEncoding on UNIX, do not use this method. Use PDEFontCreateFromSysFontWithParams() or PDEFontCreateFromSysFontAndEncoding() instead.
sysFont: IN PDSysFontA PDSysFont object referencing a system font.
flags: IN ASUns32Indicates whether to embed the font and whether to subset the font. It must be one of PDEFontCreateFlags. If you want to subset a font, set both the kPDEFontCreateEmbedded and kPDEFontWillSubset flags.
The PDEFont corresponding to sysFont.
PDEFont PDEFontCreateFromSysFontAndEncoding(IN PDSysFont sysFont, IN PDSysEncoding sysEnc, IN ASAtom useThisBaseFont, IN ASUns32 createFlags)Create a PDEFont from sysFont and sysEnc . If it fails, it raises an exception. User can call PDSysFontGetCreateFlags() to see if the combination of sysFont and sysEnc makes sense. Call PDERelease() to dispose of the returned PDEFont object when finished with it. If you want to use WinAnsiEncoding on UNIX, use this method or PDEFontCreateFromSysFontWithParams().
sysFont: IN PDSysFontA PDSysFont object referencing a system font.
sysEnc: IN PDSysEncodingA PDSysEncoding object.
useThisBaseFont: IN ASAtomThe base font. An exception will be raised if the base font name passed is a subset name (XXXXXX+FontName) or an empty string.
createFlags: IN ASUns32One of the PDEFontCreateFlags.
The newly created PDEFont object.
PDEFont PDEFontCreateFromSysFontAndEncodingInCosDoc(IN PDSysFont sysFont, IN PDSysEncoding sysEnc, IN ASAtom useThisBaseFont, IN ASUns32 createFlags, IN CosDoc cosDoc)Creates a font object like PDEFontCreateFromSysFontAndEncoding(), except that the client can specify the CosDoc in which the font is created. Create a PDEFont from sysFont and sysEnc . If it fails, it raises an exception. User can call PDSysFontGetCreateFlags() to see if the combination of sysFont and sysEnc makes sense. Call PDERelease() to dispose of the returned PDEFont object when finished with it. If you want to use WinAnsiEncoding on UNIX, use this method or PDEFontCreateFromSysFontWithParams().
sysFont: IN PDSysFontA PDSysFont object referencing a system font.
sysEnc: IN PDSysEncodingA PDSysEncoding object.
useThisBaseFont: IN ASAtomThe base font. An exception will be raised if the base font name passed is a subset name (XXXXXX+FontName) or an empty string.
createFlags: IN ASUns32One of the PDEFontCreateFlags.
cosDoc: IN CosDocIN/OUT The document in which to put the Cos representation of resource. It may be NULL .
The newly created PDEFont object.
PDEFont PDEFontCreateFromSysFontEx(IN PDSysFont sysFont, IN ASUns32 flags, IN ASAtom snapshotName, IN ASFixed *mmDesignVec)Creates a PDEFont corresponding to a font in the system. If the font is a Multiple Master font, mmDesignVector points to the design vector, whose length must equal the number of design axes of the font. Call PDERelease() to dispose of the returned font object when finished with it. The PDEFontCreateFlags flags kPDEFontCreateEmbedded and kPDEFontWillSubset must both be set in order to subset a font. If you create a PDEFont that is subsetted, call PDEFontSubsetNow() on this font afterwards.
sysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a system font.
flags: IN ASUns32IN/OUT Indicates whether to embed the font and whether to subset the font. It must be one of PDEFontCreateFlags. If you want to subset a font, set both the kPDEFontCreateEmbedded and kPDEFontWillSubset flags.
snapshotName: IN ASAtomIN/OUT The name to be associated with this particular instantiation of the PDEFont.
mmDesignVec: IN ASFixed *IN/OUT A pointer to the Multiple Master font design vector.
The PDEFont corresponding to sysFont .
PDEFont PDEFontCreateFromSysFontExInCosDoc(IN PDSysFont sysFont, IN ASUns32 flags, IN ASAtom snapshotName, IN ASFixed *mmDesignVec, IN CosDoc cosDoc)Creates a font object like PDEFontCreateFromSysFontEx(), except that the client can specify the CosDoc in which the font is created. If the font is a Multiple Master font, mmDesignVector points to the design vector, whose length must equal the number of design axes of the font. Call PDERelease() to dispose of the returned font object when finished with it. The PDEFontCreateFlags flags kPDEFontCreateEmbedded and kPDEFontWillSubset must both be set in order to subset a font. If you create a PDEFont that is subsetted, call PDEFontSubsetNow() on this font afterwards.
sysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a system font.
flags: IN ASUns32IN/OUT Indicates whether to embed the font and whether to subset the font. It must be one of PDEFontCreateFlags. If you want to subset a font, set both the kPDEFontCreateEmbedded and kPDEFontWillSubset flags.
snapshotName: IN ASAtomIN/OUT The name to be associated with this particular instantiation of the PDEFont.
mmDesignVec: IN ASFixed *IN/OUT A pointer to the Multiple Master font design vector.
cosDoc: IN CosDocIN/OUT The document in which to put the Cos representation of resource. It may be NULL .
The PDEFont corresponding to sysFont .
Creates a font object like PDEFontCreateFromSysFont(), except that the client can specify the CosDoc in which the font is created. Call PDERelease() to dispose of the returned font object when finished with it. The PDEFontCreateFlags flags kPDEFontCreateEmbedded and kPDEFontWillSubset must both be set in order to subset a font. If you create a PDEFont that is a subset, call PDEFontSubsetNow() on this font afterwards. If you want to use WinAnsiEncoding on UNIX, do not use this method. Use PDEFontCreateFromSysFontWithParams() or PDEFontCreateFromSysFontAndEncoding() instead.
sysFont: IN PDSysFontA PDSysFont object referencing a system font.
flags: IN ASUns32Indicates whether to embed the font and whether to subset the font. It must be one of PDEFontCreateFlags. If you want to subset a font, set both the kPDEFontCreateEmbedded and kPDEFontWillSubset flags.
cosDoc: IN CosDocIN/OUT The document in which to put the Cos representation of resource. It may be NULL .
The PDEFont corresponding to sysFont .
PDEFont PDEFontCreateFromSysFontWithParams(IN PDSysFont sysFont, IN PDEFontCreateFromSysFontParams params)Used to obtain a PDEFont corresponding to a font in the system. Call PDERelease() to dispose of the returned PDEFont object when finished with it. If you want to use WinAnsiEncoding on UNIX, use this method or PDEFontCreateFromSysFontAndEncoding() instead.
sysFont: IN PDSysFontThe system font.
params: IN PDEFontCreateFromSysFontParamsThe parameters structure.
The newly created PDEFont object.
PDEFont PDEFontCreateInCosDoc(IN PDEFontAttrsP attrsP, IN ASUns32 attrsSize, IN ASInt32 firstChar, IN ASInt32 lastChar, IN ASInt16 *widthsP, IN char **encoding, IN ASAtom encodingBaseName, IN ASStm fontStm, IN ASInt32 len1, IN ASInt32 len2, IN ASInt32 len3, IN CosDoc cosDoc)Creates a font object like PDEFontCreate(), except that the client can specify the CosDoc in which the font is created. The PDEFont may be represented as an embedded font (a FontFile entry in the font descriptor of the PDF file). To create a PDEFont that is stored as an embedded font, the FontFile stream may be passed in fontStm , and the len1 , len2 , and len3 parameters contain the Length1 , Length2 , and Length3 values of the FontFile stream attributes dictionary. See the description of Embedded Font Programs in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 9.9, page 288. You can find this document on the web store of the International Standards Organization (ISO). The caller must close fontStm with ASStmClose() after invoking PDEFontCreate(). Call PDERelease() to dispose of the returned font object when finished with it.
attrsP: IN PDEFontAttrsPA pointer to a PDEFontAttrs structure for the font attributes.
attrsSize: IN ASUns32The size of the attrsP buffer in bytes.
firstChar: IN ASInt32The first character index for the widths array, widthsP .
lastChar: IN ASInt32The last character index for the widths array, widthsP .
widthsP: IN ASInt16 *A pointer to the widths array.
encoding: IN char **An array of 256 pointers to glyph names specifying the custom encoding. If any pointer is NULL , no encoding information is written for that entry.
encodingBaseName: IN ASAtomThe encoding base name if the encoding is a custom encoding. If the encoding is NULL , encodingBaseName is used as the value of the encoding, and must be one of WinAnsiEncoding , MacRomanEncoding , or MacExpertEncoding . If no encoding value is desired, use ASAtomNull.
fontStm: IN ASStmThe stream with font information.
len1: IN ASInt32The length in bytes of the ASCII portion of the Type 1 font file after it has been decoded. For other font formats, such as TrueType or CFF, only len1 is used, and it is the size of the font.
len2: IN ASInt32The length in bytes of the encrypted portion of the Type 1 font file after it has been decoded.
len3: IN ASInt32The length in bytes of the portion of the Type 1 font file that contains the 512 zeros, plus the cleartomark operator, plus any following data.
cosDoc: IN CosDocIN/OUT The document in which to put the Cos representation of resource. It may be NULL .
The specified PDEFont.
void PDEFontCreateToUnicodeNow(IN PDEFont font, IN CosDoc cosDoc)This function creates the / ToUnicode table. The user can check the return value of PDEFontGetCreateNeedFlags() to see if calling PDEFontCreateToUnicodeNow() is needed.
font: IN PDEFontIN/OUT An object of type PDEFont.
cosDoc: IN CosDocIN/OUT The container document.
voidvoid PDEFontCreateWidthsNow(IN PDEFont font, IN CosDoc cosDoc)This function creates width entries for font . User can check the return value of PDEFontGetCreateNeedFlags() to see if calling PDEFontCreateWidthsNow() is needed.
font: IN PDEFontIN/OUT The font for which to create width entries.
cosDoc: IN CosDocIN/OUT The container document.
voidPDEFont PDEFontCreateWithParams(IN PDEFontCreateParams params)Creates a new PDEFont from params.
The PDEFont may be represented as an embedded font (a FontFile value in PDF). To create a PDEFont that will be stored as an embedded font, the FontFile stream may be passed as fontStm, and the len1, len2, and len3 parameters contain the Length1, Length2, and Length3 values of the FontFile. The caller must close the fontStm after calling this method. This method supports multi-byte fonts.
This method extends PDEFontCreate() to support multi-byte fonts.
Call PDERelease() to dispose of the returned font object when finished with it.
params: IN PDEFontCreateParamsPDEFont PDEFontCreateWithParamsInCosDoc(IN PDEFontCreateParams params, IN CosDoc cosDoc)Creates a font object like PDEFontCreateWithParams(), except that the client can specify the CosDoc in which the font is created. Creates a new PDEFont from params . The PDEFont may be represented as an embedded font (a FontFile value in PDF). To create a PDEFont that will be stored as an embedded font, the FontFile stream may be passed as fontStm , and the len1 , len2 , and len3 parameters contain the Length1 , Length2 , and Length3 values of the FontFile. The caller must close the fontStm after calling this method. This method supports multi-byte fonts. This method extends PDEFontCreate() to support multi-byte fonts. Call PDERelease() to dispose of the returned font object when finished with it.
params: IN PDEFontCreateParamsIN/OUT A pointer to a structure containing all font parameters necessary to fully define a font.
cosDoc: IN CosDocIN/OUT The document in which to put the Cos representation of resource. It may be NULL .
A PDEFont object of the font described by the parameters.
void PDEFontEmbedNow(IN PDEFont font, IN CosDoc cosDoc)This function embeds a font stream. User can check the return value of PDEFontGetCreateNeedFlags() to see if calling PDEFontEmbedNow() is needed.
font: IN PDEFontThe font to embed.
cosDoc: IN CosDocThe container document.
voidvoid PDEFontEmbedNowDontSubset(IN PDEFont font, IN CosDoc cosDoc)Embeds the given PDEFont inside doc without creating a subset. Use this method instead of PDEFontSubsetNow() if you created the font with the willSubset flag but changed your mind.
font: IN PDEFontThe font to embed.
cosDoc: IN CosDocThe container document.
voidGets the attributes for a font object. PDEFontGetAttrs() cannot fill in the cantEmbed and protection fields. PDSysFontAttrs() can return this information to you for system fonts. PDEFontGetAttrs() fills in the fontBBox portion of the PDEFontAttrs as ASInt16 objects, even though the member says it is an ASFixedRect . Make sure to properly convert those values using ASInt16ToFixed() so that you get the proper ASFixedRect associated with that font.
font: IN PDEFontIN/OUT A PDEFont whose attributes are found.
attrsP: OUT PDEFontAttrsPIN/OUT (Filled by the method) A pointer to a PDEFontAttrs structure for the font attributes.
attrsSize: IN ASUns32IN/OUT The size of the attrsP buffer in bytes.
voidvoid PDEFontGetCosObj(IN PDEFont font, OUT CosObj *cosObjP)Gets a Cos object for a PDEFont.
font: IN PDEFontIN/OUT A PDEFont whose Cos object is obtained.
cosObjP: OUT CosObj *IN/OUT (Filled by the method) The Cos object corresponding to font .
voidThis function returns flags indicating what needs to be done to make PDEFont complete. kPDEFontCreateNeedWidths can be cleared by PDEFontCreateWidthsNow(). kPDEFontCreateNeedToUnicode can be cleared by PDEFontCreateToUnicodeNow(). kPDEFontCreateNeedEmbed can be cleared by PDEFontEmbedNow().
font: IN PDEFontThe font object.
A value corresponding to PDEFontCreateNeedFlags().
Gets the number of bytes comprising the next code in a string of single or multi-byte character codes.
font: IN PDEFontIN/OUT A PDEFont object returned from one of the PDEFontCreate methods.
text: IN ASUns8 *IN/OUT A pointer to a string of characters.
len: IN ASInt32IN/OUT The length, in bytes, of the string of characters, starting with the character pointed to by text.
The number of bytes in the next character code pointed to by text.
Gets an array of delta encodings for the given one byte PDEFont. For encodingDelta, see the description of encoding in the ISO 32000 document, 1.7 or 2.0. You can find this document on the web store of the International Standards Organization. The array must be allocated to hold 256 entries.
font: IN PDEFontIN/OUT A PDEFont object returned from one of the PDEFontCreate methods.
encodingDelta: OUT ASAtom *IN/OUT (Filled by the method) A pointer to an ASAtom array that is filled with the delta encodings for font. Each entry is the ASAtom for a glyph name that differs from the base encoding. For more information about font encodings see the description of Base Encoding in the Character Encoding section of the ISO 32000-1:2008, Document Management- Portable Document Format-Part 1: PDF 1.7, section 9.6.6, page 262.
true if encodingDelta is filled, false otherwise.
PDSysEncoding PDEFontGetSysEncoding(IN PDEFont pdeFont)Gets the system encoding object associated with a font object.
pdeFont: IN PDEFontA PDEFont whose system encoding is found.
The system encoding object.
PDSysFont PDEFontGetSysFont(IN PDEFont pdeFont)Gets the system font object associated with a font object.
pdeFont: IN PDEFontA PDEFont whose system font is found.
PDSysFontThe system font object.
void PDEFontGetWidths(IN PDEFont font, OUT ASInt16 *widthsP)Gets the widths for a font object.
font: IN PDEFontIN/OUT A PDEFont whose widths are found.
widthsP: OUT ASInt16 *IN/OUT (Filled by the method) A pointer to the widths array. widthsP must have room for 256 values. The widths are returned in character space (1000 EM units). An EM is a typographic unit of measurement equal to the size of a font. To convert to text space, divide the value returned by 1000 . To convert to user space, multiply the text space value by the font size.
voidvoid PDEFontGetWidthsNow(IN PDEFont font, IN CosDoc cosDoc)Gets a Type0 font's width information for only those characters used in the file. Call this routine when the font was created with the kPDEFontDeferWidths flag but without the kPDEFontCreateEmbedded flag (if the font is to be embedded, call PDEFontSubsetNow(), which also gets the width info).
font: IN PDEFontThe font whose widths are found.
cosDoc: IN CosDocThe container document.
voidASBool PDEFontIsEmbedded(IN PDEFont pdeFont)Tests whether a font is an embedded font in the document in which it was created.
pdeFont: IN PDEFontA PDEFont object to test.
true if the font is embedded, false if it is not, or if it was created in one document and embedded in a different document.
ASBool PDEFontIsMultiByte(IN PDEFont font)Tests whether a font contains any multi-byte characters.
font: IN PDEFontIN/OUT A PDEFont object returned from one of the PDEFontCreate methods to test.
true if the font contains any multi-byte characters, false otherwise.
void PDEFontSetSysEncoding(IN PDEFont pdeFont, IN PDSysEncoding sysEnc)Sets the system encoding object associated with a font object. Changing the system encoding may produce unexpected results.
pdeFont: IN PDEFontA PDEFont whose system encoding is set.
sysEnc: IN PDSysEncodingThe new system encoding object.
voidvoid PDEFontSetSysFont(IN PDEFont pdeFont, IN PDSysFont sysFont)Sets the system font object to be used with a font object that does not currently have a system font associated with it.
pdeFont: IN PDEFontA PDEFont whose system font is set.
sysFont: IN PDSysFontThe new system font object.
voidvoid PDEFontSubsetNow(IN PDEFont font, IN CosDoc cosDoc)Subsets a given PDEFont in a CosDoc. If you created font with PDEFontCreateFromSysFont(), you must have set both the kPDEFontCreateEmbedded and kPDEFontWillSubset set in the flags parameter, to be able to subset the font. This method does not change the reference count.
font: IN PDEFontIN/OUT The PDEFont to subset.
cosDoc: IN CosDocIN/OUT The CosDoc whose font is subsetted.
voidGets the sum of the widths of len characters from a string of single or multi-byte characters.
font: IN PDEFontA PDEFont object returned from one of the PDEFontCreate methods.
text: IN ASUns8 *A pointer to a string of characters.
len: IN ASInt32The length of string in bytes.
The width of the text string in EM space. (In EM space, the width of 'M' is about 1000 EM units).
ASUns32 PDEFontTranslateGlyphIdsToUnicode(IN PDEFont font, IN ASUns8 *text, IN ASUns32 textLen, OUT ASUns8 *unicodeStr, IN ASUns32 size)Translates a string to Unicode values. The PDEFont must have a / ToUnicode table.
font: IN PDEFontIN/OUT The font.
text: IN ASUns8 *IN/OUT The string to convert.
textLen: IN ASUns32IN/OUT The length of text in bytes.
unicodeStr: OUT ASUns8 *IN/OUT (Filled by the method) A buffer to hold the translated string.
size: IN ASUns32IN/OUT The size of the unicodeStr buffer.
0 if the string was successfully translated. If unicodeStr is too small for the translated string, it returns the number of bytes required.
void PDEReleaseSpan(IN PDESpanSetP pdeSpan)Releases a PDESpan object that is returned by PDEFontAddGlyphs().
pdeSpan: IN PDESpanSetPvoidFlags for PDEFontCreateFromSysFont() . If you want to subset a font, set both the kPDEFontCreateEmbedded and kPDEFontWillSubset flags.
Embed the font. Create an embedded font. By itself, this will not subset the font.
Subset the font. If you want to subset a font, set both the kPDEFontCreateEmbedded and kPDEFontWillSubset flags. You must call PDEFontSubsetNow() to actually subset the font. Both embedding and subsetting a font creates a CFF font.
Do not embed the font. You cannot set both this and the kPDEFontWillSubset flags. Nor can you set kPDEFontCreateEmbedded .
Create a CIDFont with identity (GID) encoding.
Wait to get the widths until later (this affects Type0 fonts only).
PDFLib will convert cp to gid with identity embedded.
Create a ToUnicode CMap.
Supply the entire widths table (this affects Type0 fonts only).
Embed an OpenType style font subset, if appropriate.
Reserved for internal usage
Create CIDSet entry from all CIDs present in subsetted Type0 CID Fonts containing glyph descriptions based on identity encoded TrueType fonts (subtype CIDFontType2). Subsetted identity encoded Type0 fonts can have more glyphs than asked for to avoid glyph renumbering. Default behavior is to only include CIDs used in PDF page content stream in CIDset
If kPDEFontThrowIfToUnicodeUsesPUA flag is passed along with kPDEFontCreateToUnicode and kPDEFontCreateSubset, throw error in PDEFont embedding APIs if the created ToUnicode table contains Private Use Area (Range: E000-F8FF in plane 0 and Supplemental Private Use Area A & B) Unicode values
Reserved for internal usage - This flag is passed if PDEFont is used with Text rendering mode 3(Invisible)
While converting to PDFXxx and PDFAxx if fetched fontfile stream data from Cooltype is empty (NULL) , then with this flag enabled entire fontfile stream data from input file is copied to embedded font in output file
It is necessary to to create the width.
It is necessary to to create the ToUnicode stream.
It is necessary to to embed it.
0x00000002Flags for protection of PDEFontAttrs : editable embedding is not allowed.
0x00000001Flags for protection of PDEFontAttrs : embedding is not allowed.
18 items
PDEXGroup PDEFormAcquireXGroup(IN PDEForm pdeForm)Acquires the transparency group dictionary of the XObject form. Call PDERelease() to dispose of the PDEXGroup when finished with it.
pdeForm: IN PDEFormIN/OUT The from.
The transparency group object.
PDEForm PDEFormCreateClone(IN PDEForm form)Creates a new form from an existing form object. Creates a copy of the PDEForm, including the underlying CosStream. Call PDERelease() to dispose of the returned PDEForm object when finished with it.
form: IN PDEFormThe form object from which a new PDEForm is created.
The newly created form object.
PDEForm PDEFormCreateFromCosObj(IN const CosObj *xObjectP, IN const CosObj *resourcesP, IN ASFixedMatrixP matrixP)Superseded by PDEFormCreateFromCosObjEx() in Acrobat 10.0. Creates a new form from an existing Cos object. Call PDERelease() to dispose of the returned form object when finished with it.
xObjectP: IN const CosObj *The Cos object from which a PDEForm is created.
resourcesP: IN const CosObj *The xObjectP parameter's Resources dictionary. If you do not pass in a Resource object, subsequent calls to PDPageAcquirePDEContent() will fail (after the file is saved).
matrixP: IN ASFixedMatrixPA pointer to an ASFixedMatrix that holds the transformation matrix to use for the form.
The newly created form object.
PDEForm PDEFormCreateFromCosObjEx(IN const CosObj *xObjectP, IN const CosObj *resourcesP, IN ASDoubleMatrixP matrixP)Creates a new form from an existing Cos object. Supersedes PDEFormCreateFromCosObj() in Acrobat 10.0. Call PDERelease() to dispose of the returned form object when finished with it.
xObjectP: IN const CosObj *The Cos object from which a PDEForm is created.
resourcesP: IN const CosObj *The xObjectP parameter's Resources dictionary. If you do not pass in a Resource object, subsequent calls to PDPageAcquirePDEContent() will fail (after the file is saved).
matrixP: IN ASDoubleMatrixPA pointer to an ASDoubleMatrix that holds the transformation matrix to use for the form.
The newly created form object.
void PDEFormGetBBox(IN PDEForm form, OUT ASFixedRectP bboxP)Gets the bounding box for a PDEform. The result is the concatenation of the CTM and the Cos level form matrix applied on cos level bounding box. The returned bounding box is guaranteed to encompass the PDEForm, but is not guaranteed to be the smallest box that could contain the form object. Note: For other elements, PDEElementGetBBox() would return the correct bounding box values.
form: IN PDEFormThe PDEForm for which the bounding box is required.
bboxP: OUT ASFixedRectPThe resulting bounding box.
voidPDEContent PDEFormGetContent(IN PDEForm form)Gets a PDEContent object for a form. Unlike other GetContent methods, this method does increment the reference count of the returned PDEContent. Call PDERelease() to dispose of the returned PDEContent object when finished with it.
form: IN PDEFormThe form whose content is obtained.
The content for form .
Retrieves the PDEContentToCosObjFlags for this form. The flags were previously set by PDEFormSetContentToCosObjFlags() .
form: IN PDEFormvoid PDEFormGetCosObj(IN PDEForm form, OUT CosObj *cosObjP)Gets a Cos object for a form.
form: IN PDEFormIN/OUT The form whose Cos object is obtained.
cosObjP: OUT CosObj *IN/OUT (Filled by the method) The Cos object for the form.
voidASDouble PDEFormGetLeading(IN PDEForm form)Gets the Leading set in parent of PDEForm element.
form: IN PDEFormIN A form XObject object.
void PDEFormGetMatrix(IN PDEForm form, OUT ASFixedMatrixP matrixP)Superseded by PDEFormGetMatrixEx() in Acrobat 10.0. Gets the matrix for a PDEform. The result is a concatenation of the CTM and the Cos level form matrix, resulting in the transformation from the form space to the device space. For the other elements, PDEElementGetMatrix() would give correct results.
form: IN PDEFormThe form for which the matrix is required.
matrixP: OUT ASFixedMatrixPThe resultant matrix.
voidvoid PDEFormGetMatrixEx(IN PDEForm form, OUT ASDoubleMatrixP matrixP)Gets the matrix for a PDEform. Supersedes PDEFormGetMatrix() in Acrobat 10.0. The result is a concatenation of the CTM and the Cos level form matrix, resulting in the transformation from the form space to the device space. For the other elements, PDEElementGetMatrixEx() would give correct results.
form: IN PDEFormThe form for which the matrix is required.
matrixP: OUT ASDoubleMatrixPThe resultant matrix.
voidASBool PDEFormHasXGroup(IN PDEForm pdeForm)Determines whether the XObject form has a Transparency XGroup
pdeForm: IN PDEFormIN/OUT The form.
true if the XObject form has a Transparency XGroup.
ASBool PDEFormIsLeadingSet(IN PDEForm form)Returns whether text leading is set in parent of PDEForm element or not.
form: IN PDEFormIN A form XObject object.
void PDEFormSetContent(IN PDEForm form, IN PDEContent content)Sets the underlying CosStream of the form using the specified content object.
form: IN PDEFormThe form whose content is set.
content: IN PDEContentThe new content for form .
voidvoid PDEFormSetContentToCosObjFlags(IN PDEForm form, IN ASUns32 flags)Sets the PDEContentToCosObjFlags for this form.
form: IN PDEFormflags: IN ASUns32voidvoid PDEFormSetLeading(IN PDEForm form, IN ASDouble Leading)Sets the Leading in parent of PDEForm element before form emit.
form: IN PDEFormIN A form XObject object.
Leading: IN ASDoublevoidvoid PDEFormSetXGroup(IN PDEForm pdeForm, IN PDEXGroup pdeXGroup)Sets the transparency group dictionary of the form XObject.
pdeForm: IN PDEFormIN/OUT The font XObject.
pdeXGroup: IN PDEXGroupIN/OUT The transparency dictionary.
voidtypedef struct _t_PDEForm* PDEFormA PDEElement that corresponds to an instance of an XObject Form on a page (or another containing stream such as another XObject Form or annotation form). The context associated with this instance includes the actual CosObj stream that represents the XObject Form and the initial conditions of the graphics state. The latter consists of the transformation matrix, initial color values, and so forth. It is possible to have two PDEForm objects that refer to the same XObject Form. The forms will exist at different places on the same page, depending on the transformation matrix. They may also have different colors or line stroking parameters. In the case of a transparency group, the opacity is specified in the gstate . Within a PDEForm, each PDEElement has its own gstate (or is a container, place, or group object). These gstates are independent of the parent PDEForm gstate . PDEForm elements within the PDEForm may have their own opacity. A PDEContent may be obtained from a PDEForm to edit the form's display list.
1 items
4 items
PDEGroup PDEGroupCreate(void)Creates a PDEGroup object. Call PDERelease() to dispose of the returned PDEGroup object when finished with it.
: voidThe newly created PDEGroup.
PDEContent PDEGroupGetContent(IN PDEGroup pdeGroup)Gets the PDEContent for a PDEGroup. This method does not change the reference count of the returned PDEContent.
pdeGroup: IN PDEGroupIN/OUT The group whose content is obtained.
The PDEContent in pdeGroup .
void PDEGroupSetContent(IN PDEGroup pdeGroup, IN PDEContent pdeContent)Sets the PDEContent for a PDEGroup. The existing PDEContent is released by this method. This method increments the reference count of pdeContent .
pdeGroup: IN PDEGroupIN/OUT A container object.
pdeContent: IN PDEContentIN/OUT The content to set for pdeGroup .
voidtypedef struct _t_PDEGroup* PDEGroupAn in-memory representation of objects in a PDEContent object. It has no state and is not represented in any way in a PDF content stream (that is, PDEContent). When used in a PDEClip, this object is used to associate PDEText objects into a single clipping object.
37 items
Acquires the PDEImageFlate resource of the PDEImage content element when the image filter type is "FlateDecode" , or 0 if it is not. Call PDERelease() to dispose of the PDEImageFlate when finished with it.
image: IN PDEImageIN/OUT The PDEImage object.
a PDEImageFlate resource object.
Acquires the PDEImageJPX resource of the PDEImage content element when the image filter type is "JPXDecode" , or 0 if it is not. Call PDERelease() to dispose of the PDEImageJPX when finished with it.
image: IN PDEImageIN/OUT The PDEImage object.
a PDEImageJPX resource object.
PDEImage PDEImageCreate(IN PDEImageAttrsP attrsP, IN ASUns32 attrsSize, IN ASFixedMatrixP matrixP, IN ASUns32 flags, IN PDEColorSpace colorSpace, IN PDEColorValueP colorValueP, IN PDEFilterArrayP filtersP, IN ASStm dataStm, IN ASUns8 *data, IN ASUns32 encodedLen)Superseded by PDEImageCreateEx() in Acrobat 10.0. Creates an image object. The image data may be specified as a stream or as a buffer. If data is non- NULL , dataStm is ignored. See PDEImageSetDataStm() for information on handling the stream. The caller must dispose of dataStm after calling this method. Call PDERelease() to dispose of the returned image object when finished with it.
attrsP: IN PDEImageAttrsPIN/OUT A pointer to a PDEImageAttrs object with attributes of the image.
attrsSize: IN ASUns32IN/OUT The size of the attrsP buffer in bytes.
matrixP: IN ASFixedMatrixPIN/OUT A pointer to an ASFixedMatrix that holds the transformation matrix to use for the image.
flags: IN ASUns32IN/OUT PDEImageDataFlags flags. If the kPDEImageEncodedData flag is set, and the data is provided directly (not as a stream), then encodedLen must specify the length of data.
colorSpace: IN PDEColorSpaceIN/OUT The color space of the image. When the image is an image mask, colorSpace is the color space of the colorValueP argument.
colorValueP: IN PDEColorValuePIN/OUT A pointer to a PDEColorValue structure. If the image is an image mask, colorValueP must be provided.
filtersP: IN PDEFilterArrayPIN/OUT A pointer to a PDEFilterArray structure that specifies which filters to use in encoding the contents; it may be NULL . Filters will be used to encode the data in the order in which they are specified in the array.
dataStm: IN ASStmIN/OUT The stream holding the image data.
data: IN ASUns8 *IN/OUT The image data. If data is non- NULL , dataStm is ignored. If there is a great deal of data, as for a large image, it is recommended you use the dataStm parameter for the image data or use the PDEImageCreateFromCosObj() method.
encodedLen: IN ASUns32IN/OUT The encoded length of data in bytes.
The image.
PDEImage PDEImageCreateEx(IN PDEImageAttrsP attrsP, IN ASUns32 attrsSize, IN ASDoubleMatrixP matrixP, IN ASUns32 flags, IN PDEColorSpace colorSpace, IN PDEColorValueP colorValueP, IN PDEFilterArrayP filtersP, IN ASStm dataStm, IN ASUns8 *data, IN ASUns64 encodedLen)Creates an image object. Supersedes PDEImageCreate() in Acrobat 10.0. The image data may be specified as a stream or as a buffer. If dataStm is non- NULL , data is ignored. See PDEImageSetDataStm() for information on handling the stream. The caller must dispose of dataStm after calling this method. Call PDERelease() to dispose of the returned image object when finished with it.
attrsP: IN PDEImageAttrsPIN/OUT A pointer to a PDEImageAttrs object with attributes of the image.
attrsSize: IN ASUns32IN/OUT The size of the attrsP buffer in bytes.
matrixP: IN ASDoubleMatrixPIN/OUT A pointer to an ASDoubleMatrix that holds the transformation matrix to use for the image.
flags: IN ASUns32IN/OUT PDEImageDataFlags flags. If the kPDEImageEncodedData flag is set, and the data is provided directly (not as a stream), then encodedLen must specify the length of data.
colorSpace: IN PDEColorSpaceIN/OUT The color space of the image. When the image is an image mask, colorSpace is the color space of the colorValueP argument.
colorValueP: IN PDEColorValuePIN/OUT A pointer to a PDEColorValue structure. If the image is an image mask, colorValueP must be provided.
filtersP: IN PDEFilterArrayPIN/OUT A pointer to a PDEFilterArray structure that specifies which filters to use in encoding the contents; it may be NULL . Filters will be used to encode the data in the order in which they are specified in the array.
dataStm: IN ASStmIN/OUT The stream holding the image data.
data: IN ASUns8 *IN/OUT The image data. If dataStm is non- NULL , data is ignored. If there is a great deal of data, as for a large image, it is recommended you use the dataStm parameter for the image data or use the PDEImageCreateFromCosObjEx() method.
encodedLen: IN ASUns64IN/OUT The encoded length of data in bytes.
The image.
PDEImage PDEImageCreateFromCosObj(IN const CosObj *imageObjP, IN ASFixedMatrixP matrixP, IN PDEColorSpace colorSpace, IN PDEColorValueP colorValueP)Superseded by PDEImageCreateFromCosObjEx() in Acrobat 10.0. Creates an image object from a Cos object. Call PDERelease() to dispose of the returned image object when finished with it.
imageObjP: IN const CosObj *IN/OUT The Cos object for the image.
matrixP: IN ASFixedMatrixPIN/OUT A pointer to an ASFixedMatrix that holds the transformation matrix to use for the image.
colorSpace: IN PDEColorSpaceIN/OUT The color space used for the image, if the image is an image mask; otherwise, set it to NULL .
colorValueP: IN PDEColorValuePIN/OUT A pointer to a PDEColorValue structure. If the image is an image mask, colorValueP must be provided.
An image corresponding to the Cos object.
PDEImage PDEImageCreateFromCosObjEx(IN const CosObj *imageObjP, IN ASDoubleMatrixP matrixP, IN PDEColorSpace colorSpace, IN PDEColorValueP colorValueP)Creates an image object from a Cos object. Supersedes PDEImageCreateFromCosObj() in Acrobat 10.0. Call PDERelease() to dispose of the returned image object when finished with it.
imageObjP: IN const CosObj *IN/OUT The Cos object for the image.
matrixP: IN ASDoubleMatrixPIN/OUT A pointer to an ASDoubleMatrix that holds the transformation matrix to use for the image.
colorSpace: IN PDEColorSpaceIN/OUT The color space used for the image, if the image is an image mask; otherwise, set it to NULL .
colorValueP: IN PDEColorValuePIN/OUT A pointer to a PDEColorValue structure. If the image is an image mask, colorValueP must be provided.
An image corresponding to the Cos object.
PDEImage PDEImageCreateInCosDoc(IN PDEImageAttrsP attrsP, IN ASUns32 attrsSize, IN ASFixedMatrixP matrixP, IN ASUns32 flags, IN PDEColorSpace colorSpace, IN PDEColorValueP colorValueP, IN PDEFilterArrayP filtersP, IN ASStm dataStm, IN ASUns8 *data, IN ASUns32 encodedLen, IN CosDoc cosDoc)Superseded by PDEImageCreateInCosDocEx() in Acrobat 10.0. Creates an image object like PDEImageCreate(), except that the client can specify the CosDoc in which the image is created. The image data may be specified as a stream or as a buffer. If data is non- NULL , dataStm is ignored. See PDEImageSetDataStm() for information on handling the stream. The caller must dispose of dataStm after calling this method. Call PDERelease() to dispose of the returned image object when finished with it.
attrsP: IN PDEImageAttrsPIN/OUT A pointer to a PDEImageAttrs object with attributes of the image.
attrsSize: IN ASUns32IN/OUT The size of the attrsP buffer in bytes.
matrixP: IN ASFixedMatrixPIN/OUT A pointer to an ASFixedMatrix that holds the transformation matrix to use for the image.
flags: IN ASUns32IN/OUT PDEImageDataFlags flags. If the kPDEImageEncodedData flag is set, and the data is provided directly (not as a stream), then encodedLen must specify the length of data.
colorSpace: IN PDEColorSpaceIN/OUT The color space of the image. When the image is an image mask, colorSpace is the color space of the colorValueP argument.
colorValueP: IN PDEColorValuePIN/OUT A pointer to a PDEColorValue structure. If the image is an image mask, colorValueP must be provided.
filtersP: IN PDEFilterArrayPIN/OUT A pointer to a PDEFilterArray structure that specifies which filters to use in encoding the contents; it may be NULL . Filters will be used to encode the data in the order in which they are specified in the array.
dataStm: IN ASStmIN/OUT The stream holding the image data.
data: IN ASUns8 *IN/OUT The image data. If data is non- NULL , dataStm is ignored. If there is a great deal of data, as for a large image, it is recommended you use the dataStm parameter for the image data or use the PDEImageCreateFromCosObj() method.
encodedLen: IN ASUns32IN/OUT The encoded length of data in bytes.
cosDoc: IN CosDocIN/OUT Document in which to put Cos representation of resource. May be NULL.
The image.
PDEImage PDEImageCreateInCosDoc64(IN PDEImageAttrsP attrsP, IN ASUns32 attrsSize, IN ASFixedMatrixP matrixP, IN ASUns32 flags, IN PDEColorSpace colorSpace, IN PDEColorValueP colorValueP, IN PDEFilterArrayP filtersP, IN ASStm dataStm, IN ASUns8 *data, IN ASUns64 encodedLen, IN CosDoc cosDoc)Superseded by PDEImageCreateInCosDocEx() in Acrobat 10.0. Creates an image object like PDEImageCreateInCosDoc(), except that the client can create an image with a large amount of data. The image data may be specified as a stream or as a buffer. If data is non- NULL , dataStm is ignored. See PDEImageSetDataStm() for information on handling the stream. The caller must dispose of dataStm after calling this method. Call PDERelease() to dispose of the returned image object when finished with it.
attrsP: IN PDEImageAttrsPIN/OUT A pointer to a PDEImageAttrs object with attributes of the image.
attrsSize: IN ASUns32IN/OUT The size of the attrsP buffer in bytes.
matrixP: IN ASFixedMatrixPIN/OUT A pointer to an ASFixedMatrix that holds the transformation matrix to use for the image.
flags: IN ASUns32IN/OUT PDEImageDataFlags flags. If the kPDEImageEncodedData flag is set, and the data is provided directly (not as a stream), then encodedLen must specify the length of data.
colorSpace: IN PDEColorSpaceIN/OUT The color space of the image. When the image is an image mask, colorSpace is the color space of the colorValueP argument.
colorValueP: IN PDEColorValuePIN/OUT A pointer to a PDEColorValue structure. If the image is an image mask, colorValueP must be provided.
filtersP: IN PDEFilterArrayPIN/OUT A pointer to a PDEFilterArray structure that specifies which filters to use in encoding the contents; it may be NULL . Filters will be used to encode the data in the order in which they are specified in the array.
dataStm: IN ASStmIN/OUT The stream holding the image data.
data: IN ASUns8 *IN/OUT The image data. If data is non- NULL , dataStm is ignored. If there is a great deal of data, as for a large image, it is recommended you use the dataStm parameter for the image data or use the PDEImageCreateFromCosObj() method.
encodedLen: IN ASUns64IN/OUT The encoded length of data in bytes.
cosDoc: IN CosDocIN/OUT The document in which to put the Cos representation of the resource. It may be NULL .
The image.
PDEImage PDEImageCreateInCosDocEx(IN PDEImageAttrsP attrsP, IN ASUns32 attrsSize, IN ASDoubleMatrixP matrixP, IN ASUns32 flags, IN PDEColorSpace colorSpace, IN PDEColorValueP colorValueP, IN PDEFilterArrayP filtersP, IN ASStm dataStm, IN ASUns8 *data, IN ASUns64 encodedLen, IN CosDoc cosDoc)Creates an image object like PDEImageCreateInCosDoc(), except that the client can create an image with a large amount of data, and using a double precision transformation matrix. Supersedes PDEImageCreateInCosDoc() and PDEImageCreateInCosDoc64() in Acrobat 10.0. The image data may be specified as a stream or as a buffer. If dataStm is non- NULL , data is ignored. See PDEImageSetDataStm() for information on handling the stream. The caller must dispose of dataStm after calling this method. Call PDERelease() to dispose of the returned image object when finished with it.
attrsP: IN PDEImageAttrsPIN/OUT A pointer to a PDEImageAttrs object with attributes of the image.
attrsSize: IN ASUns32IN/OUT The size of the attrsP buffer in bytes.
matrixP: IN ASDoubleMatrixPIN/OUT A pointer to an ASDoubleMatrix that holds the transformation matrix to use for the image.
flags: IN ASUns32IN/OUT PDEImageDataFlags flags. If the kPDEImageEncodedData flag is set, and the data is provided directly (not as a stream), then encodedLen must specify the length of data.
colorSpace: IN PDEColorSpaceIN/OUT The color space of the image. When the image is an image mask, colorSpace is the color space of the colorValueP argument.
colorValueP: IN PDEColorValuePIN/OUT A pointer to a PDEColorValue structure. If the image is an image mask, colorValueP must be provided.
filtersP: IN PDEFilterArrayPIN/OUT A pointer to a PDEFilterArray structure that specifies which filters to use in encoding the contents; it may be NULL . Filters will be used to encode the data in the order in which they are specified in the array.
dataStm: IN ASStmIN/OUT The stream holding the image data.
data: IN ASUns8 *IN/OUT The image data. If dataStm is non- NULL , data is ignored. If there is a great deal of data, as for a large image, it is recommended you use the dataStm parameter for the image data or use the PDEImageCreateFromCosObjEx() method.
encodedLen: IN ASUns64IN/OUT The encoded length of data in bytes.
cosDoc: IN CosDocIN/OUT The document in which to put the Cos representation of the resource. It may be NULL .
The image.
Determines if image data is encoded or not. It is used only for inline images; it is not relevant to XObject images.
It always returns false for XObject images; XObject image data can be obtained from PDEImageGetData() or PDEImageGetDataStm(), either encoded or decoded.
If an inline image is obtained via PDEContentCreateFromCosObj() or related methods, the inline image data is always decoded. That is, if PDFEdit parses the stream, the data is always decoded. Only if PDEImageCreate() is used to explicitly create a new image using encoded data does PDEImageDataIsEncoded() return true.
image: IN PDEImageencodedLenP: OUT ASUns32 *void PDEImageGetAttrs(IN PDEImage image, IN PDEImageAttrsP attrsP, IN ASUns32 attrsSize)Gets the attributes for an image.
image: IN PDEImageIN/OUT The image whose attributes are obtained.
attrsP: IN PDEImageAttrsPIN/OUT (Filled by the method) A pointer to a PDEImageAttrs structure with attributes of image.
attrsSize: IN ASUns32IN/OUT The size of the attrsP buffer in bytes.
voidGets the color space object for an image. This method does not change the reference count of the returned PDEColorSpace.
image: IN PDEImagePDEColorSpace PDEImageGetColorSpaceEx(IN PDEImage image, IN ASUns32 flags)Retrieves a PDEImage object's color space, in the desired bits per component, based on the flags parameter.
image: IN PDEImageIN The PDEImage instance whose color space is desired.
flags: IN ASUns32IN A set of flags to specify the desired bits per component (bpc) of the returned color space.
void PDEImageGetCosObj(IN PDEImage image, OUT CosObj *cosObjP)Gets a Cos object for an image.
image: IN PDEImageIN/OUT The image whose Cos object is obtained.
cosObjP: OUT CosObj *IN/OUT (Filled by the method) The Cos object for the image.
voidGets an image's data. If the image is an XObject image, data is always returned as decoded data. See the note about inline images under PDEImageDataIsEncoded().
image: IN PDEImageIN/OUT The image whose data is obtained.
flags: IN ASUns32IN/OUT Unused - must be zero.
buffer: IN ASUns8 *IN/OUT The image data. If the data is decoded, buffer must be large enough to contain the number of bytes specified in the PDEImageAttrs structure obtained by PDEImageGetAttrs(). If the data is encoded, buffer must be large enough to contain the number of bytes in the encodedLenP parameter obtained by PDEImageDataIsEncoded().
voidASInt32 PDEImageGetDataLen(IN PDEImage image)Gets the length of data for an image.
image: IN PDEImageIN/OUT The image whose data length is obtained.
The number of bytes of image data, specified by the width, height, bits per component, and color space of the image.
ASInt64 PDEImageGetDataLen64(IN PDEImage image)Gets the length of data for an image.
image: IN PDEImageIN/OUT The image whose data length is obtained.
The number of bytes of image data, specified by the width, height, bits per component, and color space of the image. Clients should switch to this routine. PDEImageGetDataLen() will raise an error if it encounters an image with a length that is larger than 2^31 - 1 .
Gets a data stream for an image. It may only be called for XObject images. The caller must dispose of the returned ASStm by calling ASStmClose.
image: IN PDEImageIN/OUT The image whose data stream is obtained.
flags: IN ASUns32IN/OUT PDEImageDataFlags flags. If the kPDEImageEncodedData flag is set, data is returned in encoded form. Otherwise, data is decoded.
The stream for the image.
Gets the decode array from the attributes of the image. This array specifies the parameters used with the array of filters used to decode the image. This should be called first with a NULL decode to obtain the number of elements that may be returned so that a properly sized array can be allocated for a subsequent call. There are two decode entries per colorant in normal use.
image: IN PDEImageThe image whose decode array is obtained.
decode: OUT ASFixed *(Filled by the method) A pointer to the decode array. If it is NULL , the number of decode elements required is returned.
decodeSize: IN ASUns32The number of elements in decode .
The number of elements in the decode array.
ASInt32 PDEImageGetFilterArray(IN PDEImage image, OUT PDEFilterArrayP filtersP)Gets the filter array for an image.
image: IN PDEImageIN/OUT The image whose filter array is obtained.
filtersP: OUT PDEFilterArrayPIN/OUT (Filled by the method) A pointer to PDEFilterArray structure to fill with the current filter array for the image. filtersP must be large enough to contain all of the elements. It may be NULL to obtain the number of filter elements.
The number of filter elements.
image: IN PDEImageIN/OUT The image XObject.
matte: OUT ASFixed *IN/OUT (Filled by the method) An array of values.
numComp: IN ASUns32IN/OUT The number of values in matte .
The number of values copied.
PDEImage PDEImageGetSMask(IN PDEImage image)Gets the soft mask for an image. Use PDERelease() to dispose of the object when it is no longer referenced.
image: IN PDEImageAn object of type PDEImage.
An object of type PDEImage.
ASAtom PDEImageGetType(IN PDEImage image)Returns the type of image as "FlateDecode" , "JPXDecode" , or "Unknown" when the image filter is not one of these types.
image: IN PDEImageIN/OUT The PDEImage object.
See above.
ASBool PDEImageHasSMask(IN PDEImage image)Checks whether the image has a soft mask.
image: IN PDEImageIN/OUT An object of type PDEImage.
true if the soft mask exists, false otherwise.
ASBool PDEImageIsCosObj(IN PDEImage image)Determines if an image is an XObject image.
image: IN PDEImageIN/OUT The image to examine.
true if the image is an XObject image, false otherwise.
void PDEImageSetColorSpace(IN PDEImage image, IN PDEColorSpace space)Sets the color space of the image.
image: IN PDEImageIN/OUT The image whose color space is obtained.
space: IN PDEColorSpaceIN/OUT An object of type PDEColorSpace.
voidvoid PDEImageSetColorValue(IN PDEImage image, IN PDEColorValueP color)Sets an image's Color Value. This call is valid only for a PDEImage which is an Image Mask
image: IN PDEImageIN/OUT The image whose data is set.
color: IN PDEColorValuePvoidimage: IN PDEImageIN/OUT The image whose data is set.
flags: IN ASUns32IN/OUT A set of PDEImageDataFlags flags. If kPDEImageEncodedData is set, the data must be encoded for the current filters, and encodedLen is the length of the encoded data. If the kPDEImageEncodedData flag is not set, data is not encoded and encodedLen is the size of the decoded data.
buffer: IN ASUns8 *IN/OUT The image data.
encodedLen: IN ASUns32IN/OUT The length of the encoded data.
voidvoid PDEImageSetDataStm(IN PDEImage image, IN ASUns32 flags, IN PDEFilterArrayP filtersP, IN ASStm stm)Sets a data stream for an image. It can only be used for XObject images. The caller must dispose of the stream by calling ASStmClose().
image: IN PDEImageIN/OUT The image whose data stream is set.
flags: IN ASUns32IN/OUT PDEImageDataFlags flags. If the kPDEImageEncodedData flag is set, the stream must be encoded.
filtersP: IN PDEFilterArrayPIN/OUT A pointer to a PDEFilterArray structure. If it is not NULL , it is used to build Cos objects for the Filter, DecodeParms, and EncodeParms objects. If filtersP is NULL and kPDEImageEncodedData is set in flags , the existing Filter and DecodeParms are used. If kPDEImageEncodedData is not set and filtersP is NULL , the existing Cos objects (if any) for Filter and DecodeParms are removed and the resulting image is no longer compressed. EncodeParms is set it to DecodeParms if it exists (unless the filter is DCTDecode, for which EncodeParms is mandatory).
stm: IN ASStmIN/OUT The stream for the image data.
voidSets the decode array of an image. Normally, the decode array is accessed through the decode field in the PDEImageAttrs structure. However, this method defines a decode array to handle images with a color space that has more than four components.
image: IN PDEImageThe image whose decode array is set.
decode: IN ASFixed *A pointer to the decode array.
decodeSize: IN ASUns32The number of elements in the decode array.
voidimage: IN PDEImageIN/OUT The image XObject.
matte: IN ASFixed *IN/OUT An array of values.
numComp: IN ASUns32IN/OUT The number of values in mArray.
voidvoid PDEImageSetSMask(IN PDEImage image, IN PDEImage sMask)Sets the soft mask.
image: IN PDEImageIN/OUT The image XObject.
sMask: IN PDEImageIN/OUT The soft mask.
voidFlags for PDEImageAttrs. See the description of image attributes in "Image Dictionaries" in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 8.9.5, page 206. You can find this document on the web store of the International Standards Organization (ISO).
The image is an XObject.
The image is an imagemask.
interpolate is true .
The image has a decode array.
The image uses an indexed color space.
The image has a Mask key containing an ImageMask stream.
The image has a Mask key containing an array of color values.
Flags to enable PDEImageGetColorSpaceEx() to return a color space with a particular bpc, depending on the image's bpc.
Indicates conversion of the color space of 16 bpc image to 8 bpc.
Flags for PDEImageGetData() , PDEImageGetDataStm() , PDEImageSetData() , and PDEImageSetDataStm() .
Indicates that the filter is active; data is encoded.
Indicates if the accompanying image data is 16-bit. Should be passed in for 16-bit images to PDEImageGetData/PDEImageGetDataStm to prevent the return of 8-bit converted data.
5 items
Acquires the color space of the flate image. PDERelease should be used to release the color space when it is no longer referenced by the caller.
imgFlate: IN PDEImageFlateIN/OUT An object of type PDEImageFlate.
The color space of the flate image; otherwise it returns NULL .
void PDEImageFlateGetAttrs(IN PDEImageFlate imgFlate, OUT PDEImageFlateAttrsP attrsP, IN ASUns32 attrsSize)Gets the attributes of a flate image.
imgFlate: IN PDEImageFlateIN/OUT A flate image resource object.
attrsP: OUT PDEImageFlateAttrsPIN/OUT (Filled by the method) A pointer to a PDEImageFlateAttrs structure containing the attributes of the flate image.
attrsSize: IN ASUns32IN/OUT The size of the attrsP buffer in bytes.
voidvoid PDEImageFlateGetCosObj(IN PDEImageFlate pdeImageFlate, OUT CosObj *cosObjP)Gets a Cos object for an image.
pdeImageFlate: IN PDEImageFlateIN/OUT The flate image whose Cos object is obtained.
cosObjP: OUT CosObj *IN/OUT (Filled by the method) The Cos object for the image.
voidASStm PDEImageFlateGetDataStm(IN PDEImageFlate imgFlate, IN ASUns32 flags)Gets a data stream for a flate compressed image, PDEImageFlate object. The caller must dispose of the returned ASStm by calling ASStmClose().
imgFlate: IN PDEImageFlateIN/OUT The flate image whose data stream is obtained.
flags: IN ASUns32IN/OUT PDEImageDataFlags flags. If the kPDEImageEncodedData flag is set, data is returned in encoded form. Otherwise, data is decoded.
The stream for the image.
typedef struct _t_PDEImageFlate* PDEImageFlateA reference to a PDEImageFlate.
9 items
PDEColorSpace PDEImageJPXAcquireColorSpace(IN PDEImageJPX pdeImageJPX)Acquires the PDEColorSpace associated with the JPX encoded image, if one exists. If a PDF color space has not been associated with the JPX encoded image, 0 will be returned. This object is acquired and must be released using PDERelease() when it is no longer in use.
pdeImageJPX: IN PDEImageJPXJPXColorSpace PDEImageJPXAcquireJPXColorSpace(IN PDEImageJPX pdeImageJPX)Acquires a link list of JPXColorSpace objects defined with the JPX encoded image. if one exists. This object is acquired and must be released using PDERelease() when it is no longer in use.
pdeImageJPX: IN PDEImageJPXJPXPalette PDEImageJPXAcquirePalette(IN PDEImageJPX pdeImageJPX)Acquires the JPXPalette from the JPX image object This object is acquired and must be released using PDERelease() when it is no longer in use.
pdeImageJPX: IN PDEImageJPXvoid PDEImageJPXGetAttrs(IN PDEImageJPX pdeImageJPX, OUT PDEImageJPXAttrsP attrsP, IN ASUns32 attrsSize)Gets the attributes of a JPX encoded PDEImage.
pdeImageJPX: IN PDEImageJPXattrsP: OUT PDEImageJPXAttrsPattrsSize: IN ASUns32voidvoid PDEImageJPXGetCosObj(IN PDEImageJPX pdeImageJPX, OUT CosObj *cosObjP)Gets a Cos object for an image.
pdeImageJPX: IN PDEImageJPXIN/OUT The JPX image whose Cos object is obtained.
cosObjP: OUT CosObj *IN/OUT (Filled by the method) The Cos object for the image.
voidASStm PDEImageJPXGetDataStm(IN PDEImageJPX pdeImageJPX, IN ASUns32 flags)Returns a stream containing the image data. Color component values are interlaced. For images with greater then 8 bits per component, the component values occupy the least significant bits of a two byte value. Valid values of flags are 0 .
pdeImageJPX: IN PDEImageJPXflags: IN ASUns32ASInt32 PDEImageJPXGetNumColorSpaces(IN PDEImageJPX pdeImageJPX)Returns the number of JPX color spaces reference by the JPX encoded image.
pdeImageJPX: IN PDEImageJPXASBool PDEImageJPXHasPalette(IN PDEImageJPX pdeImageJPX)Returns true if the JPX encoded image has a JPX palette
pdeImageJPX: IN PDEImageJPX7 items
void PDEAcquire(IN PDEObject obj)Increments the reference count for an object.
obj: IN PDEObjectIN/OUT The element whose count is incremented.
voidAdds an identifier-value pair to an object.
The clientID-tag combination is a unique identifier for the value. Each client has its own identifier space. It is often convenient to use ASAtoms as tags.
Tags are a purely memory-resident feature. In addition, management of tags is the responsibility of the client. A client must manage any memory pointed to by a tag. This method only contains a pointer to the data passed in by the client. The data and the pointer will not be saved to a file. The generic pointer type is not in the PDF specification.object: IN PDEObjectclientID: IN ExtensionIDtag: IN ASUns32value: IN void *A pointer to a value to associate with object . Only the pointer is stored. If the pointer points to data, it is the responsibility of the client to manage the data and its memory.
voidGets an object's value for a given clientID-tag identifier that was added by PDEAddTag.
object: IN PDEObjectThe element whose value is obtained.
clientID: IN ExtensionIDIdentifies the caller/client. For clients, this should be the gExtensionID extension. For the Adobe PDF Library, if there is only one client of the PDFEdit subsystem, clientID should be zero. If there are multiple clients, each should specify a nonzero, non-negative clientID . (A negative clientID is reserved for the implementation.)
tag: IN ASUns32The object's tag. If object has no tag, this is 0 .
void *The value associated with the clientID-tag identifier.
obj: IN PDEObjectIN/OUT The element whose type is obtained.
The object type, which is one of PDEType.
void PDERelease(IN PDEObject obj)Decrements the reference count for the object. If the count becomes zero, the object is destroyed. Do not call PDERelease() on PDEContent that you acquired with PDPageAcquirePDEContent(); call PDPageReleasePDEContent() instead. Objects should only be disposed of with PDERelease() if the method by which they were obtained incremented the reference count for the object. In general, methods that get an object do not increment the reference count. Methods that increment the reference count typically contain the word acquire or create in the method name and specifically state that you must release the object.
obj: IN PDEObjectIN/OUT The element released.
voidvoid PDERemoveTag(IN PDEObject object, IN ExtensionID clientID, IN ASUns32 tag)Removes an object's value for a given clientID-tag identifier that was added by PDEAddTag. If PDEAddTag is called with a 0 tag, this is the same as calling PDERemoveTag().
object: IN PDEObjectThe element whose tag is removed.
clientID: IN ExtensionIDIdentifies the caller/client. For clients, this should be the gExtensionID extension. For the Adobe PDF Library, if there is only one client of the PDFEdit subsystem, clientID should be zero. If there are multiple clients, each should specify a nonzero, non-negative clientID . (A negative clientID is reserved for the implementation.)
tag: IN ASUns32The tag value.
voidtypedef struct _t_PDEObject* PDEObjectThe abstract super class of the PDFEdit classes. You can find the type of any object with the PDEObjectGetType() method. You can then cast and apply that class' methods to the object. In addition, you can cast any of the PDFEdit objects to a PDEObject and use it anywhere a PDEObject is called for, such as in the PDEObject methods.
9 items
PDEPS PDEPSCreate(IN PDEPSAttrsP attrsP, IN ASUns32 attrsSize, IN ASStm dataStm, IN ASUns8 *data, IN ASUns32 dataSize)attrsP: IN PDEPSAttrsPattrsSize: IN ASUns32dataStm: IN ASStmdata: IN ASUns8 *dataSize: IN ASUns32PDEPS PDEPSCreateFromCosObj(const CosObj *cosObjP)Creates a PDEPS object from a CosObj object. Call PDERelease() to dispose of the returned PDEPS object when finished with it.
cosObjP: const CosObj *IN/OUT An object of type CosObj.
An object of type PDEPS.
ps: IN PDEPSattrsP: OUT PDEPSAttrsPattrsSize: IN ASUns32voidps: IN PDEPSbuffer: OUT ASUns8 *bufferSize: IN ASUns32offset: IN ASInt32ps: IN PDEPSps: IN PDEPSbuffer: IN ASUns8 *bufferSize: IN ASUns32voidps: IN PDEPSstm: IN ASStmvoidPS is an XObject.
11 items
void PDEPathAddSegment(IN PDEPath path, IN ASUns32 segType, IN ASFixed x1, IN ASFixed y1, IN ASFixed x2, IN ASFixed y2, IN ASFixed x3, IN ASFixed y3)Adds a segment to a path. The number of ASFixed values used depends upon segType : segType ASFixed values kPDEMoveTo x1 y1 kPDELineTo x1 y1 kPDECurveTo x1 y1 x2 y2 y3 kPDECurveToV x1 y1 x2 y2 kPDECurveToY x1 y1 x2 y2 kPDERect x1 y1 x2 (width) y2 (height) kPDEClosePath None
path: IN PDEPathIN/OUT The path to which a segment is added.
segType: IN ASUns32IN/OUT A PDEPathElementType value indicating the type of path to add.
x1: IN ASFixedIN/OUT The x-coordinate of the first point.
y1: IN ASFixedIN/OUT The y-coordinate of the first point.
x2: IN ASFixedIN/OUT The x-coordinate of the second point.
y2: IN ASFixedIN/OUT The y-coordinate of the second point.
x3: IN ASFixedIN/OUT The x-coordinate of the third point.
y3: IN ASFixedIN/OUT The y-coordinate of the third point.
voidPDEPath PDEPathCreate(void)Creates an empty path element. Call PDERelease() to dispose of the returned path object when finished with it.
: voidAn empty path element.
path: IN PDEPathdata: OUT ASInt32 *dataSize: IN ASUns32IN/OUT Specifies the size of the buffer provided in data. If it is less than the length of the path data, the method copies dataSize bytes. If it is zero, the ASFixed value of path->size is returned.
The length of the data of path .
Gets the size of the path data and, optionally, the path data. This API is an extension to the PDEPathGetData API.
path: IN PDEPathdata: OUT ASReal *dataSize: IN ASUns32IN/OUT Specifies the size of the buffer provided in data. If it is less than the length of the path data, the method copies dataSize bytes.
The length of the data of path .
ASUns32 PDEPathGetPaintOp(IN PDEPath path)Gets the fill and stroke attributes of a path.
path: IN PDEPathThe path whose fill and stroke attributes are obtained.
A set of PDEPathOpFlags flags describing fill and stroke attributes.
path: IN PDEPathIN/OUT The path whose data is set.
data: IN ASInt32 *IN/OUT A pointer to the path data. It is a variable-sized array of path operators and operands. The format is a 32-bit operator followed by zero to three ASFixedPoint values, depending on the operator. Operators are codes for moveto , lineto , curveto , rect , or closepath operators, and must be one of PDEPathElementType. Operands are ASFixedPoint values. The data is copied into the PDEPath object.
dataSize: IN ASUns32IN/OUT The size of the new path data in bytes.
voidSets new path data for a path element. This API is an extension to the PDEPathSetData API.
path: IN PDEPathIN/OUT The path whose data is set.
data: IN ASReal *IN/OUT A pointer to the path data. It is a variable-sized array of path operators and operands. The format is a 32-bit operator followed by zero to three ASReal values, depending on the operator. Operators are codes for moveto , lineto , curveto , rect , or closepath operators, and must be one of PDEPathElementType. Operands are ASReal values. The data is copied into the PDEPath object.
dataSize: IN ASUns32IN/OUT The size of the new path data in bytes.
voidvoid PDEPathSetPaintOp(IN PDEPath path, IN ASUns32 op)Sets the fill and stroke attributes of a path.
path: IN PDEPathIN/OUT The path whose fill and stroke attributes are set.
op: IN ASUns32IN/OUT The operation to set; it must be one of PDEPathOpFlags.
voidAn enumerated data type for path segment operators in PDEPath elements.
Designates the m ( moveto ) operator, which moves the current point.
Designates the l ( lineto ) operator, which appends a straight line segment from the current point.
Designates the c ( curveto ) operator, which appends a bezier curve to the path.
Designates the v ( curveto ) operator, which appends a bezier curve to the current path when the first control point coincides with initial point on the curve.
Designates the y ( curveto ) operator, which appends a bezier curve to the current path when the second control point coincides with final point on the curve.
Designates the re operator, which adds a rectangle to the current path.
Designates the h ( closepath ) operator, which closes the current sub-path.
Designates a special path element which is used as a default. It does not represent any actual path operations like moveto, lineto, etc.
The path is neither stroked nor filled, so it is invisible.
Stroke the path, as with the S ( stroke ) operator.
Fills the path, using the nonzero winding number rule to determine the region to fill, as with the f ( fill ) operator.
Fills the path, using the even/odd rule to determine the region to fill, as with the f* ( eofill ) operator.
3 items
PDEPattern PDEPatternCreate(const CosObj *cosObjP)Creates a pattern object that can be used for a Pattern color space. See the description of Patterns in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 8.7, page 173. This document is provided on the web site of the International Standards Organization (ISO). Call PDERelease() to dispose of the returned pattern object when finished with it.
cosObjP: const CosObj *IN/OUT A CosObj stream for the pattern.
A pattern.
void PDEPatternGetCosObj(IN PDEPattern pattern, OUT CosObj *cosObjP)Gets a Cos object corresponding to a pattern object.
pattern: IN PDEPatternIN/OUT The pattern whose Cos object is obtained.
cosObjP: OUT CosObj *IN/OUT (Filled by the method) The Cos object for the pattern.
voidtypedef struct _t_PDEPattern* PDEPatternA reference to a Pattern resource used on a page in a PDF file.
6 items
Creates a place object. Call PDERelease() to dispose of the returned place object when finished with it.
mcTag: IN ASAtomIN/OUT The tag name for the place. It must not contain any white space characters (for example, spaces or tabs).
cosObjP: IN CosObj *IN/OUT An optional Marked Content dictionary associated with the place.
isInline: IN ASBoolIf true , it emits the place's dictionary into the content stream inline. If false , then the dictionary is emitted outside of the content stream and referenced by name. See the Property Lists section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 14.6.2, page 554. You can find this document on the web store of the International Standards Organization (ISO).
The place object.
pdePlace: IN PDEPlaceIN/OUT The place whose Marked Content dictionary is obtained.
placeDictP: OUT CosObj *IN/OUT (Filled by the method) A pointer to the Marked Content dictionary; may be NULL .
isInline: OUT ASBool *IN/OUT (Filled by the method) If true , the Marked Content dictionary is inline; may be NULL .
true if dictionary is obtained, false if no dictionary is present.
ASAtom PDEPlaceGetMCTag(IN PDEPlace pdePlace)Gets the Marked Content tag for a PDEPlace.
pdePlace: IN PDEPlaceIN/OUT The place whose Marked Content tag is obtained.
A tag for pdePlace .
Sets the Marked Content dictionary for a PDEPlace. The dictionary can be emitted inline or referenced from the \\Properties key in the \Resources dictionary of the containing stream.
pdePlace: IN PDEPlaceplaceDictP: IN CosObj *isInline: IN ASBoolvoidvoid PDEPlaceSetMCTag(IN PDEPlace pdePlace, IN ASAtom mcTag)Sets the Marked Content tag for a PDEPlace.
pdePlace: IN PDEPlaceIN/OUT The place whose Marked Content tag is set.
mcTag: IN ASAtomIN/OUT The tag for pdePlace .
voidtypedef struct _t_PDEPlace* PDEPlaceA PDEElement that marks a place on a page in a PDF file. In a PDF file, a place is represented by the MP or DP Marked Content operators. Marked content is useful for adding structure information to a PDF file. For instance, a drawing program may want to mark a point with information, such as the start of a path of a certain type. Marked content provides a way to retain this information in the PDF file. A DP operator functions the same as the MP operator and, in addition, allows a property list dictionary to be associated with a place.
4 items
PDEShading PDEShadingCreateFromCosObj(IN const CosObj *shadingP, IN ASFixedMatrixP matrixP)Superseded by PDEShadingCreateFromCosObjEx() in Acrobat 10.0. Creates a smooth shading object. Call PDERelease() to dispose of the returned PDEShading object when finished with it.
shadingP: IN const CosObj *IN/OUT The shading dictionary.
matrixP: IN ASFixedMatrixPIN/OUT The location and transformation matrix of the shading object.
A smooth shading object.
PDEShading PDEShadingCreateFromCosObjEx(IN const CosObj *shadingP, IN ASDoubleMatrixP matrixP)Creates a smooth shading object. Supersedes PDEShadingCreateFromCosObj() in Acrobat 10.0. Call PDERelease() to dispose of the returned PDEShading object when finished with it.
shadingP: IN const CosObj *IN/OUT The shading dictionary.
matrixP: IN ASDoubleMatrixPIN/OUT The location and transformation matrix of the shading object.
A smooth shading object.
void PDEShadingGetCosObj(IN PDEShading shading, OUT CosObj *cosObjP)Gets the CosObj for a PDEShading.
shading: IN PDEShadingIN/OUT A smooth shading object.
cosObjP: OUT CosObj *IN/OUT The Cos dictionary corresponding to shading.
voidtypedef struct _t_PDEShading* PDEShadingA PDEElement that represents smooth shading.
14 items
PDEForm PDESoftMaskAcquireForm(IN PDESoftMask pdeSoftMask, IN ASFixedMatrixP matrixP)Superseded by PDESoftMaskAcquireFormEx() in Acrobat 10.0. Acquires the PDEForm that defines the soft mask. Call PDERelease() to dispose of the PDEForm when finished with it.
pdeSoftMask: IN PDESoftMaskIN/OUT An object of type PDESoftMask.
matrixP: IN ASFixedMatrixPIN/OUT A matrix defining the transformation from coordinate space to user space.
The XObject form of the soft mask.
PDEForm PDESoftMaskAcquireFormEx(IN PDESoftMask pdeSoftMask, IN ASDoubleMatrixP matrixP)Supersedes PDESoftMaskAcquireForm() in Acrobat 10.0. Acquires the PDEForm that defines the soft mask. Call PDERelease() to dispose of the PDEForm when finished with it.
pdeSoftMask: IN PDESoftMaskIN/OUT An object of type PDESoftMask.
matrixP: IN ASDoubleMatrixPIN/OUT A matrix defining the transformation from coordinate space to user space.
The XObject form of the soft mask.
PDESoftMask PDESoftMaskCreate(IN CosDoc cosDoc, IN PDESoftMaskCreateFlags type, IN PDEForm pdeForm)Creates a new soft mask object. Call PDERelease() to dispose of the returned PDESoftMask object when finished with it.
cosDoc: IN CosDocIN/OUT The container document.
type: IN PDESoftMaskCreateFlagsIN/OUT Specifies how the mask is to be computed. It is one of the PDESoftMaskCreateFlags.
pdeForm: IN PDEFormIN/OUT The form XObject that defines the soft mask. It is the source of the mask values and the PDColorSpace in which the composite computation is to be done.
The newly created object.
PDESoftMask PDESoftMaskCreateFromCosObj(IN const CosObj *cosObjP)Creates a new soft mask object from its Cos representation. Call PDERelease() to dispose of the returned PDESoftMask object when finished with it.
cosObjP: IN const CosObj *IN/OUT The soft mask dictionary.
The newly created object.
Create a new soft mask from a name. Call PDERelease() to dispose of the returned PDESoftMask object when finished with it.
name: IN ASAtomIN/OUT The new name for the soft mask. Note that, currently, the only valid name is None .
The newly created object.
ASInt32 PDESoftMaskGetBackdropColor(IN PDESoftMask pdeSoftMask, IN ASFixed *pColorValues, IN ASInt32 numValues)Gets the array of color values of the backdrop color. Given a pointer to an array and the length of the array, it copies the color values to that array and returns the number of values copied. If the pointer to the array is NULL , the number of color values is returned.
pdeSoftMask: IN PDESoftMaskIN/OUT An object of type PDESoftMask.
pColorValues: IN ASFixed *IN/OUT (Filled by the method) A pointer to an array of color values. If it is NULL , the number of color values is returned.
numValues: IN ASInt32IN/OUT The length of the array pColorValues .
The number of values copied.
void PDESoftMaskGetCosObj(IN PDESoftMask pdeSoftMask, OUT CosObj *cosObjP)Gets the associated CosObj of the soft mask.
pdeSoftMask: IN PDESoftMaskIN/OUT The soft mask.
cosObjP: OUT CosObj *IN/OUT (Filled by the method) A pointer to the Cos object.
voidASAtom PDESoftMaskGetName(IN PDESoftMask pdeSoftMask)Gets the soft mask name.
pdeSoftMask: IN PDESoftMaskIN/OUT The soft mask.
The soft mask name if it is a name; it returns ASAtomNull otherwise.
CosObj PDESoftMaskGetTransferFunction(IN PDESoftMask pdeSoftMask)Gets the transfer function as a CosObj.
pdeSoftMask: IN PDESoftMaskIN/OUT The soft mask.
The transfer function as a CosObj.
void PDESoftMaskSetBackdropColor(IN PDESoftMask pdeSoftMask, IN ASFixed *pColorValues, IN ASInt32 numValues)Sets the backdrop color values.
pdeSoftMask: IN PDESoftMaskIN/OUT The soft mask object.
pColorValues: IN ASFixed *IN/OUT A series of color values.
numValues: IN ASInt32IN/OUT The number of values pointed to by pColorValues .
voidvoid PDESoftMaskSetTransferFunction(IN PDESoftMask pdeSoftMask, IN CosObj cosTransferFunction)Sets the transfer function associated with the soft mask.
pdeSoftMask: IN PDESoftMaskIN/OUT The soft mask object.
cosTransferFunction: IN CosObjIN/OUT The transfer function dictionary.
voidvoid PDESoftMaskSetXGroup(IN PDESoftMask pdeSoftMask, IN PDEForm pdeForm)Sets the PDEForm that defines the soft mask.
pdeSoftMask: IN PDESoftMaskIN/OUT The soft mask object.
pdeForm: IN PDEFormIN/OUT The form XObject.
voidtypedef struct _t_PDESoftMask* PDESoftMaskAn object for creating and manipulating a soft mask in a PDF file.
Specifies how the mask is to be computed.
Specifies how the mask is to be computed.
50 items
void PDETextAdd(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, IN ASUns8 *text, IN ASInt32 textLen, IN PDEFont font, IN PDEGraphicStateP gstateP, IN ASUns32 gstateLen, IN PDETextStateP tstateP, IN ASUns32 tstateLen, IN ASFixedMatrixP textMatrixP, IN ASFixedMatrixP strokeMatrixP)Superseded by PDETextAddEx() in Acrobat 10.0. Adds a character or a text run to a PDEThe text object. This method does not change the reference count of pdeText ; however, the reference count of the objects in the gstateP parameter are incremented. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextThe text object to which a character or text run is added.
flags: IN ASUns32A PDETextFlags that specifies what kind of text to add. It must be one of the following values:
index: IN ASInt32The index after which to add the character or text run.
text: IN ASUns8 *A pointer to the characters to add. Note that passing NULL for the text can invalidate the text object, but will not raise an error. Callers must not pass NULL for this parameter.
textLen: IN ASInt32The length of the text in bytes.
font: IN PDEFontThe font for the element.
gstateP: IN PDEGraphicStatePA pointer to a PDEGraphicStateP structure with the graphics state for the element.
gstateLen: IN ASUns32The length of the graphics state for the element.
tstateP: IN PDETextStatePA pointer to a PDETextState structure with the text state for the element. Note that PDFEdit ignores the wasSetFlags flag of the PDETextState structure, so you must initialize the PDETextState fields.
tstateLen: IN ASUns32The length of the text state for the element.
textMatrixP: IN ASFixedMatrixPA pointer to an ASFixedMatrix that holds the matrix for the element.
strokeMatrixP: IN ASFixedMatrixPA pointer to an ASFixedMatrix that holds the matrix for the line width when stroking text. It may be NULL . Note that this field is not currently used.
voidvoid PDETextAddEx(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, IN ASUns8 *text, IN ASInt32 textLen, IN PDEFont font, IN PDEGraphicStateP gstateP, IN ASUns32 gstateLen, IN PDETextStateP tstateP, IN ASUns32 tstateLen, IN ASDoubleMatrixP textMatrixP, IN ASDoubleMatrixP strokeMatrixP)Adds a character or a text run to a PDEThe text object. Supersedes PDETextAdd() in Acrobat 10.0. This method does not change the reference count of pdeText ; however, the reference count of the objects in the gstateP parameter are incremented. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextThe text object to which a character or text run is added.
flags: IN ASUns32A PDETextFlags that specifies what kind of text to add. It must be one of the following values:
index: IN ASInt32The index after which to add the character or text run.
text: IN ASUns8 *A pointer to the characters to add. Note that passing NULL for the text can invalidate the text object, but will not raise an error. Callers must not pass NULL for this parameter.
textLen: IN ASInt32The length of the text in bytes.
font: IN PDEFontThe font for the element.
gstateP: IN PDEGraphicStatePA pointer to a PDEGraphicStateP structure with the graphics state for the element.
gstateLen: IN ASUns32The length of the graphics state for the element.
tstateP: IN PDETextStatePA pointer to a PDETextState structure with the text state for the element. Note that PDFEdit ignores the wasSetFlags flag of the PDETextState structure, so you must initialize the PDETextState fields.
tstateLen: IN ASUns32The length of the text state for the element.
textMatrixP: IN ASDoubleMatrixPA pointer to an ASDoubleMatrix that holds the matrix for the element.
strokeMatrixP: IN ASDoubleMatrixPA pointer to an ASDoubleMatrix that holds the matrix for the line width when stroking text. It may be NULL . Note that this field is currently not used.
voidvoid PDETextAddGlyphs(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, IN PDEGlyphRunP glyphRun, IN PDEFont font, IN PDEGraphicStateP gstateP, IN ASUns32 gstateLen, IN PDETextStateP tstateP, IN ASUns32 tstateLen, IN ASFixedMatrixP textMatrixP, IN ASFixedMatrixP strokeMatrixP)Superseded by PDETextAddGlyphsEx() in Acrobat 10.0. Adds Unicode text to a PDEText object. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. This method does not change the reference count of pdeText ; however, the reference count of the objects in the gstateP parameter are incremented.
pdeText: IN PDETextThe text object to which a character or text run is added.
flags: IN ASUns32A PDETextFlags that specifies what kind of text to add. It must be one of the following values:
index: IN ASInt32The index after which to add the character or text run.
glyphRun: IN PDEGlyphRunPA pointer to a PDEGlyphRun structure with Unicode data, GlyphIDs and their correspondence.
font: IN PDEFontThe font for the element.
gstateP: IN PDEGraphicStatePA pointer to a PDEGraphicStateP structure with the graphics state for the element.
gstateLen: IN ASUns32The length of the graphics state for the element.
tstateP: IN PDETextStatePA pointer to a PDETextState structure with text state for the element. Note that PDFEdit ignores the wasSetFlags flag of the PDETextState structure, so you must initialize the PDETextState fields.
tstateLen: IN ASUns32The length of the text state for the element.
textMatrixP: IN ASFixedMatrixPA pointer to an ASFixedMatrix that holds the matrix for the element.
strokeMatrixP: IN ASFixedMatrixPA pointer to an ASFixedMatrix that holds the matrix for the line width when stroking text. It may be NULL . Note that, currently, this field is not used.
voidvoid PDETextAddGlyphsEx(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, IN PDEGlyphRunP glyphRun, IN PDEFont font, IN PDEGraphicStateP gstateP, IN ASUns32 gstateLen, IN PDETextStateP tstateP, IN ASUns32 tstateLen, IN ASDoubleMatrixP textMatrixP, IN ASDoubleMatrixP strokeMatrixP)Adds Unicode text to a PDEText object. Supersedes PDETextAddGlyphs() in Acrobat 10.0. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. This method does not change the reference count of pdeText ; however, the reference count of the objects in the gstateP parameter are incremented.
pdeText: IN PDETextThe text object to which a character or text run is added.
flags: IN ASUns32A PDETextFlags that specifies what kind of text to add. It must be one of the following values:
index: IN ASInt32The index after which to add the character or text run.
glyphRun: IN PDEGlyphRunPA pointer to a PDEGlyphRun structure with Unicode data, GlyphIDs and their correspondence.
font: IN PDEFontThe font for the element.
gstateP: IN PDEGraphicStatePA pointer to a PDEGraphicStateP structure with the graphics state for the element.
gstateLen: IN ASUns32The length of the graphics state for the element.
tstateP: IN PDETextStatePA pointer to a PDETextState structure with text state for the element. Note that PDFEdit ignores the wasSetFlags flag of the PDETextState structure, so you must initialize the PDETextState fields.
tstateLen: IN ASUns32The length of the text state for the element.
textMatrixP: IN ASDoubleMatrixPA pointer to an ASDoubleMatrix that holds the matrix for the element.
strokeMatrixP: IN ASDoubleMatrixPA pointer to an ASDoubleMatrix that holds the matrix for the line width when stroking text. It may be NULL . Note that this field is currently not used.
voidvoid PDETextAddItem(IN PDEText text, IN ASInt32 addIndex, IN PDETextItem textItem)Adds a text item to a text element at a given index position.
text: IN PDETextThe text object to which the text item is added.
addIndex: IN ASInt32The index of the text item in pdeText .
textItem: IN PDETextItemThe text item to add.
voidPDEText PDETextCreate(void)Creates an empty text object. Call PDERelease() to dispose of the returned text object when finished with it.
: voidAn empty text object.
void PDETextGetAdvance(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT ASFixedPointP advanceP)Gets the advance width of a character or a text element. Advance width is returned in either character space or user space. The advance width is the amount by which the current point advances when the character is drawn. Advance width may be horizontal or vertical, depending on the writing style. Thus advanceP has both a horizontal and vertical component. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. In addition, set the kPDETextPageSpace flag to obtain the advance width in user space. If it is not set, the advance width is in character space. If this flag is not set, this method returns a value that is independent of any sizes, matrices, or scaling, simply adding up the font's raw glyph widths, supplemented only by unscaled character and word spacing.
pdeText: IN PDETextA text object containing a character or text run whose advance width is found.
flags: IN ASUns32A PDETextFlags value that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32The index of the character or text run in pdeText .
advanceP: OUT ASFixedPointP(Filled by the method) A pointer to a ASFixedPoint value indicating the advance width.
voidvoid PDETextGetAdvanceWidth(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT ASFixedPointP advanceP)Gets the advance width of a character or a text element. Advance width is returned in either character space or user space. The advance width is the amount by which the current point advances when the character is drawn. Advance width may be horizontal or vertical, depending on the writing style. Thus advanceP has both a horizontal and vertical component. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. In addition, set the kPDETextPageSpace flag to obtain the advance width in user space. If it is not set, the advance width is in character space. If this flag is not set, this method returns a value that is independent of any sizes, matrices, or scaling, simply adding up the font's raw glyph widths, supplemented only by unscaled character and word spacing.
pdeText: IN PDETextA text object containing a character or text run whose advance width is found.
flags: IN ASUns32A PDETextFlags value that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32The index of the character or text run in pdeText .
advanceP: OUT ASFixedPointP(Filled by the method) A pointer to a ASFixedPoint value indicating the advance width.
voidGets the bounding box of a character or a text run. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextIN/OUT A text object containing a character or text run whose bounding box is found.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
bboxP: OUT ASFixedRectPIN/OUT (Filled by the method) A pointer to ASFixedRect to set to the bounding box of specified character or text run.
voidGets the font for a text character or element. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. This method does not change the reference count of the returned PDEFont.
pdeText: IN PDETextIN/OUT A text object containing a character or text run whose font is found.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
The font of the specified character or text run.
void PDETextGetGState(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT PDEGraphicStateP stateP, IN ASUns32 stateSize)Gets the graphics state of a character or a text run. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. This method does not increment the reference count of the objects in stateP .
pdeText: IN PDETextA text object containing a character or text run whose graphics state is found.
flags: IN ASUns32A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32The index of the character or text run in pdeText .
stateP: OUT PDEGraphicStateP(Filled by the method) A pointer to a PDEGraphicState structure with the graphics state of the specified character or text run.
stateSize: IN ASUns32The size of the stateP buffer in bytes.
voidvoid PDETextGetGStateEx(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT PDEGraphicStateExP stateP, IN ASUns32 stateSize)Gets the graphics state of a character or a text run. This method fills PDEGraphicStateEx as output which is higher precision alternative of PDEGraphicState structure. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. This method does not increment the reference count of the objects in stateP .
pdeText: IN PDETextA text object containing a character or text run whose graphics state is found.
flags: IN ASUns32A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32The index of the character or text run in pdeText .
stateP: OUT PDEGraphicStateExP(Filled by the method) A pointer to a PDEGraphicStateExP structure with the graphics state of the specified character or text run.
stateSize: IN ASUns32The size of the stateP buffer in bytes.
voidPDETextItem PDETextGetItem(IN PDEText text, IN ASUns32 index)Obtains a text item from a text element at a given index position.
text: IN PDETextText object from which the text item is obtained.
index: IN ASUns32The index of the text item in pdeText .
The text item object.
void PDETextGetMatrix(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT ASFixedMatrixP matrixP)Superseded by PDETextGetMatrixEx() in Acrobat 10.0. Returns the matrix of a character or a text element. Unlike PDETextGetTextMatrix(), this function does not take fontSize , hScale , and textRise in the textState into account. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextIN/OUT A text object containing a character or text run whose graphics state is found.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
matrixP: OUT ASFixedMatrixPIN/OUT (Filled by the method) An ASFixedMatrixP that holds the matrix of the specified character or text run.
voidvoid PDETextGetMatrixEx(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT ASDoubleMatrixP matrixP)Supersedes PDETextGetMatrix() in Acrobat 10.0. Returns the matrix of a character or a text element. Unlike PDETextGetTextMatrixEx(), this function does not take fontSize , hScale , and textRise in the textState into account. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextIN/OUT A text object containing a character or text run whose graphics state is found.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
matrixP: OUT ASDoubleMatrixPIN/OUT (Filled by the method) An ASDoubleMatrixP that holds the matrix of the specified character or text run.
voidGets the number of bytes occupied by the character code or text run. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextIN/OUT A PDEText object returned from one of the PDETextCreate methods whose text is examined.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
The number of bytes occupied by the text run or character.
ASInt32 PDETextGetNumChars(IN PDEText pdeText)Gets the number of characters in a text object.
pdeText: IN PDETextIN/OUT A text object whose number of characters is found.
The total number of characters in pdeText .
ASInt32 PDETextGetNumRuns(IN PDEText pdeText)Gets the number of text runs (show strings) in a text object.
pdeText: IN PDETextIN/OUT A text object whose number of text runs is found.
The number of text runs in pdeText .
Gets the quad bounding the specified text run or character. The advance portion of the quad is based on the left side bearing and advance width. It must be one of the following values: Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. In addition, if the kPDETextBounding flag is set, PDETextGetQuad() uses the font descriptor's FontBBox , which is the smallest rectangle that encloses all characters in the font. The advance portion is based on the x-coordinates of the left and right sides of FontBBox and the advance width.
pdeText: IN PDETextIN/OUT A text object containing a character or text run whose quad is found.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object.
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
quadP: OUT ASFixedQuadPIN/OUT (Filled by the method) A pointer to ASFixedQuad that bounds the specified character or text run.
voidGets the index of the text run that contains the nth character in a text object.
pdeText: IN PDETextIN/OUT A text object to examine.
charIndex: IN ASInt32IN/OUT The number of the character to find in pdeText .
The index of the text run with the specified character index into pdeText .
void PDETextGetState(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT PDETextStateP stateP, IN ASUns32 stateSize)Returns the text state of a character or a text element. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextIN/OUT A text object containing a character or text run whose text state is found.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
stateP: OUT PDETextStatePIN/OUT (Filled by the method) A pointer to a PDETextState structure to fill with the text state of the specified character or text run.
stateSize: IN ASUns32IN/OUT The size of the stateP buffer in bytes.
voidvoid PDETextGetStrokeMatrix(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT ASFixedMatrixP matrixP)Superseded by PDETextGetStrokeMatrixEx() in Acrobat 10.0. Gets the stroke matrix of a character or a text run. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. This method returns no valid information.
pdeText: IN PDETextA text object containing a character or text run whose stroke matrix is found.
flags: IN ASUns32A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32The index of the character or text run in pdeText .
matrixP: OUT ASFixedMatrixP(Filled by the method) A pointer to ASFixedMatrix that holds the stroke matrix of the specified character or text run. This matrix is the transformation for line widths when stroking. The h and v values of the matrix are ignored.
voidvoid PDETextGetStrokeMatrixEx(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT ASDoubleMatrixP matrixP)Supersedes PDETextGetStrokeMatrix() in Acrobat 10.0. Gets the stroke matrix of a character or a text run. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. This method returns no valid information.
pdeText: IN PDETextA text object containing a character or text run whose stroke matrix is found.
flags: IN ASUns32A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32The index of the character or text run in pdeText .
matrixP: OUT ASDoubleMatrixP(Filled by the method) A pointer to ASDoubleMatrix that holds the stroke matrix of the specified character or text run. This matrix is the transformation for line widths when stroking. The h and v values of the matrix are ignored.
voidASInt32 PDETextGetText(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT ASUns8 *textBuffer)Gets the text for a text run or character. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextIN/OUT A text object containing a character or text run whose text is found.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
textBuffer: OUT ASUns8 *IN/OUT (Filled by the method) The text of the specified character or text run. textBuffer must be large enough to hold the returned text. If textBuffer is NULL , it returns the number of bytes required to hold the data.
The number of bytes in the text run or character.
void PDETextGetTextMatrix(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT ASFixedMatrixP matrixP)Superseded by PDETextGetTextMatrixEx() in Acrobat 10.0. Gets the matrix of a character or a text run. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextA text object containing a character or text run whose matrix is found.
flags: IN ASUns32A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32The index of the character or text run in pdeText .
matrixP: OUT ASFixedMatrixP(Filled by the method) A pointer to ASFixedMatrix that holds the matrix of the specified character or text run. This is the transformation matrix from user space to the current text space. The h and v values of the matrix indicate the origin of the first character.
voidvoid PDETextGetTextMatrixEx(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT ASDoubleMatrixP matrixP)Supersedes PDETextGetTextMatrix() in Acrobat 10.0. Gets the matrix of a character or a text run. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextA text object containing a character or text run whose matrix is found.
flags: IN ASUns32A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32The index of the character or text run in pdeText .
matrixP: OUT ASDoubleMatrixP(Filled by the method) A pointer to ASDoubleMatrix that holds the matrix of the specified character or text run. This is the transformation matrix from user space to the current text space. The h and v values of the matrix indicate the origin of the first character.
voidvoid PDETextGetTextState(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, OUT PDETextStateP stateP, IN ASUns32 stateSize)Gets the text state of a character or a text element. This function handles only charSpacing , wordSpacing , and renderMode for backward compatibility. For all attributes, use PDETextGetState() instead. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextIN/OUT A text object containing a character or text run whose text state is found.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
stateP: OUT PDETextStatePIN/OUT (Filled by the method) A pointer to a PDETextState structure to fill with the text state of the specified character or text run.
stateSize: IN ASUns32IN/OUT The size of the stateP buffer in bytes.
voidASBool PDETextIsAtPoint(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, IN ASFixedPoint point)Tests whether a point is on specified text. It checks if the point is in a bounding box for the PDEText. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextIN/OUT The text to test.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
point: IN ASFixedPointIN/OUT The point, specified in user space coordinates.
true if the point is on the text, false otherwise.
Tests whether any part of a rectangle is on the specified text. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextIN/OUT The text to test.
flags: IN ASUns32IN/OUT A PDETextFlags flag that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
rect: IN ASFixedRectIN/OUT The rectangle, specified in user space coordinates.
true if the text is on the rectangle, false otherwise.
Removes characters or text runs from a text object. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run. This method decrements the reference count of objects associated with the pdeText in the graphic state and font.
pdeText: IN PDETextIN/OUT The text object from which text is removed.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
count: IN ASInt32IN/OUT The number of characters or text runs to remove.
voidRemoves contiguous text items from a text element starting at a given index position.
text: IN PDETextThe text object from which the text items are removed.
index: IN ASUns32The index of the first text item in pdeText to remove.
count: IN ASUns32The number of text items to remove.
voidvoid PDETextReplaceChars(IN PDEText pdeText, IN ASUns32 flags, IN ASInt32 index, IN ASUns8 *textBuffer, IN ASInt32 numChars)Replaces characters in a text object. This method does not change the number of characters in the text object; extra characters are ignored. Value Description kPDETextChar Used for a text character. kPDETextRun Used for a text run.
pdeText: IN PDETextIN/OUT The text object in which characters are replaced.
flags: IN ASUns32IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:
index: IN ASInt32IN/OUT The index of the character or text run in pdeText .
textBuffer: IN ASUns8 *IN/OUT Replacement text.
numChars: IN ASInt32IN/OUT The number of bytes to replace.
voidGets the character offset of the first character of the specified text run.
pdeText: IN PDETextIN/OUT A text object containing a character or text run whose graphics state is found.
runIndex: IN ASInt32IN/OUT The index of the text run whose first character's index is returned.
The character offset of the first character of the specified text run in pdeText .
pdeText: IN PDETextIN/OUT A text object containing a text run whose number of characters is found.
runIndex: IN ASInt32IN/OUT The index of the text run whose number of characters is returned.
The number of characters in the specified text run.
Sets the font of a text run. This method decrements the reference count of the previous font and increments the reference count of the new font.
pdeText: IN PDETextIN/OUT The text object containing a text run whose font is set.
runIndex: IN ASInt32IN/OUT The index of the text run.
font: IN PDEFontIN/OUT The font set for the text run.
voidvoid PDETextRunSetGState(IN PDEText pdeText, IN ASInt32 runIndex, IN PDEGraphicStateP stateP, IN ASUns32 stateSize)Sets the graphics state of a text run. This method increments the reference count of objects in stateP .
pdeText: IN PDETextThe text object containing a text run whose graphics state is set.
runIndex: IN ASInt32The index of the text run.
stateP: IN PDEGraphicStatePA pointer to a PDEGraphicState structure with the graphics state to set.
stateSize: IN ASUns32The size of the stateP buffer in bytes.
voidvoid PDETextRunSetGStateEx(IN PDEText pdeText, IN ASInt32 runIndex, IN PDEGraphicStateExP stateP, IN ASUns32 stateSize)Sets the graphics state of a text run. This method takes pointer to PDEGraphicStateEx as input which is higher precision alternative of PDEGraphicState structure. @note This method increments the reference count of objects in stateP.
pdeText: IN PDETextrunIndex: IN ASInt32stateP: IN PDEGraphicStateExPstateSize: IN ASUns32voidSuperseded by PDETextRunSetMatrixEx() in Acrobat 10.0. Sets the matrix of a text run. Unlike PDETextRunSetTextMatrix(), this function does not change fontSize, hScale, and textRise in the textState of PDEText.
pdeText: IN PDETextIN/OUT The text object containing a text run.
runIndex: IN ASInt32IN/OUT The index of the text run.
matrixP: IN ASFixedMatrixPIN/OUT ASFixedMatrixP pointer.
voidSets the matrix of a text run. Supersedes PDETextRunSetMatrix() in Acrobat 10.0. Unlike PDETextRunSetTextMatrixEx(), this function does not change fontSize , hScale , and textRise in the textState of PDEText.
pdeText: IN PDETextIN/OUT The text object containing a text run.
runIndex: IN ASInt32IN/OUT The index of the text run.
matrixP: IN ASDoubleMatrixPIN/OUT ASDoubleMatrixP pointer.
voidvoid PDETextRunSetState(IN PDEText pdeText, IN ASInt32 runIndex, IN PDETextStateP stateP, IN ASUns32 stateSize)Sets the text state of a text run.
pdeText: IN PDETextThe text object containing a text run whose state is set.
runIndex: IN ASInt32The index of the text run.
stateP: IN PDETextStatePA pointer to a PDETextState structure with the state to set.
stateSize: IN ASUns32The size of the stateP buffer in bytes.
voidSuperseded by PDETextRunSetStrokeMatrixEx() in Acrobat 10.0. Sets the stroke matrix of a text run. Currently this method is not implemented.
pdeText: IN PDETextThe text object containing a text run whose stroke matrix is set.
runIndex: IN ASInt32The index of the text run.
matrixP: IN ASFixedMatrixPA pointer to an ASFixedMatrix that holds the stroke matrix.
voidvoid PDETextRunSetStrokeMatrixEx(IN PDEText pdeText, IN ASInt32 runIndex, IN ASDoubleMatrixP matrixP)Sets the stroke matrix of a text run. Supersedes PDETextRunSetStrokeMatrix() in Acrobat 10.0. Currently this method is not implemented (Acrobat 10 and later).
pdeText: IN PDETextThe text object containing a text run whose stroke matrix is set.
runIndex: IN ASInt32The index of the text run.
matrixP: IN ASDoubleMatrixPA pointer to an ASDoubleMatrix that holds the stroke matrix.
voidSuperseded by PDETextRunSetTextMatrixEx() in Acrobat 10.0. Sets the text matrix of a text run.
pdeText: IN PDETextIN/OUT The text object containing a text run whose text matrix is set.
runIndex: IN ASInt32IN/OUT The index of the text run.
matrixP: IN ASFixedMatrixPIN/OUT A pointer to an ASFixedMatrix that holds the text matrix.
voidSets the text matrix of a text run. Supersedes PDETextRunSetTextMatrix() in Acrobat 10.0.
pdeText: IN PDETextIN/OUT The text object containing a text run whose text matrix is set.
runIndex: IN ASInt32IN/OUT The index of the text run.
matrixP: IN ASDoubleMatrixPIN/OUT A pointer to an ASDoubleMatrix that holds the text matrix.
voidvoid PDETextRunSetTextState(IN PDEText pdeText, IN ASInt32 runIndex, IN PDETextStateP stateP, IN ASUns32 stateSize)Sets the text state of a text run. This method has the following side effect: It modifies the text matrix of the run. In order to maintain backward compatibility, this method only directly operates on the first four fields of PDETextState . When it is called, it calculates a new text matrix with three additional fields: fontSize , hScale , and textRise (see PDETextState ). To avoid this behavior, use PDETextRunSetState() instead (which was added to address this problem).
pdeText: IN PDETextThe text object containing a text run whose text state is set.
runIndex: IN ASInt32The index of the text run.
stateP: IN PDETextStatePA pointer to a PDETextState structure with text state.
stateSize: IN ASUns32The size of the stateP buffer in bytes.
voidvoid PDETextSplitRunAt(IN PDEText pdeText, IN ASInt32 splitLoc)Splits a text run into two text runs.
pdeText: IN PDETextThe text object containing a text run to split.
splitLoc: IN ASInt32The split location, relative to the text object. The first text run is from character index 0 up to splitLoc . The second text run is from splitLoc + 1 to the end of the run.
voidtypedef struct _t_PDEText* PDETextA PDEElement representing text. It is a container for text as show strings or as individual characters. Each sub-element may have different graphics state properties. However, the same clip applies to all sub-elements of a PDEText. Also, the charpath of a PDEText can be used to represent a clip.
Text run.
Character (text run with only one character).
Obtain the advance width in page space.
Fill in the left and right bounds of the text run's bounding box.
Fill text.
Stroke text.
Fill and stroke text.
Text with no fill and no stroke (invisible).
Character spacing was set corresponding to the Tc operator.
Word spacing was set corresponding to the Tw operator.
Text rendering mode was set corresponding to the Tr operator.
Font size was set corresponding to the Tf operator.
Horizontal Scaling was set corresponding to the Tz operator.
Text rise was set corresponding to the Ts operator.
20 items
ASUns32 PDETextItemCopyText(IN PDETextItem textItem, OUT ASUns8 *buffer, IN ASUns32 bufferSize)Copies the text from a text item element into a character buffer.
textItem: IN PDETextItemA pointer to the characters to add. Note that passing NULL for text can invalidate the text object but will not raise an error. Callers must not pass NULL for this parameter.
buffer: OUT ASUns8 *(Filled by the method) A pointer to a buffer in which to store the copy.
bufferSize: IN ASUns32The length of the text buffer in bytes.
The length in bytes of textItem .
PDETextItem PDETextItemCreate(IN ASUns8 *text, IN ASUns32 textLen, IN PDEFont font, IN PDEGraphicStateP gStateP, IN ASUns32 gStateLen, IN PDETextStateP textStateP, IN ASUns32 textStateLen, IN ASFixedMatrix *textMatrixP)Superseded by PDETextItemCreateEx() in Acrobat 10.0. Creates a text item element containing a character or text run, which can be added to a PDEText text object. Call PDERelease() to dispose of the returned PDETextItem object when finished with it.
text: IN ASUns8 *A pointer to the characters to add. Note that passing NULL for text can invalidate the text object but will not raise an error. Callers must not pass NULL for this parameter.
textLen: IN ASUns32The length of the text in bytes.
font: IN PDEFontThe font for the element.
gStateP: IN PDEGraphicStatePA pointer to a PDEGraphicStateP structure with the graphics state for the element.
gStateLen: IN ASUns32The length of the graphics state for the element.
textStateP: IN PDETextStatePA pointer to a PDETextState structure with the text state for the element. Note that PDFEdit ignores the wasSetFlags flag of the PDETextState structure, so you must initialize the PDETextState fields.
textStateLen: IN ASUns32The length of the text state for the element.
textMatrixP: IN ASFixedMatrix *A pointer to an ASFixedMatrix that holds the matrix for the element.
PDETextItem PDETextItemCreateEx(IN ASUns8 *text, IN ASUns32 textLen, IN PDEFont font, IN PDEGraphicStateP gStateP, IN ASUns32 gStateLen, IN PDETextStateP textStateP, IN ASUns32 textStateLen, IN ASDoubleMatrix *textMatrixP)Creates a text item element containing a character or text run, which can be added to a PDEText text object. Supersedes PDETextItemCreate() in Acrobat 10.0. Call PDERelease() to dispose of the returned PDETextItem object when finished with it.
text: IN ASUns8 *A pointer to the characters to add. Note that passing NULL for text can invalidate the text object but will not raise an error. Callers must not pass NULL for this parameter.
textLen: IN ASUns32The length of the text in bytes.
font: IN PDEFontThe font for the element.
gStateP: IN PDEGraphicStatePA pointer to a PDEGraphicStateP structure with the graphics state for the element.
gStateLen: IN ASUns32The length of the graphics state for the element.
textStateP: IN PDETextStatePA pointer to a PDETextState structure with the text state for the element. Note that PDFEdit ignores the wasSetFlags flag of the PDETextState structure, so you must initialize the PDETextState fields.
textStateLen: IN ASUns32The length of the text state for the element.
textMatrixP: IN ASDoubleMatrix *A pointer to an ASDoubleMatrix that holds the matrix for the element.
PDEFont PDETextItemGetFont(IN PDETextItem textItem)Gets the font for a text item. This method does not change the reference count of the returned PDEFont.
textItem: IN PDETextItemThe text item whose font is obtained.
The font of the specified text item.
void PDETextItemGetGState(IN PDETextItem textItem, OUT PDEGraphicStateP stateP, IN ASUns32 stateSize)Gets the graphics state for a text item.
textItem: IN PDETextItemText item whose graphic state is obtained.
stateP: OUT PDEGraphicStateP(Filled by the method) A pointer to a PDEGraphicState structure with graphics state of the text item.
stateSize: IN ASUns32The size of the stateP buffer in bytes.
voidvoid PDETextItemGetGStateEx(IN PDETextItem textItem, OUT PDEGraphicStateExP stateP, IN ASUns32 stateSize)Gets the graphics state for a text item. This method fills PDEGraphicStateEx as output which is higher precision alternative of PDEGraphicState structure.
textItem: IN PDETextItemText item whose graphic state is obtained.
stateP: OUT PDEGraphicStateExP(Filled by the method) A pointer to a PDEGraphicStateEx structure with graphics state of the text item.
stateSize: IN ASUns32The size of the stateP buffer in bytes.
voidASUns32 PDETextItemGetTextLen(IN PDETextItem textItem)Gets the text length for a text item.
textItem: IN PDETextItemThe text item whose text length is obtained.
The text length in bytes.
void PDETextItemGetTextMatrix(IN PDETextItem textItem, IN ASUns32 charOffset, OUT ASFixedMatrix *textMatrixP)Superseded by PDETextItemGetTextMatrixEx() in Acrobat 10.0. Gets the text matrix for a character in a text item.
textItem: IN PDETextItemThe text item.
charOffset: IN ASUns32The offset of the character whose text matrix is obtained.
textMatrixP: OUT ASFixedMatrix *(Filled by the method) A pointer to a ASFixedMatrix structure with the text matrix of the character.
voidvoid PDETextItemGetTextMatrixEx(IN PDETextItem textItem, IN ASUns32 charOffset, OUT ASDoubleMatrix *textMatrixP)Supersedes PDETextItemGetTextMatrix() in Acrobat 10.0. Gets the text matrix for a character in a text item.
textItem: IN PDETextItemThe text item.
charOffset: IN ASUns32The offset of the character whose text matrix is obtained.
textMatrixP: OUT ASDoubleMatrix *(Filled by the method) A pointer to a ASDoubleMatrix structure with the text matrix of the character.
voidvoid PDETextItemGetTextState(IN PDETextItem textItem, OUT PDETextStateP textStateP, IN ASUns32 textStateSize)Gets the text state of a text item.
textItem: IN PDETextItemThe text item whose text state is obtained.
textStateP: OUT PDETextStateP(Filled by the method) A pointer to a PDETextStateP structure with text state of the text item.
textStateSize: IN ASUns32The size of the texStateP structure in bytes.
voidvoid PDETextItemRemoveChars(IN PDETextItem textItem, IN ASUns32 charOffset, IN ASUns32 count)Removes contiguous characters from a text item.
textItem: IN PDETextItemThe text item whose characters are removed.
charOffset: IN ASUns32The offset of the first character to remove.
count: IN ASUns32The number of characters to remove.
voidvoid PDETextItemReplaceChars(IN PDETextItem textItem, IN ASUns32 charIndex, IN ASUns8 *newChar, IN ASUns32 newCharLen)Replaces characters in a text item. This method does not change the number of characters in the text item; extra characters are ignored.
textItem: IN PDETextItemThe text item whose characters are replaced.
charIndex: IN ASUns32The index position of the characters to replace.
newChar: IN ASUns8 *The replacement text.
newCharLen: IN ASUns32The number of bytes to replace.
voidvoid PDETextItemReplaceText(IN PDETextItem textItem, IN ASUns8 *newText, IN ASUns32 newTextLen)Replaces all of the text in a text item.
textItem: IN PDETextItemThe text item whose text are replaced.
newText: IN ASUns8 *The replacement text.
newTextLen: IN ASUns32The number of bytes to replace.
voidvoid PDETextItemSetFont(IN PDETextItem textItem, IN PDEFont font)Sets the font for a text item. This method decrements the reference count of the previous font and increments the reference count of the new font.
textItem: IN PDETextItemThe text item whose font is set.
font: IN PDEFontThe new font object.
voidvoid PDETextItemSetGState(IN PDETextItem textItem, OUT PDEGraphicStateP stateP, IN ASUns32 stateSize)Sets the graphics state for a text item.
textItem: IN PDETextItemText item whose graphics state is set.
stateP: OUT PDEGraphicStatePA pointer to a PDEGraphicState structure with graphics state of the text item.
stateSize: IN ASUns32The size of the stateP buffer in bytes.
voidvoid PDETextItemSetGStateEx(IN PDETextItem textItem, OUT PDEGraphicStateExP stateP, IN ASUns32 stateSize)Sets the graphics state for a text item. This method takes pointer to PDEGraphicStateEx as input which is higher precision alternative of PDEGraphicState structure.
textItem: IN PDETextItemstateP: OUT PDEGraphicStateExPstateSize: IN ASUns32voidvoid PDETextItemSetTextMatrix(IN PDETextItem textItem, IN ASFixedMatrix *textMatrixP)Superseded by PDETextItemSetTextMatrixEx() in Acrobat 10.0. Sets the text matrix for a text item.
textItem: IN PDETextItemThe text item whose text matrix is set.
textMatrixP: IN ASFixedMatrix *A pointer to a ASFixedMatrix structure with the new text matrix of the text item.
voidvoid PDETextItemSetTextMatrixEx(IN PDETextItem textItem, IN ASDoubleMatrix *textMatrixP)Sets the text matrix for a text item. Supersedes PDETextItemSetTextMatrix() in Acrobat 10.0.
textItem: IN PDETextItemThe text item whose text matrix is set.
textMatrixP: IN ASDoubleMatrix *A pointer to a ASDoubleMatrix structure with the new text matrix of the text item.
voidvoid PDETextItemSetTextState(IN PDETextItem textItem, IN PDETextStateP textStateP, IN ASUns32 textStateSize)Sets the text state for a text item.
textItem: IN PDETextItemThe text item whose text state is set.
textStateP: IN PDETextStatePA PDETextStateP structure with the new text state of the text item.
textStateSize: IN ASUns32The size of the textStateP structure in bytes.
void2 items
ASAtom PDEUnknownGetOpName(IN PDEUnknown pdeUnknown)Gets the operator name of an unknown operator.
pdeUnknown: IN PDEUnknownIN/OUT Unknown element whose operator name is obtained.
An ASAtom for the name of the operator for pdeUnknown .
typedef struct _t_PDEUnknown* PDEUnknownA PDEElement representing an unknown element.
11 items
PDEColorSpace PDEXGroupAcquireColorSpace(IN PDEXGroup pdeXGroup)Acquires the color space of the transparency group. Call PDERelease() to dispose of the PDEColorSpace when finished with it.
pdeXGroup: IN PDEXGroupThe transparency group object.
The color space; otherwise it returns NULL .
PDEXGroup PDEXGroupCreate(IN CosDoc cosDoc, IN PDEXGroupCreateFlags type)Create a new XGroup of the given type. Call PDERelease() to dispose of the returned PDEXGroup object when finished with it.
cosDoc: IN CosDocThe document in which the object will be created.
type: IN PDEXGroupCreateFlagsIt must be kPDEXGroupTypeTransparency.
The newly created transparency group object.
PDEXGroup PDEXGroupCreateFromCosObj(IN const CosObj *cosObjP)Creates a new XGroup object from its Cos representation. Call PDERelease() to dispose of the returned PDEXGroup object when finished with it.
cosObjP: IN const CosObj *IN/OUT The XGroup object dictionary.
The PDEXGroup object.
void PDEXGroupGetCosObj(IN PDEXGroup pdeXGroup, OUT CosObj *cosObjP)Gets the CosObj of the transparency group.
pdeXGroup: IN PDEXGroupThe transparency group object.
cosObjP: OUT CosObj *(Filled by the method) A pointer to the Cos object.
voidASBool PDEXGroupGetIsolated(IN PDEXGroup pdeXGroup)Gets the isolated boolean value of the transparency group.
pdeXGroup: IN PDEXGroupThe transparency group object.
true if the transparency group is isolated; false otherwise.
ASBool PDEXGroupGetKnockout(IN PDEXGroup pdeXGroup)Gets the knockout boolean value of the transparency group.
pdeXGroup: IN PDEXGroupThe transparency group object.
The knockout value.
void PDEXGroupSetColorSpace(IN PDEXGroup pdeXGroup, IN PDEColorSpace pdeColorSpace)Sets the PDEXObject that defines the color space into which colors are converted when painted into this group.
pdeXGroup: IN PDEXGroupThe transparency group object.
pdeColorSpace: IN PDEColorSpaceThe color space to associate with the XGroup.
voidvoid PDEXGroupSetIsolated(IN PDEXGroup pdeXGroup, IN ASBool isolated)Sets the XGroup to be isolated or not. It corresponds to the / I key within the XGroup's dictionary.
pdeXGroup: IN PDEXGroupIN/OUT The transparency group object.
isolated: IN ASBoolIN/OUT true to isolate the XGroup, false otherwise.
voidvoid PDEXGroupSetKnockout(IN PDEXGroup pdeXGroup, IN ASBool knockout)Sets the knockout value.
pdeXGroup: IN PDEXGroupIN/OUT The transparency group object.
knockout: IN ASBoolIN/OUT The knockout value.
voidAn enumerated data type used to specify the type of transparency group to create.
Creates a transparency XGroup object.
3 items
PDEXObject PDEXObjectCreate(IN const CosObj *cosObjP)Creates a new PDEXObject from a Cos object. Call PDERelease() to dispose of the returned PDEXObject when finished with it.
cosObjP: IN const CosObj *IN/OUT The Cos object for the PDEXObject.
A PDEXObject corresponding to cosObjP .
void PDEXObjectGetCosObj(IN PDEXObject xObject, OUT CosObj *cosObjP)Gets a Cos object corresponding to a PDEXObject.
xObject: IN PDEXObjectIN/OUT The PDEXobject whose Cos object is obtained.
cosObjP: OUT CosObj *IN/OUT (Filled by the method) The Cos object for xObject .
voidtypedef struct _t_PDEXObject* PDEXObjectA PDEElement representing an arbitrary XObject.
9 items
PDSysEncoding PDSysEncodingCreateFromBaseName(IN ASAtom baseEncName, IN const char **diffEnc)Create an encoding object from the base name. Call PDERelease() to dispose of the returned PDSysEncoding object when finished with it.
baseEncName: IN ASAtomIN/OUT The base encoding. See the description of Base Encoding in the Character Encoding section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 9.6.6, page 262. You can find this document on the web store of the International Standards Organization (ISO).
diffEnc: IN const char **IN/OUT An array of 256 const char* describing the differences from the encoding specified by baseEncName . It may be NULL .
An object of type PDSysEncoding.
PDSysEncoding PDSysEncodingCreateFromCMapName(IN ASAtom cmapName)Create an encoding object from a PDF CMap name. Call PDERelease() to dispose of the returned PDSysEncoding object when finished with it.
cmapName: IN ASAtomThe CMap name.
An object of type PDSysEncoding.
PDSysEncoding PDSysEncodingCreateFromCMapStream(IN CosObj cmapStream)Creates an encoding object from a given PDF CMap stream. Call PDERelease() to dispose of the returned PDSysEncoding object when it is no longer needed.
cmapStream: IN CosObjThe CMap stream from which to create the encoding object.
The encoding object to be created.
PDSysEncoding PDSysEncodingCreateFromCodePage(IN ASInt32 codePage, IN ASInt16 wMode)Create an encoding object from a code page. Call PDERelease() to dispose of the returned PDSysEncoding object when finished with it.
codePage: IN ASInt32The code page character-mapping construct. See Code Page Values.
wMode: IN ASInt160 for horizontal writing, 1 for vertical writiing.
An object of type PDSysEncoding.
ASInt16 PDSysEncodingGetWMode(IN PDSysEncoding sysEnc)Returns writing mode. 0 for horizontal writing and 1 for vertical writing.
sysEnc: IN PDSysEncodingIN/OUT An object of type PDSysEncoding.
0 for horizontal writing and 1 for vertical writing.
ASBool PDSysEncodingIsIdentity(IN PDSysEncoding sysEnc)Returns true for Identity-H or Identity-V encoding, false otherwise.
sysEnc: IN PDSysEncodingIN/OUT An object of type PDSysEncoding.
See above.
sysEnc: IN PDSysEncodingIN/OUT An object of type PDSysEncoding.
See above.
void PDSysEncodingSetIsUTF16(IN PDSysEncoding sysEnc, IN ASBool isUTF16)sysEnc: IN PDSysEncodingIN/OUT An object of type PDSysEncoding.
isUTF16: IN ASBoolA boolean value specifying if the encoding is UTF-16
voidtypedef struct _t_PDSysEncoding* PDSysEncodingA PDEElement that provides system encoding for a PDF file.
19 items
If there is a font on the system that matches this PDEFont, embed the full font regardless of whether it was subsetted or not embedded at all in the first place. This will not work for CID fonts, because they must be subsetted. The matching is based on the PDSysFontMatchFlags. Only the font object itself is modified; no content streams are changed. This method does not change the reference count of the font.
font: IN PDEFontIN/OUT A PDEFont object returned from one of the PDEFontCreate methods.
flags: IN ASUns32IN/OUT Flags from PDSysFontMatchFlags that determine matches.
cosDoc: IN CosDocIN/OUT Currently unused.
voidvoid PDEnumSysFonts(IN PDSysFontEnumProc enumProc, IN void *clientData)Enumerates all of the system fonts with a user-supplied procedure. The PDSysFont must be acquired during the enumeration if the font is needed beyond the enumProc . Developers should not assume that the enumProc will be called. If no system fonts are found (for example, if the PSRESOURCEPATH environment variable is not set on UNIX platforms), enumProc is never called, and PDEnumSysFonts() does not raise an exception. The font names that are returned from the methods PDEnumSysFonts() and PDSysFontGetAttrs() are different in 5.0 and later (compared to 4.05). The differences are shown in the table: Acrobat 4.05 Name Acrobat 4.05 PSname Acrobat 5.0 (and later) Name Acrobat 5.0 (and later) Psname MS-Mincho NULL MSMincho MS-Mincho MS-Gothic NULL MSGothic MS-Gothic MS-PMincho NULL MSPMincho MS-PMincho MS-PGothic NULL MSPGothic MS-PGothic MS-UIGothic NULL MSUIGothic MS-UIGothic
enumProc: IN PDSysFontEnumProcIN/OUT A user-supplied callback to call once for each system font. Enumeration continues until all fonts have been enumerated, or until enumProc returns false .
clientData: IN void *IN/OUT A pointer to user-supplied data to pass to enumProc each time it is called.
voidFinds a system font that matches the requested attributes. The method gets the PDSysFont rather than acquires it, so do not call PDERelease() on the returned PDSysFont when done with it.
attrs: IN PDEFontAttrsPIN/OUT A pointer to a PDEFontAttrs structure with the attributes of the font you are searching for.
attrsSize: IN ASUns32IN/OUT The size of the attrs buffer in bytes.
flags: IN ASUns32IN/OUT Flags from PDSysFontMatchFlags.
PDSysFontThe desired system font.
PDSysFont PDFindSysFontEx(IN PDEFontAttrsP attrs, IN ASUns32 attrsSize, IN ASUns32 flags, OUT ASFixed *mmDesignVector, OUT ASInt32 *designVecLength)Finds a system font that matches the requested attributes. If the requested font is a multiple master font instance, the base font is returned, and the specified design vector is decoded and returned in mmDesignVector. The method gets the PDSysFont rather than acquires it, so do not call PDERelease() on the returned PDSysFont when done with it.
attrs: IN PDEFontAttrsPIN/OUT A pointer to a PDEFontAttrs structure with the attributes of the font you are searching for.
attrsSize: IN ASUns32IN/OUT The size of the attrs buffer in bytes.
flags: IN ASUns32IN/OUT Flags from PDSysFontMatchFlags.
mmDesignVector: OUT ASFixed *IN/OUT (Filled by the method) If the requested font is a Multiple Master font instance, the specified design vector is decoded and returned in mmDesignVector .
designVecLength: OUT ASInt32 *IN/OUT (Filled by the method) Pass the length of mmDesignVector . This parameter also returns the number of elements filled in mmDesignVector (the maximum is 4 ).
PDSysFontThe desired system font.
PDSysFont PDFindSysFontForPDEFont(IN PDEFont font, IN ASUns32 flags)Finds a system font that matches the requested PDEFont. The method gets the PDSysFont rather than acquires it, so do not call PDERelease() on the returned PDSysFont when done with it.
font: IN PDEFontIN/OUT A PDEFont whose matching system font is found.
flags: IN ASUns32IN/OUT A bit field comprised of PDSysFontMatchFlags values.
kPDSysFontMatchNameAndCharSet
kPDSysFontMatchFontType
PDSysFontMatchFlags Passing zero matches font by name only.
PDSysFontThe system font corresponding to font .
PDSysFontPlatDataP PDSysFontAcquirePlatformData(IN PDSysFont sysFont)Acquires platform-specific data for use by user interface code. It must be released when finished by PDSysFontReleasePlatformData().
sysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a system font returned by either PDFindSysFont() or PDFindSysFontForPDEFont().
PDSysFontPlatDataPA pointer to a platform-dependent structure, PDSysFontPlatData , containing information relating to a system font. It returns NULL if it is out of memory.
void PDSysFontGetAttrs(IN PDSysFont sysFont, OUT PDEFontAttrsP attrsP, IN ASUns32 attrsSize)Gets the attributes of a system font. The attributes will be returned in the buffer pointed to by attrsP . No more than attrsSize bytes will be written to the buffer. This call can be expensive to execute, as it may involve parsing the font in order to determine attributes. The font names that are returned from the methods PDEnumSysFonts() and PDSysFontGetAttrs() are different in 5.0 and later (compared to 4.05). The differences are shown in the table: Acrobat 4.05 Name Acrobat 4.05 PSname Acrobat 5.0 (and later) Name Acrobat 5.0 (and later) Psname MS-Mincho NULL MSMincho MS-Mincho MS-Gothic NULL MSGothic MS-Gothic MS-PMincho NULL MSPMincho MS-PMincho MS-PGothic NULL MSPGothic MS-PGothic MS-UIGothic NULL MSUIGothic MS-UIGothic
sysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a system font whose attributes are obtained.
attrsP: OUT PDEFontAttrsPIN/OUT (Filled by the method) A pointer to a PDEFontAttrs structure with the attributes of a system font.
attrsSize: IN ASUns32IN/OUT The size of the attrsP buffer in bytes.
voidvoid PDSysFontGetCIDSystemInfo(IN PDSysFont sysFont, OUT ASAtom *registry, OUT ASAtom *ordering, OUT ASInt32 *supplement)Derives the registry, ordering, and supplement information of a multi-byte system font. This information can be used to create a PDEFont from a system font. For more information on CID fonts, see PDFontGetCIDSystemInfo().
sysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a multi-byte system font.
registry: OUT ASAtom *IN/OUT (Filled by the method) The ASAtom representing the CIDFont's Registry information (for example, "Adobe" ).
ordering: OUT ASAtom *IN/OUT (Filled by the method) The ASAtom representing the CIDFont's Ordering information (for example, "Japan1" ).
supplement: OUT ASInt32 *IN/OUT (Filled by the method) The SystemSupplement field from the CIDFont.
voidASInt32 PDSysFontGetCreateFlags(IN PDSysFont sysFont, IN PDSysEncoding sysEnc)This function returns a createFlags that can be passed to PDEFontCreateFromSysFontAndEncoding(). If the combination of sysFont and sysEnc is not allowed, -1 is returned.
sysFont: IN PDSysFontIN/OUT An object of type PDSysFont.
sysEnc: IN PDSysEncodingIN/OUT An object of type PDSysEncoding.
See above.
Uns8 ** PDSysFontGetEncoding(IN PDSysFont sysFont, OUT ASAtom *encodingNameP)Gets the encoding of a single byte encoded system font. The returned encoding must be freed via a call to ASfree(). If the return value is zero, encodingNameP contains the name of the encoding: For a Type 1 font, the default encoding is that specified by the Encoding value in the font dictionary. For a TrueType font, the default encoding is that specified in the single byte CMAP table.
sysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a system font whose encoding is obtained.
encodingNameP: OUT ASAtom *IN/OUT (Filled by the method) An encoding name if the return value of PDSysFontGetEncoding() is zero. If encodingNameP is the NULL ASAtom, the font uses its default encoding.
Uns8 **An encoding array of 256 C strings. Each entry in the array either contains a glyph name or NULL . If it is NULL , the corresponding entry uses the font's built in encoding value.
void PDSysFontGetInfo(IN PDSysFont sysFont, OUT PDEFontInfoP infoP, IN ASUns32 infoSize)Gets high-level information about a system font.
sysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a system font whose information is obtained.
infoP: OUT PDEFontInfoPIN/OUT (Filled by the method) A pointer to PDEFontInfoRec structure to fill with font information for sysFont . No more than infoSize bytes are written to this buffer.
infoSize: IN ASUns32IN/OUT The size of the infoP buffer in bytes.
voidASAtom PDSysFontGetName(IN PDSysFont sysFont)Gets the PostScript or TrueType styled name for a system font.
sysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a system font whose name is obtained.
The ASAtom for the system font's name.
PDScript PDSysFontGetScript(IN PDSysFont sysFont)Returns a PDScript value for the specified PDSysFont.
sysFont: IN PDSysFontThe font from which to acquire the script.
PDScriptvoid PDSysFontGetType0Widths(IN PDSysFont sysFont, IN ASAtom ordering, OUT ASBool *hasDW, OUT ASInt32 *dw, OUT CosObj *w, OUT ASBool *hasDW2, OUT ASInt32 *dw2, OUT CosObj *w2)Gets width information from a Type 0 system font. This information can be used to create a PDEFont from a system font. You can find this document on the web store of the International Standards Organization (ISO). You can find this document on the web store of the International Standards Organization (ISO). You can find this document on the web store of the International Standards Organization (ISO). You can find this document on the web store of the International Standards Organization (ISO). In general, you are discouraged from using this method. Instead use PDEFontCreateFromSysFontAndEncoding() followed by PDEFontCreateWidthsNow() to create the W entry in a font.
sysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a multibyte system font.
ordering: IN ASAtomIN/OUT An ASAtom representing the CIDFont's Ordering information. It is used to get a CMap object for sysFont .
hasDW: OUT ASBool *IN/OUT (Filled by the method) true if sysFont has a valid dw value; false otherwise.
dw: OUT ASInt32 *IN/OUT (Filled by the method) The default width for glyphs in a CIDFont. Currently, it is always 1000 . See the description of CIDFontType 0 in "Composite Fonts" in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 9.7, page 267.
w: OUT CosObj *IN/OUT (Filled by the method) A Cos array of a set of lists that define the widths for the glyphs in the CIDFont. Each list can specify individual widths for consecutive CIDs, or one width for a range of CIDs. For information on the format of this array, see the description of CID Fonts in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 9.7.4, page 269.
hasDW2: OUT ASBool *IN/OUT (Filled by the method) true if sysFont has a valid dw2 value. The default is false .
dw2: OUT ASInt32 *IN/OUT (Filled by the method) The default metrics for writing mode 1. This entry is an array of two ASInt32 numbers: the y component of the position vector and the y component of the displacement vector for writing mode 1. The x component of the position vector is always half the width of the character. The x component of the displacement vector is always 0 . The default value is [880-1000] . For information on writing mode 1, see the description of CID Fonts in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 9.7.4, page 269.
w2: OUT CosObj *IN/OUT (Filled by the method) A Cos array defining the metrics for vertical writing. Its format is similar to the format of the array in w . It defines the x and y components of the position vector, and the y component of the displacement vector. The x component of the displacement vector is always 0 . For information on the format of this array, see the description of CID Fonts in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 9.7.4, page 269.
voidvoid PDSysFontGetWidths(IN PDSysFont sysFont, OUT ASInt16 *widthsP)Gets the widths of a single byte encoded system font.
sysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a system font whose widths are obtained.
widthsP: OUT ASInt16 *IN/OUT (Filled by the method) A pointer to the widths array. widthsP must have room for 256 entries.
voidsysFont: IN PDSysFontIN/OUT A PDSysFont object referencing a system font whose widths are obtained.
widthsP: OUT ASInt16 *IN/OUT (Filled by the method) A pointer to the widths array. widthsP must have room for 256 entries.
mmDesignVector: IN ASFixed *IN/OUT If sysFont is a multiple master font, it points to the design vector, whose length must equal the number of design axes of sysFont .
voidvoid PDSysFontReleasePlatformData(IN PDSysFontPlatDataP platDataP)Releases platform-specific data for the specified PDSysFont.
platDataP: IN PDSysFontPlatDataPIN/OUT A pointer to a PDSysFontPlatDataP structure containing platform-specific data.
voidASInt32 PDSysFontVerifyEncoding(IN PDSysFont sysFont, IN PDSysEncoding sysEnc)Similar to PDSysFontGetCreateFlags but avoids compatibility issues with changing PDSysFontGetCreateFlags. If the combination of sysFont and sysEnc is not allowed, -1 is returned. If the combination is ok, then 0 is returned. If the combination only works if the font is embedded, kPDEFontCreateEmbedded is returned.
sysFont: IN PDSysFontIN/OUT An object of type PDSysFont.
sysEnc: IN PDSysEncodingIN/OUT An object of type PDSysEncoding.
See above.