CPDFListView.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  1. //
  2. // CPDFListView.h
  3. // ComPDFKit
  4. //
  5. // Copyright © 2014-2022 PDF Technologies, Inc. All Rights Reserved.
  6. //
  7. // THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW
  8. // AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE ComPDFKit LICENSE AGREEMENT.
  9. // UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES.
  10. // This notice may not be removed from this file.
  11. //
  12. #import <ComPDFKit/ComPDFKit.h>
  13. #import <Foundation/Foundation.h>
  14. #import <QuartzCore/QuartzCore.h>
  15. #import <KMDrawViewSDK_Mac/KMDrawViewSDK_Mac.h>
  16. #define SKAnnotationKey @"SKAnnotation"
  17. extern NSString *SKPasteboardTypeLineStyle;
  18. extern NSNotificationName const CPDFListViewSelectionChangedNotification;
  19. extern NSNotificationName const CPDFListViewToolModeChangeNotification;
  20. extern NSNotificationName const CPDFListViewAnnotationTypeChangeNotification;
  21. extern NSNotificationName const CPDFListViewMagnificationChangedNotification;
  22. extern NSNotificationName const CPDFListViewDidAddAnnotationNotification;
  23. extern NSNotificationName const CPDFListViewDidRemoveAnnotationNotification;
  24. extern NSNotificationName const CPDFListViewActiveAnnotationsChangeNotification;
  25. extern NSNotificationName const CPDFListViewAnnotationsAttributeHasChangeNotification;
  26. extern NSNotificationName const KMPDFViewTableAnnotationDidChangeNotification;
  27. extern NSNotificationName const CPDFListViewDisplayModeChangeNotification;
  28. typedef NS_ENUM(NSInteger, CPDFViewSidebarSpeedMode) {
  29. CPDFViewSidebarSpeedModeLeft = 0,
  30. CPDFViewSidebarSpeedModeRight
  31. };
  32. typedef NS_ENUM(NSInteger, CAnnotationType) {
  33. CAnnotationTypeUnkown = 0,
  34. CAnnotationTypeAnchored,
  35. CAnnotationTypeLink,
  36. CAnnotationTypeFreeText,
  37. CAnnotationTypeLine,
  38. CAnnotationTypeArrow,
  39. CAnnotationTypeSquare,
  40. CAnnotationTypeCircle,
  41. CAnnotationTypePolyGon,
  42. CAnnotationTypePolyLine,
  43. CAnnotationTypeHighlight,
  44. CAnnotationTypeUnderline,
  45. CAnnotationTypeSquiggly,
  46. CAnnotationTypeStrikeOut,
  47. CAnnotationTypeStamp,
  48. CAnnotationTypeSignSignature,
  49. /*CAnnotationTypeCaret,*/
  50. CAnnotationTypeInk,
  51. /*CAnnotationTypePopUp,*/
  52. /*CAnnotationTypeFileattachment,*/
  53. /*CAnnotationTypeSound,*/
  54. /*CAnnotationTypeMovie,*/
  55. CAnnotationTypeRedact,
  56. CAnnotationTypeEraser,
  57. CAnnotationTypeEditTextImage,
  58. CAnnotationTypeAddText,
  59. CAnnotationTypeAddImage,
  60. CAnnotationTypeFileOCR,
  61. CAnnotationTypeAreaOCR,
  62. CAnnotationTypeRadioButton = 100,
  63. CAnnotationTypeCheckBox,
  64. CAnnotationTypeTextField,
  65. CAnnotationTypeComboBox,
  66. CAnnotationTypeListMenu,
  67. CAnnotationTypeActionButton,
  68. CAnnotationTypeSignature,
  69. CAnnotationTypeSignText = 200,
  70. CAnnotationTypeSignFalse,
  71. CAnnotationTypeSignTure,
  72. CAnnotationTypeSignCircle,
  73. CAnnotationTypeSignLine,
  74. CAnnotationTypeSignDot,
  75. CAnnotationTypeSignConfig,
  76. CAnnotationTypeSignDate,
  77. CAnnotationTypeTable,
  78. };
  79. typedef NS_ENUM(NSInteger, CToolMode) {
  80. CTextToolMode = 0,
  81. CMoveToolMode,
  82. CMagnifyToolMode,
  83. CSelectToolMode,
  84. CNoteToolMode,
  85. CSelectZoomToolMode,
  86. CFormToolMode,
  87. CSelfSignMode,
  88. CRedactToolMode,
  89. CMeasureToolMode,
  90. CRedactErasureToolMode,
  91. CEditPDFToolMode,
  92. };
  93. typedef NS_ENUM(NSUInteger, KMPDFActiveFormsAlignType) {
  94. KMPDFActiveFormsAlignType_Left = 0,
  95. KMPDFActiveFormsAlignType_Vertical,
  96. KMPDFActiveFormsAlignType_Right,
  97. KMPDFActiveFormsAlignType_Top,
  98. KMPDFActiveFormsAlignType_Horizontally,
  99. KMPDFActiveFormsAlignType_Bottom,
  100. KMPDFActiveFormsAlignType_DisHorizontally,
  101. KMPDFActiveFormsAlignType_DisVertical
  102. };
  103. typedef NS_ENUM(NSUInteger, KMPDFViewActiveFormsType) {
  104. KMPDFViewActiveFormsType_NotAllform = -1,//注释类型不全为form类型
  105. KMPDFViewActiveFormsType_Mix = 0,//包含多种类型的form(全为form)
  106. KMPDFViewActiveFormsType_Pure,//单纯只有一种form(全为form)
  107. KMPDFViewActiveFormsType_PureSingle,//单纯只有一种form(全为form),个数为1
  108. KMPDFViewActiveFormsType_Text,//单纯只有一种form,并且是text(全为form)
  109. KMPDFViewActiveFormsType_TextSingle,//单纯只有一种form,并且是text(全为form),个数为1
  110. KMPDFViewActiveFormsType_None
  111. };
  112. typedef NS_ENUM(NSUInteger, KMPDFViewMode) {
  113. KMPDFViewModeNormal = 0,
  114. KMPDFViewModeSoft,
  115. KMPDFViewModeNight,
  116. KMPDFViewModeGreen,
  117. KMPDFViewModeThemes1,
  118. KMPDFViewModeThemes2,
  119. KMPDFViewModeThemes3,
  120. KMPDFViewModeThemes4,
  121. KMPDFViewModeOther
  122. };
  123. typedef NS_ENUM(NSInteger, KMPDFViewSplitMode) {
  124. KMPDFViewSplitModeDisable = 0,
  125. KMPDFViewSplitModeHorizontal,
  126. KMPDFViewSplitModeVertical
  127. };
  128. enum {
  129. SKDragArea = 1 << 16,
  130. SKResizeUpDownArea = 1 << 17,
  131. SKResizeLeftRightArea = 1 << 18,
  132. SKResizeDiagonal45Area = 1 << 19,
  133. SKResizeDiagonal135Area = 1 << 20,
  134. SKReadingBarArea = 1 << 21,
  135. SKSpecialToolArea = 1 << 22
  136. };
  137. @protocol CPDFListViewDelegate;
  138. @class CStampSignatureObject,CPDFListStampAnnotation,CPDFListSignatureAnnotation, KMFormListMenuPopWindowController, KMTableCellData;
  139. @interface CPDFListView : CPDFView
  140. @property (nonatomic, weak) id<CPDFListViewDelegate>pdfListViewDelegate;
  141. // Methods for The currently selected Annotation.
  142. @property (nonatomic, readonly) NSMutableArray <CPDFAnnotation *>*activeAnnotations;
  143. // Methods for The currently selected Annotation.
  144. @property (nonatomic, readonly) CPDFAnnotation * activeAnnotation;
  145. // Methods for The annotation type currently selected.
  146. @property (nonatomic, assign) CAnnotationType annotationType;
  147. // Method of the currently selected annotation mode.
  148. @property (nonatomic, assign) CToolMode toolMode;
  149. // The magnification times when the current magnifying glass is in mode
  150. @property (nonatomic, readonly) CGFloat magnification;
  151. @property (nonatomic, assign) BOOL isSetLinkDestinationArea;
  152. // Show Annotation or not
  153. @property (nonatomic, assign) BOOL hideNotes;
  154. // Whether to display a Form comment hop number
  155. @property (nonatomic, assign) BOOL showHopnumber;
  156. // Whether to display the Form name
  157. @property (nonatomic, assign) BOOL showFormFieldName;
  158. // Auxiliary reference line
  159. @property (nonatomic, strong) CAShapeLayer *shapeLayerLeftV;
  160. @property (nonatomic, strong) CAShapeLayer *shapeLayerRightV;
  161. @property (nonatomic, strong) CAShapeLayer *shapeLayerTopH;
  162. @property (nonatomic, strong) CAShapeLayer *shapeLayerBottomH;
  163. @property (nonatomic, assign) NSPoint lastAddAnnotationPoint;
  164. @property (nonatomic, assign) BOOL isCreatAnnotation;
  165. @property (nonatomic, assign) NSInteger toolBarCreateAnnotationMenuItem;
  166. @property (nonatomic, assign) BOOL isTakeSnapeSelectConetent;
  167. @property (nonatomic, assign) KMPDFViewMode viewMode;
  168. @property (nonatomic, assign) KMPDFViewSplitMode viewSplitMode;
  169. @property (nonatomic, strong) KMFormListMenuPopWindowController *listWindowController;
  170. @property (nonatomic, strong) NSTrackingArea *trackingArea;
  171. @property (nonatomic, strong) NSImage *originImage;
  172. @property (nonatomic,retain) KMTableCellData *cellCopyData;
  173. @property (nonatomic,retain) NSTextField *tableTextField;
  174. @property (nonatomic, assign) NSPoint dragTablePoint;
  175. @property (nonatomic, assign) BOOL editAreaBoundUpdating;
  176. // Measurement attribute setting
  177. @property (nonatomic, retain) CPDFDistanceMeasureInfo *distanceMeasureInfo;
  178. @property (nonatomic, retain) CPDFPerimeterMeasureInfo *perimeterMeasureInfo;
  179. @property (nonatomic, retain) CPDFAreaMeasureInfo *polygonAreaMeasureInfo;
  180. @property (nonatomic, retain) CPDFAreaMeasureInfo *squareAreaMeasureInfo;
  181. @property (nonatomic, assign) BOOL isPresentationMode;
  182. @property (nonatomic, strong) KMDrawView *presentationDrawView;
  183. - (CPDFAnnotation *)addAnnotationWithType:(CAnnotationType)annotationType selection:(CPDFSelection *)selection page:(CPDFPage *)page bounds:(NSRect)bounds;
  184. - (void)addAnnotationWithAnnotation:(CPDFAnnotation *)annotation toPage:(CPDFPage *)page;
  185. // Add stamp Annotation, add directly after mouse click
  186. // a new parameter.
  187. // stampObject - stamp Object.
  188. // isToolModel - Whether it is a pattern
  189. - (void)setAddStampObject:(CStampSignatureObject *)stampObject keepToolModel:(BOOL)isToolModel;
  190. // Add an image Stamp note
  191. - (void)addAnnotationWithImage:(NSImage *)image page:(CPDFPage *)page point:(NSPoint)point;
  192. // Refresh the currently selected Annotation
  193. - (void)updateActiveAnnotations:(NSArray<CPDFAnnotation *> *)activeAnnotation;
  194. // Edit Annotation
  195. - (void)editAnnotation:(CPDFAnnotation *)annotation;
  196. // Rotate Stamp notes, angle 0-360 degrees,Rotation is supported only by the current addition
  197. - (void)rotateStampAnnotation:(CPDFListStampAnnotation *)annotation rotateAngle:(NSInteger)angle;
  198. // Rotate Signature notes, angle 0-360 degrees,Rotation is supported only by the current addition
  199. - (void)rotateSignatureAnnotation:(CPDFListSignatureAnnotation *)annotation rotateAngle:(NSInteger)angle;
  200. // When selecting a region mode, the selected region is obtained
  201. - (NSRect)currentSelectionRect;
  202. // Scale the page to the specified range
  203. - (void)zoomToRect:(NSRect)rect onPage:(CPDFPage *)page;
  204. // Remove Auxiliary reference line
  205. - (void)removeShapeLayer;
  206. // Determines whether the current annotation is consistent with the selected annotation mode
  207. - (BOOL)consistentTypeWithAnnotation:(CPDFAnnotation *)annotation;
  208. - (void)formsAnnotationAlign:(KMPDFActiveFormsAlignType)type;
  209. - (void)addImageAnnotation:(NSImage *)image center:(NSPoint)center isRemoveBGColor:(BOOL)isRemoveBGColor;
  210. - (void)setPageBackgroundColorWithColor:(NSColor *)color viewMode:(KMPDFViewMode)viewMode;
  211. - (BOOL)writeSelectionToPasteboard:(NSPasteboard *)pboard types:(NSArray *)types;
  212. - (void)enterPresentationDrawMode;
  213. - (BOOL)isEnterPresentationDrawMode;
  214. - (void)changePresentationDrawModelColor:(NSColor *)color;
  215. - (void)resetPresentationDrawMode;
  216. - (void)exitPresentationDrawMode;
  217. - (KMDrawView *)CreatePresentationDrawView;
  218. @end
  219. @protocol CPDFListViewDelegate <NSObject>
  220. @optional
  221. - (void)PDFListViewChangedSelectionOrMagnification:(CPDFListView *)pdfListView;
  222. - (void)PDFListViewDidSelectionEnd:(CPDFListView *)pdfListView;
  223. - (void)PDFListViewChangedMagnification:(CPDFListView *)pdfListView;
  224. - (void)PDFListViewChangedToolMode:(CPDFListView *)pdfListView forToolMode:(CToolMode)toolMode;
  225. - (void)PDFListViewChangedAnnotationType:(CPDFListView *)pdfListView forAnnotationType:(CAnnotationType)annotationType;
  226. - (NSColor *)PDFListViewBackgroundColor;
  227. - (void)PDFListViewAddAnnotations:(CPDFListView *)pdfListView forAddAnnotations:(NSArray<CPDFAnnotation *> *)annotations inPage:(CPDFPage *)pdfPage;
  228. - (void)PDFListViewRemoveAnnotations:(CPDFListView *)pdfListView forRemoveAnnotations:(NSArray<CPDFAnnotation *> *)annotations inPage:(CPDFPage *)pdfPage;
  229. - (void)PDFListViewDeleteAnnotations:(CPDFListView *)pdfListView forDeleteAnnotations:(NSArray<CPDFAnnotation *> *)annotations inPage:(CPDFPage *)pdfPage;
  230. - (void)PDFListViewChangeatioActiveAnnotations:(CPDFListView *)pdfListView forActiveAnnotations:(NSArray<CPDFAnnotation *> *)annotations isRightMenu:(BOOL)isRightMenu;
  231. - (void)PDFListViewMenuForEvent:(CPDFListView *)pdfListView forEvent:(NSEvent *)theEvent clickMenu:(NSMenu **)menu isMoveSelectAnno:(BOOL)isMoveSelectAnno;
  232. - (BOOL)PDFListViewMenuValidate:(CPDFListView *)pdfListView menuItem:(NSMenuItem *)menuItem isTakesEffect:(BOOL *)isTakesEffect;
  233. - (void)PDFListViewEditAnnotation:(CPDFListView *)pdfListView forAnnotation:(CPDFAnnotation *)anotation;
  234. - (BOOL)PDFListViewKeyDownIsContinue:(CPDFListView *)pdfListView theEvent:(NSEvent *)theEvent;
  235. - (NSArray<NSMenuItem *> *)PDFListViewMenuItemsEditingAtPoint:(CGPoint)point forPage:(CPDFPage *)page menuItems:(NSArray <NSMenuItem *>*)menuItems;
  236. - (void)PDFListViewDidTextFontChanged:(CPDFListView *)pdfListView;
  237. - (void)PDFListViewDidTextColorChanged:(CPDFListView *)pdfListView withColor:(NSColor *)color;
  238. - (void)PDFListViewRedactErasure:(CPDFListView *)pdfListView;
  239. - (void)PDFListViewLinkDestinationStart:(CPDFListView *)pdfListView withActiveAnnotation:(CPDFAnnotation *)annotation;
  240. - (void)PDFListViewLinkDestinationEnd:(CPDFListView *)pdfListView withActiveAnnotation:(CPDFAnnotation *)annotation;
  241. - (void)PDFListViewKeyDowClosePanel:(CPDFViewSidebarSpeedMode)speedy event:(NSEvent *)theEvent;
  242. - (NSArray<NSColor *> *)PDFListViewEventMarkupColorWithAnnotation:(CPDFAnnotation *)annotation;
  243. - (BOOL)PDFListViewHaveDocumentAttribute;
  244. // 是否需要绘制注释 【文字、背景】
  245. - (BOOL)PDFListView:(CPDFListView *)pdfListView needDrawAnnotation:(CPDFAnnotation *)annotation;
  246. - (void)PDFListViewAnnotationAttributeHasChange:(CPDFListView *)pdfListView withAnnotation:(CPDFAnnotation *)annotation;
  247. - (void)PDFListView:(CPDFListView *)sender showSnapshotAtPageNumber:(NSInteger)pageNum forRect:(NSRect)rect scaleFactor:(CGFloat)scaleFactor autoFits:(BOOL)autoFits;
  248. - (void)PDFListView:(CPDFListView *)pdfView documentDataDidChanged:(id)docData withInfo:(NSDictionary *)info;
  249. - (void)PDFListViewAnnotationMeasureInfoChange:(CPDFListView *)pdfListView withAnnotation:(CPDFAnnotation *)annotation;
  250. - (void)PDFListViewMeasureCancel:(CPDFListView *)pdfListView;
  251. @end