CPDFRedactAnnotation.h 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. //
  2. // CPDFRedactAnnotation.h
  3. // ComPDFKit
  4. //
  5. // Copyright © 2014-2023 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/CPDFAnnotation.h>
  13. /**
  14. * Redaction annotations are used to remove content from a document.
  15. */
  16. @interface CPDFRedactAnnotation : CPDFAnnotation
  17. @property(nonatomic,assign) BOOL drawRedactionsAsRedacted;
  18. /**
  19. * Gets the areas that should be covered by the redaction annotation.
  20. */
  21. - (NSArray *)quadrilateralPoints;
  22. /**
  23. * Uses the quadrilateral points property to set the areas that should be covered by the redaction annotation.
  24. */
  25. - (void)setQuadrilateralPoints:(NSArray *)points;
  26. /**
  27. * Gets the fill color displayed in the specified area after applying the redaction. The color is drawn on the specified rect. Defaults to black.
  28. */
  29. - (CPDFKitPlatformColor *)interiorColor;
  30. /**
  31. * Sets the fill color displayed in the specified area after applying the redaction. The color is drawn on the specified rect. Defaults to black.
  32. */
  33. - (void)setInteriorColor:(CPDFKitPlatformColor *)color;
  34. /**
  35. * Gets the color used for the redaction’s border in its marked state. Defaults to red.
  36. */
  37. - (CPDFKitPlatformColor *)borderColor;
  38. /**
  39. * Sets the color used for the redaction’s border in its marked state. Defaults to red.
  40. */
  41. - (void)setBorderColor:(CPDFKitPlatformColor *)color;
  42. /**
  43. * Gets the text font displayed in the specified area after applying the redaction.
  44. */
  45. - (CPDFKitPlatformFont *)font;
  46. /**
  47. * Sets the text font displayed in the specified area after applying the redaction.
  48. */
  49. - (void)setFont:(CPDFKitPlatformFont *)font;
  50. /**
  51. * Gets the text color displayed in the specified area after applying the redaction.
  52. */
  53. - (CPDFKitPlatformColor *)fontColor;
  54. /**
  55. * Sets the text color displayed in the specified area after applying the redaction.
  56. */
  57. - (void)setFontColor:(CPDFKitPlatformColor *)fontColor;
  58. /**
  59. * Gets the text alignment displayed in the specified area after applying the redaction.
  60. */
  61. - (NSTextAlignment)alignment;
  62. /**
  63. * Sets the text alignment displayed in the specified area after applying the redaction.
  64. */
  65. - (void)setAlignment:(NSTextAlignment)alignment;
  66. /**
  67. * Gets the text displayed in the specified area after applying the redaction.
  68. */
  69. - (NSString *)overlayText;
  70. /**
  71. * Sets the text displayed in the specified area after applying the redaction.
  72. */
  73. - (void)setOverlayText:(NSString *)text;
  74. /**
  75. * Applies redaction annotation.
  76. */
  77. - (void)applyRedaction;
  78. @end