クラス SGTextObject

テキストウィジェットを提供するクラス [詳細]

#include <sgobject.h>

SGTextObjectに対する継承グラフ
Inheritance graph
[凡例]

すべてのメンバ一覧

Public メソッド

 SGTextObject (SGDialog *dlg, SGObject *parent, int id)
 コンストラクタ
virtual ~SGTextObject ()
 デストラクタ
virtual void Draw (SGSurface *surface, SGRect region, int offx=0, int offy=0)
virtual SGString * GetText ()
virtual void SetText (SGString text)
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 クラスを取得する
int IsComma ()
 カンマ表示を行う設定になっているかどうか確認する
void SetComma (int enable)
 カンマ付き表示をする/しないを設定する

Protected 変数

SGString mText
 (未記入)
SGTextAttribute mTextAttr
 (未記入)
SGSurface * mTPlane
 最後に表示したテキストプレーンを保持
SGRect mDst
 (未記入)
SGRect mDr
 (未記入)

説明

テキストウィジェットを提供するクラス

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

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

コンストラクタ

引数:
dlg このオブジェクトを持っているダイアログ
parent このオブジェクトを管理する親オブジェクト
id オブジェクトのリソースID
~SGTextObject (  )  [virtual]

デストラクタ

関数

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

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

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

SGObjectを再定義しています。

SGString * GetText (  )  [virtual]

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

戻り値:
文字列

SGObjectを再定義しています。

void SetText ( SGString  text  )  [virtual]

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

引数:
text 文字列

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

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

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

戻り値:
TRUE カンマ表示する
FALSE カンマ表示しない
void SetComma ( int  enable  ) 

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

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

引数:
enable する/しない 

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

変数

SGString mText [protected]

(未記入)

SGTextAttribute mTextAttr [protected]

(未記入)

SGSurface* mTPlane [protected]

最後に表示したテキストプレーンを保持

SGRect mDst [protected]

(未記入)

SGRect mDr [protected]

(未記入)

このクラスの説明は次のファイルから生成されました:
PlusG リファレンスマニュアル Ver 2.0.0