クラス SGFrameObject

フレームウィジェットを提供するクラス [詳細]

#include <sgobject.h>

SGFrameObjectに対する継承グラフ

Public メソッド
	SGFrameObject (SGDialog dlg, SGObject parent, int id)
	コンストラクタ
virtual	~SGFrameObject ()
	デストラクタ
virtual void	Draw (SGSurface *surface, SGRect region, int offx=0, int offy=0)
virtual void	SetText (SGString text)
virtual SGString *	GetText ()
virtual void	SetFontId (int fontid)
virtual void	SetMarginX (int margin)
virtual void	SetMarginY (int margin)
virtual void	SetAlign (int align)
virtual void	SetColor (unsigned int col)
virtual void	SetColorEffect (unsigned int col)
virtual void	SetLinespace (int space)
virtual int	GetFontId ()
virtual int	GetMarginX ()
virtual int	GetMarginY ()
virtual int	GetAlign ()
virtual unsigned int	GetColor ()
virtual unsigned int	GetColorEffect ()
virtual int	GetLinespace ()
SGTextAttribute &	GetTextAttr ()
	テキストの属性を保持している SGTextAttribute クラスを取得する
void	SetImage (SGImage *image)
	オブジェクトにイメージを登録する

説明

フレームウィジェットを提供するクラス

コンストラクタとデストラクタ

SGFrameObject	(	SGDialog *	dlg,
		SGObject *	parent,
		int	id
	)

コンストラクタ

引数:

	dlg	このオブジェクトを持っているダイアログ
	parent	このオブジェクトを管理する親オブジェクト
	id	オブジェクトのリソースID

~SGFrameObject ( ) [virtual]

デストラクタ

関数

void Draw	(	SGSurface *	surface,
		SGRect	region,
		int	offx = `0`,
		int	offy = `0`
	)			`[virtual]`

オブジェクトを描画する更新範囲内に含まれるオブジェクトの描画を行います。

引数:

	surface	表示するサーフェース
	region	更新範囲
	offx	オフセットX
	offy	オフセットY

SGObjectを再定義しています。

void SetText ( SGString text ) [virtual]

文字列を設定する文字列を設定します。

引数:

text

文字列

SGObjectを再定義しています。

SGString * GetText ( ) [virtual]

文字列を取得する文字列を取得します。

戻り値:: 文字列

SGObjectを再定義しています。

void SetFontId ( int fontid ) [virtual]

使用するフォントを設定するこのオブジェクトが使用するフォントを設定します。
オブジェクトがフォントを持たない場合、処理は無視されます。

引数:

fontid

フォントのリソースID

SGObjectを再定義しています。

void SetMarginX ( int margin ) [virtual]

文字列を配置する時の横方向のマージンを設定する文字列を配置する時の横方向のマージンを設定します。
オブジェクトが文字列を持たない場合、処理は無視されます。

引数:

margin

マージン幅

SGObjectを再定義しています。

void SetMarginY ( int margin ) [virtual]

文字列を配置する時の縦方向のマージンを設定する文字列を配置する時の縦方向のマージンを設定します。
オブジェクトが文字列を持たない場合、処理は無視されます。

引数:

margin

マージン幅

SGObjectを再定義しています。

void SetAlign ( int align ) [virtual]

文字列の配置情報を設定する文字列の配置情報を設定します。
オブジェクトが文字列を持たない場合、処理は無視されます。
文字列の配置情報は SGDialog::SetAlign() を使用すると便利です。

引数:

align

配置
左右方向の寄せ

SG_ALIGN_CENTER  中央
SG_ALIGN_LEFT    左寄せ
SG_ALIGN_RIGHT   右寄せ

上下方向の寄せ

SG_ALIGN_MIDDLE  中央
SG_ALIGN_TOP     上寄せ
SG_ALIGN_BOTTOM  下寄せ

属性

SG_ALIGN_XSTRETCH 横方向が枠に収まらない時は幅を縮小して全部を表示します。
SG_ALIGN_YSTRETCH 縦方向が枠に収まらない時は高さを縮小して全部を表示します。
SG_ALIGN_STRETCH  横方向または縦方向が枠に収まらない時は縮小して全部を表示します。
SG_ALIGN_COMMA    ３桁毎にカンマを追加し、通貨表示にします（1,234,567）
SG_ALIGN_NOCLIP   枠からはみ出す場合でもクリップしないでそのまま表示します。

左右方向の寄せと上下方向の寄せをそれぞれ指定できます。
属性は複数指定可能です。
寄せや属性など複数指定の場合は｜(or)で組み合わせて指定します。

参照:: SGDialog::SetAlign(int objid,int align)

SGObjectを再定義しています。

void SetColor ( unsigned int col ) [virtual]

文字列表示色を設定する文字列を表示する色を設定します。
オブジェクトが文字列を持たない場合、処理は無視されます。

引数:

col

文字色

SGObjectを再定義しています。

void SetColorEffect ( unsigned int col ) [virtual]

効果色を設定する文字列を表示する際の効果色を設定します。
オブジェクトが文字列を持たない場合、処理は無視されます。

引数:

col

文字色

SGObjectを再定義しています。

void SetLinespace ( int space ) [virtual]

複数行文字列を表示する時の改行幅を設定する複数行文字列を表示する時の改行幅を設定します。オブジェクトが文字列を持たない場合、処理は無視されます。

引数:

space

改行幅

SGObjectを再定義しています。

int GetFontId ( ) [virtual]

使用しているフォントを取得するこのオブジェクトが使用しているフォントのリソースIDを取得します。
オブジェクトがフォントを持っていない場合は０（ゼロ）が返ります。

戻り値:: フォントのリソースIDを返す。

SGObjectを再定義しています。

int GetMarginX ( ) [virtual]

文字列を配置する時の横方向のマージンを取得する文字列を配置する時の横方向のマージンを取得します。
オブジェクトが文字列を持たない場合、処理は無視されます。

戻り値:: マージン幅

SGObjectを再定義しています。

int GetMarginY ( ) [virtual]

文字列を配置する時の縦方向のマージンを取得する文字列を配置する時の縦方向のマージンを取得します。
オブジェクトが文字列を持たない場合、処理は無視されます。

戻り値:: マージン幅

SGObjectを再定義しています。

int GetAlign ( ) [virtual]

文字列の配置情報を取得する文字列の配置情報を取得します。
オブジェクトが文字列を持たない場合、０ゼロが返ります。文字列の配置情報の取得は SGDialog::GetAlign() を使用すると便利です。

戻り値:

配置
左右方向の寄せ

SG_ALIGN_CENTER  中央
SG_ALIGN_LEFT    左寄せ
SG_ALIGN_RIGHT   右寄せ

上下方向の寄せ

SG_ALIGN_MIDDLE  中央
SG_ALIGN_TOP     上寄せ
SG_ALIGN_BOTTOM  下寄せ

属性

SG_ALIGN_XSTRETCH 横方向が枠に収まらない時は幅を縮小して全部を表示します。
SG_ALIGN_YSTRETCH 縦方向が枠に収まらない時は高さを縮小して全部を表示します。
SG_ALIGN_STRETCH  横方向または縦方向が枠に収まらない時は縮小して全部を表示します。
SG_ALIGN_COMMA    ３桁毎にカンマを追加し、通貨表示にします（1,234,567）
SG_ALIGN_NOCLIP   枠からはみ出す場合でもクリップしないでそのまま表示します。

属性は複数指定されている場合があります。

参照:: SGDialog::GetAlign(int objid)

SGObjectを再定義しています。

unsigned int GetColor ( ) [virtual]

文字列表示色を取得する文字列を表示する色を取得します。
オブジェクトが文字列を持たない場合、０ゼロが返ります。

戻り値:: 文字色

SGObjectを再定義しています。

unsigned int GetColorEffect ( ) [virtual]

効果色を取得する文字列を表示する際の効果色を取得します。
オブジェクトが文字列を持たない場合、０ゼロが返ります。

戻り値:: 効果色

SGObjectを再定義しています。

int GetLinespace ( ) [virtual]

複数行文字列を表示する時の改行幅を設定する複数行文字列を表示する時の改行幅を設定します。オブジェクトが文字列を持たない場合、０ゼロが返ります。

戻り値:: 改行幅

SGObjectを再定義しています。

SGTextAttribute & GetTextAttr ( )

テキストの属性を保持している SGTextAttribute クラスを取得する

テキストの属性を保持している SGTextAttribute クラスを取得します。
取得するテキスト属性に関する詳細は SGTextAttribute を参照して下さい。

戻り値:: テキストの属性（ SGTextAttribute ）

参照:: SGTextAttribute::SGTextAttribute()

void SetImage ( SGImage * image )

オブジェクトにイメージを登録する

オブジェクトにイメージを登録します。
この関数は SGGroupObject::AddFrame() からコールされています。最終的に SGFrameImage::CreateImage() をコールして登録されているファイル名の画像を読み込み、サーフェースを生成します。

引数:

image

フレーム用イメージクラス

このクラスの説明は次のファイルから生成されました:

sgobject.h
sgobject.cpp

クラス SGFrameObject

Public メソッド

説明

コンストラクタとデストラクタ

関数