クラス SGEditboxObject

エディットボックスウィジェットを提供するクラス [詳細]

#include <sgobject.h>

SGEditboxObjectに対する継承グラフ

Public メソッド
	SGEditboxObject (SGDialog dlg, SGObject parent, int id)
	コンストラクタ
virtual	~SGEditboxObject ()
	デストラクタ
virtual void	SetAttr (int attr)
virtual void	Draw (SGSurface *surface, SGRect region, int offx=0, int offy=0)
virtual void	SetText (SGString text)
virtual SGString *	GetText ()
virtual int	GetFocusStop ()
virtual void	SetFocusStop (int stop)
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	GetCaret ()
	キャレットの有無を取得する
virtual void	SetCaret (int caret)
	キャレットの有無を設定する
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 (int type)
	テキストの属性を保持している SGTextAttribute クラスを取得する
int	SetCaretPosition (int ctrl, int index=-1)
	キャレット位置を変更する
void	SetImage (SGImage *image)
	オブジェクトにイメージを登録する
int	CtrlText (int ctrl, const char *data=NULL)
	文字列を操作する
int	GetCaretPos ()
	キャレットの位置を取得する
int	GetTextLength ()
	文字列の長さを取得する
int	IsComma ()
	カンマ表示を行う設定になっているかどうか確認する
void	SetComma (int enable)
	カンマ付き表示をする/しないを設定する
int	IsPassword ()
	パスワード表示を行う設定になっているかどうか確認する
void	SetPassword (int enable)
	パスワード表示をする/しないを設定する

説明

エディットボックスウィジェットを提供するクラス

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

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

コンストラクタ

引数:

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

~SGEditboxObject ( ) [virtual]

デストラクタ

関数

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)

SGObjectを再定義しています。

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を再定義しています。

int GetFocusStop ( ) [virtual]

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

戻り値:

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

SGObjectを再定義しています。

void SetFocusStop ( int stop ) [virtual]

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

引数:

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

SGObjectを再定義しています。

int GetEnableRepeat ( ) [virtual]

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

引数:

enable

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

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

戻り値:

	TRUE	有効
	FALSE	無効

SGObjectを再定義しています。

void SetEnableRepeat ( int enable = 1 ) [virtual]

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

引数:

enable

有効／無効

TRUE  有効（省略時）
FALSE 無効

SGObjectを再定義しています。

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

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

引数:

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

SGObjectを再定義しています。

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

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

引数:

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

SGObjectを再定義しています。

int GetCaret ( ) [virtual]

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

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

戻り値:

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

SGObjectを再定義しています。

void SetCaret ( int caret ) [virtual]

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

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

引数:

caret

有無

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

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 ( int type )

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

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

引数:

type

種類

SG_ATTR_NORMAL(0)   通常の状態用
SG_ATTR_DISABLE(1)  ディスエーブルの状態用
SG_ATTR_ACTIVE(2)   アクティブの状態用（ラジオ、チェックなど）
SG_ATTR_FOCUS(3)    フォーカス用

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

参照:: SGTextAttribute::SGTextAttribute()

int SetCaretPosition	(	int	ctrl,
		int	index = `-1`
	)

キャレット位置を変更する

キャレット位置を変更します。

引数:

ctrl

機能コード

SG_CUR_POSITION  キャレット位置をindex文字目に移動します。
SG_CUR_FORWARD   キャレット位置を一文字分進めます。
SG_CUR_BACK      キャレット位置を一文字分戻します。
SG_CUR_BEGIN     キャレット位置を先頭に移動します。
SG_CUR_LAST      キャレット位置を文字列の最後に移動します。

ctrlがSG_CUR_POSITIONでindexを省略する（０以下を指定する）と位置を変えずに単に再表示となります。

index

キャレット位置
※ctrlがSG_CUR_POSITIONの時のみ使用

戻り値:: 変更後のキャレット位置

void SetImage ( SGImage * image )

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

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

引数:

image

エディットボックス用イメージクラス

int CtrlText	(	int	ctrl,
		const char *	data = `NULL`
	)

文字列を操作する

エディットボックス内の文字列を操作します。
文字列を操作する場合は SGDialog::EditboxCtrl() を使用すると便利です。

引数:

ctrl

機能コード

SG_CUR_DELETE キャレット位置の右側の文字を１文字削除します。
SG_CUR_INSERT キャレット位置に指定の文字列（data）を挿入します。
SG_CUR_ADD    エディット文字列に指定の文字列（data）を追加します。
SG_CUR_REMOVEALL 全てのエディット文字列を削除します。

data

追加/挿入文字列

戻り値:: 変更後のカーソルポジション

参照:: SGDialog::EditboxCtrl(int objid,int ctrl,int pos)

int GetCaretPos ( )

キャレットの位置を取得する

キャレットの位置を取得します。

戻り値:: 位置

int GetTextLength ( )

文字列の長さを取得する

文字列の長さを取得します。

戻り値:: 文字列の長さ

int IsComma ( )

カンマ表示を行う設定になっているかどうか確認する

カンマ表示を行う設定になっているかどうかを確認します。

戻り値:

	TRUE	カンマ表示する
	FALSE	カンマ表示しない

void SetComma ( int enable )

カンマ付き表示をする/しないを設定する

通貨表示（1,300,000）のようにカンマ付き表示をする/しないを設定します。

引数:

enable

する/しない

TRUE  カンマ付き４ケタ区切り表示する
FALSE カンマ表示しない

int IsPassword ( )

パスワード表示を行う設定になっているかどうか確認する

パスワード表示を行う設定になっているかどうかを確認します。

戻り値:

	TRUE	パスワード表示する
	FALSE	パスワード表示しない

void SetPassword ( int enable )

パスワード表示をする/しないを設定する

パスワード表示をする/しないを設定します。

引数:

enable

する/しない

TRUE  パスワード表示する
FALSE パスワード表示しない

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

sgobject.h
sgobject.cpp

クラス SGEditboxObject

Public メソッド

説明

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

関数