Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for iOS

SBSSymbologySettings.h
Go to the documentation of this file.
1 //
2 // SBSSymbologySettings.h
3 // BarcodeScanner
4 //
5 // Created by Moritz Hartmeier on 20/05/15.
6 // Copyright (c) 2015 Scandit AG. All rights reserved.
7 //
8 
9 #import <Foundation/Foundation.h>
10 
11 #import "SBSCode.h"
12 
13 
29 extern NSString * _Nonnull const SBSSymbologySettingsExtensionRemoveLeadingZero;
30 
37 extern NSString * _Nonnull const SBSSymbologySettingsExtensionTiny SBS_DEPRECATED_MSG_ATTRIBUTE("this extension is deprecated. Using it has no effect. You can safely remove it from your code");
38 
46 extern NSString * _Nonnull const SBSSymbologySettingsExtensionFullAscii;
50 /* Possible checksum algorithms. */
62 
63 
67 @interface SBSSymbologySettings : NSObject
68 
69 /* The symbology these settings belong to. */
70 @property (nonatomic, assign, readonly) SBSSymbology symbology;
71 
84 @property (nonatomic, assign) BOOL enabled;
85 
97 @property (nonatomic, assign) BOOL colorInvertedEnabled;
98 
109 @property (nonnull, nonatomic, strong) NSSet<NSNumber *> *checksums;
110 
127 @property (nonnull, nonatomic, strong) NSSet<NSNumber *> *activeSymbolCounts;
128 
141 - (BOOL)isExtensionEnabled:(nonnull NSString *)extension;
142 
156 - (void)setExtension:(nonnull NSString *)extension enabled:(BOOL)enabled;
157 
163 @property (nonnull, nonatomic, readonly) NSSet<NSString *> *enabledExtensions;
164 
165 @end
Definition: SBSSymbologySettings.h:55
NSString *_Nonnull const SBSSymbologySettingsExtensionFullAscii
Turn on/off full ASCII mode for Code39.
Holds settings specific to a single symbology such as checksums and active symbol count...
Definition: SBSSymbologySettings.h:67
Definition: SBSSymbologySettings.h:57
NSString *_Nonnull const SBSSymbologySettingsExtensionRemoveLeadingZero
Enable/disable removal of leading zero.
SBSSymbology symbology
Definition: SBSSymbologySettings.h:70
Definition: SBSSymbologySettings.h:52
Definition: SBSSymbologySettings.h:59
#define SBS_ENUM_END(name)
Definition: SBSCommon.h:17
SBSChecksum
Definition: SBSSymbologySettings.h:51
SBSSymbology
Enumerates the symbologies supported by Scandit Barcode Scanner.
Definition: SBSCode.h:44
Definition: SBSSymbologySettings.h:58
Definition: SBSSymbologySettings.h:56
#define SBS_DEPRECATED_MSG_ATTRIBUTE(message)
Definition: SBSCommon.h:21
BOOL colorInvertedEnabled
Whether color-inverted decoding of this symbology is enabled.
Definition: SBSSymbologySettings.h:97
Definition: SBSSymbologySettings.h:60
Definition: SBSSymbologySettings.h:53
Definition: SBSSymbologySettings.h:54
NSString *_Nonnull const SBSSymbologySettingsExtensionTiny
Enable/disable optimizations for tiny data-matrix codes.
NSSet< NSNumber * > * checksums
Active optional checksums for this symbology.
Definition: SBSSymbologySettings.h:109
BOOL enabled
Whether decoding of this symbology is enabled.
Definition: SBSSymbologySettings.h:84
NSSet< NSString * > * enabledExtensions
Retrieve the currently enabled extensions for this symbology.
Definition: SBSSymbologySettings.h:163
NSSet< NSNumber * > * activeSymbolCounts
This function allows to control the length of barcodes to be decoded.
Definition: SBSSymbologySettings.h:127
#define SBS_ENUM_BEGIN(name)
Definition: SBSCommon.h:16