Barcode Check Icon Annotation
Defined in framework ScanditBarcodeCapture
- SDCBarcodeCheckInfoAnnotationWidthPreset
Added in version 7.1.0
The available width options for an info annotation.
- SDCBarcodeCheckInfoAnnotationWidthPresetSmall
Added in version 7.1.0
Small width. Recommended for annotations that contain only text or icon, and do not include a header or footer.
- SDCBarcodeCheckInfoAnnotationWidthPresetMedium
Added in version 7.1.0
Medium width.
- SDCBarcodeCheckInfoAnnotationWidthPresetLarge
Added in version 7.1.0
Large width.
- SDCBarcodeCheckInfoAnnotationAnchor
Added in version 7.1.0
The available anchor options for an info annotation.
- SDCBarcodeCheckInfoAnnotationAnchorLeft
Added in version 7.1.0
The annotation is anchored at its left edge.
- SDCBarcodeCheckInfoAnnotationAnchorRight
Added in version 7.1.0
The annotation is anchored at its right edge.
- SDCBarcodeCheckInfoAnnotationAnchorBottom
Added in version 7.1.0
The annotation is anchored at its bottom-center point.
- SDCBarcodeCheckInfoAnnotationAnchorTop
Added in version 7.1.0
The annotation is anchored at its top-center point.
- SDCBarcodeCheckInfoAnnotationDelegate
@protocol SDCBarcodeCheckInfoAnnotationDelegate <NSObject>
Added in version 7.1.0
The delegate for the info annotation.
- - barcodeCheckInfoAnnotationDidTapHeader:
- (
void
)barcodeCheckInfoAnnotationDidTapHeader:(SDCBarcodeCheckInfoAnnotation *)annotationAdded in version 7.1.0
Called when the annotation header is tapped. Called only if SDCBarcodeCheckInfoAnnotation.isEntireAnnotationTappable is NO.
- (
void
)barcodeCheckInfoAnnotationDidTapFooter:(SDCBarcodeCheckInfoAnnotation *)annotationAdded in version 7.1.0
Called when the annotation footer is tapped. Called only if SDCBarcodeCheckInfoAnnotation.isEntireAnnotationTappable is NO.
- - barcodeCheckInfoAnnotation:didTapLeftIconForComponent:at:
- (
void
)barcodeCheckInfoAnnotation:(SDCBarcodeCheckInfoAnnotation *)annotation didTapLeftIconForComponent:(SDCBarcodeCheckInfoAnnotationBodyComponent *)component at:(NSInteger)componentIndexAdded in version 7.1.0
Called when the left icon of an annotation component is tapped. componentIndex specifies the index of the component containing the tapped icon within the SDCBarcodeCheckInfoAnnotation.body array. Called only if SDCBarcodeCheckInfoAnnotation.isEntireAnnotationTappable is NO.
- - barcodeCheckInfoAnnotation:didTapRightIconForComponent:at:
- (
void
)barcodeCheckInfoAnnotation:(SDCBarcodeCheckInfoAnnotation *)annotation didTapRightIconForComponent:(SDCBarcodeCheckInfoAnnotationBodyComponent *)component at:(NSInteger)componentIndexAdded in version 7.1.0
Called when the right icon of an annotation component is tapped. componentIndex specifies the index of the component containing the tapped icon within the SDCBarcodeCheckInfoAnnotation.body array. Called only if SDCBarcodeCheckInfoAnnotation.isEntireAnnotationTappable is NO.
- - barcodeCheckInfoAnnotationDidTap:
- (
void
)barcodeCheckInfoAnnotationDidTap:(SDCBarcodeCheckInfoAnnotation *)annotationAdded in version 7.1.0
Called when the annotation is tapped. Called only if SDCBarcodeCheckInfoAnnotation.isEntireAnnotationTappable is YES.
- SDCBarcodeCheckInfoAnnotation
@interface SDCBarcodeCheckInfoAnnotation : UIView <SDCBarcodeCheckAnnotation>
Added in version 7.1.0
Info annotations are tooltips that display text and icons, structured as an array of body components. Each body component contains text and may include optional tappable icons on both the left and right sides.
In addition to the body components, info annotations can include an optional header, and footer. By default, they appear automatically when the corresponding barcode is scanned. Info annotations are available in three predefined widths, with their height dynamically adjusting to fit the content. Here are some examples:
Body component only.
Body component and header.
Body component with attributed text and tappable icon.
- - initWithBarcode:
- (nonnull
instancetype
)initWithBarcode:(SDCBarcode *)barcodeAdded in version 7.1.0
Constructs a new instance with the given barcode.
- barcode
@property (nonatomic, strong, readonly) SDCBarcode *barcode
Added in version 7.1.0
The barcode instance for the annotation.
- hasTip
@property (nonatomic, assign)
BOOL
hasTipAdded in version 7.1.0
Whether the annotation has a tip. The default value is YES.
- isEntireAnnotationTappable
@property (nonatomic, assign)
BOOL
isEntireAnnotationTappableAdded in version 7.1.0
If NO, each individual element within the annotation (header, footer, icons in body components) is tappable. If YES, the entire annotation is tappable.
- anchor
@property (nonatomic, assign) SDCBarcodeCheckInfoAnnotationAnchor anchor
Added in version 7.1.0
The annotation anchor. The default value is SDCBarcodeCheckInfoAnnotationAnchorBottom.
- width
@property (nonatomic, assign) SDCBarcodeCheckInfoAnnotationWidthPreset width
Added in version 7.1.0
The annotation width. The default value is SDCBarcodeCheckInfoAnnotationWidthPresetSmall.
- body
@property (nonatomic, strong) NSArray<SDCBarcodeCheckInfoAnnotationBodyComponent *> *body
Added in version 7.1.0
The annotation body, represented as an array of body components. The default value is [].
- header
@property (nonatomic, strong, nullable) SDCBarcodeCheckInfoAnnotationHeader *header
Added in version 7.1.0
The annotation header. The default value is nil.
@property (nonatomic, strong, nullable) SDCBarcodeCheckInfoAnnotationFooter *footer
Added in version 7.1.0
The annotation footer. The default value is nil.
- backgroundColor
@property (nonatomic, strong) UIColor *backgroundColor
Added in version 7.1.0
The background color. The default value is white.
- delegate
@property (nonatomic, weak)
id
<SDCBarcodeCheckInfoAnnotationDelegate> delegateAdded in version 7.1.0
An object that receives notifications for UI-related events.