# CheckBoxPanel

## 概要 - Abstract

このライブラリ gui.CheckBoxPanel は、GUI部品として、チェックボックスが並ぶパネル ―― チェックボックスパネル ―― を提供します。

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

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

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

## 目次 - Index

struct CheckBoxPanel
  チェックボックスパネルの構造体です。
CheckBoxPanel newCheckBoxPanel(int x, int y, int width, int height, string labelText[ ], bool defaultValue[ ])
  チェックボックスパネルを生成します。
void deleteComponent(CheckBoxPanel &panelInstance)
  チェックボックスパネルを破棄します。
void paintComponent(CheckBoxPanel &panelInstance)
  チェックボックスパネルを再描画します。
void mountComponent(CheckBoxPanel &panelInstance, int componentID)
  チェックボックスパネルを、別のGUIコンポーネント上に配置します。
void demountComponent(CheckBoxPanel &panelInstance, int componentID)
  チェックボックスパネルを、別のGUIコンポーネントから配置解除します。
int getPanel(CheckBoxPanel &panelInstance)
  パネルのコンポーネントIDを返します。
int getCheckBox(CheckBoxPanel &panelInstance, string labelText)
  指定されたラベルに対応するチェックボックスを取得します。
int getCheckBox(CheckBoxPanel &panelInstance, int index)
  指定されたインデックスのチェックボックスを取得します。
int[ ] getComponentSize(CheckBoxPanel &panelInstance)
  パネルのサイズを返します。
void setComponentSize(CheckBoxPanel &panelInstance, int width, int height)
  パネルのサイズを設定します。
void setComponentSize(CheckBoxPanel &panelInstance)
  パネルの現在のサイズに合わせて、内部コンポーネントのサイズを自動設定します。パネルのサイズを外部から変更した際に使用します。
int[ ] getComponentLocation(CheckBoxPanel &panelInstance)
  パネルの位置を返します。
void setComponentLocation(CheckBoxPanel &panelInstance, int x, int y)
  パネルの位置を設定します。

## 構造体 - Structs

文法的定義 - Signature | struct CheckBoxPanel
構造体名 - Name | CheckBoxPanel
役割 - Role | チェックボックスパネルの構造体です。

## 変数 - Variables

- なし - None -

## 関数 - Functions

文法的定義 - Signature | CheckBoxPanel newCheckBoxPanel(int x, int y, int width, int height, string labelText[ ], bool defaultValue[ ])
関数名 - Name | newCheckBoxPanel
役割 - Role | チェックボックスパネルを生成します。
引数 - Arguments | (int型) x : パネルのX座標 (int型) y : パネルのY座標 (int型) width : パネルの幅 (int型) height : パネルの高さ (string[]型) labelText : ラベル文字列を格納する配列 defaultText : チェックボックスの初期値文字列を格納する配列
戻り値 - Return | (CheckBoxPanel型) 生成したチェックボックスパネル構造体

文法的定義 - Signature | void deleteComponent(CheckBoxPanel &panelInstance)
関数名 - Name | deleteComponent
役割 - Role | チェックボックスパネルを破棄します。
引数 - Arguments | (CheckBoxPanel型) panelInstance : 破棄するチェックボックスパネル
戻り値 - Return | (void型)

文法的定義 - Signature | void paintComponent(CheckBoxPanel &panelInstance)
関数名 - Name | paintComponent
役割 - Role | チェックボックスパネルを再描画します。
引数 - Arguments | (CheckBoxPanel型) panelInstance : 再描画するチェックボックスパネル
戻り値 - Return | (void型)

文法的定義 - Signature | void mountComponent(CheckBoxPanel &panelInstance, int componentID)
関数名 - Name | mountComponent
役割 - Role | チェックボックスパネルを、別のGUIコンポーネント上に配置します。
引数 - Arguments | (CheckBoxPanel型) panelInstance : 配置するチェックボックスパネル (int型) componentID : 配置先GUIコンポーネントID
戻り値 - Return | (void型)

文法的定義 - Signature | void demountComponent(CheckBoxPanel &panelInstance, int componentID)
関数名 - Name | demountComponent
役割 - Role | チェックボックスパネルを、別のGUIコンポーネントから配置解除します。
引数 - Arguments | (CheckBoxPanel型) panelInstance : 配置解除するチェックボックスパネル (int型) componentID : 配置先GUIコンポーネントID
戻り値 - Return | (void型)

文法的定義 - Signature | int getPanel(CheckBoxPanel &panelInstance)
関数名 - Name | getPanel
役割 - Role | パネルのコンポーネントIDを返します。
引数 - Arguments | (CheckBoxPanel型) panelInstance : 取得対象のチェックボックスパネル
戻り値 - Return | (int型) パネルのGUIコンポーネントID

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

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

文法的定義 - Signature | int[ ] getComponentSize(CheckBoxPanel &panelInstance)
関数名 - Name | getComponentSize
役割 - Role | パネルのサイズを返します。
引数 - Arguments | (CheckBoxPanel型) panelInstance : 対象のチェックボックスパネル
戻り値 - Return | (int[]型) パネルのサイズを格納する配列

文法的定義 - Signature | void setComponentSize(CheckBoxPanel &panelInstance, int width, int height)
関数名 - Name | setComponentSize
役割 - Role | パネルのサイズを設定します。
引数 - Arguments | (CheckBoxPanel型) panelInstance : 対象のチェックボックスパネル (int型) width : パネルの幅 (int型) height : パネルの高さ
戻り値 - Return | (void型)

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

文法的定義 - Signature | int[ ] getComponentLocation(CheckBoxPanel &panelInstance)
関数名 - Name | getComponentLocation
役割 - Role | パネルの位置を返します。
引数 - Arguments | (CheckBoxPanel型) panelInstance : 対象のチェックボックスパネル
戻り値 - Return | (int[]型) パネルの位置を格納する配列

文法的定義 - Signature | void setComponentLocation(CheckBoxPanel &panelInstance, int x, int y)
関数名 - Name | setComponentLocation
役割 - Role | パネルの位置を設定します。
引数 - Arguments | (CheckBoxPanel型) panelInstance : 対象のチェックボックスパネル (int型) x : ウィンドウのX座標 (int型) y : ウィンドウのY座標
戻り値 - Return | (void型)