4.3. ISDCBBuilder
added in version 1.7.0
カスタマーディスプレイ制御用コマンドを生成する機能を提供するインターフェイスです。
本インターフェイスは、カスタマーディスプレイに対応しているモデル専用です。 対応しているモデルは 対応外部機器 を参照ください。
列挙体
名称
説明
国際文字指定定数
コードページ指定定数
カーソルモード指定定数
コントラストモード指定定数
プロパティ
名称
説明
生成、追加されたコマンド列です。
生成、追加されたコマンド列の先頭にプリンタへのパススルーコマンドが追加されたコマンド列です。
メソッド
名称
説明
データ(テキストやコマンド)をコマンドバッファに追加します。
バックスペースコマンドを生成し、コマンドバッファに追加します。
水平タブコマンドを生成し、コマンドバッファに追加します。
ラインフィードコマンドを生成し、コマンドバッファに追加します。
キャリッジリターンコマンドを生成し、コマンドバッファに追加します。
グラフィック表示コマンドを生成し、コマンドバッファに追加します。
国際文字指定コマンドを生成し、コマンドバッファに追加します。
コードページ指定コマンドを生成し、コマンドバッファに追加します。
画面を行末までクリアするコマンドを生成し、コマンドバッファに追加します。
画面をクリアするコマンドを生成し、コマンドバッファに追加します。
カーソルをホームポジションに移動するコマンドを生成し、コマンドバッファに追加します。
バックライトをオン・オフするコマンドを生成し、コマンドバッファに追加します。
カーソルを指定された位置に移動するコマンドを生成し、コマンドバッファに追加します。
カーソルモード変更コマンドを生成し、コマンドバッファに追加します。
コントラストモード変更コマンドを生成し、コマンドバッファに追加します。
ユーザー定義文字(SBCS)登録コマンドを生成し、コマンドバッファに追加します。
ユーザー定義文字(DBCS)登録コマンドを生成し、コマンドバッファに追加します。
4.3.1. SDCBInternationalType
added in version 1.7.0
国際文字指定定数です。
宣言
public enum SDCBInternationalType : Int { case USA case france case germany case UK case denmark case sweden case italy case spain case japan case norway case denmark2 case spain2 case latinAmerica case korea }
定数
名称
説明
USA
アメリカ
france
フランス
germany
ドイツ
UK
イギリス
denmark
デンマーク
sweden
スウェーデン
italy
イタリア
spain
スペイン
japan
日本
norway
ノルウェー
denmark2
デンマークII
spain2
スペインII
latinAmerica
ラテンアメリカ
korea
韓国
4.3.2. SDCBCodePageType
added in version 1.7.0
コードページ指定定数です。
宣言
public enum SDCBCodePageType : Int { case CP437 case katakana case CP850 case CP860 case CP863 case CP865 case CP1252 case CP866 case CP852 case CP858 case japanese case simplifiedChinese case traditionalChinese case hangul }
定数
名称
説明
CP437
CodePage437 (USA, Std. Europe)
katakana
Katakana
CP850
PC850 (Multilingual)
CP860
PC860 (Portuguese)
CP863
PC863 (Canadian-French)
CP865
PC865 (Norwegian)
CP1252
WPC1252
CP866
PC866 [Cyrillic #2]
CP852
PC852 [Latin 2]
CP858
Page 19 [PC858]
japanese
Japanese font (shift JIS)
simplifiedChinese
Simplified Chinese (GB2312)
traditionalChinese
Traditional Chinese (Big5)
hangul
Hangul (KSC5601)
4.3.3. SDCBCursorMode
added in version 1.7.0
カーソルモード指定定数です。
宣言
public enum SDCBCursorMode : Int { case off case blink case on }
定数
名称
説明
off
カーソル消灯
blink
カーソル点滅
on
カーソル点灯
4.3.4. SDCBContrastMode
added in version 1.7.0
コントラストモード指定定数です。
宣言
public enum SDCBContrastMode : Int { case minus3 case minus2 case minus1 case default case plus1 case plus2 case plus3 }
定数
名称
説明
minus3
コントラスト マイナス3
minus2
コントラスト マイナス2
minus1
コントラスト マイナス1
default
デフォルト
plus1
コントラスト プラス1
plus2
コントラスト プラス2
plus3
コントラスト プラス3
4.3.5. commands
added in version 1.7.0
コマンドバッファ(生成したコマンド)を取得します。
宣言
open var commands: UnsafeMutablePointer<Int32>! { get }
引数
なし
値
説明
型
コマンドバッファ(生成したコマンド)
NSMutableData
4.3.6. passThroughCommands
added in version 1.7.0
コマンドバッファ(生成したコマンド)の先頭にプリンタへのパススルーコマンドが追加されたコマンド列を取得します。
宣言
open var passThroughCommands: UnsafeMutablePointer<Int32>! { get }
引数
なし
戻り値
説明
型
コマンドバッファ(生成したコマンド)
NSMutableData
4.3.7. appendData
added in version 1.7.0
データ(テキストやコマンド)をコマンドバッファに追加します。
宣言
open func appendByte(_ data: UInt8) open func appendData(_ otherData: Any!) open func appendBytes(_ bytes: UnsafeRawPointer!, length: Any!)
引数
名称
説明
型
dataotherDatabytesデータ(テキストやコマンド)
UInt8DataUnsafeRawPointerlength
データ長
UInt
戻り値
なし
4.3.8. appendBackSpace
added in version 1.7.0
バックスペースコマンドを生成し、コマンドバッファに追加します。
宣言
open func appendBackSpace()
引数
なし
戻り値
なし
4.3.9. appendHorizontalTab
added in version 1.7.0
水平タブコマンドを生成し、コマンドバッファに追加します。
宣言
open func appendHorizontalTab()
引数
なし
戻り値
なし
4.3.10. appendLineFeed
added in version 1.7.0
ラインフィードコマンドを生成し、コマンドバッファに追加します。
宣言
open func appendLineFeed()
引数
なし
戻り値
なし
4.3.11. appendCarriageReturn
added in version 1.7.0
キャリッジリターンコマンドを生成し、コマンドバッファに追加します。
宣言
open func appendCarriageReturn()
引数
なし
戻り値
なし
4.3.12. appendBitmap
added in version 1.7.0
グラフィック表示コマンドを生成し、コマンドバッファに追加します。
宣言
open func appendBitmap(_ image: Any!, diffusion: Any!)
引数
名称
説明
型
bitmap
表示したいイメージ横 160dot、縦 40dotのモノクロBitmapクラスのインスタンスを指定してください。異なるサイズのBitmapが指定された場合、横 160dot、縦 40dotにリサイズされます。Bitmapの各ピクセルの色は自動でモノクロ2値に変換されます。UIImage
diffusion
誤差拡散true ... 誤差拡散を行うfalse ... 誤差拡散を行わないBool
戻り値
なし
4.3.13. appendInternational
added in version 1.7.0
国際文字指定コマンドを生成し、コマンドバッファに追加します。
宣言
open func appendInternational(_ type: Any!)
引数
名称
説明
型
internationalType
国際文字指定定数
戻り値
なし
4.3.14. appendCodePage
added in version 1.7.0
コードページ指定コマンドを生成し、コマンドバッファに追加します。
宣言
open func appendCodePage(_ type: Any!)
引数
名称
説明
型
codePageType
コードページ指定定数
戻り値
なし
4.3.15. appendDeleteToEndOfLine
added in version 1.7.0
画面を行末までクリアするコマンドを生成し、コマンドバッファに追加します。
宣言
open func appendDeleteToEndOfLine()
引数
なし
戻り値
なし
4.3.16. appendClearScreen
added in version 1.7.0
画面をクリアするコマンドを生成し、コマンドバッファに追加します。
宣言
open func appendClearScreen()
引数
なし
戻り値
なし
4.3.17. appendHomePosition
added in version 1.7.0
カーソルをホームポジションに移動するコマンドを生成し、コマンドバッファに追加します。
宣言
open func appendHomePosition()
引数
なし
戻り値
なし
4.3.18. appendTurnOn
added in version 1.7.0
バックライトをオン・オフするコマンドを生成し、コマンドバッファに追加します。
宣言
open func appendTurn(on turnOn: Any!)
引数
名称
説明
型
turnOn
バックライトのオン・オフ
Bool
戻り値
なし
4.3.19. appendSpecifiedPosition
added in version 1.7.0
カーソルを指定された位置に移動するコマンドを生成し、コマンドバッファに追加します。
宣言
open func appendSpecifiedPosition(_ x: Int32, y: Int32)
引数
名称
説明
型
x
桁位置(一番左の桁が1)
Int32
y
行位置(一番上の行が1)
Int32
戻り値
なし
4.3.20. appendCursorMode
added in version 1.7.0
カーソルモード変更コマンドを生成し、コマンドバッファに追加します。
宣言
open func appendCursorMode(_ cursorMode: Any!)
引数
名称
説明
型
cursorMode
カーソルモード指定定数
戻り値
なし
4.3.21. appendContrastMode
added in version 1.7.0
コントラストモード変更コマンドを生成し、コマンドバッファに追加します。
宣言
open func appendContrastMode(_ contrastMode: Any!)
引数
名称
説明
型
contrastMode
コントラストモード指定定数
戻り値
なし
4.3.22. appendUserDefinedCharacter
added in version 1.7.0
ユーザー定義文字(SBCS)登録コマンドを生成し、コマンドバッファに追加します。
宣言
open func appendUserDefinedCharacter(_ index: Int32, code: Int32, font: UnsafeMutablePointer<UInt8>!)
引数
名称
説明
型
index
フォント番号00h ≦ index ≦ 1FhInt32
code
ユーザー定義文字の文字コード20h ≦ code ≦ 7FhappendCodePage メソッドで japanese を指定した場合、以下の範囲も使用可能です。A0h ≦ code ≦ DFhInt32
font
16byteのフォントデータフォントデータの作成方法は、下記データフォーマットを参照してください。nil を指定すると、指定したフォント番号のユーザー定義文字を解除します。UnsafeMutablePointer<UInt8>
戻り値
なし
ユーザー定義文字のフォントデータのフォーマット
4.3.23. appendUserDefinedDbcsCharacter
added in version 1.7.0
ユーザー定義文字(DBCS)登録コマンドを生成し、コマンドバッファに追加します。
宣言
open func appendUserDefinedDbcsCharacter(_ index: Int32, code: Int32, font: UnsafeMutablePointer<UInt8>!)
引数
名称
説明
型
index
フォント番号00h ≦ index ≦ 0FhInt32
code
ユーザー定義文字の文字コード20h ≦ code ≦ 7FhappendCodePage メソッドで japanese を指定した場合、以下の範囲も使用可能です。80 00h ≦ code ≦ FF FFhInt32
font
32byteのフォントデータフォントデータの作成方法は、下記データフォーマットを参照してください。nil を指定すると、指定したフォント番号のユーザー定義文字を解除します。UnsafeMutablePointer<UInt8>
戻り値
なし
ユーザー定義文字のフォントデータのフォーマット