SimpleDialogBox クラス

SimpleDialogBox クラスは ユーザー定義のダイアログボックスを作成するために使用します。
スクリプト実行中に作成したダイアログボックスを表示させ、ダイアログボックスからパラメータ値を訂正することができます。
Application クラスから呼び出すことができます。
. [詳解]

公開メンバ関数
void	AddAxisSelection (String &originName, String &vectorName, String &label, int col=0, int colSpan=1)
	ダイアログボックスに軸選択を追加します。 [詳解]
void	AddCheckBox (String &name, String &label, bool defaultValue, int col=0, int colSpan=1)
	ダイアログボックスにチェックボックスを追加します。 [詳解]
void	AddComboBox (String &name, String &label, StringList &list, int defaultIndex=0, int col=0, int colSpan=1)
	ダイアログボックスにコンボボックスを追加します。 [詳解]
void	AddDirectoryPath (String &name, String &label, String &path, int col=0, int colSpan=1)
	ダイアログボックスに、ディレクトリ指定用の入力フィールドを追加します。 [詳解]
void	AddInteger (String &name, String &label, int defaultvalue, int col=0, int colSpan=1)
	ダイアログボックスに整数入力のフィールドを追加します。 [詳解]
void	AddIntegerList (String &name, String &label, String &defaultValue, int col=0, int colSpan=1)
	ダイアログボックスに整数リスト入力のフィールドを追加します。 [詳解]
void	AddLabel (String &text, int col=0, int colSpan=1)
	ダイアログボックスにテキストラベルを追加します。 [詳解]
void	AddLine (int col=0, int colSpan=1)
	ダイアログボックスに区切り線を追加します。 [詳解]
void	AddOpenFilename (String &name, String &label, String &path, String &filters, int col=0, int colSpan=1)
	ダイアログボックスに、入力ファイル指定用のフィールドを追加します。 [詳解]
void	AddRadio (String &name, String &label, int value, int col=0, int colSpan=1)
	ダイアログボックスにラジオボタンを追加します。 [詳解]
void	AddReal (String &name, String &label, double defaultValue, int col=0, int colSpan=1)
	ダイアログボックスに実数入力のフィールドを追加します。 [詳解]
void	AddSaveFilename (String &name, String &label, String &path, String &filters, int col=0, int colSpan=1)
	ダイアログボックスに、ファイル保存用のフィールドを追加します。 [詳解]
void	AddSelectEdgeList (String &name, String &label, int col=0, int colSpan=1)
	ダイアログボックスに、エッジ選択用のフィールドを追加します。 [詳解]
void	AddSelectFaceList (String &name, String &label, int col=0, int colSpan=1)
	ダイアログボックスに、面選択用のフィールドを追加します。 [詳解]
void	AddSelectPartList (String &name, String &label, int col=0, int colSpan=1)
	ダイアログボックスに、パート選択用のフィールドを追加します。 [詳解]
void	AddSelectVertexList (String &name, String &label, int col=0, int colSpan=1)
	ダイアログボックスに、頂点選択用のフィールドを追加します。 [詳解]
void	AddSpinBox (String &name, String &label, int defaultValue, int col=0, int colSpan=1)
	ダイアログボックスに整数パラメータを指定するためのスピンボックスを追加します。 [詳解]
void	AddString (String &name, String &label, String &defaultValue, int col=0, int colSpan=1)
	ダイアログボックスに文字列入力のフィールドを追加します。 [詳解]
Variant	GetMeshGroupIndices (String &name)
	選択用のフィールドからすべてのメッシュグループのIDを整数リストで取得します [詳解]
Point *	GetPoint (String &name)
	名前で指定した点の位置を取得する [詳解]
Variant	GetSetIndices (String &name)
	選択用のフィールドからすべてのセットのIDを整数リストで取得します [詳解]
Variant	GetValue (String &name)
	パラメータの値を取得します。 [詳解]
Variant	GetValueAsIntegerList (String &name)
	パラメータの値を整数リストで取得します。 [詳解]
bool	IsValid ()
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
void	SetCancelButtonVisible (bool visible)
	キャンセルボタンの表示/非表示を設定します。 [詳解]
void	SetHelp (String &helpString)
	ダイアログボックスのヘルプボタンが押された際に表示される説明を設定します。
void	SetHelpKey (String &helpKey)
	これは内部関数であるため、正式にサポートしていません。
void	SetMaximum (String &name, Variant &value)
	フィールドの入力値に上限を設けます。 [詳解]
void	SetMinimum (String &name, Variant &value)
	フィールドの入力値に下限を設けます。 [詳解]
void	SetModal (bool on)
	ダイアログをモーダルで開くかモードレスで開くかを設定します。 [詳解]
void	SetTitle (String &dialogTitle)
	ダイアログボックスのタイトルを指定します。
void	SetTooltip (String &name, String &tooltip, int value=-1)
	フィールドにツールチップを設定します。 [詳解]
void	SetTranslation (String &english, String &japanese)
	JMAGの表示言語として日本語を選択した場合の、ラベルテキストを指定します。 [詳解]
int	Show ()
	ダイアログボックスを表示します。OK の場合は "1" を、キャンセルの場合は "0" を取得します。
bool	WasCancelled ()
	キャンセルボタンが押された場合に、True を取得します。

詳解

SimpleDialogBox クラスは ユーザー定義のダイアログボックスを作成するために使用します。
スクリプト実行中に作成したダイアログボックスを表示させ、ダイアログボックスからパラメータ値を訂正することができます。
Application クラスから呼び出すことができます。
.

このクラスのオブジェクトを作成する例:

d = app.CreateDialogBox()
d.AddIngeter("param", "An integer value", 0)
d.Show()
v = d.GetValue("param")

関数詳解

void SimpleDialogBox::AddAxisSelection	(	String &	originName,
		String &	vectorName,
		String &	label,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに軸選択を追加します。

引数

originName	原点の名前
vectorName	向きの名前
label	ラベルとして表示されるテキスト
col	区切り線の表示開始位置の列番号
colspan	区切り線がまたがる列数

void SimpleDialogBox::AddCheckBox	(	String &	name,
		String &	label,
		bool	defaultValue,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスにチェックボックスを追加します。

パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValue() に渡されます。
パラメータ名は SetTooltip() などでも同様に使用されます。

引数

name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
defaultValue	チェックボックスの初期状態（0:OFF、1:ON）
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddComboBox	(	String &	name,
		String &	label,
		StringList &	list,
		int	defaultIndex = 0,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスにコンボボックスを追加します。

パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後にパラメータ値を取得するために GetValue() へ渡されます。
パラメータ名は SetTooltip() でも同様に使用されます。
GetValue() の返り値は選択項目のインデックスとなります。

引数

name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
list	コンボボックスに設定する文字列のリスト
defaultIndex	コンボボックスにデフォルトで表示する項目のインデックス、パラメータの初期値
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddDirectoryPath	(	String &	name,
		String &	label,
		String &	path,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに、ディレクトリ指定用の入力フィールドを追加します。

ディレクトリ指定用の入力フィールドは、ディレクトリの位置を指定するためのダイアログボックスを表示させる、Browse ボタンを持ちます。
パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValue() へ渡されます。
パラメータ名は SetTooltip() でも同様に使用されます。

引数

name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
path	ディレクトリ指定用のダイアログボックスにおいてデフォルトとする、ディレクトリパス
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddInteger	(	String &	name,
		String &	label,
		int	defaultvalue,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに整数入力のフィールドを追加します。

パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後にパラメータ値を取得するために GetValue() へ渡されます。
パラメータ名は SetTooltip() 、 SetMinimum() 、 SetMaximum() などでも同様に使用されます。

引数

name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
defaultValue	テキストボックス内に表示される、パラメータの初期値
col	フィールドの表示開始位置の列番号
colspan	フィールドがまたがる列数

void SimpleDialogBox::AddIntegerList	(	String &	name,
		String &	label,
		String &	defaultValue,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに整数リスト入力のフィールドを追加します。

パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValue() に渡されます。
パラメータ名は SetTooltip() などでも同様に使用されます。

引数

name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
defaultValue	テキストボックス内に表示される、パラメータの初期値
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddLabel	(	String &	text,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスにテキストラベルを追加します。

引数

text	ラベルとして表示されるテキスト
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddLine	(	int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに区切り線を追加します。

引数

col	区切り線の表示開始位置の列番号
colspan	区切り線がまたがる列数

void SimpleDialogBox::AddOpenFilename	(	String &	name,
		String &	label,
		String &	path,
		String &	filters,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに、入力ファイル指定用のフィールドを追加します。

入力ファイル指定用のフィールドは、開くファイルを指定するためのダイアログボックスを表示させる、Browse ボタンを持ちます。
パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValue() へ渡されます。
パラメータ名は SetTooltip() でも同様に使用されます。
引数filterでは、ファイルの種類やワイルドカードのリスト用の文字列を指定します。

{*.py}
               d.AddOpenFilename("param", "Filename:", "", "Any File (*.*)")

引数

name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
path	入力ファイル指定用のダイアログボックスで、デフォルトとするファイルパス
filters	ファイルの種類やフィルターの文字列
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddRadio	(	String &	name,
		String &	label,
		int	value,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスにラジオボタンを追加します。

同じラジオボタングループに属するすべてのラジオボタンには、同じ名称を付ける必要があります。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValue() に渡されます。
ラジオボタングループの場合、 GetValue() により取得された値が、どのラジオボタンが選択されているかという情報として AddRadio() に渡されます。
ラジオボタンにツールチップを設定した場合は SetTooltip() にも同様に GetValue() により取得された値が渡されます。：

d.AddRadio("param", "Label One", 1)
d.AddRadio("param", "Label Two", 2)
d.SetTooltip("param", "Tooltip one", 1)
d.SetTooltip("param", "Tooltip two", 2)

引数

name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
value	このラジオボタンに関連付けられた値
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddReal	(	String &	name,
		String &	label,
		double	defaultValue,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに実数入力のフィールドを追加します。

パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValue() へ渡されます。
パラメータ名は SetTooltip() 、 SetMinimum() 、 SetMaximum() などでも同様に使用されます。

引数

name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
defaultValue	テキストボックス内に表示される、パラメータの初期値
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddSaveFilename	(	String &	name,
		String &	label,
		String &	path,
		String &	filters,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに、ファイル保存用のフィールドを追加します。

ファイル保存用の入力フィールドは、保存するファイルの置き場所を指定するためのダイアログボックスを表示させる、Browseボタンを持ちます。
パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValue() へ渡されます。
パラメータ名は SetTooltip() でも同様に使用されます。
引数filterでは、ファイルの種類やワイルドカードのリスト用の文字列を指定します。

{*.py}
               d.AddSaveFilename("param", "Filename:", "", "Any File (*.*)")

引数

value
name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
path	ファイル保存用のダイアログボックスにおいてデフォルトとする、ファイルの保存先
filters	ファイルの種類やフィルターの文字列
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddSelectEdgeList	(	String &	name,
		String &	label,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに、エッジ選択用のフィールドを追加します。

エッジ選択用のフィールドは、編集・削除・すべてハイライト・セットを作成・セットとメッシュグループを選択ボタンを持ちます。
パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValueAsIntegerList() へ、セットのIDを取得するために GetSetIndices() へ、メッシュグループのIDを取得するために GetMeshGroupIndices() へ渡されます。
パラメータ名は SetTooltip() でも同様に使用されます。

引数

name	パラメータ名
label	パラメータのラベルとして選択用フィールド上に表示されるテキスト
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddSelectFaceList	(	String &	name,
		String &	label,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに、面選択用のフィールドを追加します。

面選択用のフィールドは、編集・削除・すべてハイライト・セットを作成・セットとメッシュグループを選択ボタンを持ちます。
パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValueAsIntegerList() へ、セットのIDを取得するために GetSetIndices() へ、メッシュグループのIDを取得するために GetMeshGroupIndices() へ渡されます。
パラメータ名は SetTooltip() でも同様に使用されます。

引数

name	パラメータ名
label	パラメータのラベルとして選択用フィールド上に表示されるテキスト
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddSelectPartList	(	String &	name,
		String &	label,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに、パート選択用のフィールドを追加します。

パート選択用のフィールドは、編集・削除・すべてハイライト・セットを作成・セットとメッシュグループを選択ボタンを持ちます。
パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValueAsIntegerList() へ、セットのIDを取得するために GetSetIndices() へ、メッシュグループのIDを取得するために GetMeshGroupIndices() へ渡されます。
パラメータ名は SetTooltip() でも同様に使用されます。

引数

name	パラメータ名
label	パラメータのラベルとして選択用フィールド上に表示されるテキスト
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddSelectVertexList	(	String &	name,
		String &	label,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに、頂点選択用のフィールドを追加します。

頂点選択用のフィールドは、編集・削除・すべてハイライト・セットを作成・セットとメッシュグループを選択ボタンを持ちます。
パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValueAsIntegerList() へセットのIDを取得するために、 GetSetIndices() へメッシュグループのIDを取得するために、 GetMeshGroupIndices() へ渡されます。
パラメータ名は SetTooltip() でも同様に使用されます。

引数

name	パラメータ名
label	パラメータのラベルとして選択用フィールド上に表示されるテキスト
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddSpinBox	(	String &	name,
		String &	label,
		int	defaultValue,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに整数パラメータを指定するためのスピンボックスを追加します。

パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後にパラメータ値を取得するために GetValue() へ渡されます。
パラメータ名は SetTooltip() 、 SetMinimum() 、 SetMaximum() などでも同様に使用されます。
スピンボックスの場合、入力値の上下限を設けることができます。

引数

name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
defaultValue	スピンボックス内に表示される、パラメータの初期値
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

void SimpleDialogBox::AddString	(	String &	name,
		String &	label,
		String &	defaultValue,
		int	col = 0,
		int	colSpan = 1
	)

ダイアログボックスに文字列入力のフィールドを追加します。

パラメータ名には、他のフィールドとは重複しないユニークなものを指定してください。
パラメータ名は、ダイアログボックス表示後、パラメータ値を取得するために GetValue() へ渡されます。
パラメータ名は SetTooltip() 、 SetMinimum() 、 SetMaximum() でも同様に使用されます。

引数

name	パラメータ名
label	パラメータのラベルとしてダイアログボックス上に表示されるテキスト
defaultValue	テキストボックス内にデフォルトで表示される文字列
col	ラベルの表示開始位置の列番号
colspan	ラベルがまたがる列数

Variant SimpleDialogBox::GetMeshGroupIndices

(

String &

name

)

選択用のフィールドからすべてのメッシュグループのIDを整数リストで取得します

引数

name	対象選択用のフィールドのパラメータ名

Point * SimpleDialogBox::GetPoint

(

String &

name

)

名前で指定した点の位置を取得する

引数

name

取得する点の名前

戻り値

Point オブジェクト

Variant SimpleDialogBox::GetSetIndices

(

String &

name

)

選択用のフィールドからすべてのセットのIDを整数リストで取得します

引数

name	対象選択用のフィールドのパラメータ名

Variant SimpleDialogBox::GetValue

(

String &

name

)

パラメータの値を取得します。

引数

name

パラメータ名

Variant SimpleDialogBox::GetValueAsIntegerList

(

String &

name

)

パラメータの値を整数リストで取得します。

引数

name

パラメータ名

bool SimpleDialogBox::IsValid

(

)

オブジェクトが有効であるとき、戻り値として True を取得します。

戻り値

SimpleDialogBox オブジェクトの有効・無効

void SimpleDialogBox::SetCancelButtonVisible

(

bool

visible

)

キャンセルボタンの表示/非表示を設定します。

引数

visible

True=1 : 表示 False=0 : 非表示

void SimpleDialogBox::SetMaximum	(	String &	name,
		Variant &	value
	)

フィールドの入力値に上限を設けます。

整数または実数入力のフィールドの場合、テキストボックスに入力可能な値の上下限値として使用されます。
スピンボックスの場合、スピンボックスの入力値の範囲を決定します。

引数

name	上限値を設けるパラメータ名
value	パラメータの上限値

void SimpleDialogBox::SetMinimum	(	String &	name,
		Variant &	value
	)

フィールドの入力値に下限を設けます。

整数または実数入力のフィールドの場合、テキストボックスに入力可能な値の上下限値として使用されます。
スピンボックスの場合、スピンボックスの入力値の範囲を決定します。

引数

name	下限値を設けるパラメータ名
value	パラメータの下限値

void SimpleDialogBox::SetModal

(

bool

on

)

ダイアログをモーダルで開くかモードレスで開くかを設定します。

引数

visible

True=1 : モーダル表示 False=0 : モードレス表示

void SimpleDialogBox::SetTooltip	(	String &	name,
		String &	tooltip,
		int	value = -1
	)

フィールドにツールチップを設定します。

引数

name	ツールチップを設定するパラメータ名
tooltip	ツールチップとして表示されるテキスト
value	この引数はラジオボタンの場合に使用します。詳細は AddRadio() の説明をご覧ください。

void SimpleDialogBox::SetTranslation	(	String &	english,
		String &	japanese
	)

JMAGの表示言語として日本語を選択した場合の、ラベルテキストを指定します。

表示言語として英語と日本語の両方を使用する場合に、 SetTranslation() を使ってください。

• 英語を表示言語とした際には、引数 english で指定されたラベルテキストがそのまま表示されます。
• 日本語を表示言語とした際には、引数 english で指定されたラベルテキストが、引数 japanese で指定されたラベルテキストに置き換えられます。 表示言語として英語だけ、または、日本語だけを使用する場合には、 SetTranslation() を使用する必要はありません。また、 SetTranslation() は、 AddString() の 引数 defaultValue で指定されたテキストには使用できません。

              \param english JMAGの表示言語が英語の場合のラベルテキスト
              \param japanese JMAGの表示言語が日本語の場合のラベルテキスト
  

以下は使用例です。

d = app.CreateDialogBox()
test = "aaa"
test_jp = "bbb"
d.SetTranslation(test, test_jp)
d.AddLabel(test)