PTCustomStampOption

@interface PTCustomStampOption : NSObject <NSCoding>

/**
 * The main text of the stamp annotation.
 */
@property (nonatomic, strong) NSString *text;

/**
 * The secondary text of the stamp annotation.
 */
@property (nonatomic, strong) NSString *secondText;

/**
 * The starting colour of the background gradient of the stamp annotation.
 */
@property (nonatomic, strong) UIColor *bgColorStart;

/**
 * The end colour of the background gradient of the stamp annotation.
 */
@property (nonatomic, strong) UIColor *bgColorEnd;

/**
 * The text color of the stamp annotation.
 */
@property (nonatomic, strong) UIColor *textColor;

/**
 * The border colour of the stamp annotation.
 */
@property (nonatomic, strong) UIColor *borderColor;

/**
 * The fill opacity of the stamp annotation.
 */
@property (nonatomic) CGFloat fillOpacity;

/**
 * Whether the stamp annotation is pointing left.
 */
@property (nonatomic) BOOL pointingLeft;

/**
 * Whether the stamp annotation is pointing right.
 */
@property (nonatomic) BOOL pointingRight;

/**
 * Returns an initialized `PTCustomStampOption`.
 *
 * @param text            The text to be displayed in the rubber stamp
 * @param secondText      The text to be displayed below first text
 * @param bgColorStart    The start background color in gradient background
 * @param bgColorEnd      The end background color in gradient background
 * @param textColor       The text color
 * @param borderColor     The border color
 * @param fillOpacity     The fill opacity
 * @param pointingLeft    True if pointing left
 * @param pointingRight   True if pointing right
 *
 * @return an initialized `PTCustomStampOption`.
 */
-(instancetype)initWithText:(NSString *)text secondText:(nullable NSString*)secondText bgColorStart:(UIColor*)bgColorStart bgColorEnd:(UIColor*)bgColorEnd textColor:(UIColor*)textColor borderColor:(UIColor*)borderColor fillOpacity:(CGFloat)fillOpacity pointingLeft:(BOOL)pointingLeft pointingRight:(BOOL)pointingRight NS_DESIGNATED_INITIALIZER;

/**
 * Returns an initialized `PTCustomStampOption`.
 *
 * @param text            The text to be displayed in the rubber stamp
 * @param secondText      The text to be displayed below first text
 * @param colourModel   The colour used in the stamp
 * @param fillOpacity     The fill opacity
 * @param pointingLeft    True if pointing left
 * @param pointingRight   True if pointing right
 *
 * @return an initialized `PTCustomStampOption`.
 */
-(instancetype)initWithText:(NSString *)text secondText:(nullable NSString*)secondText colourModel: (PTRubberStampColorModel*)colourModel fillOpacity:(CGFloat)fillOpacity pointingLeft:(BOOL)pointingLeft pointingRight:(BOOL)pointingRight;
/**
 * Returns an initialized `PTCustomStampOption`.
 *
 * @param stampObj The stamp SDF object with which to configure the custom stamp.
 *
 * @return an initialized `PTCustomStampOption`.
 */
-(instancetype)initWithFormXObject:(PTObj*)stampObj NS_DESIGNATED_INITIALIZER;

/**
 * Method to configure a rubber stamp's appearance object from a `PTCustomStampOption`.
*/
- (void)configureStampObject:(PTObj *)stampObj;


-(instancetype)initWithCoder:(NSCoder *)aDecoder NS_DESIGNATED_INITIALIZER;


-(instancetype)init NS_UNAVAILABLE;

@end

Undocumented

  • The main text of the stamp annotation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull text;

    Swift

    var text: String { get set }

  • The secondary text of the stamp annotation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull secondText;

    Swift

    var secondText: String { get set }

  • The starting colour of the background gradient of the stamp annotation.

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor *_Nonnull bgColorStart;

    Swift

    var bgColorStart: UIColor { get set }

  • The end colour of the background gradient of the stamp annotation.

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor *_Nonnull bgColorEnd;

    Swift

    var bgColorEnd: UIColor { get set }

  • The text color of the stamp annotation.

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor *_Nonnull textColor;

    Swift

    var textColor: UIColor { get set }

  • The border colour of the stamp annotation.

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor *_Nonnull borderColor;

    Swift

    var borderColor: UIColor { get set }

  • The fill opacity of the stamp annotation.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat fillOpacity;

    Swift

    var fillOpacity: CGFloat { get set }

  • Whether the stamp annotation is pointing left.

    Declaration

    Objective-C

    @property (nonatomic) BOOL pointingLeft;

    Swift

    var pointingLeft: Bool { get set }

  • Whether the stamp annotation is pointing right.

    Declaration

    Objective-C

    @property (nonatomic) BOOL pointingRight;

    Swift

    var pointingRight: Bool { get set }

  • Returns an initialized PTCustomStampOption.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithText:(nonnull NSString *)text
                          secondText:(nullable NSString *)secondText
                        bgColorStart:(nonnull UIColor *)bgColorStart
                          bgColorEnd:(nonnull UIColor *)bgColorEnd
                           textColor:(nonnull UIColor *)textColor
                         borderColor:(nonnull UIColor *)borderColor
                         fillOpacity:(CGFloat)fillOpacity
                        pointingLeft:(BOOL)pointingLeft
                       pointingRight:(BOOL)pointingRight;

    Swift

    init(text: String, secondText: String?, bgColorStart: UIColor, bgColorEnd: UIColor, textColor: UIColor, borderColor: UIColor, fillOpacity: CGFloat, pointingLeft: Bool, pointingRight: Bool)

    Parameters

    text

    The text to be displayed in the rubber stamp
    secondText

    The text to be displayed below first text
    bgColorStart

    The start background color in gradient background
    bgColorEnd

    The end background color in gradient background
    textColor

    The text color
    borderColor

    The border color
    fillOpacity

    The fill opacity
    pointingLeft

    True if pointing left
    pointingRight

    True if pointing right

    Return Value

    an initialized PTCustomStampOption.

  • Returns an initialized PTCustomStampOption.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithText:(nonnull NSString *)text
                          secondText:(nullable NSString *)secondText
                         colourModel:
                             (nonnull PTRubberStampColorModel *)colourModel
                         fillOpacity:(CGFloat)fillOpacity
                        pointingLeft:(BOOL)pointingLeft
                       pointingRight:(BOOL)pointingRight;

    Swift

    convenience init(text: String, secondText: String?, colour colourModel: PTRubberStampColorModel, fillOpacity: CGFloat, pointingLeft: Bool, pointingRight: Bool)

    Parameters

    text

    The text to be displayed in the rubber stamp
    secondText

    The text to be displayed below first text
    colourModel

    The colour used in the stamp
    fillOpacity

    The fill opacity
    pointingLeft

    True if pointing left
    pointingRight

    True if pointing right

    Return Value

    an initialized PTCustomStampOption.

  • Returns an initialized PTCustomStampOption.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFormXObject:(nonnull PTObj *)stampObj;

    Swift

    init(formXObject stampObj: PTObj)

    Parameters

    stampObj

    The stamp SDF object with which to configure the custom stamp.

    Return Value

    an initialized PTCustomStampOption.

  • Method to configure a rubber stamp’s appearance object from a PTCustomStampOption.

    Declaration

    Objective-C

    - (void)configureStampObject:(nonnull PTObj *)stampObj;

    Swift

    func configureStampObject(_ stampObj: PTObj)

  • Undocumented

    Declaration

    Objective-C

    -(instancetype)initWithCoder:(NSCoder *)aDecoder NS_DESIGNATED_INITIALIZER;

    Swift

    init(coder aDecoder: NSCoder)

  • Undocumented

    Declaration

    Objective-C

    -(instancetype)init NS_UNAVAILABLE;