# ImageLabelWindow

## 概要 - Abstract

このライブラリ gui.ImageLabelWindow は、GUI部品として、画像ラベルを表示するウィンドウ ―― 画像ラベルウィンドウ ―― を提供します。
即席の描画ウィンドウや、画像ファイルの内容を表示するウィンドウなどとして使用できます。

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

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

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

## 目次 - Index

struct ImageLabelWindow
  画像ラベルウィンドウの構造体です。
ImageLabelWindow newImageLabelWindow(int x, int y, int width, int height, string title, int graphics)
  画像ラベルウィンドウを生成します。
ImageLabelWindow newImageLabelWindow(int graphics)
  自動でウィンドウサイズを決定し、画像ラベルウィンドウを生成します。
void deleteComponent(ImageLabelWindow &windowInstance)
  画像ラベルウィンドウを破棄します。
int getWindow(ImageLabelWindow &windowInstance)
  ウィンドウのGUIコンポーネントIDを返します。
int getImageLabel(ImageLabelWindow &windowInstance)
  画像ラベルのGUIコンポーネントIDを返します。
void setComponentSize(ImageLabelWindow &windowInstance, int width, int height)
  ウィンドウサイズを設定します。
void setComponentSize(ImageLabelWindow &windowInstance)
  ウィンドウの現在のサイズに合わせて、内部コンポーネントのレイアウトを自動設定します。ウインドウのサイズを外部から変更した際に使用します。
int[ ] getComponentSize(ImageLabelWindow &windowInstance)
  ウィンドウのサイズを返します。
void fitComponentSize(ImageLabelWindow &windowInstance)
  グラフィックスリソースにちょうど適切なウィンドウサイズを設定します。
void setComponentLocation(ImageLabelWindow &windowInstance, int x, int y)
  ウィンドウの位置を設定します。
int[ ] getComponentLocation(ImageLabelWindow &windowInstance)
  ウィンドウの位置を返します。
void paintComponent(ImageLabelWindow &windowInstance)
  ウィンドウを再描画します。
void hideComponent(ImageLabelWindow &windowInstance)
  ウィンドウを不可視化します。
void showComponent(ImageLabelWindow &windowInstance)
  ウィンドウを可視化します。

## 構造体 - Structs

文法的定義 - Signature | struct ImageLabelWindow
構造体名 - Name | ImageLabelWindow
役割 - Role | 画像ラベルウィンドウの構造体です。

## 変数 - Variables

- なし - None -

## 関数 - Functions

文法的定義 - Signature | ImageLabelWindow newImageLabelWindow(int x, int y, int width, int height, string title, int graphics)
関数名 - Name | newImageLabelWindow
役割 - Role | 画像ラベルウィンドウを生成します。
引数 - Arguments | (int型) x : ウィンドウ左上頂点のX座標 (int型) y : ウィンドウ左上頂点のY座標 (int型) width : ウィンドウの幅 (int型) height : ウィンドウの高さ (string型) title : ウィンドウのタイトル (int型) graphics : グラフィックスリソース
戻り値 - Return | (ImageLabelWindow型) 生成したウィンドウ構造体

文法的定義 - Signature | ImageLabelWindow newImageLabelWindow(int graphics)
関数名 - Name | newImageLabelWindow
役割 - Role | 自動でウィンドウサイズを決定し、画像ラベルウィンドウを生成します。
引数 - Arguments | (int型) graphics : グラフィックスリソース
戻り値 - Return | (ImageLabelWindow型) 生成したウィンドウ構造体

文法的定義 - Signature | void deleteComponent(ImageLabelWindow &windowInstance)
関数名 - Name | deleteComponent
役割 - Role | 画像ラベルウィンドウを破棄します。
引数 - Arguments | (ImageLabelWindow型) windowInstance : 破棄するウィンドウ
戻り値 - Return | (void型)

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

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

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

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

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

文法的定義 - Signature | void fitComponentSize(ImageLabelWindow &windowInstance)
関数名 - Name | fitComponentSize
役割 - Role | グラフィックスリソースにちょうど適切なウィンドウサイズを設定します。
引数 - Arguments | (ImageLabelWindow型) windowInstance : 設定対象のウィンドウ
戻り値 - Return | (void型)

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

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

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

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

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