Qco for iOS マニュアル - sbkro/Qco_for_iOS GitHub Wiki

Qcoって何？

Qcoは、Objective-Cで作られたシンプルなQRコードエンコードライブラリです。Qcoは簡単にQRコードが作成できるように設計されています。ちなみに、Qcoは、「QRcode Creator of Objective-C」の略字で、「きゅーこ」と読んでください。

インストール方法

  1. リポジトリからQcoをダウンロードし、Xcode内でビルドをしてください。
  2. Qcoを利用するプロジェクトに、"libQco.a"と"QCQRCode.h"を追加してください。
  3. [TARGETS] -> [Build Phase] -> [Link Binary With Library]に、"libQco.a", "UIKit.framework", "Foundation.framework" "CoreGraphics.framework"を追加してください。
  4. Qco (QCQRCode.h) を利用する実装ファイル (.m)を（.mm）へ変更してください。これは、QcoがC++プログラムをラッピングしているため、必要な作業となります。

使い方

Qcoは3つの手順でQRコードを作成できるように設計しています。

  1. 初期化
  2. パラメータの設定. (必要があれば)
  3. エンコード
#inclide "QCQRCode.h"
...
// Initialize
QCQRCode * encoder = [[QCQRCode alloc] init];
// Set parameters.
encoder.moduleSize = 10;
// Encode
UIImage * qrcode = [encoder encodeWithText:@"Hello Qco."];

メソッド

(id) init;

初期化メソッドとなります。このメソッド実行時に、以下のパラメータを自動で設定します。もし必要があれば、プロパティ経由で変更を行なってください。

  • モジュールサイズ（セルサイズ） : 1ピクセル
  • エラー補正レベル : Low (QCErrorCorrectLevelLow)
  • バージョン : 自動。エンコードするテキストの長さによって変化します
  • 前景色 : 黒
  • 背景色 : 白

(UIImage *) encodeWithText: (NSString *) text;

NSStringで指定したテキストからQRコードを作成します。文字数制限にオーバーした場合、nilを返却します。

Property

int moduleSize

1モジュールあたりのピクセルサイズになります。この値が大きくなるほど、画像のサイズは大きくなります。

enum QCErrorCorrectLevel correctLevel;

エラー補正レベルになります。補正レベルが高くなるほど、画像のサイズは大きくなります。

int symbolVersion;

QRコードのバージョンとなります。この値は1から40の範囲となります。この値が大きくなるほど、画像サイズが大きくなります。

UIColor * fgColor;

QRコードの前景色になります。

UIColor * bgColor;

QRコードの背景色になります。

Sample Code

Qcoを利用したサンプルコードを作成しましたので、ご参考ください。

License

MIT Licenceに準拠します。当ライブラリは、Psytec社のQRコードエンコードソフトのソースコードを一部利用しており、C++のソースコードをラッピングしたものとのとなっております。詳しくは以下のサイトをご参照ください。

動作環境

  • iOS 5.1