# TextFieldWindow

## 概要 - Abstract

このライブラリ gui.TextFieldWindow は、GUI部品として、テキストフィールドが並ぶウィンドウ ―― テキストフィールドウィンドウ ―― を提供します。

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

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

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

## 目次 - Index

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

## 構造体 - Structs

文法的定義 - Signature | struct TextFieldWindow
構造体名 - Name | TextFieldWindow
役割 - Role | テキストフィールドウィンドウの構造体です。

## 変数 - Variables

- なし - None -

## 関数 - Functions

文法的定義 - Signature | TextFieldWindow newTextFieldWindow(int x, int y, int width, int height, string title, string labelText[ ], string defaultValue[ ])
関数名 - Name | newTextFieldWindow
役割 - Role | 自動でウィンドウサイズを決定し、テキストフィールドウィンドウを生成します。
引数 - Arguments | (int型) x : ウィンドウ左上頂点のX座標 (int型) y : ウィンドウ左上頂点のY座標 (int型) width : ウィンドウの幅 (int型) height : ウィンドウの高さ (string型) title : ウィンドウのタイトル (string[]型) labelText : 全テキストフィールドのラベル文字列を格納する配列 (string[]型) defaultValue : 全テキストフィールドのデフォルト値を格納する配列
戻り値 - Return | (TextFieldWindow型) 生成したテキストフィールドウィンドウ

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

文法的定義 - Signature | void deleteComponent(TextFieldWindow &windowInstance)
関数名 - Name | deleteComponent
役割 - Role | テキストフィールドウィンドウを破棄します。
引数 - Arguments | (TextFieldWindow型) windowInstance : 破棄するウィンドウ
戻り値 - Return | (void型)

文法的定義 - Signature | void setTextLabelWidth(TextFieldWindow &windowInstance, int labelWidth)
関数名 - Name | setTextLabelWidth
役割 - Role | ラベル部分の幅を設定します。
引数 - Arguments | (TextFieldWindow型) windowInstance : 取得対象のテキストフィールドウィンドウ (int型) labelWidth : ラベル幅
戻り値 - Return | (void型)

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

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

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

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

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

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

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

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

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

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

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

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

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

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