#define CastToPDAnnot ( a ) *( PDAnnot *) &( a ) a | The link annotation or text annotation to cast.
|
#define PDAnnotIgnorePerms 0x0008 #define PDAnnotInfoInit ( x ) #define PDAnnotMaxDashes 10 #define PDAnnotOperationAll 0xFFFF #define PDAnnotOperationFilter 0x0002 #define PDAnnotOperationFlatten 0x0010 #define PDAnnotOperationManager 0x0004 #define PDAnnotOperationSummarize 0x0001 #define pdAnnotHidden 0x02 #define pdAnnotInvisible 0x01 #define pdAnnotLock 0x80 #define pdAnnotLockContents 0x200 #define pdAnnotNoRotate 0x10 #define pdAnnotNoView 0x20 #define pdAnnotNoZoom 0x08 #define pdAnnotPrint 0x04 #define pdAnnotReadOnly 0x40 #define pdAnnotSequenceAdjust 0x80000000 noView bit to toggle. #define pdAnnotToggleNoView 0x100 kPDAnnotPrintStandard=1 | A standard print operation.
|
kPDAnnotPrintVariableData | The user selected Form Fields Only.
|
typedef OPAQUE_64_BITS PDAnnot; typedef struct _t_PDAnnotClipboardData *PDAnnotClipboardData; For value options see PDAnnotPrintOps.
typedef ASEnum16 PDAnnotPrintOp; ASBool PDAnnotWillPrintProc(PDAnnotHandler pdanh, PDAnnot annot); pdanh | The annotation handler of the annotation type to print.
|
annot | The annotation to print.
|
| |
The size of the data structure. It must be set to
sizeof(PDAnnotInfoRec). | |
The allowed operations.
| |
unsigned char *cAuthor; | The author of this annotation.
|
unsigned char *cContents; | The associated text for this annotation.
|
unsigned char *cDate; | The modification date of this annotation.
|
The layer of this annotation.
| |
|
ASBool PDAnnotCanCopy(PDPage sourcePage, PDAnnot annot); sourcePage | The page containing the annotation to test. It can be
NULL (as when copying annotations while spawning a hidden template). |
annot | The annotation to test.
|
ASBool PDAnnotCanPaste(PDPage destPage, const ASFixedPoint *center, PDAnnotClipboardData data); destPage | The page to which the annotation would be pasted.
|
center | The location for the center of the annotation on the destination page, or a
NULL pointer to center the annotation on the destination page. |
data | The copied annotation data to test.
|
PDAnnotClipboardData PDAnnotCopy(PDPage sourcePage, PDAnnot annot); sourcePage | The page containing the annotation to copy. It can be
NULL (as when copying annotations while spawning a hidden template). |
annot | The annotation to copy.
|
void PDAnnotDestroyClipboardData(PDAnnotClipboardData data); data | The clipboard annotation data to destroy.
|
ASBool PDAnnotEqual(PDAnnot anAnnot, PDAnnot annot2); anAnnot | The first annotation to compare.
|
annot2 | The second annotation to compare.
|
true if the annotations are equal, false otherwise. Two annotations are equal only if their Cos objects are equal (see CosObjEqual()). PDAnnot PDAnnotFromCosObj(CosObj obj); obj | The dictionary Cos object whose annotation is obtained.
|
is raised if the annotation is invalid, as determined by PDAnnotIsValid().
|
ASBool PDAnnotGetColor(PDAnnot anAnnot, PDColorValue color); anAnnot | The note or link annotation whose color is obtained.
| ||||||||||
color | (Filled by the method) The annotation's color, which is used as follows:
|
CosObj PDAnnotGetCosObj(PDAnnot annot); annot | IN/OUT The annotation whose Cos object is obtained.
|
NULL Cos object if the annotation is not valid, as determined by PDAnnotIsValid(). ASBool PDAnnotGetDate(PDAnnot anAnnot, ASTimeRecP date); anAnnot | The annotation whose date is obtained.
|
date | (Filled by the method) The annotation's time and date.
|
true if the annotation contains a date key and the value of that key can be successfully parsed as a date string, false otherwise. is raised if the annotation is not valid or if the value of the annotation's M (ModDate) key is not a string.
| |
is raised if
date is NULL. |
ASUns32 PDAnnotGetFlags(PDAnnot anAnnot); anAnnot | IN/OUT The annotation whose flags are obtained.
|
0 if the annotation does not have a flags key. PDOCMD PDAnnotGetOCMD(PDAnnot annot); annot | The annotation from which the dictionary is obtained.
|
NULL if the annotation does not contain a dictionary. void PDAnnotGetRect(PDAnnot anAnnot, ASFixedRect *boxP); anAnnot | IN/OUT The annotation whose location and size are set.
|
boxP | IN/OUT (Filled by the method) A pointer to a rectangle that specifies the annotation's bounding rectangle, specified in user space coordinates.
|
ASAtom PDAnnotGetSubtype(PDAnnot anAnnot); anAnnot | The annotation whose subtype is obtained.
|
Note: This text is stored in either PDFDocEncoding or in Unicode. If it is stored in Unicode, a valid Byte Order Mark must be present.
ASInt32 PDAnnotGetTitle(PDAnnot anAnnot, char *buffer, ASInt32 bufSize); anAnnot | IN/OUT The annotation whose label is obtained.
|
buffer | IN/OUT (Filled by the method) The string into which the annotation's label string is copied. If the string is non-
NULL, up to bufsSize bytes are copied into the buffer. |
bufSize |
NULL, it returns the number of bytes copied, not counting the trailing NULL. If the string is NULL, it returns the number of bytes that would be copied if the string were not NULL. void PDAnnotGetTitleASText(PDAnnot anAnnot, ASText title); anAnnot | The annotation whose label is obtained.
|
title | (Filled by the method) The text object containing the annotation's label string. The client must pass a valid ASText object title. The routine does not allocate it.
|
ON-OFF states of the optional-content groups in the optional-content dictionary (OCMD) and the dictionary's visibility policy. ASBool PDAnnotIsCurrentlyVisible(PDAnnot annot, PDOCContext ocContext); annot | The annotation to test.
|
ocContext | The optional-content context in which the visibility is tested.
|
ASBool PDAnnotIsValid(PDAnnot anAnnot); anAnnot | The annotation whose validity is tested.
|
void PDAnnotNotifyDidChange(PDAnnot annot, ASAtom key, ASInt32 err); annot | The annotation that has changed.
|
key | The ASAtom corresponding to the name of the key in the annotation's Cos dictionary that is changing.
|
err | An error code to pass to any method registered to receive the PDAnnotDidChange() notification. Pass zero if the annotation was changed successfully. Pass a nonzero value if an error occurred while changing the annotation.
|
void PDAnnotNotifyWillChange(PDAnnot annot, ASAtom key); annot | The annotation that has changed.
|
key | The ASAtom corresponding to the name of the key in the annotation's Cos dictionary that is changing.
|
PDAnnot PDAnnotPaste(PDPage destPage, const ASFixedPoint *center, PDAnnotClipboardData data); destPage | The page to which the annotation is pasted.
|
center | The location for the center of the annotation on the destination page, or a
NULL pointer to center the annotation on the destination page. |
data | The copied annotation data to paste.
|
void PDAnnotRemoveOCMD(PDAnnot annot); annot | The annotation for which to remove the dictionary.
|
void PDAnnotSetColor(PDAnnot anAnnot, const PDColorValue color); anAnnot | IN/OUT The note or link annotation whose color is set.
| ||||||||||
color | IN/OUT The annotation's color, which is used as follows:
|
void PDAnnotSetDate(PDAnnot anAnnot, const ASTimeRecP date); anAnnot | IN/OUT The annotation whose date is set.
|
date | IN/OUT The annotation's time and date.
|
void PDAnnotSetFlags(PDAnnot anAnnot, ASUns32 flags); anAnnot | IN/OUT The annotation whose flags are set.
|
flags | IN/OUT An
OR of the PDAnnot Flags values. |
void PDAnnotSetOCMD(PDAnnot annot, PDOCMD pdocmd); annot | The annotation for which to set the dictionary.
|
pdocmd | The new dictionary.
|
void PDAnnotSetRect(PDAnnot anAnnot, const ASFixedRect *newBox); anAnnot | IN/OUT The annotation whose location and size are set.
|
newBox | IN/OUT A pointer to a rectangle that specifies the annotation's bounding rectangle, specified in user space coordinates.
|
Note: This text is stored in either PDFDocEncoding or in Unicode. If it is stored in Unicode, a valid Byte Order Mark must be present.
void PDAnnotSetTitle(PDAnnot anAnnot, const char *str, ASInt32 nBytes); anAnnot | IN/OUT The annotation whose label is set.
|
str | IN/OUT The string containing the label to set.
|
nBytes | IN/OUT The length of the label. The first
nBytes bytes of str are used as the label. |
void PDAnnotSetTitleASText(PDAnnot anAnnot, const ASText title); anAnnot | The annotation whose label is set.
|
title | The text object containing the label to set.
|