# 機能設計書 188-SetTabItemClosed

## 概要

本ドキュメントは、ImGuiライブラリのSetTabItemClosed関数の機能設計を記述する。この関数はタブが閉じられたことを事前にタブバーに通知するためのAPIである。

### 本機能の処理概要

SetTabItemClosed関数は、タブが閉じられたことをタブバーに事前通知し、タブの削除時に発生する視覚的なフリッカー（ちらつき）を防止する。プログラムからタブを閉じる場合（閉じるボタン以外の方法で閉じる場合）に使用する。

**業務上の目的・背景**：タブがプログラムから閉じられた場合（例えばチェックボックスで制御する場合など）、タブバーはその変更を次のフレームまで検出できない。この遅延により、1フレームの間タブバーに「隙間」が生じ、視覚的なフリッカーが発生する。SetTabItemClosedはこの問題を解決するために、タブが閉じられることを事前に通知する。

**機能の利用シーン**：
- チェックボックスやトグルでタブの表示/非表示を制御する場合
- プログラムからタブを動的に削除する場合
- 外部からの操作でタブを閉じる場合
- 再編成可能なタブバーでフリッカーを防止する場合

**主要な処理内容**：
1. タブバーコンテキストの確認
2. タブIDの計算
3. タブアイテムの検索
4. WantCloseフラグの設定

**関連システム・外部連携**：
- BeginTabBar/EndTabBarとの連携
- BeginTabItemとの連携（p_openパラメータ）
- タブバーのレイアウト処理

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 21 | Documents | 補助機能 | タブの閉じる通知 |

## 機能種別

UI状態通知処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| tab_or_docked_window_label | const char* | Yes | 閉じるタブのラベル（またはドッキングウィンドウ名） | 有効な文字列 |

### 入力データソース

- 現在のタブバーコンテキスト（g.CurrentTabBar）
- タブのラベルからIDを計算

## 出力仕様

### 出力データ

なし（void関数）

### 出力先

- タブアイテムのWantCloseフラグ

## 処理フロー

### 処理シーケンス

```
1. タブバーコンテキストの確認
   └─ 手動タブバー内かどうかを判定
2. タブIDの計算
   └─ ラベルからハッシュ値を生成
3. タブアイテムの検索
   └─ IDでタブを検索
4. WantCloseフラグの設定
   └─ タブが見つかった場合はtab->WantClose = true
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{手動タブバー内?}
    B -->|No| C[終了]
    B -->|Yes| D[タブIDを計算]
    D --> E[タブを検索]
    E --> F{タブが見つかった?}
    F -->|No| C
    F -->|Yes| G[WantClose = true]
    G --> C
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-188-01 | 呼び出しタイミング | BeginTabBar()の後、タブの送信前に呼び出す | タブバー内 |
| BR-188-02 | 手動タブバー限定 | DockNodeタブバーでは効果なし | 手動タブバー |
| BR-188-03 | フリッカー防止 | Reorderableフラグ使用時に効果がある | Reorderable時 |
| BR-188-04 | 閉じるボタン連携 | 閉じるボタンでの閉じは自動処理される | 閉じるボタン使用時 |

### 計算ロジック

特になし

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

該当なし（ImGuiはUIライブラリであり、データベース操作は行わない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | 無視 | タブが見つからない | 何もしない |
| N/A | 無視 | タブバーコンテキスト外 | 何もしない |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- タブの検索は効率的に行われること

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

該当なし

## 備考

- この関数は100%オプションで、フリッカーを削減するためのみに使用される
- 閉じるボタンで閉じられたタブは自動的にフラグが設定されるため、この関数を呼び出す必要はない
- 主にImGuiTabBarFlags_Reorderableを使用している場合に効果がある
- WantCloseフラグはTabBarLayout()で処理される

---

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

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

### 推奨読解順序

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

まず、タブの閉じる処理に関連するデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiTabItem構造体のWantCloseフィールド（2807行目） |

**読解のコツ**: WantCloseフラグはSetTabItemClosedで設定され、TabBarLayout()で処理される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui_widgets.cpp | `imgui_widgets.cpp` | SetTabItemClosed関数（10659-10670行目） |

**主要処理フロー**:
1. **10661-10662行目**: 手動タブバー内かどうかの判定
2. **10665-10666行目**: タブIDの計算
3. **10667-10668行目**: タブの検索とWantCloseの設定

#### Step 3: WantCloseフラグの処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_widgets.cpp | `imgui_widgets.cpp` | TabBarLayout内でのWantClose処理 |

**主要処理フロー**:
- WantCloseがtrueのタブはレイアウト計算から除外される
- 次のフレームでタブが削除される

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

```
ImGui::SetTabItemClosed(label)
    │
    ├─ (判定: 手動タブバー内か)
    │
    ├─ TabBarCalcTabID(tab_bar, label, NULL)
    │      └─ ラベルからIDを計算
    │
    └─ TabBarFindTabByID(tab_bar, tab_id)
           └─ tab->WantClose = true
```

### データフロー図

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

label ──────────▶ SetTabItemClosed() ──▶ tab->WantClose = true
                         │
                         ├─ ID計算
                         └─ タブ検索
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | API宣言 |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | SetTabItemClosed実装 |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダー | WantCloseフィールド定義 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | 使用例（NotifyOfDocumentsClosedElsewhere） |
