Support hardware keyboards in your app

ハイライト

UIKit のハードウェアキーボードサポートはレスポンダーチェーン上に構築されています。アプリは UIKeyCommand と UIResponderStandardEditActions を使用して検出可能なショートカットキーを提供し、UITableView/UICollectionView の複数選択コールバックを使用して Shift/Command 選択に応答し、UIGestureRecognizer.modifierFlags と pressesBegan/pressesEnded を使用して修飾キージェスチャとキーを処理できます。プレス/リリースイベント。

主要内容

iPad アプリはもともとタッチを中心に設計されました。画面上にボタンが表示され、クリックするだけで機能を見つけることができます。外付けハードウェアキーボードが日常的に使用されるようになると、別の期待が生まれました。ユーザーは、Space を使用して再生を制御し、Command を使用してショートカットキーを見つけ、Shift または Command を使用してリストの選択を拡張し、矢印キーを使用してキャンバスオブジェクトを微調整したいと考えていました。

このセッションでは、まずイベントの由来について説明します。キーボードイベントがレスポンダーチェーンに入ります。現在、ファーストレスポンダが最初にイベントを受信します。処理できない場合、イベントはチェーンを上流に進みます。 UIKit は、このチェーンに沿って各レスポンダーの公開データを収集します。keyCommandsをクリックし、Command キーを押し続けると表示される検出可能 HUD にそれらを表示します。

その後、スピーチによりキーボードのサポートが 4 つの層に分割されました。最初のレベルはカスタムショートカットキーです。使用します。UIKeyCommand入力とセレクターを接続します。 2 番目のレベルは標準の編集アクションです。selectAll(_:)、copy(_:)、paste(_:)これらの方法では、追加のショートカットキーを作成する必要はありません。 3 番目のレベルはリストビューとコレクションビューでの複数選択で、システムは Shift または Command に基づいて選択を展開します。 4 番目の層は下位レベルの入力です。ジェスチャ認識機能は修飾キーを読み取ることができます。UIResponderキーダウン、キーアップにダイレクトに反応します。

このモデルセットは Mac Catalyst にも対応しています。UIKeyCommand継承元UICommand、コマンドビルダー API を入力して、macOS メニューバーに表示できます。開発者は、iPad と Mac 用に 2 つの完全に別個のコマンドポータルを維持する必要がなくなりました。

詳細

1. UIKeyCommand を使用してカスタムショートカットキーを公開する

（01:17）UIKeyCommandアプリ独自に定義されたキーボードショートカットを表します。これには、発見可能性のタイトル、トリガー入力、オプションの修飾子フラグ、および呼び出されたときに実行するアクションが含まれます。 UIKitパスUIResponder.keyCommandsレスポンダーチェーンからこれらのコマンドを収集します。

(03:14) このスピーチでは、例として音楽の再生コントロールを使用しています。プレーヤービューコントローラーがファーストレスポンダーになった後、スペースキーでトリガーできるようになります。playPause。

class PlayerViewController: UIViewController {

    override var canBecomeFirstResponder: Bool {
        return true
    }

    override func viewDidAppear(_ animated: Bool) {
        becomeFirstResponder()
    }

    override var keyCommands: [UIKeyCommand]? {
        return [
            UIKeyCommand(title: NSLocalizedString("PLAY_PAUSE", comment: "…"),
                        action: #selector(playPause),
                         input: " ")
        ]
    }
}

キーポイント:

canBecomeFirstResponder戻るtrue、このビューコントローラーはキーボードイベントエントリになることができます。 -viewDidAppear(_:)電話becomeFirstResponder()、プレーヤーインターフェイスは、ショートカットキーが表示された直後に受け取ることができます。 -keyCommands現在のインターフェースで使用可能なコマンドの配列を返します。 -input: " "スペースバーをバインドしますplayPause セレクター。
titleCommand キーを長押ししたときにシステムがユーザーに表示するローカライズされた文字列を使用します。

2. 標準の編集アクションでは、UIKeyCommand を手書きする必要はありません。

(04:31) 多くのショートカットキーには、すでにシステム規則があります。音楽ライブラリやファイルリストでよく使われる「全選択」「コピー」「ペースト」は以下に属します。UIResponderStandardEditActions。レスポンダーサブクラスの対応するメソッドをオーバーライドする限り、UIKit は共通の編集ショートカットキーをこれらのアクションに接続できます。

class SongListTableViewController: UITableViewController {

    override var canBecomeFirstResponder: Bool {
        return true
    }

    override func viewDidAppear(_ animated: Bool) {
        becomeFirstResponder()
    }

    /* UIResponderStandardEditActions */

    override func selectAll(_ sender: Any?) { … }

    override func copy(_ sender: Any?) { … }

    override func paste(_ sender: Any?) { … }

}

キーポイント:

UITableViewControllerあまりにもUIResponder、レスポンダーチェーンに直接参加できます。 -selectAll(_:)、copy(_:)、paste(_:)からUIResponderStandardEditActions。
これらの標準アクションを使用する場合、作成する必要はありませんUIKeyCommand。
この書き方により、ユーザーは期待どおりに Mac から Command-A、Command-C、および Command-V を iPad アプリに持ち込むことができます。

(05:52) カスタムコマンドが Mac Catalyst メニューバーに入ると、次のことができます。UIKeyCommandとしてUICommandコマンドビルダーを入れます。

class UIKeyCommand : UICommand {
    ...
}

override func buildMenu(with builder: UIMenuBuilder) {
    builder.replaceChildren(ofMenu: .file) { children in
        return [ UIKeyCommand() ] + children
    }
}

キーポイント:

UIKeyCommandはいUICommandサブカテゴリ。 -buildMenu(with:)これは、コマンドのメニュー構造へのエントリポイントです。 -replaceChildren(ofMenu:)指定したメニューのサブ項目を置換または補足できます。
Mac Catalyst アプリの場合、キーボードショートカットとメニュー項目は同じコマンドモデルのセットを指す必要があります。

3. テーブルビューとコレクションビューでキーボードによる複数選択をサポートする

(06:28) アプリにファイルリストがある場合、ユーザーは Shift クリックで連続した項目を選択し、Command クリックで連続していない選択を展開することを期待します。UITableViewそしてUICollectionView対応する複数選択コールバックが提供されています。

optional func tableView(_ tableView: UITableView,
       shouldBeginMultipleSelectionInteractionAt indexPath: IndexPath) -> Bool

optional func tableView(_ tableView: UITableView,
       didBeginMultipleSelectionInteractionAt indexPath: IndexPath)

キーポイント:

shouldBeginMultipleSelectionInteractionAt戻るtrueその後、システムは複数選択インタラクションの処理を開始します。
テーブルビューは編集モードになり、コレクションビューは複数選択モードになります。
システムは、ユーザーが Shift キーを押すか Command キーを押すかに基づいて現在の選択を展開します。 -didBeginMultipleSelectionInteractionAt一括操作バーの表示など、周囲のUIを更新するのに適しています。

4. ジェスチャ認識機能でキーボード修飾キーを読み取る

(07:47) iOS 13.4 が追加されましたUIGestureRecognizer.modifierFlags。これは、Gesture Recognizer の状態が変化したときにユーザーがどのキーボード修飾キーを押したかを記録します。数値の例としては、Shift キーを押しながら図形のサイズを変更するときに縦横比を維持することや、Command キーを押しながら複数のオブジェクトを選択することが挙げられます。

func recognizedDragGesture(_ panGesture: UIPanGestureRecognizer) {

    if panGesture.modifierFlags.contains(.command) {
        snapToGrid = true
    } else if panGesture.modifierFlags.contains(.shift) {
        constrainAspectRatio = true
    }

    ...
}

キーポイント:

modifierFlags現在のジェスチャ認識機能では、キーボードを個別に聞く必要はありません。 -.commandグリッドスナップなどの正確な編集モードに切り替えることができます。 -.shiftアスペクト比を維持する制約モードに切り替えることができます。
このタイプの対話は、描画、植字、表、地図編集などの専門的なシナリオに適しています。

5. pressesBegan と pressesEnded を使用して元のキーイベントに応答する

（09:00）UIKeyCommandショートカットキーがトリガーされたときに 1 回だけ呼び出されます。矢印キーを使用してキャンバスオブジェクトを移動するなどの操作では、キーダウンとキーアップを区別する必要があります。押すと移動が開始され、放すと移動が停止します。新しい生のキーボードイベントエントリは次のとおりです。UIResponder.pressesBegan(_:with:)そしてUIResponder.pressesEnded(_:with:)。

class UIResponder: NSObject {
    func pressesBegan(_ presses: Set<UIPress>,
                     with event: UIPressesEvent)

    func pressesEnded(_ presses: Set<UIPress>,
                     with event: UIPressesEvent)
}

キーポイント:

pressesBeganハードウェアキーボードのキーが押されたときに呼び出されます。 -pressesEndedキーが放されたときに呼び出されます。
これら 2 つの方法は、継続的なアクションに適していますが、1 回だけトリガーされるメニューコマンドには適していません。
元のキーイベントは引き続きレスポンダーチェーンを通過するため、ビューまたはビューコントローラーに配置できます。

(09:59) キャンバスの例:pressesBegan矢印キーをチェックインしますpressesEnded動くのをやめてください。

class CanvasViewController: UIViewController {

     override func pressesBegan(_ presses: Set<UIPress>, with event: UIPressesEvent?) {
         for press in presses {
             guard let key = press.key else { continue }
             switch key.keyCode {
             case .keyboardUpArrow: startMoveUp()
             case .keyboardDownArrow: startMoveDown()
                 …
             }
     }
     }

     override func pressesEnded(_ presses: Set<UIPress>, with event: UIPressesEvent?) {
         stopMoving()
     }

}

キーポイント:

press.key空の可能性があるため、最初に使用してくださいguardキーなしで押すとスキップします。 -key.keyCode上下などの特定のボタンを区別できます。 -startMoveUp()そしてstartMoveDown()方向キーを押した後の継続的な動作を表します。 -stopMoving()つけるpressesEnded、ユーザーがボタンを放した後にアクションが確実に停止するようにします。

(10:29) Raw キーイベントは修飾キーを読み取ることもできます。次の例では、オブジェクトの移動時に Shift をチェックし、「移動中に選択」動作に切り替えます。

class CanvasViewController: UIViewController {

    override func pressesBegan(_ presses: Set<UIPress>, with event: UIPressesEvent?) {
        var selectWhileMoving = false
        for press in presses {
            guard let key = press.key else { continue }
            if key.modifierFlags.contains(.shift) {
                selectWhileMoving = true
            }

            switch key.keyCode {
            case .keyboardUpArrow: startMoveUp()

            }
        }
    }
}

キーポイント:

key.modifierFlags.contains(.shift)現在のキーイベントの修飾キーのステータスを直接読み取ります。 -selectWhileMovingこれはビジネス状態であり、移動と同時に選択が拡張されることを示します。
これはジェスチャ認識機能と同じですmodifierFlagsこれは同じインタラクティブなアイデアです。ハードウェアキーボードはモードの切り替えを担当し、タッチ、ポインター、または矢印キーはアクションの実行を担当します。

重要ポイント

内容: メディアプレーヤーにスペースバーの再生/一時停止を追加します。 実行する価値がある理由: Session は明示的に Music を使用して、メディア再生アプリでスペースバーが一般的に期待されていることを示します。 開始方法: 再生インターフェイスのビューコントローラーをファーストレスポンダーにします。keyCommands1 つを返しますUIKeyCommand、バンドルinput: " "再生状態切り替えメソッドに接続します。
内容: ファイル、曲、プロジェクトリストで Command-A、Command-C、Command-V をサポートするようにします。 実行する価値がある理由:UIResponderStandardEditActionsユーザーに馴染みのある標準の編集ショートカットキーにアクセスして、カスタムコマンドの数を減らすことができます。 開始方法: リストコントローラーでオーバーライドしますselectAll(_:)、copy(_:)、paste(_:)、コントローラーがファーストレスポンダーになれることを確認します。
内容: Shift/Command による複数選択をリストに追加します。 これを実行する価値がある理由: デスクトップユーザーは、Shift キーで連続する項目を選択し、Command キーで非連続な選択を展開することを当然期待します。 UIKit は、テーブルビューとコレクションビューへの複数選択の入り口をすでに提供しています。 開始方法: 実装shouldBeginMultipleSelectionInteractionAtそして戻るtrue、またdidBeginMultipleSelectionInteractionAtバッチ操作 UI はに表示されます。
内容: 描画ツールまたは植字ツールに修飾キーモードを追加します。 実行する価値がある理由: スピーチ内の Numbers の例は、Shift と Command を使用すると、同じドラッグジェスチャでより正確な編集動作を生成できることを示しています。 開始方法:UIPanGestureRecognizerコールバックから読み取るmodifierFlags、によると.shift、.commandアスペクト比の維持、グリッドへのスナップ、または複数選択モードを切り替えます。
内容: 矢印キーを使用して、キャンバスオブジェクトを連続的に移動します。 実行する価値がある理由:UIKeyCommandこれは 1 回だけトリガーされ、連続的な動作にはキーダウンとキーアップの 2 つのフェーズが必要です。 開始方法: キャンバスビューコントローラーでオーバーライドするpressesBeganそしてpressesEnded、によるとkey.keyCode移動を開始し、キーを放すと停止します。

Support hardware keyboards in your app

ハイライト

主要内容

詳細

1. UIKeyCommand を使用してカスタムショートカットキーを公開する

2. 標準の編集アクションでは、UIKeyCommand を手書きする必要はありません。

3. テーブルビューとコレクションビューでキーボードによる複数選択をサポートする

4. ジェスチャ認識機能でキーボード修飾キーを読み取る

5. pressesBegan と pressesEnded を使用して元のキーイベントに応答する

重要ポイント

関連セッション

コメント

ハイライト

主要内容

詳細

1. UIKeyCommand を使用してカスタム ショートカット キーを公開する

2. 標準の編集アクションでは、UIKeyCommand を手書きする必要はありません。

3. テーブル ビューとコレクション ビューでキーボードによる複数選択をサポートする

4. ジェスチャ認識機能でキーボード修飾キーを読み取る

5. pressesBegan と pressesEnded を使用して元のキー イベントに応答する

重要ポイント

関連セッション

コメント

1. UIKeyCommand を使用してカスタムショートカットキーを公開する

3. テーブルビューとコレクションビューでキーボードによる複数選択をサポートする

5. pressesBegan と pressesEnded を使用して元のキーイベントに応答する