PTAppearance

@interface PTAppearance : NSObject

Class used to customize the appearance of the optional redaction overlay.

  • If RedactionOverlay is set to true, Redactor will draw an overlay covering all redacted regions. The rest of properties in the Appearance class defines visual properties of the overlay. If false the overlay region will not be drawn.

    Declaration

    Objective-C

    - (void)setRedactionOverlay:(BOOL)value;

    Swift

    func setRedactionOverlay(_ value: Bool)
  • Undocumented

    Declaration

    Objective-C

    - (BOOL)getRedactionOverlay;

    Swift

    func getRedactionOverlay() -> Bool
  • PositiveOverlayColor defines the overlay background color in RGB color space for positive redactions.

    Declaration

    Objective-C

    - (void)setPositiveOverlayColor:(PTColorPt *)value;

    Swift

    func setPositiveOverlayColor(_ value: PTColorPt!)
  • Undocumented

    Declaration

    Objective-C

    - (PTColorPt*)getPositiveOverlayColor;

    Swift

    func getPositiveOverlayColor() -> PTColorPt!
  • NegativeOverlayColor defines the overlay background color in RGB color space for negative redactions.

    Declaration

    Objective-C

    - (void)setNegativeOverlayColor:(PTColorPt *)value;

    Swift

    func setNegativeOverlayColor(_ value: PTColorPt!)
  • Undocumented

    Declaration

    Objective-C

    - (PTColorPt*)getNegativeOverlayColor;

    Swift

    func getNegativeOverlayColor() -> PTColorPt!
  • Border specifies if the overlay will be surrounded by a border.

    Declaration

    Objective-C

    - (void)setBorder:(BOOL)value;

    Swift

    func setBorder(_ value: Bool)
  • Undocumented

    Declaration

    Objective-C

    - (BOOL)getBorder;

    Swift

    func getBorder() -> Bool
  • Specifies if the text (e.g. Redacted etc.) should be placed on top of the overlay. The remaining properties relate to the positioning, and styling of the overlay text.

    Declaration

    Objective-C

    - (void)setUseOverlayText:(BOOL)value;

    Swift

    func setUseOverlayText(_ value: Bool)
  • Undocumented

    Declaration

    Objective-C

    - (BOOL)getUseOverlayText;

    Swift

    func getUseOverlayText() -> Bool
  • Specifies the font used to represent the text in the overlay.

    Declaration

    Objective-C

    - (void)setTextFont:(PTFont *)value;

    Swift

    func setTextFont(_ value: PTFont!)
  • Undocumented

    Declaration

    Objective-C

    - (PTFont*)getTextFont;

    Swift

    func getTextFont() -> PTFont!
  • Undocumented

    Declaration

    Objective-C

    - (void)setMinFontSize: (double)value;

    Swift

    func setMinFontSize(_ value: Double)
  • Undocumented

    Declaration

    Objective-C

    - (double)getMinFontSize;

    Swift

    func getMinFontSize() -> Double
  • Specifies the minimum and maximum font size used to represent the text in the overlay.

    Declaration

    Objective-C

    - (void)setMaxFontSize:(double)value;

    Swift

    func setMaxFontSize(_ value: Double)
  • Undocumented

    Declaration

    Objective-C

    - (double)getMaxFontSize;

    Swift

    func getMaxFontSize() -> Double
  • Specifies the color used to paint the text in the overlay (in RGB).

    Declaration

    Objective-C

    - (void)setTextColor:(PTColorPt *)value;

    Swift

    func setTextColor(_ value: PTColorPt!)
  • Undocumented

    Declaration

    Objective-C

    - (PTColorPt*)getTextColor;

    Swift

    func getTextColor() -> PTColorPt!
  • Specifies the horizontal text alignment in the overlay: align<0 -> text will be left aligned. align==0 -> text will be center aligned. align>0 -> text will be right aligned.

    Declaration

    Objective-C

    - (void)setHorizTextAlignment:(int)value;

    Swift

    func setHorizTextAlignment(_ value: Int32)
  • Undocumented

    Declaration

    Objective-C

    - (int)getHorizTextAlignment;

    Swift

    func getHorizTextAlignment() -> Int32
  • Specifies the vertical text alignment in the overlay: align<0 -> text will be top aligned. align==0 -> text will be center aligned. align>0 -> text will be bottom aligned.

    Declaration

    Objective-C

    - (void)setVertTextAlignment:(int)value;

    Swift

    func setVertTextAlignment(_ value: Int32)
  • Undocumented

    Declaration

    Objective-C

    - (int)getVertTextAlignment;

    Swift

    func getVertTextAlignment() -> Int32
  • Specifies whether an overlay should be drawn in place of the redacted content. This option can be used to indicate the areas where the content was removed from without revealing the content itself. @default Default value is False.

    Note

    The overlay region used RedactedContentColor as a fill color.

    Declaration

    Objective-C

    - (void)setShowRedactedContentRegions:(BOOL)value;

    Swift

    func setShowRedactedContentRegions(_ value: Bool)
  • Undocumented

    Declaration

    Objective-C

    - (BOOL)getShowRedactedContentRegions;

    Swift

    func getShowRedactedContentRegions() -> Bool
  • Specifies the color used to paint the regions where content was removed. Only useful when ShowRedactedContentRegions == true. @default Default value is Gray color.

    Declaration

    Objective-C

    - (void)setRedactedContentColor:(PTColorPt *)value;

    Swift

    func setRedactedContentColor(_ value: PTColorPt!)
  • Undocumented

    Declaration

    Objective-C

    - (PTColorPt*)getRedactedContentColor;

    Swift

    func getRedactedContentColor() -> PTColorPt!
  • Undocumented

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()