Files
shadowsocks-iOS/zxing-objc/ZXingObjC/ZXEncodeHints.h
2014-02-18 12:21:52 +08:00

89 lines
2.6 KiB
Objective-C

/*
* Copyright 2012 ZXing authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import "ZXCompaction.h"
#import "ZXDimensions.h"
#import "ZXErrorCorrectionLevel.h"
#import "ZXSymbolShapeHint.h"
/**
* These are a set of hints that you may pass to Writers to specify their behavior.
*/
@class ZXDimension, ZXSymbolShapeHint;
@interface ZXEncodeHints : NSObject
+ (id)hints;
/**
* Specifies what character encoding to use where applicable.
*/
@property (nonatomic, assign) NSStringEncoding encoding;
/**
* Specifies the matrix shape for Data Matrix .
*/
@property (nonatomic, strong) ZXSymbolShapeHint *dataMatrixShape;
/**
* Specifies a minimum barcode size. Only applicable to Data Matrix now.
*/
@property (nonatomic, strong) ZXDimension *minSize;
/**
* Specifies a maximum barcode size. Only applicable to Data Matrix now.
*/
@property (nonatomic, strong) ZXDimension *maxSize;
/**
* Specifies what degree of error correction to use, for example in QR Codes.
* For Aztec it represents the minimal percentage of error correction words.
* Note: an Aztec symbol should have a minimum of 25% EC words.
*/
@property (nonatomic, strong) ZXErrorCorrectionLevel *errorCorrectionLevel;
/**
* Specifies what percent of error correction to use.
* For Aztec it represents the minimal percentage of error correction words.
* Note: an Aztec symbol should have a minimum of 25% EC words.
*/
@property (nonatomic, strong) NSNumber *errorCorrectionPercent;
/**
* Specifies margin, in pixels, to use when generating the barcode. The meaning can vary
* by format; for example it controls margin before and after the barcode horizontally for
* most 1D formats.
*/
@property (nonatomic, strong) NSNumber *margin;
/**
* Specifies whether to use compact mode for PDF417.
*/
@property (nonatomic, assign) BOOL pdf417Compact;
/**
* Specifies what compaction mode to use for PDF417.
*/
@property (nonatomic, assign) ZXCompaction pdf417Compaction;
/**
* Specifies the minimum and maximum number of rows and columns for PDF417.
*/
@property (nonatomic, strong) ZXDimensions *pdf417Dimensions;
@end