# CheckBoxWindow

## 概要 - Abstract

このライブラリ gui.CheckBoxWindow は、GUI部品として、チェックボックスが並ぶウィンドウ ―― チェックボックスウィンドウ ―― を提供します。

VCSSLの標準ライブラリ「 GUI 」では、GUI部品をint型のIDで扱いますが、このモジュールで提供されるGUI部品は、CheckBoxWindow 構造体として扱います。

CheckBoxWindow 構造体は、内部にリソースのID等を保持していますが、
生成・破棄のための関数が提供されるため、その中身を特に意識する必要はありません（ むしろメンバへの直接的なアクセスは推奨されません ）。
具体的には、 newCheckBoxWindow 関数で生成し、 deleteComponent 関数で破棄します。

またこのモジュールでは、CheckBoxWindow 構造体を標準ライブラリ「 GUI 」と同様の感覚でそのまま扱えるように、標準GUIライブラリ関数のオーバーロードも提供されます。
例えば、 mountComponent 関数や、setComponentSize 関数、 setComponentLocation 関数などが提供されます。

## 目次 - Index

struct CheckBoxWindow
  チェックボックスウィンドウの構造体です。
CheckBoxWindow newCheckBoxWindow(int x, int y, int width, int height, string title, string labelText[ ], bool[ ] defaultValue)
  チェックボックスウィンドウを生成します。
CheckBoxWindow newCheckBoxWindow(string labelText[ ], bool[ ] defaultValue)
  自動でウィンドウサイズを決定し、チェックボックスウィンドウを生成します。
void deleteComponent(CheckBoxWindow &windowInstance)
  チェックボックスウィンドウを破棄します。
void setButton(CheckBoxWindow &windowInstance, string label)
  ウィンドウ下部に、決定ボタンを出現させます。
int getButton(CheckBoxWindow &windowInstance)
  決定ボタンのコンポーネントIDを取得します。
int getWindow(CheckBoxWindow &windowInstance)
  ウィンドウのGUIコンポーネントIDを取得します。
int getCheckBox(CheckBoxWindow &windowInstance, string labelText)
  指定されたラベルに対応するチェックボックスを取得します。
int getCheckBox(CheckBoxWindow &windowInstance, int index)
  指定されたインデックスのチェックボックスを取得します。
int[ ] getComponentSize(CheckBoxWindow &windowInstance)
  ウィンドウのサイズを返します。
void setComponentSize(CheckBoxWindow &windowInstance, int width, int height)
  ウィンドウのサイズを設定します。
void setComponentSize(CheckBoxWindow &windowInstance)
  ウィンドウの現在のサイズに合わせて、内部コンポーネントのサイズを自動設定します。ウィンドウのサイズを外部から変更した際に使用します。
int[ ] getComponentLocation(CheckBoxWindow &windowInstance)
  ウィンドウの位置を返します。
void setComponentLocation(CheckBoxWindow &windowInstance, int x, int y)
  ウィンドウの位置を設定します。
void paintComponent(CheckBoxWindow &windowInstance)
  ウィンドウを再描画します。
void hideComponent(CheckBoxWindow &windowInstance)
  ウィンドウを不可視化します。
void showComponent(CheckBoxWindow &windowInstance)
  ウィンドウを可視化します。

## 構造体 - Structs

文法的定義 - Signature | struct CheckBoxWindow
構造体名 - Name | CheckBoxWindow
役割 - Role | チェックボックスウィンドウの構造体です。

## 変数 - Variables

- なし - None -

## 関数 - Functions

文法的定義 - Signature | CheckBoxWindow newCheckBoxWindow(int x, int y, int width, int height, string title, string labelText[ ], bool[ ] defaultValue)
関数名 - Name | newCheckBoxWindow
役割 - Role | チェックボックスウィンドウを生成します。
引数 - Arguments | (int型) x : ウィンドウ左上頂点のX座標 (int型) y : ウィンドウ左上頂点のY座標 (int型) width : ウィンドウの幅 (int型) height : ウィンドウの高さ (string型) title : ウィンドウのタイトル (string[]型) labelText : 全チェックボックスのラベル文字列を格納する配列 defaultText : 全チェックボックスのデフォルト値を格納する配列
戻り値 - Return | (CheckBoxWindow型) 生成したチェックボックスウィンドウ

文法的定義 - Signature | CheckBoxWindow newCheckBoxWindow(string labelText[ ], bool[ ] defaultValue)
関数名 - Name | newCheckBoxWindow
役割 - Role | 自動でウィンドウサイズを決定し、チェックボックスウィンドウを生成します。
引数 - Arguments | (string[]型) labelText : 全チェックボックスのラベル文字列を格納する配列 defaultText : 全チェックボックスのデフォルト値を格納する配列
戻り値 - Return | (CheckBoxWindow型) 生成したチェックボックスウィンドウ

文法的定義 - Signature | void deleteComponent(CheckBoxWindow &windowInstance)
関数名 - Name | deleteComponent
役割 - Role | チェックボックスウィンドウを破棄します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 破棄するウィンドウ
戻り値 - Return | (void型)

文法的定義 - Signature | void setButton(CheckBoxWindow &windowInstance, string label)
関数名 - Name | setButton
役割 - Role | ウィンドウ下部に、決定ボタンを出現させます。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ 決定ボタンのラベル文字列 :
戻り値 - Return | (void型)

文法的定義 - Signature | int getButton(CheckBoxWindow &windowInstance)
関数名 - Name | getButton
役割 - Role | 決定ボタンのコンポーネントIDを取得します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ
戻り値 - Return | (int型) 決定ボタンのコンポーネントID

文法的定義 - Signature | int getWindow(CheckBoxWindow &windowInstance)
関数名 - Name | getWindow
役割 - Role | ウィンドウのGUIコンポーネントIDを取得します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ
戻り値 - Return | (int型) ウィンドウのGUIコンポーネントID

文法的定義 - Signature | int getCheckBox(CheckBoxWindow &windowInstance, string labelText)
関数名 - Name | getCheckBox
役割 - Role | 指定されたラベルに対応するチェックボックスを取得します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ (string型) labelText : 取得対象のチェックボックスに対応するラベル文字列
戻り値 - Return | (int型) チェックボックスのGUIコンポーネントID

文法的定義 - Signature | int getCheckBox(CheckBoxWindow &windowInstance, int index)
関数名 - Name | getCheckBox
役割 - Role | 指定されたインデックスのチェックボックスを取得します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ (int型) index : チェックボックスのインデックス
戻り値 - Return | (int型) チェックボックスのGUIコンポーネントID

文法的定義 - Signature | int[ ] getComponentSize(CheckBoxWindow &windowInstance)
関数名 - Name | getComponentSize
役割 - Role | ウィンドウのサイズを返します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ
戻り値 - Return | (int[]型) ウィンドウのサイズを格納する配列

文法的定義 - Signature | void setComponentSize(CheckBoxWindow &windowInstance, int width, int height)
関数名 - Name | setComponentSize
役割 - Role | ウィンドウのサイズを設定します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ (int型) width : 幅 (int型) width : 高さ
戻り値 - Return | (void型) ウィンドウのサイズを格納する配列

文法的定義 - Signature | void setComponentSize(CheckBoxWindow &windowInstance)
関数名 - Name | setComponentSize
役割 - Role | ウィンドウの現在のサイズに合わせて、内部コンポーネントのサイズを自動設定します。ウィンドウのサイズを外部から変更した際に使用します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ
戻り値 - Return | (void型)

文法的定義 - Signature | int[ ] getComponentLocation(CheckBoxWindow &windowInstance)
関数名 - Name | getComponentLocation
役割 - Role | ウィンドウの位置を返します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ
戻り値 - Return | (int[]型) ウィンドウの位置を格納する配列

文法的定義 - Signature | void setComponentLocation(CheckBoxWindow &windowInstance, int x, int y)
関数名 - Name | setComponentLocation
役割 - Role | ウィンドウの位置を設定します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ (int型) x : ウィンドウのX座標 (int型) y : ウィンドウのY座標
戻り値 - Return | (void型)

文法的定義 - Signature | void paintComponent(CheckBoxWindow &windowInstance)
関数名 - Name | paintComponent
役割 - Role | ウィンドウを再描画します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ
戻り値 - Return | (void型)

文法的定義 - Signature | void hideComponent(CheckBoxWindow &windowInstance)
関数名 - Name | hideComponent
役割 - Role | ウィンドウを不可視化します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ
戻り値 - Return | (void型)

文法的定義 - Signature | void showComponent(CheckBoxWindow &windowInstance)
関数名 - Name | showComponent
役割 - Role | ウィンドウを可視化します。
引数 - Arguments | (CheckBoxWindow型) windowInstance : 対象のウィンドウ
戻り値 - Return | (void型)