# 機能設計書 20-ShowUserGuide

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるShowUserGuide関数の機能設計を記載する。この関数はエンドユーザー向けの基本的な操作ガイドを表示するブロックを提供する。

### 本機能の処理概要

ShowUserGuide関数は、Dear ImGuiを使用したアプリケーションのエンドユーザーが知っておくべき基本的な操作方法（マウス/キーボード操作）を説明するテキストブロックを追加する。この関数自体はウィンドウを作成しないため、呼び出し側でウィンドウまたは他のコンテナ内で使用する必要がある。ウィンドウの操作、テキスト入力、キーボードナビゲーションなど、ImGuiの一般的な操作方法を箇条書きで説明する。

**業務上の目的・背景**：GUIアプリケーションのユーザビリティ向上のため、操作方法を明確に伝えることは重要である。ShowUserGuideは、ImGuiの標準的な操作方法をユーザーに伝えるための定型文を提供し、開発者がヘルプ機能を最小限のコードで実装できるようにする。特に、ImGui特有の操作（タイトルバーダブルクリックでの折りたたみ、Ctrl+クリックでの数値入力等）は、直感的でない場合があるため、ガイドの提供は有用である。

**機能の利用シーン**：
- アプリケーションのヘルプメニューに操作ガイドを表示する際
- ShowDemoWindowのHelpセクション内で操作方法を説明する際
- 初回起動時のチュートリアルやオンボーディングで使用する際

**主要な処理内容**：
1. ウィンドウ操作の説明（タイトルバーダブルクリック、リサイズ）
2. スライダー/ドラッグボックスの操作説明（Ctrl+クリック）
3. Tab/Shift+Tabによるフィールド移動
4. Ctrl+Tab/Ctrl+Shift+Tabによるウィンドウフォーカス
5. テキスト入力時の操作説明（Ctrl+X/C/V、Ctrl+Z等）
6. キーボードナビゲーション有効時の操作説明

**関連システム・外部連携**：
- ShowDemoWindow（Helpセクション内で使用）
- io.FontAllowUserScaling（ズーム機能の説明表示条件）

**権限による制御**：本機能に権限制御はない。ただし、IMGUI_DISABLE_DEMO_WINDOWSが定義されている場合は空の関数となる。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 7 | User Guide | 主画面 | ユーザーガイドの表示 |
| 1 | Demo Window | 使用箇所 | Helpセクション内で呼び出し |

## 機能種別

情報表示 / ヘルプ

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (なし) | - | - | パラメータなし | - |

### 入力データソース

- ImGuiIO::FontAllowUserScaling（ズーム機能の有効/無効）

## 出力仕様

### 出力データ

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

### 出力先

- ImGuiウィジェットとして描画（BulletText、Indent/Unindent）

## 処理フロー

### 処理シーケンス

```
1. 基本操作の説明
   └─ BulletText（タイトルバー、リサイズ、Ctrl+クリック、Tab移動等）
2. ズーム機能の説明（条件付き）
   └─ io.FontAllowUserScalingがtrueの場合のみ表示
3. テキスト入力操作の説明
   └─ BulletText + Indent/Unindent
4. キーボードナビゲーションの説明
   └─ BulletText + Indent/Unindent
```

### フローチャート

```mermaid
flowchart TD
    A[ShowUserGuide呼び出し] --> B[BulletText - タイトルバー操作]
    B --> C[BulletText - リサイズ操作]
    C --> D[BulletText - Ctrl+クリック]
    D --> E[BulletText - Tab移動]
    E --> F[BulletText - Ctrl+Tab]
    F --> G{io.FontAllowUserScaling?}
    G -->|Yes| H[BulletText - ズーム機能]
    G -->|No| I[BulletText - テキスト入力説明]
    H --> I
    I --> J[Indent]
    J --> K[テキスト操作の詳細]
    K --> L[Unindent]
    L --> M[BulletText - キーボードナビゲーション説明]
    M --> N[Indent]
    N --> O[ナビゲーション操作の詳細]
    O --> P[Unindent]
    P --> Q[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | ブロック形式 | この関数はウィンドウを作成しない | 常時 |
| BR-02 | ズーム表示条件 | io.FontAllowUserScalingがtrueの場合のみズーム説明を表示 | 常時 |
| BR-03 | 階層構造 | テキスト入力とキーボードナビゲーションの詳細はIndent/Unindentで階層化 | 常時 |

### 計算ロジック

該当なし（静的テキスト表示）

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

該当なし（インメモリ動作）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | - | エラーなし |

### リトライ仕様

該当なし（毎フレーム呼び出し）

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

該当なし

## パフォーマンス要件

- 静的テキストのみのため軽量

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

該当なし（ローカルUI表示のみ）

## 備考

- IMGUI_DISABLE_DEMO_WINDOWSが定義されている場合、空の関数となる
- 表示内容は英語のみ（ローカライズなし）
- macOSではCtrlの代わりにCmdキーが使用される場合がある（io.ConfigMacOSXBehaviors）

---

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

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

### 推奨読解順序

#### Step 1: データ構造を理解する

関連するIO設定を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiIO::FontAllowUserScaling |

**読解のコツ**: FontAllowUserScalingはCtrl+マウスホイールでのフォントズームを有効にする設定。この設定がtrueの場合のみズーム説明を表示。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | ShowUserGuide関数の宣言（415行目） |
| 2-2 | imgui_demo.cpp | `imgui_demo.cpp` | ShowUserGuide関数の実装（8695行目〜） |

**主要処理フロー**:
1. **8697行目**: ImGuiIO& io = GetIO()
2. **8698行目**: BulletText - タイトルバーダブルクリック
3. **8699-8701行目**: BulletText - リサイズ操作
4. **8702行目**: BulletText - Ctrl+クリック
5. **8703行目**: BulletText - Tab移動
6. **8704行目**: BulletText - Ctrl+Tab
7. **8705-8706行目**: 条件付きズーム説明
8. **8707-8714行目**: テキスト入力操作（Indent/Unindent使用）
9. **8715-8722行目**: キーボードナビゲーション操作

#### Step 3: 使用箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_demo.cpp | `imgui_demo.cpp` | ShowDemoWindowのHelpセクション（461行目） |

**主要処理フロー**:
- ShowDemoWindow内のCollapsingHeader("Help")内でShowUserGuide()が呼び出される

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

```
ShowUserGuide()
    │
    ├─ GetIO()
    │      └─ io.FontAllowUserScaling
    │
    ├─ BulletText("Double-click on title bar to collapse window.")
    │
    ├─ BulletText("Click and drag on lower corner or border to resize...")
    │
    ├─ BulletText("Ctrl+Click on a slider or drag box to input value as text.")
    │
    ├─ BulletText("Tab/Shift+Tab to cycle through keyboard editable fields.")
    │
    ├─ BulletText("Ctrl+Tab/Ctrl+Shift+Tab to focus windows.")
    │
    ├─ [条件付き] BulletText("Ctrl+Mouse Wheel to zoom window contents.")
    │
    ├─ BulletText("While inputting text:")
    │      ├─ Indent()
    │      ├─ BulletText("Ctrl+Left/Right to word jump.")
    │      ├─ BulletText("Ctrl+A or double-click to select all.")
    │      ├─ BulletText("Ctrl+X/C/V to use clipboard cut/copy/paste.")
    │      ├─ BulletText("Ctrl+Z to undo, Ctrl+Y/Ctrl+Shift+Z to redo.")
    │      ├─ BulletText("Escape to revert.")
    │      └─ Unindent()
    │
    └─ BulletText("With keyboard navigation enabled:")
           ├─ Indent()
           ├─ BulletText("Arrow keys or Home/End/PageUp/PageDown to navigate.")
           ├─ BulletText("Space to activate a widget.")
           ├─ BulletText("Return to input text into a widget.")
           ├─ BulletText("Escape to deactivate a widget...")
           ├─ BulletText("Alt to jump to the menu layer of a window.")
           └─ Unindent()
```

### データフロー図

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

(なし)               ShowUserGuide()                User Guide テキスト
                           │
                           ├─ BulletText × 複数
                           │
io.FontAllowUserScaling    ├─ [条件付き] ズーム説明
    │                      │
    └──────────────────────┴─ Indent/Unindent
                                  │
                                  └─ 階層化されたガイド表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | ShowUserGuide宣言（415行目） |
| imgui_demo.cpp | `imgui_demo.cpp` | ソース | ShowUserGuide実装（8695-8723行目） |
