# 機能設計書 206-SetKeyboardFocusHere

## 概要

本ドキュメントは、ImGuiライブラリにおける `SetKeyboardFocusHere` 関数の機能設計を定義する。この関数は、キーボードフォーカスを次のウィジェットに設定するために使用される。

### 本機能の処理概要

SetKeyboardFocusHere関数は、キーボードフォーカスを指定したオフセット位置のウィジェットに移動させる。デフォルト（offset=0）では次のウィジェットにフォーカスが移動し、offset=-1では直前のウィジェットにフォーカスが移動する。正の値のoffsetを使用すると、複数コンポーネントウィジェットの内部サブコンポーネントにアクセスできる。

**業務上の目的・背景**：キーボードのみでの操作や、特定の入力フィールドへの自動フォーカスが必要な場面で使用される。例えば、検索フィルタを開いた時に自動的に入力フィールドにフォーカスを当てたり、フォーム送信後に次の入力項目にフォーカスを移動させたりする用途がある。

**機能の利用シーン**：
- 検索/フィルタダイアログを開いた時の自動フォーカス
- エラー発生時の問題フィールドへのフォーカス移動
- フォーム内での次項目への自動移動
- マルチセレクト削除後の適切な項目へのフォーカス
- カスタムキーボードナビゲーションの実装

**主要な処理内容**：
1. ドラッグ&ドロップまたはウィンドウ移動中でないか確認
2. ナビゲーションウィンドウを現在のウィンドウに設定
3. ナビゲーション移動リクエストを送信
4. offset値に応じてフォーカス対象を決定

**関連システム・外部連携**：ナビゲーションシステム、スクロールシステム、アクティベーションシステムと連携する。

**権限による制御**：本機能自体に権限制御はない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 23 | Widgets | 参照画面 | コンボボックスフィルタでのフォーカス設定 |
| 27 | Inputs | 参照画面 | 入力フィールドへのフォーカス制御 |

## 機能種別

フォーカス制御 / キーボードナビゲーション / ウィジェット制御

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| offset | int | No（デフォルト: 0） | フォーカス対象のオフセット。0=次のウィジェット、-1=直前のウィジェット、正の値=サブコンポーネント | offset >= -1 |

### 入力データソース

プログラムコードからの直接呼び出し。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| なし | void | 戻り値なし |

### 出力先

- ImGuiContext::NavTabbingDir（タブ方向）
- ImGuiContext::NavTabbingCounter（タブカウンタ）
- ナビゲーション移動リクエスト

## 処理フロー

### 処理シーケンス

```
1. ImGuiContextの取得
   └─ グローバルコンテキスト（GImGui）を取得
2. ドラッグ&ドロップ/ウィンドウ移動チェック
   └─ アクティブな場合は早期リターン（デバッグログ出力）
3. ナビゲーションウィンドウ設定
   └─ SetNavWindow(window)を呼び出し
4. ナビゲーション移動リクエスト送信
   └─ NavMoveRequestSubmitを呼び出し
   └─ スクロールフラグを設定
5. オフセット処理
   └─ offset == -1: 直前のアイテムにフォーカス
   └─ offset >= 0: タブカウンタを設定
```

### フローチャート

```mermaid
flowchart TD
    A[SetKeyboardFocusHere呼び出し] --> B{DragDrop/Moving中?}
    B -->|Yes| C[デバッグログ出力]
    C --> D[早期リターン]
    B -->|No| E[SetNavWindow]
    E --> F[NavMoveRequestSubmit]
    F --> G{offset == -1?}
    G -->|Yes| H[NavMoveRequestResolveWithLastItem]
    G -->|No| I[NavTabbingDir = 1]
    H --> J[終了]
    I --> K[NavTabbingCounter = offset + 1]
    K --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-206-1 | オフセット範囲 | offset は -1 以上である必要がある | 常時 |
| BR-206-2 | ドラッグ中無効 | ドラッグ&ドロップ中およびウィンドウ移動中は無視される | DragDropActive時 |
| BR-206-3 | アクティベーション | フォーカス移動時にウィジェットをアクティベートする | 常時 |
| BR-206-4 | スクロール連動 | フォーカス対象が見えない場合は自動スクロール | 常時 |

### 計算ロジック

オフセットによるフォーカス対象決定：
```
if (offset == -1):
    直前のアイテム（LastItem）にフォーカス
else:
    NavTabbingDir = 1
    NavTabbingCounter = offset + 1
    次のN番目のウィジェットにフォーカス
```

## データベース操作仕様

### 操作別データベース影響一覧

本機能はデータベース操作を行わない（純粋なUI制御機能）。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| IM_ASSERT | アサーション | offset < -1の場合 | offset >= -1を満たす値を指定 |
| なし | 無視 | ドラッグ&ドロップ中の呼び出し | デバッグログ出力後、処理をスキップ |

### リトライ仕様

リトライ機能なし（即時処理）

## トランザクション仕様

トランザクション管理なし（UI状態の更新）。

## パフォーマンス要件

- 軽量な処理（ナビゲーションリクエストの設定のみ）
- オーバーヘッドは最小限

## セキュリティ考慮事項

- フォーカス制御はUIの利便性機能であり、セキュリティ上のリスクはない

## 備考

- 将来的にActivateItem()として再設計される可能性がある（コメントによる示唆）
- MovingWindowはSetActiveIdUsingNavAndKeysで保護されるが、ActiveId取得時に自動解除される
- カスタムコンボボックスフィルタなどで頻繁に使用される

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: API宣言を理解する

公開APIの宣言とドキュメントコメントを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | SetKeyboardFocusHere関数の宣言（995行目） |

**主要処理フロー**:
- **995行目**: 関数宣言とドキュメントコメント（offset引数の説明）

#### Step 2: 実装を理解する

SetKeyboardFocusHere関数の実装詳細を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | SetKeyboardFocusHere関数の実装（8757-8788行目） |

**主要処理フロー**:
- **8757行目**: 関数定義の開始
- **8761行目**: offset >= -1のアサーション
- **8764-8772行目**: ドラッグ&ドロップ/MovingWindow中のチェック
- **8774行目**: SetNavWindow呼び出し
- **8776-8777行目**: NavMoveRequestSubmit呼び出し
- **8778-8787行目**: offset値に応じた処理分岐

#### Step 3: 使用例を理解する

デモコードでの使用パターンを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_demo.cpp | `imgui_demo.cpp` | コンボボックスフィルタでの使用（1350行目） |
| 3-2 | imgui_demo.cpp | `imgui_demo.cpp` | マルチセレクト削除後のフォーカス（2875行目） |

### プログラム呼び出し階層図

```
ImGui::SetKeyboardFocusHere(int offset)
    │
    ├─ GImGui（グローバルコンテキスト取得）
    │
    ├─ IM_ASSERT(offset >= -1)
    │
    ├─ DragDrop/MovingWindow確認
    │      └─ IMGUI_DEBUG_LOG_FOCUS（無視時）
    │
    ├─ SetNavWindow(window)
    │
    ├─ NavMoveRequestSubmit()
    │      ├─ ImGuiDir（方向設定）
    │      ├─ ImGuiNavMoveFlags（フラグ設定）
    │      └─ ImGuiScrollFlags（スクロール設定）
    │
    └─ offset分岐
           ├─ offset == -1: NavMoveRequestResolveWithLastItem
           └─ offset >= 0: NavTabbingDir/Counter設定
```

### データフロー図

```
[入力]                     [処理]                           [出力]

offset(int) ──────────▶ SetKeyboardFocusHere() ─▶ NavMoveRequest
                              │
現在のwindow ─────────▶       │ ───────────────▶ NavWindow設定
                              │
DragDrop/Moving状態 ──▶       └─────────────────▶ NavTabbingDir/Counter
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | 公開API宣言 |
| imgui.cpp | `imgui.cpp` | ソース | 実装コード |
| imgui_demo.cpp | `imgui_demo.cpp` | ソース | 使用例 |
