ButtonPanel


概要 - Abstract

このライブラリ gui.ButtonPanel は、GUI部品として、ボタンが並ぶパネル ―― ボタンパネル ―― を提供します。

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

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

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


目次 - Index

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

構造体 - Structs

文法的定義
- Signature
struct ButtonPanel
構造体名
- Name
ButtonPanel
役割
- Role
ボタンパネルの構造体です。

変数 - Variables

- なし - None -


関数 - Functions

文法的定義
- Signature
ButtonPanel newButtonPanel(int x, int y, int width, int height, string labelText[ ])
関数名
- Name
newButtonPanel
役割
- Role
ボタンパネルを生成します。
引数
- Arguments
(int型) x : パネルのX座標
(int型) y : パネルのY座標
(int型) width : パネルの幅
(int型) height : パネルの高さ
(string[]型) labelText : ラベル文字列を格納する配列
buttonWidth : ボタンの幅
buttonText : ボタンの文字列を格納する配列
戻り値
- Return
(ButtonPanel型) 生成したボタンパネル構造体
文法的定義
- Signature
void deleteComponent(ButtonPanel &panelInstance)
関数名
- Name
deleteComponent
役割
- Role
ボタンパネルを破棄します。
引数
- Arguments
(ButtonPanel型) panelInstance : 破棄するボタンパネル
戻り値
- Return
(void型)
文法的定義
- Signature
void paintComponent(ButtonPanel &panelInstance)
関数名
- Name
paintComponent
役割
- Role
ボタンパネルを再描画します。
引数
- Arguments
(ButtonPanel型) panelInstance : 再描画するボタンパネル
戻り値
- Return
(void型)
文法的定義
- Signature
void mountComponent(ButtonPanel &panelInstance, int componentID)
関数名
- Name
mountComponent
役割
- Role
ボタンパネルを、別のGUIコンポーネント上に配置します。
引数
- Arguments
(ButtonPanel型) panelInstance : 配置するボタンパネル
(int型) componentID : 配置先GUIコンポーネントID
戻り値
- Return
(void型)
文法的定義
- Signature
void demountComponent(ButtonPanel &panelInstance, int componentID)
関数名
- Name
demountComponent
役割
- Role
ボタンパネルを、別のGUIコンポーネントから配置解除します。
引数
- Arguments
(ButtonPanel型) panelInstance : 配置解除するボタンパネル
(int型) componentID : 配置先GUIコンポーネントID
戻り値
- Return
(void型)
文法的定義
- Signature
int getPanel(ButtonPanel &panelInstance)
関数名
- Name
getPanel
役割
- Role
パネルのコンポーネントIDを返します。
引数
- Arguments
(ButtonPanel型) panelInstance : 取得対象のボタンパネル
戻り値
- Return
(int型) パネルのGUIコンポーネントID
文法的定義
- Signature
int getButton(ButtonPanel &panelInstance, string labelText)
関数名
- Name
getButton
役割
- Role
指定されたラベルに対応するボタンを取得します。
引数
- Arguments
(ButtonPanel型) panelInstance : 対象のボタンパネル
(string型) labelText : 取得対象のボタンに対応するラベル文字列
戻り値
- Return
(int型) ボタンのGUIコンポーネントID
文法的定義
- Signature
int getButton(ButtonPanel &panelInstance, int index)
関数名
- Name
getButton
役割
- Role
指定されたインデックスのボタンを取得します。
引数
- Arguments
(ButtonPanel型) panelInstance : 対象のボタンパネル
(int型) index : ボタンのインデックス
戻り値
- Return
(int型) ボタンのGUIコンポーネントID
文法的定義
- Signature
int[ ] getComponentSize(ButtonPanel &panelInstance)
関数名
- Name
getComponentSize
役割
- Role
パネルのサイズを返します。
引数
- Arguments
(ButtonPanel型) panelInstance : 対象のボタンパネル
戻り値
- Return
(int[]型) パネルのサイズを格納する配列
文法的定義
- Signature
void setComponentSize(ButtonPanel &panelInstance, int width, int height)
関数名
- Name
setComponentSize
役割
- Role
パネルのサイズを設定します。
引数
- Arguments
(ButtonPanel型) panelInstance : 対象のボタンパネル
(int型) width : パネルの幅
(int型) height : パネルの高さ
戻り値
- Return
(void型)
文法的定義
- Signature
void setComponentSize(ButtonPanel &panelInstance)
関数名
- Name
setComponentSize
役割
- Role
パネルの現在のサイズに合わせて、内部コンポーネントのサイズを自動設定します。パネルのサイズを外部から変更した際に使用します。
引数
- Arguments
(ButtonPanel型) panelInstance : 対象のボタンパネル
戻り値
- Return
(void型)
文法的定義
- Signature
int[ ] getComponentLocation(ButtonPanel &panelInstance)
関数名
- Name
getComponentLocation
役割
- Role
パネルの位置を返します。
引数
- Arguments
(ButtonPanel型) panelInstance : 対象のボタンパネル
戻り値
- Return
(int[]型) パネルの位置を格納する配列
文法的定義
- Signature
void setComponentLocation(ButtonPanel &panelInstance, int x, int y)
関数名
- Name
setComponentLocation
役割
- Role
パネルの位置を設定します。
引数
- Arguments
(ButtonPanel型) panelInstance : 対象のボタンパネル
(int型) x : ウィンドウのX座標
(int型) y : ウィンドウのY座標
戻り値
- Return
(void型)