PDEElementCopy
()
. kPDEElementCopyForClip = 0x0001 | The copied element does not need
gstate or clip . |
kPDEElementCopyClipping = 0x0002 | Acquire the clip path and put it in the copied object.
|
typedef
struct
_t_PDEElement
*
PDEElement
;
ASBool
PDEElementEnumProc(
IN
PDEElement
elem
,
IN
void
*
clientData
);
elem | The PDEElement.
|
clientData | User-supplied data that was specified in the call to PDEEnumElements().
|
PDEElement
PDEElementCopy(
IN
PDEElement
pdeElement
,
IN
ASUns32
flags
);
pdeElement | IN/OUT The element to copy.
|
flags | IN/OUT A bit field of PDEElementCopyFlags.
|
pdeElement
. 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.
ASUns32
PDEElementGetAllVisibilities(
PDEElement
elem
,
PDEContent
content
,
PDOCContext
ocContext
,
ASBool
*
visibilities
,
ASUns32
capacity
);
elem | The element for which to obtain visibilities.
|
content | The content containing the element.
|
ocContext | The optional-content context in which the element is tested.
|
visibilities | |
capacity | The size of the visibilities array.
|
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.
void
PDEElementGetBBox(
IN
PDEElement
pdeElement
,
OUT
ASFixedRectP
bboxP
);
pdeElement | IN/OUT An element whose bounding box is obtained.
|
bboxP | IN/OUT (Filled by the method) A pointer to a ASFixedRect structure specifying the bounding box of
pdeElement , specified in user space coordinates. |
gstate
and should not be expected to return valid results. Note: This method does not change the reference count of the clip object.
PDEClip
PDEElementGetClip(
IN
PDEElement
pdeElement
);
pdeElement | IN/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.
|
pdeElement
. Gets the graphics state information for an element.
This method is only valid for PDEForm, PDEImage, PDEPath, and PDEShading elements.
void
PDEElementGetGState(
IN
PDEElement
pdeElement
,
OUT
PDEGraphicStateP
stateP
,
IN
ASUns32
stateSize
);
pdeElement | An element whose graphics state is obtained.
|
stateP | (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 | The size of the
stateP buffer in bytes. |
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.
void
PDEElementGetGStateEx(
IN
PDEElement
pdeElement
,
OUT
PDEGraphicStateExP
stateP
,
IN
ASUns32
stateSize
);
pdeElement | An element whose graphics state is obtained.
|
stateP | (Filled by the method) A pointer to a PDEGraphicStateEx structure that contains graphics state information for
pdeElement . This PDEGraphicStateExP 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 | The size of the
stateP buffer in bytes. |
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.
void
PDEElementGetMatrix(
IN
PDEElement
pdeElement
,
OUT
ASFixedMatrixP
matrixP
);
pdeElement | An element whose transformation matrix is obtained.
|
matrixP | (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. |
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.
void
PDEElementGetMatrixEx(
IN
PDEElement
pdeElement
,
OUT
ASDoubleMatrixP
matrixP
);
pdeElement | An element whose transformation matrix is obtained.
|
matrixP | (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. |
NULL
.NULL
.PDOCMD
PDEElementGetOCMD(
PDEElement
elem
);
elem | The element from which the dictionary is obtained.
|
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
);
pdeElement | The PDEElement whose graphics state is to be obtained.
|
stateP | (Filled by the method) A pointer to a PDEGraphicState structure that contains graphics state information for
pdeElement . |
stateSize | The size of the
stateP buffer. Set it to sizeof(PDEGraphicState) . |
ASBool
PDEElementHasGStateEx(
IN
PDEElement
pdeElement
,
OUT
PDEGraphicStateExP
stateP
,
IN
ASUns32
stateSize
);
pdeElement | The PDEElement whose graphics state is to be obtained.
|
stateP | (Filled by the method) A pointer to a PDEGraphicStateEx structure that contains graphics state information for
pdeElement . |
stateSize | The size of the
stateP buffer. Set it to sizeof(PDEGraphicStateEx) . |
ASBool
PDEElementIsAtPoint(
IN
PDEElement
elem
,
IN
ASFixedPoint
point
);
elem | IN/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/OUT The point, specified in user space coordinates.
|
ASBool
PDEElementIsAtRect(
IN
PDEElement
elem
,
IN
ASFixedRect
rect
);
elem | IN/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/OUT The rectangle, specified in user space coordinates.
|
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:
true
if the object is visible, without considering whether the PDEContent that the element belongs to is visible.true
.ASBool
PDEElementIsCurrentlyVisible(
PDEElement
elem
,
PDEContent
content
,
PDOCContext
ocContext
);
elem | The element to test.
|
content | The content containing the element.
|
ocContext | The optional-content context in which the element is tested.
|
ON-OFF
states of the optional-content groups. ASBool
PDEElementMakeVisible(
PDEElement
elem
,
PDEContent
content
,
PDOCContext
ocContext
);
elem | The element for which to set the visibility state.
|
content | The content containing the element.
|
ocContext | The optional-content context in which the element is made visible.
|
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:
void
PDEElementRemoveOCMD(
PDEElement
elem
);
elem | The element for which to remove the dictionary.
|
pdeElement
parameter's previous clip's reference count is decremented (if it had one), and the pdeClip
parameter's reference count is incremented. void
PDEElementSetClip(
IN
PDEElement
pdeElement
,
IN
PDEClip
pdeClip
);
pdeElement | IN/OUT An element whose clip is set.
|
pdeClip | IN/OUT The clip to set for
pdeContent . |
Sets the graphics state information for an element.
This method is valid only for PDEForm, PDEImage, PDEPath, and PDEShading elements.
Note: 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.
void
PDEElementSetGState(
IN
PDEElement
pdeElement
,
IN
PDEGraphicStateP
stateP
,
IN
ASUns32
stateSize
);
pdeElement | An element whose graphics state is set.
|
stateP | A 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 | The size of the
stateP buffer in bytes. |
will be raised if the first parameter,
pdeElement , does not have a graphics state associated with it. |
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.
Note: 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.
void
PDEElementSetGStateEx(
IN
PDEElement
pdeElement
,
IN
PDEGraphicStateExP
stateP
,
IN
ASUns32
stateSize
);
pdeElement | An element whose graphics state is set.
|
stateP | A pointer to a PDEGraphicStateEx 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 | The size of the
stateP buffer in bytes. |
will be raised if the first parameter,
pdeElement , does not have a graphics state associated with it. |
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.
void
PDEElementSetMatrix(
IN
PDEElement
pdeElement
,
IN
ASFixedMatrixP
matrixP
);
pdeElement | IN/OUT An element whose transformation matrix is set.
|
matrixP | IN/OUT A pointer to an ASFixedMatrix that holds the transformation matrix to set for
pdeContent . |
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.
void
PDEElementSetMatrixEx(
IN
PDEElement
pdeElement
,
IN
ASDoubleMatrixP
matrixP
);
pdeElement | IN/OUT An element whose transformation matrix is set.
|
matrixP | IN/OUT A pointer to an ASDoubleMatrix that holds the transformation matrix to set for
pdeContent . |
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:
void
PDEElementSetOCMD(
PDEElement
elem
,
PDOCMD
pdOCMD
);
elem | The element for which to set the dictionary.
|
pdOCMD | The new dictionary.
|