# 通知設計書 31-SetTabItemClosed

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるSetTabItemClosed関数による「タブクローズ事前通知」機能の設計を定義する。この通知機能は、タブバーまたはドッキングシステムに対して、タブやウィンドウが閉じられることを事前に伝達し、視覚的なちらつきを防止するためのものである。

### 本通知の処理概要

SetTabItemClosed関数は、タブバーやドッキングシステムに対してタブまたはドッキングウィンドウが閉じられたことを事前に通知する機能を提供する。この通知により、1フレームのギャップやちらつきを回避できる。

**業務上の目的・背景**：タブバーの再順序可能（reorderable）機能を使用している場合、タブが外部で閉じられると（例：キーボードショートカット、メニュー操作など）、ImGuiがそのタブの消失を認識するのが1フレーム遅れる。この遅延により、タブバーに一瞬の空白が表示されたり、選択中のタブが消えた際に「選択タブなし」状態が1フレーム発生するなど、視覚的なちらつき（flicker）が生じる。SetTabItemClosedは、このちらつきを未然に防ぐために、外部クローズを即座にシステムに伝達する。

**通知の送信タイミング**：アプリケーションコードがタブの状態変更（open状態からclosed状態への変更）を検知した直後、かつ次フレームでBeginTabItem()が呼ばれなくなる前に呼び出す。タブバー使用時はBeginTabBar()とEndTabBar()の間で呼び出す必要がある。

**通知の受信者**：ImGuiのタブバーシステム（ImGuiTabBar構造体）が受信者となる。具体的には、TabBarLayout()関数が次回の呼び出し時にWantCloseフラグを処理する。

**通知内容の概要**：閉じられるタブのラベル（文字列）を通知する。このラベルからタブIDが計算され、該当タブのWantCloseフラグがtrueに設定される。

**期待されるアクション**：タブバーシステムは、WantCloseフラグを持つタブを次のレイアウト処理で適切に除外し、スムーズなUI遷移を実現する。これにより、タブが消えた瞬間の空白や選択タブなし状態が回避される。

## 通知種別

アプリ内通知（ImGui内部システム通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高 |
| リトライ | 無 |

### 送信先決定ロジック

現在アクティブなタブバー（g.CurrentTabBar）が存在し、かつドッキングノードでない（ImGuiTabBarFlags_DockNodeが設定されていない）場合に、そのタブバー内の該当タブに通知される。

## 通知テンプレート

### API仕様

| 項目 | 内容 |
|-----|------|
| 関数名 | SetTabItemClosed |
| パラメータ | const char* tab_or_docked_window_label |
| 戻り値 | void |

### 使用例

```cpp
// タブが外部で閉じられたことを検知
if (!doc.Open && doc.OpenPrev)
    ImGui::SetTabItemClosed(doc.Name);
doc.OpenPrev = doc.Open;
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| tab_or_docked_window_label | タブまたはドッキングウィンドウのラベル | アプリケーション管理 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | タブの外部クローズ | タブがImGui外で閉じられた | キーボードショートカット等による外部クローズ |
| API呼び出し | アプリケーションコード | 開状態から閉状態への変更検知 | 前フレームでopenだったが今フレームでcloseになった |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| タブバー外での呼び出し | BeginTabBar()とEndTabBar()の間でない場合は効果なし |
| ドッキングノードタブバー | ImGuiTabBarFlags_DockNodeが設定されている場合は手動タブバーとして処理されない |
| 該当タブが見つからない | 指定されたラベルに対応するタブが存在しない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[アプリがタブクローズを検知] --> B{タブバー内か?}
    B -->|No| C[処理終了]
    B -->|Yes| D{ドッキングノードか?}
    D -->|Yes| C
    D -->|No| E[タブIDを計算]
    E --> F{タブが存在するか?}
    F -->|No| C
    F -->|Yes| G[tab->WantClose = true]
    G --> H[次フレームでTabBarLayout処理]
    H --> I[タブがスムーズに除外される]
    I --> C
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ImGuiTabBar | タブバー状態管理 | g.CurrentTabBarから取得 |
| ImGuiTabItem | 個別タブ情報 | TabBarFindTabByIDで検索 |

### テーブル別参照項目詳細

#### ImGuiTabBar

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| Flags | ドッキングノードフラグ確認 | ImGuiTabBarFlags_DockNode |
| Tabs | タブ一覧 | 検索対象 |

#### ImGuiTabItem

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| ID | タブ識別子 | ラベルから計算されたIDと照合 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ImGuiTabItem | UPDATE | WantCloseフラグを設定 |

#### ImGuiTabItem更新

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | WantClose | true | TabBarLayout()で処理される |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| タブ不在 | 指定ラベルのタブが存在しない | 処理をスキップ（エラーは発生しない） |
| タブバー外呼び出し | CurrentTabBarがNULL | 処理をスキップ（エラーは発生しない） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | なし |
| リトライ対象エラー | なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（フレーム内で即時処理）

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

内部API呼び出しのため、セキュリティ考慮事項はなし。

## 備考

- この関数は100%オプショナルであり、呼び出さなくてもタブは正常にクローズされる
- 閉じるボタンで閉じられたタブは自動的にフラグ設定されるため、この関数を呼ぶ必要はない
- ImGuiTabBarFlags_Reorderableフラグを使用していないタブバーでは効果が限定的
- ドッキングブランチではドッキングウィンドウにも適用可能

---

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

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

### 推奨読解順序

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

まず、タブバーとタブアイテムのデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiTabBarとImGuiTabItem構造体の定義。WantCloseフラグの役割を理解する |

**読解のコツ**: ImGuiTabItemにはWantCloseというboolフィールドがあり、これがtrueになるとTabBarLayout()で削除対象として処理される。

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

処理の起点となる関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | 955行目：SetTabItemClosed関数の宣言とコメント |
| 2-2 | imgui_widgets.cpp | `imgui_widgets.cpp` | 10659-10670行目：SetTabItemClosed関数の実装 |

**主要処理フロー**:
1. **10661行目**: ImGuiContextの取得
2. **10662行目**: 手動タブバー内かどうかの判定（ドッキングノードでないことを確認）
3. **10666行目**: ラベルからタブIDを計算（TabBarCalcTabID）
4. **10667行目**: タブIDでタブを検索（TabBarFindTabByID）
5. **10668行目**: タブが見つかった場合、WantCloseフラグをtrueに設定

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_demo.cpp | `imgui_demo.cpp` | 10323-10333行目：NotifyOfDocumentsClosedElsewhere関数での使用例 |

**主要処理フロー**:
- **10329行目**: タブが今フレームでclosedになったことを検知
- **10330行目**: SetTabItemClosedを呼び出してタブバーに通知

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

```
ImGui::SetTabItemClosed(label)
    |
    +-- g.CurrentTabBar チェック
    |
    +-- ImGuiTabBarFlags_DockNode チェック
    |
    +-- TabBarCalcTabID(tab_bar, label, NULL)
    |       |
    |       +-- タブIDを計算
    |
    +-- TabBarFindTabByID(tab_bar, tab_id)
    |       |
    |       +-- タブを検索
    |
    +-- tab->WantClose = true
            |
            (次フレームのTabBarLayout()で処理)
```

### データフロー図

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

タブラベル ---------> SetTabItemClosed -------> WantCloseフラグ
  (const char*)       |                         (bool = true)
                      |
                      +-- タブID計算
                      +-- タブ検索
                      +-- フラグ設定
                                                    |
                                                    v
                                            TabBarLayout()
                                                    |
                                                    v
                                            ちらつきなしクローズ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | SetTabItemClosed関数宣言（955行目） |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | SetTabItemClosed関数実装（10659-10670行目） |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiTabBar/ImGuiTabItem構造体定義 |
| imgui_demo.cpp | `imgui_demo.cpp` | サンプル | 使用例（10323-10333行目） |
