Skip to content

BRLMPrintImageSettings

A protocol to set parameters associated with converting your data into printable data for the printers.

Overview

All print settings classes created by initDefaultPrintSettingsWithPrinterModel: are inherited from this protocol. The initialize method also set values of this protocol. You set new values to adjust your print result.

Properties

printerModel

A printer model you passed to the initialize method. For allowed values, see BRLMPrinterModel.

Declaration

@property (nonatomic) BRLMPrinterModel printerModel;

scaleMode

A scale mode that specifies how your data is scaled in a print area of your printer. For allowed values, see BRLMPrintSettingsScaleMode.

Declaration

@property (nonatomic) BRLMPrintSettingsScaleMode scaleMode;

scaleValue

A scale value. This is effective when scaleMode is BRLMPrintSettingsScaleModeScaleValue.

Declaration

@property (nonatomic) CGFloat scaleValue;

imageRotation

An image rotation that specifies the angle in which your data is placed in the print area. Rotation direction is clockwise. For allowed values, see BRLMPrintSettingsRotation.

Declaration

@property (nonatomic) BRLMPrintSettingsRotation imageRotation;

halftone

A way to rasterize your data. For allowed values, see BRLMPrintSettingsHalftone.

Declaration

@property (nonatomic) BRLMPrintSettingsHalftone halftone;

hAlignment

A horizontal alignment that specifies how your data is placed in the printable area. For allowed values, see BRLMPrintSettingsHorizontalAlignment.

Declaration

@property (nonatomic) BRLMPrintSettingsHorizontalAlignment hAlignment;

vAlignment

A vertical alignment that specifies how your data is placed in the printable area. For allowed values, see BRLMPrintSettingsVerticalAlignment.

Declaration

@property (nonatomic) BRLMPrintSettingsVerticalAlignment vAlignment;

compress

A compress mode that specifies how to compress your data. For allowed values, see BRLMPrintSettingsCompressMode.

Declaration

@property (nonatomic) BRLMPrintSettingsCompressMode compress;

halftoneThreshold

A threshold value. This is effective when the halftone is BRLMPrintSettingsHalftoneThreshold.

Declaration

@property (nonatomic) UInt8 halftoneThreshold;

numCopies

The number of copies you print.

Declaration

@property (nonatomic) NSUInteger numCopies;

skipStatusCheck

Whether or not to check the status before printing.

Declaration

@property (nonatomic) BOOL skipStatusCheck;

printQuality

A priority that is print speed or print quality. Whether or not this has an effect is depend on your printer.

Declaration

@property (nonatomic) BRLMPrintSettingsPrintQuality printQuality;

Supported printers for each enumerator are as below.

Enumerator Supported Printer
BRLMPrintSettingsPrintQualityBest All printer
BRLMPrintSettingsPrintQualityFast QL series, TD-2XXX series (only when the 'resolution' is Normal)

Types

BRLMPrintSettingsCompressMode

Declaration

typedef NS_ENUM(NSInteger, BRLMPrintSettingsCompressMode) {
    BRLMPrintSettingsCompressModeNone,
    BRLMPrintSettingsCompressModeTiff,
    BRLMPrintSettingsCompressModeMode9,
};

BRLMPrintSettingsHalftone

Declaration

typedef NS_ENUM(NSInteger, BRLMPrintSettingsHalftone) {
    BRLMPrintSettingsHalftoneThreshold,
    BRLMPrintSettingsHalftoneErrorDiffusion,
    BRLMPrintSettingsHalftonePatternDither,
};

BRLMPrintSettingsHorizontalAlignment

Declaration

typedef NS_ENUM(NSInteger, BRLMPrintSettingsHorizontalAlignment) {
    BRLMPrintSettingsHorizontalAlignmentLeft,
    BRLMPrintSettingsHorizontalAlignmentCenter,
    BRLMPrintSettingsHorizontalAlignmentRight,
};

BRLMPrintSettingsOrientation

Declaration

typedef NS_ENUM(NSInteger, BRLMPrintSettingsOrientation) {
    BRLMPrintSettingsOrientationPortrait,
    BRLMPrintSettingsOrientationLandscape,
};

BRLMPrintSettingsResolution

Declaration

typedef NS_ENUM(NSInteger, BRLMPrintSettingsResolution) {
    BRLMPrintSettingsResolutionLow,
    BRLMPrintSettingsResolutionNormal,
    BRLMPrintSettingsResolutionHigh,
};

BRLMPrintSettingsScaleMode

Declaration

typedef NS_ENUM(NSInteger, BRLMPrintSettingsScaleMode) {
    BRLMPrintSettingsScaleModeActualSize,
    BRLMPrintSettingsScaleModeFitPageAspect,
    BRLMPrintSettingsScaleModeFitPaperAspect,
    BRLMPrintSettingsScaleModeScaleValue,
};

BRLMPrintSettingsVerticalAlignment

Declaration

typedef NS_ENUM(NSInteger, BRLMPrintSettingsVerticalAlignment) {
    BRLMPrintSettingsVerticalAlignmentTop,
    BRLMPrintSettingsVerticalAlignmentCenter,
    BRLMPrintSettingsVerticalAlignmentBottom,
};

BRLMPrintSettingsPrintQuality

Declaration

typedef NS_ENUM(NSInteger, BRLMPrintSettingsPrintQuality) {
    BRLMPrintSettingsPrintQualityBest,
    BRLMPrintSettingsPrintQualityFast,
};

BRLMPrintSettingsRotation

Declaration

typedef NS_ENUM(NSInteger, BRLMPrintSettingsRotation) {
    BRLMPrintSettingsRotationRotate0,
    BRLMPrintSettingsRotationRotate90,
    BRLMPrintSettingsRotationRotate180,
    BRLMPrintSettingsRotationRotate270,
};

Deprecates

Deprecated

printOrientation

Please use imageRotation instead.