Foxit PDF SDK
fpdf_annot_r.h
Go to the documentation of this file.
1 
48 #ifndef _FSPDF_ANNOT_R_H_
49 #define _FSPDF_ANNOT_R_H_
50 
86 #ifdef __cplusplus
87 extern "C" {
88 #endif
89 
90 /*******************************************************************************/
91 /* Load or unload annotations from page */
92 /*******************************************************************************/
120 FS_RESULT FSPDF_Page_LoadAnnots(FSCRT_PAGE page);
121 
145 FS_RESULT FSPDF_Page_UnloadAnnots(FSCRT_PAGE page);
146 
147 /*******************************************************************************/
148 /* Enumerate annotation types */
149 /*******************************************************************************/
150 #ifndef _FSPDF_DEF_MACRO_ANNOTTYPE_
151 #define _FSPDF_DEF_MACRO_ANNOTTYPE_
152 
159 #define FSPDF_ANNOTTYPE_TEXT "Text"
160 
161 #define FSPDF_ANNOTTYPE_LINK "Link"
162 
163 #define FSPDF_ANNOTTYPE_FREETEXT "FreeText"
164 
165 #define FSPDF_ANNOTTYPE_LINE "Line"
166 
167 #define FSPDF_ANNOTTYPE_SQUARE "Square"
168 
169 #define FSPDF_ANNOTTYPE_CIRCLE "Circle"
170 
171 #define FSPDF_ANNOTTYPE_POLYGON "Polygon"
172 
173 #define FSPDF_ANNOTTYPE_POLYLINE "PolyLine"
174 
175 #define FSPDF_ANNOTTYPE_HIGHLIGHT "Highlight"
176 
177 #define FSPDF_ANNOTTYPE_UNDERLINE "Underline"
178 
179 #define FSPDF_ANNOTTYPE_SQUIGGLY "Squiggly"
180 
181 #define FSPDF_ANNOTTYPE_STRIKEOUT "StrikeOut"
182 
183 #define FSPDF_ANNOTTYPE_STAMP "Stamp"
184 
185 #define FSPDF_ANNOTTYPE_CARET "Caret"
186 
187 #define FSPDF_ANNOTTYPE_INK "Ink"
188 
189 #define FSPDF_ANNOTTYPE_POPUP "Popup"
190 
191 #define FSPDF_ANNOTTYPE_FILEATTACHMENT "FileAttachment"
192 
193 #define FSPDF_ANNOTTYPE_REDACT "Redact"
194 
198 #define FSPDF_ANNOTTYPE_SOUND "Sound"
199 
203 #define FSPDF_ANNOTTYPE_MOVIE "Movie"
204 
209 #define FSPDF_ANNOTTYPE_WIDGET "Widget"
210 
214 #define FSPDF_ANNOTTYPE_SCREEN "Screen"
215 
219 #define FSPDF_ANNOTTYPE_PRINTERMARK "PrinterMark"
220 
224 #define FSPDF_ANNOTTYPE_TRAPNET "TrapNet"
225 
230 #define FSPDF_ANNOTTYPE_WATERMARK "Watermark"
231 
236 #define FSPDF_ANNOTTYPE_PSI "PSInk"
237 
241 #define FSPDF_ANNOTTYPE_3D "3D"
242 
244 #endif /* _FSPDF_DEF_MACRO_ANNOTTYPE_ */
245 
280 FS_RESULT FSPDF_Annot_GetCount(FSCRT_PAGE page, const FSCRT_BSTR* filter, FS_INT32* count);
281 
319 FS_RESULT FSPDF_Annot_Get(FSCRT_PAGE page, const FSCRT_BSTR* filter, FS_INT32 index, FSCRT_ANNOT* annot);
320 
361 FS_RESULT FSPDF_Annot_GetAtPos(FSCRT_PAGE page, const FSCRT_BSTR* filter, FS_FLOAT x, FS_FLOAT y, FS_FLOAT tolerance, FSCRT_ANNOT* annot);
362 
404 FS_RESULT FSPDF_Annot_GetAtDevicePos(FSCRT_PAGE page, const FSCRT_BSTR* filter, const FSCRT_MATRIX* matrix, FS_INT32 x, FS_INT32 y, FS_INT32 tolerance, FSCRT_ANNOT* annot);
405 
438 FS_RESULT FSPDF_Annot_GetIndex(FSCRT_ANNOT annot, const FSCRT_BSTR* filter, FS_INT32* index);
439 
487 FS_RESULT FSPDF_Annot_GetAllByTabOrder(FSCRT_PAGE page, const FSCRT_BSTR* filter, FSCRT_ANNOT* annotArray, FS_INT32* count);
488 
489 /*******************************************************************************/
490 /* Annotation common properties */
491 /*******************************************************************************/
492 #ifndef _FSPDF_DEF_MACRO_ANNOTFLAG_
493 #define _FSPDF_DEF_MACRO_ANNOTFLAG_
494 
506 #define FSPDF_ANNOTFLAG_INVISIBLE 0x0001
507 
513 #define FSPDF_ANNOTFLAG_HIDDEN 0x0002
514 
522 #define FSPDF_ANNOTFLAG_PRINT 0x0004
523 
531 #define FSPDF_ANNOTFLAG_NOZOOM 0x0008
532 
540 #define FSPDF_ANNOTFLAG_NOROTATE 0x0010
541 
549 #define FSPDF_ANNOTFLAG_NOVIEW 0x0020
550 
558 #define FSPDF_ANNOTFLAG_READONLY 0x0040
559 
567 #define FSPDF_ANNOTFLAG_LOCKED 0x0080
568 
575 #define FSPDF_ANNOTFLAG_TOGGLENOVIEW 0x0100
576 
584 #define FSPDF_ANNOTFLAG_LOCKEDCONTENTS 0x0200
585 
587 #endif /* _FSPDF_DEF_MACRO_ANNOTFLAG_ */
588 
589 #ifndef _FSPDF_DEF_MACRO_ANNOT_ICONNAME_
590 #define _FSPDF_DEF_MACRO_ANNOT_ICONNAME_
591 
596 #define FSPDF_ANNOT_ICONNAME_TEXT_CHECK "Check"
597 
598 #define FSPDF_ANNOT_ICONNAME_TEXT_CIRCLE "Circle"
599 
600 #define FSPDF_ANNOT_ICONNAME_TEXT_COMMENT "Comment"
601 
602 #define FSPDF_ANNOT_ICONNAME_TEXT_CROSS "Cross"
603 
604 #define FSPDF_ANNOT_ICONNAME_TEXT_HELP "Help"
605 
606 #define FSPDF_ANNOT_ICONNAME_TEXT_INSERT "Insert"
607 
608 #define FSPDF_ANNOT_ICONNAME_TEXT_KEY "Key"
609 
610 #define FSPDF_ANNOT_ICONNAME_TEXT_NEWPARAGRAPH "NewParagraph"
611 
612 #define FSPDF_ANNOT_ICONNAME_TEXT_NOTE "Note"
613 
614 #define FSPDF_ANNOT_ICONNAME_TEXT_PARAGRAPH "Paragraph"
615 
616 #define FSPDF_ANNOT_ICONNAME_TEXT_RIGHARROW "RightArrow"
617 
618 #define FSPDF_ANNOT_ICONNAME_TEXT_RIGHPOINTER "RightPointer"
619 
620 #define FSPDF_ANNOT_ICONNAME_TEXT_STAR "Star"
621 
622 #define FSPDF_ANNOT_ICONNAME_TEXT_UPARROW "UpArrow"
623 
624 #define FSPDF_ANNOT_ICONNAME_TEXT_UPLEFTARROW "UpleftArrow"
625 
627 #define FSPDF_ANNOT_ICONNAME_FILEATTACH_GRAPH "Graph"
628 
629 #define FSPDF_ANNOT_ICONNAME_FILEATTACH_PAPERCLIP "Paperclip"
630 
631 #define FSPDF_ANNOT_ICONNAME_FILEATTACH_PUSHPIN "PushPin"
632 
633 #define FSPDF_ANNOT_ICONNAME_FILEATTACH_TAG "Tag"
634 
636 #define FSPDF_ANNOT_ICONNAME_STAMP_APPROVED "Approved"
637 
638 #define FSPDF_ANNOT_ICONNAME_STAMP_ASIS "AsIs"
639 
640 #define FSPDF_ANNOT_ICONNAME_STAMP_CONFIDENTIAL "Confidential"
641 
642 #define FSPDF_ANNOT_ICONNAME_STAMP_DEPARTMENTAL "Departmental"
643 
644 #define FSPDF_ANNOT_ICONNAME_STAMP_DRAFT "Draft"
645 
646 #define FSPDF_ANNOT_ICONNAME_STAMP_EXPERIMENTAL "Experimental"
647 
648 #define FSPDF_ANNOT_ICONNAME_STAMP_EXPIRED "Expired"
649 
650 #define FSPDF_ANNOT_ICONNAME_STAMP_FINAL "Final"
651 
652 #define FSPDF_ANNOT_ICONNAME_STAMP_FORCOMMENT "ForComment"
653 
654 #define FSPDF_ANNOT_ICONNAME_STAMP_FORPUBLICRELEASE "ForPublicRelease"
655 
656 #define FSPDF_ANNOT_ICONNAME_STAMP_NOTAPPROVED "NotApproved"
657 
658 #define FSPDF_ANNOT_ICONNAME_STAMP_NOTFORPUBLICRELEASE "NotForPublicRelease"
659 
660 #define FSPDF_ANNOT_ICONNAME_STAMP_SOLD "Sold"
661 
662 #define FSPDF_ANNOT_ICONNAME_STAMP_TOPSECRET "TopSecret"
663 
665 #define FSPDF_ANNOT_ICONNAME_SOUND_SPEAKER "Speaker"
666 
667 #define FSPDF_ANNOT_ICONNAME_SOUND_MIC "Mic"
668 
670 #endif /* _FSPDF_DEF_MACRO_ANNOT_ICONNAME_ */
671 
672 #ifndef _FSPDF_DEF_MACRO_ANNOT_INTENTNAME_
673 #define _FSPDF_DEF_MACRO_ANNOT_INTENTNAME_
674 
680 #define FSPDF_ANNOT_INTENTNAME_FREETEXT_CALLOUT "FreeTextCallout"
681 
682 #define FSPDF_ANNOT_INTENTNAME_FREETEXT_TYPEWRITER "FreeTextTypewriter"
683 
685 #define FSPDF_ANNOT_INTENTNAME_LINE_ARROW "LineArrow"
686 
687 #define FSPDF_ANNOT_INTENTNAME_LINE_DIMENSION "LineDimension"
688 
690 #define FSPDF_ANNOT_INTENTNAME_POLYGON_CLOUD "PolygonCloud"
691 
692 #define FSPDF_ANNOT_INTENTNAME_POLYGON_DIMENSION "PolygonDimension"
693 
695 #define FSPDF_ANNOT_INTENTNAME_POLYLINE_DIMENSION "PolyLineDimension"
696 
698 #endif /* _FSPDF_DEF_MACRO_ANNOT_INTENTNAME_ */
699 
700 #ifndef _FSPDF_DEF_MACRO_ANNOT_LINEENDINGSTYLE_
701 #define _FSPDF_DEF_MACRO_ANNOT_LINEENDINGSTYLE_
702 
708 #define FSPDF_ANNOT_LINEENDINGSTYLE_NONE "None"
709 
710 #define FSPDF_ANNOT_LINEENDINGSTYLE_SQUARE "Square"
711 
712 #define FSPDF_ANNOT_LINEENDINGSTYLE_CIRCLE "Circle"
713 
714 #define FSPDF_ANNOT_LINEENDINGSTYLE_DIAMOND "Diamond"
715 
716 #define FSPDF_ANNOT_LINEENDINGSTYLE_OPENARROW "OpenArrow"
717 
718 #define FSPDF_ANNOT_LINEENDINGSTYLE_CLOSEDARROW "ClosedArrow"
719 
720 #define FSPDF_ANNOT_LINEENDINGSTYLE_BUTT "Butt"
721 
722 #define FSPDF_ANNOT_LINEENDINGSTYLE_REVERSEOPENARROW "ROpenArrow"
723 
724 #define FSPDF_ANNOT_LINEENDINGSTYLE_REVERSECLOSEDARROW "RClosedArrow"
725 
726 #define FSPDF_ANNOT_LINEENDINGSTYLE_SLASH "Slash"
727 
729 #endif /* _FSPDF_DEF_MACRO_ANNOT_LINEENDINGSTYLE_ */
730 
731 #ifndef _FSPDF_DEF_MACRO_ANNOT_HIGHLIGHTINGMODE_
732 #define _FSPDF_DEF_MACRO_ANNOT_HIGHLIGHTINGMODE_
733 
739 #define FSPDF_ANNOT_HIGHLIGHTINGMODE_NONE 0
740 
741 #define FSPDF_ANNOT_HIGHLIGHTINGMODE_INVERT 1
742 
743 #define FSPDF_ANNOT_HIGHLIGHTINGMODE_OUTLINE 2
744 
745 #define FSPDF_ANNOT_HIGHLIGHTINGMODE_PUSH 3
746 
750 #define FSPDF_ANNOT_HIGHLIGHTINGMODE_TOGGLE 4
751 
753 #endif /* _FSPDF_DEF_MACRO_ANNOT_HIGHLIGHTINGMODE_ */
754 
755 #ifndef _FSPDF_DEF_MACRO_ANNOT_BORDERSTYLE_
756 #define _FSPDF_DEF_MACRO_ANNOT_BORDERSTYLE_
757 
763 #define FSPDF_ANNOT_BORDERSTYLE_SOLID 0
764 
765 #define FSPDF_ANNOT_BORDERSTYLE_DASHED 1
766 
767 #define FSPDF_ANNOT_BORDERSTYLE_UNDERLINE 2
768 
769 #define FSPDF_ANNOT_BORDERSTYLE_BEVELED 3
770 
771 #define FSPDF_ANNOT_BORDERSTYLE_INSET 4
772 
773 #define FSPDF_ANNOT_BORDERSTYLE_CLOUDY 5
774 
776 #endif /* _FSPDF_DEF_MACRO_ANNOT_BORDERSTYLE_ */
777 
778 #ifndef _FSPDF_DEF_MACRO_ANNOT_ICONFITFLAG_
779 #define _FSPDF_DEF_MACRO_ANNOT_ICONFITFLAG_
780 
786 #define FSPDF_ANNOT_ICONFITFLAG_SCALEWAY 1
787 
788 #define FSPDF_ANNOT_ICONFITFLAG_ASPECTRATIO 2
789 
790 #define FSPDF_ANNOT_ICONFITFLAG_POSITION 4
791 
792 #define FSPDF_ANNOT_ICONFITFLAG_FITBOUNDS 8
793 
795 #endif /* _FSPDF_DEF_MACRO_ANNOT_ICONFITFLAG_ */
796 
797 #ifndef _FSPDF_DEF_MACRO_ANNOT_ICONSCALEWAY_
798 #define _FSPDF_DEF_MACRO_ANNOT_ICONSCALEWAY_
799 
804 #define FSPDF_ANNOT_ICONSCALEWAY_ALWAYS 0
805 
806 #define FSPDF_ANNOT_ICONSCALEWAY_BIGGER 1
807 
808 #define FSPDF_ANNOT_ICONSCALEWAY_SMALLER 2
809 
810 #define FSPDF_ANNOT_ICONSCALEWAY_NEVER 3
811 
813 #endif /* _FSPDF_DEF_MACRO_ANNOT_ICONSCALEWAY_ */
814 
815 #ifndef _FSPDF_DEF_MACRO_ANNOT_MKENTRY_
816 #define _FSPDF_DEF_MACRO_ANNOT_MKENTRY_
817 
823 #define FSPDF_ANNOT_MKENTRY_ROTATION 0
824 
825 #define FSPDF_ANNOT_MKENTRY_BORDERCOLOR 1
826 
827 #define FSPDF_ANNOT_MKENTRY_BACKGROUNDCOLOR 2
828 
829 #define FSPDF_ANNOT_MKENTRY_NORMALCAPTION 3
830 
831 #define FSPDF_ANNOT_MKENTRY_ROLLOVERCAPTION 4
832 
833 #define FSPDF_ANNOT_MKENTRY_DOWNCAPTION 5
834 
835 #define FSPDF_ANNOT_MKENTRY_NORMALICON 6
836 
837 #define FSPDF_ANNOT_MKENTRY_ROLLOVERICON 7
838 
839 #define FSPDF_ANNOT_MKENTRY_DOWNICON 8
840 
841 #define FSPDF_ANNOT_MKENTRY_ICONFIT 9
842 
843 #define FSPDF_ANNOT_MKENTRY_TEXTPOSITION 10
844 
846 #endif /* _FSPDF_DEF_MACRO_ANNOT_MKENTRY_ */
847 
848 #ifndef _FSPDF_DEF_STRUCTURE_ANNOTICONFIT_
849 #define _FSPDF_DEF_STRUCTURE_ANNOTICONFIT_
850 
853 typedef struct _FSPDF_ANNOTICONFIT
854 {
912 
913 #endif /* _FSPDF_DEF_STRUCTURE_ANNOTICONFIT_ */
914 
915 #ifndef _FSPDF_DEF_STRUCTURE_ANNOTBORDER_
916 #define _FSPDF_DEF_STRUCTURE_ANNOTBORDER_
917 
920 typedef struct _FSPDF_ANNOTBORDER
921 {
960  FS_FLOAT dashPattern[16];
962 
963 #endif /* _FSPDF_DEF_STRUCTURE_ANNOTBORDER_ */
964 
993 FS_RESULT FSPDF_Annot_GetType(FSCRT_ANNOT annot, FSCRT_BSTR* annotType);
994 
1020 FS_RESULT FSPDF_Annot_GetRect(FSCRT_ANNOT annot, FSCRT_RECTF* rect);
1021 
1054 FS_RESULT FSPDF_Annot_GetDeviceRect(FSCRT_ANNOT annot, FS_BOOL bTransformIcon, const FSCRT_MATRIX* matrix,
1055  FSCRT_RECT* deviceRect);
1056 
1083 FS_RESULT FSPDF_Annot_GetFlags(FSCRT_ANNOT annot, FS_DWORD* flags);
1084 
1112 FS_RESULT FSPDF_Annot_GetName(FSCRT_ANNOT annot, FSCRT_BSTR* name);
1113 
1141 FS_RESULT FSPDF_Annot_GetContents(FSCRT_ANNOT annot, FSCRT_BSTR* contents);
1142 
1167 FS_RESULT FSPDF_Annot_GetBorder(FSCRT_ANNOT annot, FSPDF_ANNOTBORDER* border);
1168 
1198 FS_RESULT FSPDF_Annot_GetColor(FSCRT_ANNOT annot, FS_BOOL isFillColor, FS_ARGB* color);
1199 
1227 FS_RESULT FSPDF_Annot_GetApplyFillColor(FSCRT_ANNOT annot, FS_ARGB* color);
1228 
1254 
1280 
1308 FS_RESULT FSPDF_Annot_GetSubject(FSCRT_ANNOT annot, FSCRT_BSTR* subject);
1309 
1337 FS_RESULT FSPDF_Annot_GetTitle(FSCRT_ANNOT annot, FSCRT_BSTR* title);
1338 
1364 FS_RESULT FSPDF_Annot_GetOpacity(FSCRT_ANNOT annot, FS_FLOAT* opacity);
1365 
1395 FS_RESULT FSPDF_Annot_GetIntent(FSCRT_ANNOT annot, FSCRT_BSTR* intent);
1396 
1422 FS_RESULT FSPDF_Annot_GetOpenStatus(FSCRT_ANNOT annot, FS_BOOL* isOpen);
1423 
1453 FS_RESULT FSPDF_Annot_GetIconName(FSCRT_ANNOT annot, FSCRT_BSTR* iconName);
1454 
1486 FS_RESULT FSPDF_Annot_GetAlignment(FSCRT_ANNOT annot, FS_INT32* alignment);
1487 
1514 FS_RESULT FSPDF_Annot_GetHighlightingMode(FSCRT_ANNOT annot, FS_INT32* hlMode);
1515 
1563 FS_RESULT FSPDF_Annot_GetQuadPoints(FSCRT_ANNOT annot, FSCRT_QUADPOINTSF* quadPoints, FS_INT32* count);
1564 
1600 FS_RESULT FSPDF_Annot_GetCalloutLinePoints(FSCRT_ANNOT annot, FS_FLOAT* x1, FS_FLOAT* y1, FS_FLOAT* x2, FS_FLOAT* y2, FS_FLOAT* x3, FS_FLOAT* y3);
1601 
1633 FS_RESULT FSPDF_Annot_GetInnerRectMargin(FSCRT_ANNOT annot, FS_FLOAT* left, FS_FLOAT* top, FS_FLOAT* right, FS_FLOAT* bottom);
1634 
1668 FS_RESULT FSPDF_Annot_GetLineEndingStyles(FSCRT_ANNOT annot, FSCRT_BSTR* startingStyle, FSCRT_BSTR* endingStyle);
1669 
1697 FS_RESULT FSPDF_Annot_GetLinePosition(FSCRT_ANNOT annot, FS_FLOAT* x1, FS_FLOAT* y1, FS_FLOAT* x2, FS_FLOAT* y2);
1698 
1728 FS_RESULT FSPDF_Annot_GetLeaderLineLength(FSCRT_ANNOT annot, FS_FLOAT* length);
1729 
1755 FS_RESULT FSPDF_Annot_GetLeaderLineExtension(FSCRT_ANNOT annot, FS_FLOAT* extLength);
1756 
1782 FS_RESULT FSPDF_Annot_GetLeaderLineOffset(FSCRT_ANNOT annot, FS_FLOAT* offset);
1783 
1809 FS_RESULT FSPDF_Annot_HasCaptionContents(FSCRT_ANNOT annot, FS_BOOL* hasCap);
1810 
1846 FS_RESULT FSPDF_Annot_GetCaptionPosition(FSCRT_ANNOT annot, FSCRT_BSTR* captionPos);
1847 
1885 FS_RESULT FSPDF_Annot_GetCaptionOffset(FSCRT_ANNOT annot, FS_FLOAT* offsetx, FS_FLOAT* offsety);
1886 
1926 FS_RESULT FSPDF_Annot_GetVertices(FSCRT_ANNOT annot, FS_FLOAT* vertices, FS_INT32* count);
1927 
1961 FS_RESULT FSPDF_Annot_GetSymbol(FSCRT_ANNOT annot, FSCRT_BSTR* symbol);
1962 
1996 FS_RESULT FSPDF_Annot_GetInkList(FSCRT_ANNOT annot, FSCRT_PATHDATA* pathData);
1997 
2025 FS_RESULT FSPDF_Annot_GetAttachment(FSCRT_ANNOT annot, FSPDF_ATTACHMENT* attachment);
2026 
2052 FS_RESULT FSPDF_Annot_GetDefaultAppearance(FSCRT_ANNOT annot, FSPDF_DEFAULTAPPEARANCE* defAppearance);
2053 
2080 FS_RESULT FSPDF_Annot_GetIconFit(FSCRT_ANNOT annot, FSPDF_ANNOTICONFIT* iconFit);
2081 
2112 FS_RESULT FSPDF_Annot_HasMKEntry(FSCRT_ANNOT annot, FS_INT32 mkEntry, FS_BOOL* hasEntry);
2113 
2140 FS_RESULT FSPDF_Annot_GetMKRotation(FSCRT_ANNOT annot, FS_INT32* degree);
2141 
2172 FS_RESULT FSPDF_Annot_GetMKColor(FSCRT_ANNOT annot, FS_INT32 mkEntry, FS_ARGB* color);
2173 
2206 FS_RESULT FSPDF_Annot_GetMKCaption(FSCRT_ANNOT annot, FS_INT32 mkEntry, FSCRT_BSTR* caption);
2207 
2244 FS_RESULT FSPDF_Annot_GetMKIconBitmap(FSCRT_ANNOT annot, FS_INT32 mkEntry, FSCRT_BITMAP* bitmap);
2245 
2271 FS_RESULT FSPDF_Annot_GetFormControl(FSCRT_ANNOT widgetAnnot, FSPDF_FORMCONTROL* formControl);
2272 
2297 FS_RESULT FSPDF_Annot_GetDict(FSCRT_ANNOT annot, FSPDF_OBJECT* dictionary);
2298 
2299 /*******************************************************************************/
2300 /* Markup controls */
2301 /*******************************************************************************/
2302 #ifndef _FSPDF_DEF_MACRO_ANNOTSTATEMODEL_
2303 #define _FSPDF_DEF_MACRO_ANNOTSTATEMODEL_
2304 
2310 #define FSPDF_ANNOTSTATEMODEL_MARKED 0
2311 
2312 #define FSPDF_ANNOTSTATEMODEL_REVIEW 1
2313 
2315 #endif /* _FSPDF_DEF_MACRO_ANNOTSTATEMODEL_ */
2316 
2317 #ifndef _FSPDF_DEF_MACRO_ANNOTSTATE_
2318 #define _FSPDF_DEF_MACRO_ANNOTSTATE_
2319 
2326 #define FSPDF_ANNOTSTATE_MARKED_MARKED 0
2327 
2328 #define FSPDF_ANNOTSTATE_MARKED_UNMARKED 1
2329 
2331 #define FSPDF_ANNOTSTATE_REVIEW_ACCEPTED 0
2332 
2333 #define FSPDF_ANNOTSTATE_REVIEW_REJECTED 1
2334 
2335 #define FSPDF_ANNOTSTATE_REVIEW_CANCELLED 2
2336 
2337 #define FSPDF_ANNOTSTATE_REVIEW_COMPLETED 3
2338 
2339 #define FSPDF_ANNOTSTATE_REVIEW_NONE 4
2340 
2342 #endif /* _FSPDF_DEF_MACRO_ANNOTSTATE_ */
2343 
2375 FS_RESULT FSPDF_Annot_CountStateAnnots(FSCRT_ANNOT annot, FS_INT32 stateModel, FS_INT32* count);
2376 
2412 FS_RESULT FSPDF_Annot_GetStateAnnot(FSCRT_ANNOT annot, FS_INT32 stateModel, FS_INT32 index, FSCRT_ANNOT* stateAnnot);
2413 
2446 FS_RESULT FSPDF_Annot_GetState(FSCRT_ANNOT stateAnnot, FS_INT32* stateModel, FS_INT32* state);
2447 
2472 FS_RESULT FSPDF_Annot_IsGrouped(FSCRT_ANNOT annot, FS_BOOL* isGrouped);
2473 
2501 FS_RESULT FSPDF_Annot_GetGroupHeader(FSCRT_ANNOT annot, FSCRT_ANNOT* groupHeader);
2502 
2543 FS_RESULT FSPDF_Annot_GetGroupElements(FSCRT_ANNOT annot, FSCRT_ANNOT* elements, FS_INT32* count);
2544 
2570 FS_RESULT FSPDF_Annot_CountReplies(FSCRT_ANNOT annot, FS_INT32* count);
2571 
2601 FS_RESULT FSPDF_Annot_GetReply(FSCRT_ANNOT annot, FS_INT32 index, FSCRT_ANNOT* replyAnnot);
2602 
2631 FS_RESULT FSPDF_Annot_GetPopup(FSCRT_ANNOT annot, FSCRT_ANNOT* popupAnnot);
2632 
2633 /*******************************************************************************/
2634 /* Annotation trigger actions */
2635 /*******************************************************************************/
2662 FS_RESULT FSPDF_Annot_CountActions(FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32* count);
2663 
2692 FS_RESULT FSPDF_Annot_GetAction(FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 index, FSPDF_ACTIONDATA* actionData);
2693 
2694 /*******************************************************************************/
2695 /* Annotation display */
2696 /*******************************************************************************/
2734 FS_RESULT FSPDF_RenderContext_StartAnnots(FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer,
2735  const FSCRT_ANNOT* annots, FS_INT32 count, FSCRT_PROGRESS* renderProgress);
2736 
2773 FS_RESULT FSPDF_RenderContext_StartPageAnnots(FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer,
2774  FSCRT_PAGE page, FSCRT_PROGRESS* renderProgress);
2775 
2776 /*******************************************************************************/
2777 /* Search text in annotation appearance */
2778 /*******************************************************************************/
2819 FS_RESULT FSPDF_Annot_SearchInAppearance(FSCRT_ANNOT annot, const FSCRT_BSTR* searchPattern, FS_DWORD flags, FSPDF_TEXTSEARCH* textSearch);
2820 
2821 #ifdef __cplusplus
2822 };
2823 #endif
2824  /* group FPDFANNOT */
2826 
2827 #endif /* _FSPDF_ANNOT_R_H_ */
2828 
FS_RESULT FSPDF_Annot_GetInnerRectMargin(FSCRT_ANNOT annot, FS_FLOAT *left, FS_FLOAT *top, FS_FLOAT *right, FS_FLOAT *bottom)
Get the margin between inner rectangle and rectangle of an annotation.
FS_RESULT FSPDF_Annot_GetLinePosition(FSCRT_ANNOT annot, FS_FLOAT *x1, FS_FLOAT *y1, FS_FLOAT *x2, FS_FLOAT *y2)
Get line position of a line annotation.
FS_INT32 borderStyle
Border style.
Definition: fpdf_annot_r.h:933
FS_RESULT FSPDF_RenderContext_StartPageAnnots(FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, FSCRT_PAGE page, FSCRT_PROGRESS *renderProgress)
Render all annotations of a page on render context.
FS_RESULT FSPDF_Annot_GetModifiedDateTime(FSCRT_ANNOT annot, FSCRT_DATETIMEZONE *dt)
Get modification time of an annotation.
Structure for annotation border.
Definition: fpdf_annot_r.h:920
FS_RESULT FSPDF_Annot_GetContents(FSCRT_ANNOT annot, FSCRT_BSTR *contents)
Get contents of an annotation.
FS_RESULT FSPDF_Annot_IsGrouped(FSCRT_ANNOT annot, FS_BOOL *isGrouped)
Check whether an annotation is in a group.
FS_RESULT FSPDF_Annot_CountStateAnnots(FSCRT_ANNOT annot, FS_INT32 stateModel, FS_INT32 *count)
Count specific state annotations associated with a markup annotation.
FS_RESULT FSPDF_Annot_CountReplies(FSCRT_ANNOT annot, FS_INT32 *count)
Count replies of a markup annotation.
FS_RESULT FSPDF_Annot_GetFlags(FSCRT_ANNOT annot, FS_DWORD *flags)
Get flags of an annotation.
FS_RESULT FSPDF_Annot_GetInkList(FSCRT_ANNOT annot, FSCRT_PATHDATA *pathData)
Get ink list data of an ink annotation.
Structure for rectangle, in float.
Definition: fs_base_r.h:2081
FS_DWORD flags
Icon fit flag.
Definition: fpdf_annot_r.h:866
FS_RESULT FSPDF_Annot_GetAlignment(FSCRT_ANNOT annot, FS_INT32 *alignment)
Get alignment of a free text annotation.
float FS_FLOAT
32-bit floating-point number, single precision.
Definition: fs_base_r.h:148
FS_FLOAT borderWidth
Width of border, in points.
Definition: fpdf_annot_r.h:927
FS_RESULT FSPDF_Annot_GetIntent(FSCRT_ANNOT annot, FSCRT_BSTR *intent)
Get intent of a markup annotation.
FS_RESULT FSPDF_Annot_GetAction(FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 index, FSPDF_ACTIONDATA *actionData)
Get action data of specific index associated with an annotation.
Structure for rectangle, in integer.
Definition: fs_base_r.h:2059
FS_RESULT FSPDF_Annot_GetMKCaption(FSCRT_ANNOT annot, FS_INT32 mkEntry, FSCRT_BSTR *caption)
Get caption of a specific type in MK dictionary.
FS_RESULT FSPDF_Annot_GetIconName(FSCRT_ANNOT annot, FSCRT_BSTR *iconName)
Get icon name of an annotation.
FS_RESULT FSPDF_Annot_GetRect(FSCRT_ANNOT annot, FSCRT_RECTF *rect)
Get rectangle of an annotation.
FS_RESULT FSPDF_Annot_GetGroupHeader(FSCRT_ANNOT annot, FSCRT_ANNOT *groupHeader)
Get header annotation of a group, to which an annotation belongs.
FS_RESULT FSPDF_Annot_GetAttachment(FSCRT_ANNOT annot, FSPDF_ATTACHMENT *attachment)
Get attachment of a file attachment annotation.
FS_RESULT FSPDF_Page_LoadAnnots(FSCRT_PAGE page)
Load annotations from a PDF page.
FS_RESULT FSPDF_Annot_GetName(FSCRT_ANNOT annot, FSCRT_BSTR *name)
Get name of an annotation.
FS_FLOAT bottom
Left-over space to allocate at the bottom of the icon.
Definition: fpdf_annot_r.h:902
FS_RESULT FSPDF_Annot_GetOpacity(FSCRT_ANNOT annot, FS_FLOAT *opacity)
Get opacity of a markup annotation.
FS_RESULT FSPDF_Annot_CountActions(FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 *count)
Count actions associated with an annotation.
FS_RESULT FSPDF_Annot_GetDefaultAppearance(FSCRT_ANNOT annot, FSPDF_DEFAULTAPPEARANCE *defAppearance)
Get default appearance of a free text annotation, which can be used in formatting text.
unsigned int FS_DWORD
32-bit unsigned integer.
Definition: fs_base_r.h:142
FS_RESULT FSPDF_Page_UnloadAnnots(FSCRT_PAGE page)
Unload annotations of a PDF page.
FS_RESULT FSPDF_Annot_GetReply(FSCRT_ANNOT annot, FS_INT32 index, FSCRT_ANNOT *replyAnnot)
Get reply with specifies index of a markup annotation.
FS_RESULT FSPDF_Annot_GetPopup(FSCRT_ANNOT annot, FSCRT_ANNOT *popupAnnot)
Get a pop-up annotation from a specific markup annotation.
FS_RESULT FSPDF_Annot_GetSymbol(FSCRT_ANNOT annot, FSCRT_BSTR *symbol)
Get symbol of a caret annotation.
FS_BOOL aspectRatio
A boolean value that indicates which type of scaling is to be used.
Definition: fpdf_annot_r.h:888
FS_RESULT FSPDF_Annot_GetFormControl(FSCRT_ANNOT widgetAnnot, FSPDF_FORMCONTROL *formControl)
Get a PDF form control from a widget annotation handle.
FS_RESULT FSPDF_Annot_GetHighlightingMode(FSCRT_ANNOT annot, FS_INT32 *hlMode)
Get highlighting mode of a link or widget annotation.
FS_RESULT FSPDF_Annot_GetDeviceRect(FSCRT_ANNOT annot, FS_BOOL bTransformIcon, const FSCRT_MATRIX *matrix, FSCRT_RECT *deviceRect)
Get rectangle of an annotation in device coordinations.
FS_RESULT FSPDF_Annot_GetCaptionOffset(FSCRT_ANNOT annot, FS_FLOAT *offsetx, FS_FLOAT *offsety)
Get caption offset of a line annotation.
FS_RESULT FSPDF_Annot_GetLeaderLineExtension(FSCRT_ANNOT annot, FS_FLOAT *extLength)
Get leader line extension of a line annotation.
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
Structure for date and time.
Definition: fs_base_r.h:2021
FS_RESULT FSPDF_Annot_GetLeaderLineOffset(FSCRT_ANNOT annot, FS_FLOAT *offset)
Get leader line offset of a line annotation.
FS_RESULT FSPDF_Annot_GetColor(FSCRT_ANNOT annot, FS_BOOL isFillColor, FS_ARGB *color)
Get fill or border color of an annotation.
FS_RESULT FSPDF_Annot_GetOpenStatus(FSCRT_ANNOT annot, FS_BOOL *isOpen)
Get open status of a text or pop-up annotation.
FS_RESULT FSPDF_Annot_GetBorder(FSCRT_ANNOT annot, FSPDF_ANNOTBORDER *border)
Get border of an annotation.
FS_BOOL fitBounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fpdf_annot_r.h:910
FS_RESULT FSPDF_Annot_GetMKIconBitmap(FSCRT_ANNOT annot, FS_INT32 mkEntry, FSCRT_BITMAP *bitmap)
Get icon bitmap of specific icon type in MK dictionary.
Structure for default appearance.
Definition: fpdf_base_r.h:278
FS_RESULT FSPDF_Annot_GetSubject(FSCRT_ANNOT annot, FSCRT_BSTR *subject)
Get subject of a markup annotation.
FS_RESULT FSPDF_Annot_GetDict(FSCRT_ANNOT annot, FSPDF_OBJECT *dictionary)
Get the dictionary of an annotation.
FS_RESULT FSPDF_Annot_GetCount(FSCRT_PAGE page, const FSCRT_BSTR *filter, FS_INT32 *count)
Get count of annotations, by specific filter.
FS_RESULT FSPDF_Annot_GetType(FSCRT_ANNOT annot, FSCRT_BSTR *annotType)
Get type of an annotation.
Structure for annotation icon fit.
Definition: fpdf_annot_r.h:853
Structure for an action data.
Definition: fpdf_base_r.h:841
int FS_BOOL
Boolean type (This should be TRUE or FALSE).
Definition: fs_base_r.h:133
FS_FLOAT left
Left-over space to allocate at the left of the icon.
Definition: fpdf_annot_r.h:895
FS_RESULT FSPDF_Annot_GetCreationDateTime(FSCRT_ANNOT annot, FSCRT_DATETIMEZONE *dt)
Get creation time of a markup annotation.
FS_RESULT FSPDF_Annot_GetMKRotation(FSCRT_ANNOT annot, FS_INT32 *degree)
Get rotation (the number of degrees) in MK dictionary.
FS_RESULT FSPDF_Annot_GetAtDevicePos(FSCRT_PAGE page, const FSCRT_BSTR *filter, const FSCRT_MATRIX *matrix, FS_INT32 x, FS_INT32 y, FS_INT32 tolerance, FSCRT_ANNOT *annot)
Get annotation at a specific position in device (in pixel), by specific filter.
FS_RESULT FSPDF_Annot_GetVertices(FSCRT_ANNOT annot, FS_FLOAT *vertices, FS_INT32 *count)
Get vertices of a polygon or polyline annotation.
FS_RESULT FSPDF_Annot_GetMKColor(FSCRT_ANNOT annot, FS_INT32 mkEntry, FS_ARGB *color)
Get color of specific type in MK dictionary.
FS_RESULT FSPDF_Annot_GetCalloutLinePoints(FSCRT_ANNOT annot, FS_FLOAT *x1, FS_FLOAT *y1, FS_FLOAT *x2, FS_FLOAT *y2, FS_FLOAT *x3, FS_FLOAT *y3)
Get callout line points of a free text annotation.
FS_FLOAT dashPhase
Dash phase.
Definition: fpdf_annot_r.h:947
FS_RESULT FSPDF_Annot_GetStateAnnot(FSCRT_ANNOT annot, FS_INT32 stateModel, FS_INT32 index, FSCRT_ANNOT *stateAnnot)
Get specified state annotation associated with a markup annotation.
FS_RESULT FSPDF_Annot_Get(FSCRT_PAGE page, const FSCRT_BSTR *filter, FS_INT32 index, FSCRT_ANNOT *annot)
Get annotation with specified index, by specific filter.
FS_RESULT FSPDF_Annot_HasCaptionContents(FSCRT_ANNOT annot, FS_BOOL *hasCap)
Check if there is a caption to a line annotation.
FS_RESULT FSPDF_Annot_GetIconFit(FSCRT_ANNOT annot, FSPDF_ANNOTICONFIT *iconFit)
Get icon fit of a widget annotation.
FS_RESULT FSPDF_Annot_GetLineEndingStyles(FSCRT_ANNOT annot, FSCRT_BSTR *startingStyle, FSCRT_BSTR *endingStyle)
Get line ending styles of an annotation.
FS_RESULT FSPDF_Annot_GetIndex(FSCRT_ANNOT annot, const FSCRT_BSTR *filter, FS_INT32 *index)
Get index of a specific annotation, by specific filter.
unsigned int FS_ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_base_r.h:145
FS_INT32 dashCount
Count of useful elements in array dashPattern.
Definition: fpdf_annot_r.h:953
FS_RESULT FSPDF_Annot_GetAtPos(FSCRT_PAGE page, const FSCRT_BSTR *filter, FS_FLOAT x, FS_FLOAT y, FS_FLOAT tolerance, FSCRT_ANNOT *annot)
Get annotation at a specific position in PDF page, by specific filter.
FS_RESULT FSPDF_RenderContext_StartAnnots(FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, const FSCRT_ANNOT *annots, FS_INT32 count, FSCRT_PROGRESS *renderProgress)
Render annotations on render context.
Structure for 2D matrix.
Definition: fs_base_r.h:2133
Structure for byte string.
Definition: fs_base_r.h:613
FS_RESULT FSPDF_Annot_GetQuadPoints(FSCRT_ANNOT annot, FSCRT_QUADPOINTSF *quadPoints, FS_INT32 *count)
Get quadrilaterals points of an annotation.
FS_RESULT FSPDF_Annot_GetGroupElements(FSCRT_ANNOT annot, FSCRT_ANNOT *elements, FS_INT32 *count)
Get group elements if annotation is in a group, including itself.
FS_RESULT FSPDF_Annot_GetCaptionPosition(FSCRT_ANNOT annot, FSCRT_BSTR *captionPos)
Get caption position of a line annotation.
FS_RESULT FSPDF_Annot_GetApplyFillColor(FSCRT_ANNOT annot, FS_ARGB *color)
Get the filling color of a redact annotation after applying and the color is also used as its rollove...
FS_RESULT FSPDF_Annot_GetLeaderLineLength(FSCRT_ANNOT annot, FS_FLOAT *length)
Get leader line length of a line annotation.
FS_RESULT FSPDF_Annot_HasMKEntry(FSCRT_ANNOT annot, FS_INT32 mkEntry, FS_BOOL *hasEntry)
Check if specific entry is in MK dictionary.
FS_RESULT FSPDF_Annot_GetTitle(FSCRT_ANNOT annot, FSCRT_BSTR *title)
Get title of a markup annotation.
FS_FLOAT cloudIntensity
Intensity of the cloudy effect.
Definition: fpdf_annot_r.h:941
FS_RESULT FSPDF_Annot_GetAllByTabOrder(FSCRT_PAGE page, const FSCRT_BSTR *filter, FSCRT_ANNOT *annotArray, FS_INT32 *count)
Get annotations by tab order, with specific filter (except pop-up annotation).
FS_RESULT FSPDF_Annot_GetState(FSCRT_ANNOT stateAnnot, FS_INT32 *stateModel, FS_INT32 *state)
Get state model and state out of a state text annotation.
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160
FS_INT32 scaleWay
The circumstances under which the icon should be scaled inside the annotation rectangle.
Definition: fpdf_annot_r.h:879
Structure for quad points, in float.
Definition: fs_base_r.h:2103
FS_RESULT FSPDF_Annot_SearchInAppearance(FSCRT_ANNOT annot, const FSCRT_BSTR *searchPattern, FS_DWORD flags, FSPDF_TEXTSEARCH *textSearch)
Start a text search process in the appearance of a specified PDF annotation.

Foxit Software Corporation Logo
@2019 Foxit Software Incorporated. All rights reserved.