UniPRT SDK v1.0.0.0
 
Loading...
Searching...
No Matches
AQRBarcode Class Reference

Base class for QR Code 2D barcode. More...

#include <AQRBarcode.h>

Inheritance diagram for AQRBarcode:
ABarcode2D <ISquareCell> <IBarcode2D> <IBarcodeItem_2D> <IPositionRuler> <IRotation> PglQRBarcode QRBarcode

Instance Methods

(instancetype- initWithStart:data:
 Used for most cases where data will be encoded automatically into barcode.
 
(instancetype- initWithStart:manuallyEncodedData:
 This is used for cases where manual encoding of barcode data is desired.
 
- Instance Methods inherited from ABarcode2D
(NSString *) - NS_REQUIRES_SUPER
 
- Instance Methods inherited from <IBarcode2D>
(NSString *) - description
 Returns the string that can be sent to printer.
 

Properties

id< IPointstart
 The starting point for the QR code.
 
NSStringdata
 Automatically encoded data. Manually, DataManuallyEncoded, encoded has priority over automatic encoding.
 
NSArray< NSArray * > * dataManuallyEncoded
 Manually encoded data. Manually encoded has priority over automatic encoding.
 
QRCodeMaskEnum mask
 Mask used in the QR code generation.
 
QRCodeModelEnum model
 Model of the QR code.
 
QRCodeErrorCorrectionEnum errorCorrection
 Error correction level of the QR code.
 
id< ICellSquarecellSize
 Size of the cells that make up the QR code.
 
- Properties inherited from ABarcode2D
id< IRulerruler
 
id< IPointstart
 
NSString * data
 
RotateEnum rotation
 
- Properties inherited from <IBarcodeItem_2D>
id< IPointstart
 Position where barcode starts.
 
NSString * data
 The barcode content.
 
- Properties inherited from <IPositionRuler>
id< IRulerruler
 
- Properties inherited from <IRotation>
RotateEnum rotation
 
- Properties inherited from <ISquareCell>
id< ICellSquarecellSize
 Barcode cell size. Larger cell size results in barcodes that take up a larger area.
 

Detailed Description

Base class for QR Code 2D barcode.

Data encoded in a QR barcode can be encoded automatically or manually. Unless there is a need to optimize the amount of data stored in the barcode, automatic encoding should be used.

Method Documentation

◆ initWithStart:data:

- (instancetype) initWithStart: (id< IPoint >) start
data: (NSString *) data 

Used for most cases where data will be encoded automatically into barcode.

Reimplemented in PglQRBarcode, and QRBarcode.

◆ initWithStart:manuallyEncodedData:

- (instancetype) initWithStart: (id< IPoint >) start
manuallyEncodedData: (NSArray< NSArray * > *) dataManuallyEncoded 

This is used for cases where manual encoding of barcode data is desired.

Reimplemented in QRBarcode.

Property Documentation

◆ cellSize

- (id<ICellSquare>) cellSize
readwritenonatomicstrong

Size of the cells that make up the QR code.

◆ data

- (NSString*) data
readwritenonatomicstrong

Automatically encoded data. Manually, DataManuallyEncoded, encoded has priority over automatic encoding.

Data can be encoded automatically or manually. If there is manually encoded data, this automatically encoded data will be ignored.

◆ dataManuallyEncoded

- (NSArray<NSArray *>*) dataManuallyEncoded
readwritenonatomicstrong

Manually encoded data. Manually encoded has priority over automatic encoding.

Data can be encoded automatically or manually. If there is automatically encoded data, it is ignored and this manually encoded data will be used.

For manually encoding data, a list of pairs of strings and their related encoding method can be provided using this property.

◆ errorCorrection

- (QRCodeErrorCorrectionEnum) errorCorrection
readwritenonatomicassign

Error correction level of the QR code.

◆ mask

- (QRCodeMaskEnum) mask
readwritenonatomicassign

Mask used in the QR code generation.

◆ model

- (QRCodeModelEnum) model
readwritenonatomicassign

Model of the QR code.

◆ start

- (id<IPoint>) start
readwritenonatomicstrong

The starting point for the QR code.


The documentation for this class was generated from the following file: