クラス SGObject

ウィジェットオブジェクトの基底クラス [詳細]

#include <sgobject.h>

SGObjectに対する継承グラフ

[凡例]

Public メソッド
	SGObject (SGDialog dlg, SGObject parent, int id, int type)
	コンストラクタ
virtual	~SGObject ()
	デストラクタ
virtual SGObject *	Find (int id)
	このオブジェクトのリソースIDが指定されたIDと同じか調べる
virtual SGObject *	FindType (int type)
	このオブジェクトの種類が指定された種類と同じか調べる
virtual SGObject *	FindFirst ()
	このオブジェクトが無効でなく非表示でないことを調べる
virtual SGObject *	FindFocus ()
	このオブジェクトがフォーカスを持っているか調べる
virtual SGObject *	FindNext (int id, SGObject **idobj)
	次のオブジェクトを検索する
virtual SGObject *	FindPrevious (int id, SGObject **idobj)
	前のオブジェクトを検索する
virtual SGObject *	FindCaret ()
	キャレットを持つオブジェクトを検索する
virtual SGObject *	GetActiveObject (int groupid)
	アクティブになっているオブジェクトを検索する
virtual SGObject *	GetObjectFromHandle (SGHandle handle)
	ハンドルからオブジェクトのポインタを取得する
void	SetOffset (int offx, int offy)
	オフセット値を設定する
void	GetPosition (int &x, int &y, int &w, int &h)
	オブジェクトの位置を取得する
SGRect	GetPosition ()
	オブジェクトの位置を取得する
void	SetPosition (int x, int y)
	オブジェクトの位置を設定する
void	SetPosition (int x, int y, int w, int h)
	オブジェクトの位置と大きさを設定する
void	SetSize (int w, int h)
	オブジェクトのサイズを設定する
int	IsVisible ()
	表示状態を取得する
int	PosX ()
	オブジェクトのX座標を取得する
int	PosY ()
	オブジェクトのY座標を取得する
int	PosW ()
	オブジェクトの幅を取得する
int	PosH ()
	オブジェクトの高さを取得する
void	SetClickable (int enable)
	オブジェクトのクリッカブル属性のON/OFFを行う
int	IsClickable ()
	オブジェクトのクリッカブル属性を取得する
int	GetMyDialogId ()
	ダイアログのリソースIDを取得する
SGHandle	GetHandle ()
	ハンドルを取得する
SGHandle	GetMyDialogHandle ()
	ダイアログのハンドルを取得する
SGObject *	GetParent ()
	親オブジェクトを取得する
void	SetParent (SGObject *parent)
	親オブジェクトを設定する
virtual int	GetCaret ()
	キャレットの有無を取得する
virtual void	SetCaret (int caret)
	キャレットの有無を設定する
virtual void	SetAttr (int attr)
	オブジェクトの属性を設定する
virtual void	SetRadioButton (int enable=1)
virtual int	GetRadioButton ()
virtual SGHandle	HitTest (int posx, int posy)
virtual SGRect	Update ()
	オブジェクトの表示を更新する
virtual void	Draw (SGSurface *surface, SGRect region, int offx=0, int offy=0)
virtual SGString *	GetText ()
	文字列を取得する
virtual void	SetText (SGString text)
	文字列を設定する
virtual int	GetFocusStop ()
	フォーカス属性を付けることができるか調べる
virtual void	SetFocusStop (int stop)
	フォーカス属性を付けることが、できる/できない、を設定する
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 ()
	複数行文字列を表示する時の改行幅を設定する
virtual int	GetEnableRepeat ()
	押し下げ状態の時にクリックを許可する/しないを設定
virtual void	SetEnableRepeat (int enable=1)
	キーリピートの有効／無効を設定する
virtual void	GetRepeatTime (int &first, int &interval)
	キーリピートが開始されるまでの時間とキーリピート間隔を取得する
virtual void	SetRepeatTime (int first, int interval)
	キーリピートが開始されるまでの時間とキーリピート間隔を設定する
virtual int	GetPushTime ()
	押し下げ状態を維持する時間を取得
virtual void	SetPushTime (int time)
	押し下げ状態を維持する時間を設定
virtual int	GetPushClickEnable ()
	押し下げ状態の時にクリックを許可する/しないを取得
virtual void	SetPushClickEnable (int enable)
	押し下げ状態の時にクリックを許可する/しないを設定
int	GetType ()
	オブジェクトの種類を取得する
int	GetId ()
	リソースIDを取得する
int	GetAttr ()
	オブジェクトの属性を取得する
int	IsPush ()
	押し下げ状態かを確認する
int	GetFocus ()
	フォーカスの状態を取得する
void	GetDialogPos (int &x, int &y)
	ダイアログの位置を取得する
Protected メソッド
SGCore *	Core ()
	コアオブジェクトを取得する
SGSurface *	Surface ()
	サーフェースを取得する

説明

ウィジェットオブジェクトの基底クラス

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

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

コンストラクタ

オブジェクトの基本クラスです。

引数:

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

~SGObject ( ) [virtual]

デストラクタ

関数

SGObject * Find ( int id ) [virtual]

このオブジェクトのリソースIDが指定されたIDと同じか調べる

このオブジェクトのリソースIDが指定されたIDと同じか調べます。
※基本クラスです。 SGGroupObject::Find() が使用する為に存在します。
詳細は SGGroupObject::Find() を参照して下さい。

引数:

id

リソースID

戻り値:

	このオブジェクト	指定のIDと、このオブジェクトのリソースIDが同じ場合
	NULL	指定のIDと、このオブジェクトのリソースIDが違う場合

SGGroupObjectで再定義されています。

SGObject * FindType ( int type ) [virtual]

このオブジェクトの種類が指定された種類と同じか調べる

このオブジェクトの種類が指定された種類と同じか調べます。
※基本クラスです。 SGGroupObject::FindType() が使用する為に存在します。
詳細は SGGroupObject::FindType() を参照して下さい。

引数:

type

種類

戻り値:

	このオブジェクト	指定の種類と、このオブジェクトの種類が同じ場合
	NULL	指定の種類と、このオブジェクトの種類が違う場合

SGGroupObjectで再定義されています。

SGObject * FindFirst ( ) [virtual]

このオブジェクトが無効でなく非表示でないことを調べる

このオブジェクトが無効でなく非表示でないことを調べます。
※基本クラスです。 SGGroupObject::FindFirst() が使用する為に存在します。
詳細は SGGroupObject::FindFirst() を参照して下さい。

戻り値:

	このオブジェクト	このオブジェクトが無効でなく非表示でない場合
	NULL	このオブジェクトが無効、または非表示の場合

SGGroupObjectで再定義されています。

SGObject * FindFocus ( ) [virtual]

このオブジェクトがフォーカスを持っているか調べる

このオブジェクトがフォーカスを持っているか調べます。
※基本クラスです。 SGGroupObject::FindFocus() が使用する為に存在します。
詳細は SGGroupObject::FindFocus() を参照して下さい。

戻り値:

	このオブジェクト	このオブジェクトがフォーカスを持っている場合
	NULL	このオブジェクトがフォーカスを持っていない場合

SGGroupObjectで再定義されています。

SGObject * FindNext	(	int	id,
		SGObject **	idobj
	)			`[virtual]`

次のオブジェクトを検索する

次のオブジェクトを探す為にグループオブジェクトが使用します。
※基本クラスです。 SGGroupObject::FindNext() が使用する為に存在します。
詳細は SGGroupObject::FindNext() を参照して下さい。

idobjがNULLの場合で与えられたidがこのオブジェクトのIDと一致する場合、 idobjに、このオブジェクトを代入し、NULLを返します。（idがゼロの場合はこのオブジェクトがフォースを持っている場合に、このオブジェクトを代入します。）
idobjがNULLでない場合は、このオブジェクトが無効でなく非表示でないことを確認します。

引数:

	id	基準となるオブジェクトのリソースID ０（ゼロ）を指定すると現在のフォーカスオブジェクトになります。
	idobj	指定したidにより見つかったオブジェクト（取得用）

戻り値:

	このオブジェクト	検索条件を満たす場合
	NULL	検索条件を満たさない場合

SGObject * FindPrevious	(	int	id,
		SGObject **	idobj
	)			`[virtual]`

前のオブジェクトを検索する

前のオブジェクトを探す為にグループオブジェクトが使用します。
※基本クラスです。 SGGroupObject::FindPrevious() が使用する為に存在します。
詳細は SGGroupObject::FindPrevious() を参照して下さい。

idobjがNULLの場合で与えられたidがこのオブジェクトのIDと一致する場合、 idobjに、このオブジェクトを代入し、NULLを返します。（idがゼロの場合はこのオブジェクトがフォースを持っている場合に、このオブジェクトを代入します。）
idobjがNULLでない場合は、このオブジェクトが無効でなく非表示でないことを確認します。

引数:

	id	基準となるオブジェクトのリソースID ０（ゼロ）を指定すると現在のフォーカスオブジェクトになります。
	idobj	指定したidにより見つかったオブジェクト（取得用）

戻り値:

	このオブジェクト	検索条件を満たす場合
	NULL	検索条件を満たさない場合

SGObject * FindCaret ( ) [virtual]

キャレットを持つオブジェクトを検索する

グループ内からキャレットを持ったオブジェクトを検索します。
キャレットオブジェクトはダイアログに１つだけ存在できます。 ※基本クラスです。 SGGroupObject::FindCaret() が使用する為に存在します。
詳細は SGGroupObject::FindCaret() を参照して下さい。

戻り値:: 見つかった場合、オブジェクトのポインタを返します。見つからなかった場合はNULLを返します。

SGGroupObjectで再定義されています。

SGObject * GetActiveObject ( int groupid ) [virtual]

アクティブになっているオブジェクトを検索する

指定されたgroupidがこのオブジェクトのグループIDと等しく、かつアクティブかどうか調べます。
※基本クラスです。 SGGroupObject::GetActiveObject() が使用する為に存在します。
詳細は SGGroupObject::GetActiveObject() を参照して下さい。

引数:

groupid

検索対象オブジェクトのグループID

戻り値:: 見つかった場合、オブジェクトのポインタを返します。見つからなかった場合はNULLを返します。

SGGroupObjectで再定義されています。

SGObject * GetObjectFromHandle ( SGHandle handle ) [virtual]

ハンドルからオブジェクトのポインタを取得する

ハンドルからオブジェクトのポインタを取得します。 ※基本クラスです。 SGGroupObject::GetObjectFromHandle() が使用する為に存在します。
詳細は SGGroupObject::GetObjectFromHandle() を参照して下さい。

引数:

handle

オブジェクトのハンドル

戻り値:: 指定されたハンドルを持つオブジェクトのポインタを返す。取得に失敗した場合は、NULLを返す。

SGGroupObjectで再定義されています。

void SetOffset	(	int	offx,
		int	offy
	)

オフセット値を設定する

オブジェクトのオフセットを設定します。
オフセットは座標に付加されるものです。
主に内部で使用されます。

引数:

	offx
	offy

void GetPosition	(	int &	x,
		int &	y,
		int &	w,
		int &	h
	)

オブジェクトの位置を取得する

オブジェクトの位置を取得します。

引数:

	&x	X座標（取得用）
	&y	Y座標（取得用）
	&w	幅　（取得用）
	&h	高さ（取得用）

SGRect GetPosition ( )

オブジェクトの位置を取得する

オブジェクトの位置を取得します。

戻り値:: 各頂点の座標がセットされたSGRect構造体

void SetPosition	(	int	x,
		int	y
	)

オブジェクトの位置を設定する

オブジェクトの位置を設定します。

引数:

	x	X座標
	y	Y座標

void SetPosition	(	int	x,
		int	y,
		int	w,
		int	h
	)

オブジェクトの位置と大きさを設定する

オブジェクトの位置と大きさを設定します。

引数:

	x	X座標
	y	Y座標
	w	幅
	h	高さ

void SetSize	(	int	w,
		int	h
	)

オブジェクトのサイズを設定する

オブジェクトのサイズを設定します

引数:

	w	幅
	h	高さ

int IsVisible ( )

表示状態を取得する

オブジェクトの表示状態（表示/非表示）を取得します。

戻り値:

	TRUE	表示状態
	FALSE	非表示状態

int PosX ( )

オブジェクトのX座標を取得する

オブジェクトのX座標を取得します。

戻り値:: オブジェクトのX座標

int PosY ( )

オブジェクトのY座標を取得する

オブジェクトのY座標を取得します。

戻り値:: オブジェクトのY座標

int PosW ( )

オブジェクトの幅を取得する

オブジェクトの幅を取得します。

戻り値:: オブジェクトの幅

int PosH ( )

オブジェクトの高さを取得する

オブジェクトの高さを取得します。

戻り値:: オブジェクトの高さ

void SetClickable ( int enable )

オブジェクトのクリッカブル属性のON/OFFを行う

オブジェクトのクリッカブル属性のON/OFFを行います。

引数:

enable

ON/OFF

TRUE  クリック通知が発行されるようにする
FALSE クリック通知が発行されないようにする

int IsClickable ( )

オブジェクトのクリッカブル属性を取得する

オブジェクトのクリッカブル属性を取得します。

戻り値:

	TRUE	クリック通知は発行されます。
	FALSE	クリック通知は発行されません。

int GetMyDialogId ( )

ダイアログのリソースIDを取得する

このオブジェクトを持っているダイアログのリソースIDを取得します。

戻り値:: ダイアログのリソースID

SGHandle GetHandle ( )

ハンドルを取得する

このオブジェクトのハンドルを取得します。

戻り値:: ハンドル

SGHandle GetMyDialogHandle ( )

ダイアログのハンドルを取得する

このオブジェクトを持っているダイアログのハンドルを取得します。

戻り値:: ダイアログのハンドル

SGObject * GetParent ( )

親オブジェクトを取得する

親オブジェクトを取得します。

戻り値:: 親オブジェクトのポインタ

void SetParent ( SGObject * parent )

親オブジェクトを設定する

親オブジェクトを設定します。

引数:

parent

親オブジェクトのポインタ

int GetCaret ( ) [virtual]

キャレットの有無を取得する

このオブジェクトにキャレットが存在するかどうか確認します。
キャレットはエディットボックスにのみ存在します。

戻り値:

	TRUE	キャレット有り
	FALSE	キャレット無し

SGEditboxObjectで再定義されています。

void SetCaret ( int caret ) [virtual]

キャレットの有無を設定する

このオブジェクトのキャレットをON/OFFします。
キャレットを置くことができるのはエディットボックスだけです。

引数:

caret

有無

TRUE  キャレットを置く
FALSE キャレットを外す

SGEditboxObjectで再定義されています。

void SetAttr ( int attr ) [virtual]

オブジェクトの属性を設定する

オブジェクトの属性を設定します。

引数:

attr

属性

SG_ATTR_NORMAL  (0)
SG_ATTR_DISABLE (1)
SG_ATTR_ACTIVE  (2)
SG_ATTR_FOCUS   (3)
SG_ATTR_DOWN    (4)
SG_ATTR_ACTDOWN (5)
SG_ATTR_HIDE    (6)
SG_FOCUS_ON     (16)
SG_FOCUS_OFF    (17)
SG_PUSH_ON      (18)
SG_PUSH_OFF     (19)

SGEditboxObjectで再定義されています。

void SetRadioButton ( int enable = 1 ) [virtual]

ラジオボタン属性の有無を設定するラジオボタン属性の有無を設定します。
グループにラジオボタン属性が付いている場合、そのグループ内のオブジェクトはアクティブ属性を付けることができるオブジェクトが１つに制限されます。一つのオブジェクトにアクティブ属性を付けると以前のアクティブオブジェクトは自動的にノーマル属性になります。

引数:

enable

ON/FF（省略時ON）

TRUE  ラジオボタン属性をONにします。
FALSE ラジオボタン属性をOFFにします。

SGGroupObjectで再定義されています。

int GetRadioButton ( ) [virtual]

ラジオボタン属性の有無を取得するラジオボタン属性の有無を取得します。
グループにラジオボタン属性が付いている場合、そのグループ内のオブジェクトはアクティブ属性を付けることができるオブジェクトが１つに制限されます。一つのオブジェクトにアクティブ属性を付けると以前のアクティブオブジェクトは自動的にノーマル属性になります。

戻り値:

	TRUE	ラジオボタン属性ON
	FALSE	ラジオボタン属性OFF

SGGroupObjectで再定義されています。

SGHandle HitTest	(	int	posx,
		int	posy
	)			`[virtual]`

指定した座標にオブジェクトが存在するか判定する指定した座標にオブジェクトが存在するか判定します。

引数:

	posx	X座標(ダイアログの左辺を0とする)
	posy	Y座標(ダイアログの上辺を0とする)

戻り値:: オブジェクトが存在する場合、オブジェクトのハンドルを返す。存在しない場合、0を返す。

SGButtonObject, SGPictureObject, SGIconObject, SGMovieObject, SGCanvasObject, と SGGroupObjectで再定義されています。

SGRect Update ( ) [virtual]

オブジェクトの表示を更新する

オブジェクトの表示を更新します。
位置、サイズ、属性などの変更後は Update() が必要です。
実際の表示更新は SGDialog::Flip() が呼ばれた時に行います。
この関数はダイアログクラスの Update() 関数内で使われていてオブジェクトの変更後の Update() Flip() が内部でコールされます。
オブジェクトの属性変更、移動などの編集作業は SGDialog::Update() を使用すると便利です。

戻り値:: 更新領域を返します。

参照:: SGDialog::Update(int objid,int attr); SGDialog::Update(int objid,const char* text); SGDialog::Update(int objid,int x,int y); SGDialog::Update(int objid,int x,int y,int w,int h)

SGPictureObject, と SGIconObjectで再定義されています。

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

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

引数:

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

SGButtonObject, SGEditboxObject, SGFrameObject, SGPictureObject, SGIconObject, SGMovieObject, SGCanvasObject, SGTextObject, と SGGroupObjectで再定義されています。

SGString * GetText ( ) [virtual]

文字列を取得する

文字列を取得します。

戻り値:: 文字列

SGKeyboardObject, SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

void SetText ( SGString text ) [virtual]

文字列を設定する

文字列を設定します。

引数:

text

文字列

SGKeyboardObject, SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

int GetFocusStop ( ) [virtual]

フォーカス属性を付けることができるか調べる

このオブジェクトにフォーカス属性を付けることができるか調べます。

戻り値:

	TRUE	フォーカス属性を付けることができます。
	FALSE	フォーカス属性を付けることはできません。

SGButtonObject, と SGEditboxObjectで再定義されています。

void SetFocusStop ( int stop ) [virtual]

フォーカス属性を付けることが、できる/できない、を設定する

フォーカス属性を付けることが、できる/できない、を設定します。
フォーカスが有効なオブジェクトはボタンとエディットボックスのみです。
その他のオブジェクトに設定した場合は無視されます。
ボタンやエディットボックスにフォーカスを置きたくない場合に使用します。
デフォルトではボタン、エディットボックスはフォーカスが有効になっています。

引数:

	stop	TRUE 有効（フォーカス属性を付けることができるようにする）
	stop	FALSE 無効（フォーカス属性を付けることができないようにする）

SGButtonObject, と SGEditboxObjectで再定義されています。

void SetFontId ( int fontid ) [virtual]

使用するフォントを設定する

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

引数:

fontid

フォントのリソースID

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

void SetMarginX ( int margin ) [virtual]

文字列を配置する時の横方向のマージンを設定する

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

引数:

margin

マージン幅

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

void SetMarginY ( int margin ) [virtual]

文字列を配置する時の縦方向のマージンを設定する

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

引数:

margin

マージン幅

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

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)

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

void SetColor ( unsigned int col ) [virtual]

文字列表示色を設定する

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

引数:

col

文字色

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

void SetColorEffect ( unsigned int col ) [virtual]

効果色を設定する

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

引数:

col

文字色

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

void SetLinespace ( int space ) [virtual]

複数行文字列を表示する時の改行幅を設定する

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

引数:

space

改行幅

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

int GetFontId ( ) [virtual]

使用しているフォントを取得する

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

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

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

int GetMarginX ( ) [virtual]

文字列を配置する時の横方向のマージンを取得する

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

戻り値:: マージン幅

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

int GetMarginY ( ) [virtual]

文字列を配置する時の縦方向のマージンを取得する

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

戻り値:: マージン幅

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

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)

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

unsigned int GetColor ( ) [virtual]

文字列表示色を取得する

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

戻り値:: 文字色

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

unsigned int GetColorEffect ( ) [virtual]

効果色を取得する

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

戻り値:: 効果色

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

int GetLinespace ( ) [virtual]

複数行文字列を表示する時の改行幅を設定する

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

戻り値:: 改行幅

SGButtonObject, SGEditboxObject, SGFrameObject, と SGTextObjectで再定義されています。

int GetEnableRepeat ( ) [virtual]

押し下げ状態の時にクリックを許可する/しないを設定

押し下げ状態の時に次のクリックを許可するかしないかを設定します。詳しくは SetPushTime の説明を参照して下さい。

引数:

enable

TRUE:許可する FALSE:許可しない

参照:: SGObject::SetPushTime(int time) キーリピートの有効／無効を取得するキーリピートの有効／無効を取得します。キーリピートが有効なオブジェクトはボタンとエディットボックスのみです。

戻り値:

	TRUE	有効
	FALSE	無効

SGButtonObject, と SGEditboxObjectで再定義されています。

void SetEnableRepeat ( int enable = 1 ) [virtual]

キーリピートの有効／無効を設定する

キーリピートの有効／無効を設定します。
キーリピートが有効なオブジェクトはボタンとエディットボックスのみです。
その他のオブジェクトに設定した場合は無視されます。
初期状態ではキーリピートは無効に設定されています。

引数:

enable

有効／無効

TRUE  有効（省略時）
FALSE 無効

SGButtonObject, と SGEditboxObjectで再定義されています。

void GetRepeatTime	(	int &	first,
		int &	interval
	)			`[virtual]`

キーリピートが開始されるまでの時間とキーリピート間隔を取得する

キーリピートが開始されるまでの時間とキーリピート間隔を取得します。

引数:

	first	キーリピートが開始されるまでの時間取得用(ms)
	interval	キーリピート間隔取得用(ms)

SGButtonObject, と SGEditboxObjectで再定義されています。

void SetRepeatTime	(	int	first,
		int	interval
	)			`[virtual]`

キーリピートが開始されるまでの時間とキーリピート間隔を設定する

キーリピートが開始されるまでの時間とキーリピート間隔を設定します。

引数:

	first	キーリピートが開始されるまでの時間(ms)
	interval	キーリピート間隔(ms)

SGButtonObject, と SGEditboxObjectで再定義されています。

int GetPushTime ( ) [virtual]

押し下げ状態を維持する時間を取得

押し下げ状態を維持する時間を取得します。

戻り値:: 時間(ms)

SGButtonObjectで再定義されています。

void SetPushTime ( int time ) [virtual]

押し下げ状態を維持する時間を設定

押し下げ状態を維持する時間を設定します。
初期状態（設定しない場合）は200msです。
押し下げられたボタンは、ボタンを離した時（UPイベント時）元の状態に戻りますが、押してから離すまでの時間が、ここで設定した時間以下の場合はDOWN状態を維持し、ボタンの表示は押下状態を維持します。その場合、設定した時間が経過した時に元の状態に戻ります。
※ SGObject::SetPushClickEnable() でFALSE（許可しない）が設定されている場合、押し下げられているボタンをもう一度クリックしてもクリックイベントは発生しません。
※ 初期状態（設定しない場合）では PushClickEnable は不許可に設定されています。

引数:

time

時間(ms)

参照:: SGObject::SetPushClickEnable(int enable)

SGButtonObjectで再定義されています。

int GetPushClickEnable ( ) [virtual]

押し下げ状態の時にクリックを許可する/しないを取得

押し下げ状態の時に次のクリックを許可するかしないかを取得します。

TRUE:許可する

戻り値:

FALSE:許可しない

SGButtonObjectで再定義されています。

void SetPushClickEnable ( int enable ) [virtual]

押し下げ状態の時にクリックを許可する/しないを設定

押し下げ状態の時に次のクリックを許可するかしないかを設定します。詳しくは SetPushTime の説明を参照して下さい。

引数:

enable

TRUE:許可する FALSE:許可しない

参照:: SGObject::SetPushTime(int time)

SGButtonObjectで再定義されています。

int GetType ( )

オブジェクトの種類を取得する

オブジェクトの種類を取得します。

戻り値:

種類

SG_OBJ_BUTTON(1)   ボタン
SG_OBJ_EDITBOX(2)  エディットボックス
SG_OBJ_FRAME(3)    フレーム
SG_OBJ_PICTURE(4)  ピクチャー
SG_OBJ_ICON(5)     アイコン
SG_OBJ_CANVAS(6)   キャンバス
SG_OBJ_TEXT(7)     テキスト
SG_OBJ_KEYBOARD(8) キーボード
SG_OBJ_GROUP(9)    グループ

int GetId ( )

リソースIDを取得する

オブジェクトのリソースIDを取得します。

戻り値:: リソースID

int GetAttr ( )

オブジェクトの属性を取得する

オブジェクトの属性を取得します。

戻り値:

属性

SG_ATTR_NORMAL  (0)
SG_ATTR_DISABLE (1)
SG_ATTR_ACTIVE  (2)
SG_ATTR_FOCUS   (3)
SG_ATTR_DOWN    (4)
SG_ATTR_ACTDOWN (5)
SG_ATTR_HIDE    (6)
SG_FOCUS_ON     (16)
SG_FOCUS_OFF    (17)

int IsPush ( )

押し下げ状態かを確認する

押し下げ状態かどうか確認します。オブジェクトがボタンでかつ押下状態の時TRUEが戻ります。

戻り値:

	TRUE	押下状態
	FALSE	解放(ノーマル)状態

int GetFocus ( )

フォーカスの状態を取得する

フォーカスの状態を取得します。

戻り値:

	TRUE	フォーカス状態
	FALSE	フォーカスされていない状態

void GetDialogPos	(	int &	x,
		int &	y
	)

ダイアログの位置を取得する

このオブジェクトを持っているダイアログの表示座標を取得します。

引数:

	&x	X座標（取得用）
	&y	Y座標（取得用）

SGCore * Core ( ) [protected]

コアオブジェクトを取得する

コアオブジェクトを取得します。

戻り値:: SGCoreクラスのポインタ

SGSurface * Surface ( ) [protected]

サーフェースを取得する

オブジェクトを持っているダイアログのサーフェースを取得します。
オブジェクトを表示するサーフェースです。

戻り値:: SGSurfaceクラスのポインタ

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

sgobject.h
sgobject.cpp

クラス SGObject

Public メソッド

Protected メソッド

説明

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

関数