SFZMessageDialog

通知メッセージを表示するダイアログです。

#include <SFZMessageDialog.h.hpp>

class SFZMessageDialog : public SFZDialog;

SFMTYPEDEFCLASS(SFZMessageDialog)

継承図

協調図

解説

SFZMessageDialog は、アイコンイメージ・メッセージテキスト・OK ボタンを表示することができます。

それぞれの要素は省略して使用することもできます。

OK ボタンを省略、または操作不可能状態に設定する場合、操作キーでの操作が可能になります。

図 226. SFZMessageDialog クラスの動作例

	重要
	すべてのダイアログにおいて、`SFYResponder::SetParent` 関数、`SFYResponder::SetState` 関数、`SFYResponder::SetRealBound` 関数の呼び出しは必須です。その他の関数は必要に応じて呼び出すことも省略することもできます。

参照

通知メッセージを表示するダイアログ [SFZMessageDialog] | SFZDialog | SFZQuestionDialog

メンバ

コンストラクタ/デストラクタ
SFZMessageDialog( `Void` ) SFZMessageDialog クラスのコンストラクタです。
~SFZMessageDialog( `Void` ) SFZMessageDialog クラスのデストラクタです。

パブリック関数
`SFZTextButtonControlSmpConstRef`	GetButton( `Void` ) ダイアログのボタンコントロールを取得します。
`SFXWideStringConstRef`	GetButtonText( `Void` ) ボタンのテキストを取得します。
`SInt16`	GetFrameSize( `Void` ) フレームマージンのサイズを取得します。
`SFZImageLabelControlSmpConstRef`	GetIcon( `Void` ) ダイアログのアイコンを取得します。
`SFBImageSmpConstRef`	GetIconImage( `Void` ) ダイアログのアイコン画像を取得します。
`SFZMultipleTextLabelControlSmpConstRef`	GetMessage( `Void` ) ダイアログのテキストラベルを取得します。
`SFXWideStringConstRef`	GetMessageText( `Void` ) ダイアログのメッセージテキストを取得します。
`SInt16`	GetSpaceSize( `Void` ) フレームのスペースマージンのサイズを取得します。
static `SFZMessageDialogSmp`	NewInstance( `SFCErrorPtr` exception = null ) 新しいインスタンスを作成します。
`SFCError`	SetButtonText( `ButtonEnum` button , `SFXPathConstRef` path , `UInt16` id ) SetButtonText( `ButtonEnum` button , `SFXWideStringConstRef` param ) ボタンのテキストを設定します。
`Void`	SetFrameSize( `SInt16` param ) フレームマージンのサイズを設定します。
`SFCError`	SetIconImage( `SFXPathConstRef` path ) SetIconImage( `SFBImageSmpConstRef` param ) SetIconImage( `SFXPathConstRef` path , `UInt16` id ) ダイアログのアイコン画像を設定します。
`SFCError`	SetMessageText( `SFXPathConstRef` path , `UInt16` id ) SetMessageText( `SFXWideStringConstRef` param ) ダイアログのメッセージテキストを設定します。
`Void`	SetSpaceSize( `SInt16` param ) ダイアログのスペースマージンのサイズを設定します。
`Void`	CancelTimer( `Void` ) (SFZDialog から継承) ダイアログのタイマーをキャンセルします。
`Void`	ClearHandler( `Void` ) (SFYResponder から継承) ハンドラの登録をすべて解除します。
`Void`	ClearTracer( `Void` ) (SFYResponder から継承) トレーサの登録をすべて解除します。
`SFCError`	Distribute( `SFXEventConstRef` event , `BoolPtr` result = null ) (SFYResponder から継承) 配信エンジンを起動してイベントを配信します。
`SFXRGBColorConstRef`	GetBackgroundColor( `Void` ) (SFYWidget から継承) 背景の色を取得します。
`SFYResponderSmp`	GetChildBack( `Void` ) (SFYResponder から継承) GetChildBack( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetChildBack( `UInt32` id ) (SFYResponder から継承) GetChildBack( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 最背面に位置する子レスポンダを取得します。
`SFYResponderSmp`	GetChildBackward( `SInt32` index ) (SFYResponder から継承) GetChildBackward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetChildBackward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) GetChildBackward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 背面から数えて指定された順番に位置する子レスポンダを取得します。
`SInt32`	GetChildCount( `Void` ) (SFYResponder から継承) GetChildCount( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetChildCount( `UInt32` id ) (SFYResponder から継承) GetChildCount( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 子レスポンダの数を取得します。
`SFYResponderSmp`	GetChildForward( `SInt32` index ) (SFYResponder から継承) GetChildForward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetChildForward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) GetChildForward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 前面から数えて指定された順番に位置する子レスポンダを取得します。
`SFYResponderSmp`	GetChildFront( `Void` ) (SFYResponder から継承) GetChildFront( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetChildFront( `UInt32` id ) (SFYResponder から継承) GetChildFront( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 最前面に位置する子レスポンダを取得します。
`SFYDistributerPtr`	GetDistributer( `Void` ) (SFYResponder から継承) 配信エンジンを取得します。
`AVKType`	GetEscapeKey( `Void` ) (SFZDialog から継承) ESCAPE キーを取得します。
`SFXRectangle`	GetGlobalBound( `Void` ) (SFYResponder から継承) グローバル領域を取得します。
`UInt32`	GetID( `Void` ) (SFYResponder から継承) ID を取得します。
`SFXRectangle`	GetLocalBound( `Void` ) (SFYResponder から継承) ローカル領域を取得します。
`SInt32`	GetNthBackward( `Void` ) (SFYResponder から継承) GetNthBackward( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetNthBackward( `UInt32` id ) (SFYResponder から継承) GetNthBackward( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが背面から数えて何番目に位置するかを取得します。
`SInt32`	GetNthForward( `Void` ) (SFYResponder から継承) GetNthForward( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetNthForward( `UInt32` id ) (SFYResponder から継承) GetNthForward( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが前面から数えて何番目に位置するかを取得します。
`AVKType`	GetOperateKey( `Void` ) (SFZDialog から継承) 操作キーを取得します。
`AVKType`	GetPageDownKey( `Void` ) (SFYContainer から継承) 仮想領域を下方向に１ページ分スクロールするキーを取得します。
`AVKType`	GetPageUpKey( `Void` ) (SFYContainer から継承) 仮想領域を上方向に１ページ分スクロールするキーを取得します。
`SFYResponderSmp`	GetParent( `Void` ) (SFYResponder から継承) 親レスポンダを取得します。
`Bool`	GetPropertyTransparent( `Void` ) (SFYResponder から継承) 透過属性を取得します。
`SFXRectangleConstRef`	GetRealBound( `Void` ) (SFYResponder から継承) 実領域を取得します。
`VoidPtr`	GetReference( `Void` ) (SFYResponder から継承) リファレンス値を取得します。
`SFYRendererPtr`	GetRenderer( `Void` ) (SFYResponder から継承) 描画エンジンを取得します。
`SFYResponderSmp`	GetRoot( `Void` ) (SFYResponder から継承) ルートレスポンダを取得します。
`AVKType`	GetScrollDownKey( `Void` ) (SFYContainer から継承) 仮想領域を下方向にスクロールするキーを取得します。
`Bool`	GetScrollRepeat( `Void` ) (SFYContainer から継承) 連続スクロールフラグを取得します。
`SInt16`	GetScrollStep( `Void` ) (SFYContainer から継承) スクロールステップを取得します。
`AVKType`	GetScrollUpKey( `Void` ) (SFYContainer から継承) 仮想領域を上方向にスクロールするキーを取得します。
`AVKType`	GetSnapDownKey( `Void` ) (SFYContainer から継承) 仮想領域を下端までスクロールするキーを取得します。
`AVKType`	GetSnapUpKey( `Void` ) (SFYContainer から継承) 仮想領域を上端までスクロールするキーを取得します。
`Bool`	GetStateActive( `Bool` inherit = false ) (SFYResponder から継承) 活性状態を取得します。
`Bool`	GetStateEnable( `Bool` inherit = false ) (SFYResponder から継承) 操作可能状態を取得します。
`Bool`	GetStateFocus( `Bool` inherit = false ) (SFYResponder から継承) フォーカス状態を取得します。
`Bool`	GetStateVisible( `Bool` inherit = false ) (SFYResponder から継承) 可視状態を取得します。
`SFXRectangle`	GetSuitableBound( `Void` ) (SFYResponder から継承) GetSuitableBound( `SFXRectangleConstRef` param ) (SFYResponder から継承) 最適な大きさを取得します。
`SFXMargin`	GetSuitableMargin( `Void` ) (SFYResponder から継承) 最適な余白を取得します。
`SFCType`	GetType( `Void` ) (SFYResponder から継承) タイプを取得します。
`SFXRectangleConstRef`	GetVirtualBound( `Void` ) (SFYResponder から継承) 仮想領域を取得します。
`Void`	Initialize( `Void` ) (SFYResponder から継承) レスポンダを初期化します。
`Void`	Invalidate( `Void` ) (SFYResponder から継承) Invalidate( `SFXRectangleConstRef` param ) (SFYResponder から継承) 再描画領域を登録します。
`Void`	InvokeBackward( `SFXEventConstRef` event , `Bool` overload , `BoolPtr` result = null ) (SFYResponder から継承) レスポンダにイベントを送信します。ハンドラ関数はハンドラリストに登録された順序で呼び出されます。
`Void`	InvokeForward( `SFXEventConstRef` event , `Bool` overload , `BoolPtr` result = null ) (SFYResponder から継承) レスポンダにイベントを送信します。ハンドラ関数はハンドラリストに登録された逆順で呼び出されます。
`Bool`	IsBack( `Void` ) (SFYResponder から継承) IsBack( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) IsBack( `UInt32` id ) (SFYResponder から継承) IsBack( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが最背面に位置するかどうかを判定します。
`Bool`	IsFront( `Void` ) (SFYResponder から継承) IsFront( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) IsFront( `UInt32` id ) (SFYResponder から継承) IsFront( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが最前面に位置するかどうかを判定します。
`Bool`	IsNthBackward( `SInt32` index ) (SFYResponder から継承) IsNthBackward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) IsNthBackward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) IsNthBackward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
`Bool`	IsNthForward( `SInt32` index ) (SFYResponder から継承) IsNthForward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) IsNthForward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) IsNthForward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
`Bool`	IsRoot( `Void` ) (SFYResponder から継承) 自レスポンダがルートレスポンダかどうかを判定します。
`Bool`	PageDown( `Void` ) (SFYContainer から継承) 仮想領域を下方向に１ページ分スクロールします。
`Bool`	PageUp( `Void` ) (SFYContainer から継承) 仮想領域を上方向に１ページ分スクロールします。
`SFCError`	RegisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::RuleRecConstRef` rule ) (SFYResponder から継承) RegisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::HandlerSPPConstPtr` spp , `VoidPtrConstPtr` reference , `SInt32` length ) (SFYResponder から継承) RegisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::RuleRecConstPtr` rule , `SInt32` length ) (SFYResponder から継承) RegisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::HandlerSPP` spp , `VoidPtr` reference ) (SFYResponder から継承) ハンドラを登録します。
`SFCError`	RegisterTracer( `SFXEventRangeConstRef` range , `SFYTracer::RuleRecConstRef` rule ) (SFYResponder から継承) RegisterTracer( `SFXEventRangeConstPtr` range , `SFYTracer::OrderEnumConstPtr` order , `SFYTracer::StateEnumConstPtr` state , `BoolConstPtr` overload , `SInt32` length ) (SFYResponder から継承) RegisterTracer( `SFXEventRangeConstPtr` range , `SFYTracer::RuleRecConstPtr` rule , `SInt32` length ) (SFYResponder から継承) RegisterTracer( `SFXEventRangeConstRef` range , `SFYTracer::OrderEnum` order , `SFYTracer::StateEnum` state , `Bool` overload ) (SFYResponder から継承) トレーサを登録します。
`SFCError`	Render( `Bool` force = false ) (SFYResponder から継承) 描画エンジンを起動して再描画します。
`Void`	RewindTimer( `Void` ) (SFZDialog から継承) ダイアログが自動的に閉じるまでの時間を再設定します。
`Void`	ScheduleTimer( `UInt32` param ) (SFZDialog から継承) 指定した時間が経過すればダイアログが自動的に閉じるようにスケジュールします。
`Bool`	ScrollDown( `Void` ) (SFYContainer から継承) 仮想領域を下方向にスクロールします。
`Bool`	ScrollUp( `Void` ) (SFYContainer から継承) 仮想領域を上方向にスクロールします。
`Void`	SetBackgroundColor( `SFXRGBColorConstRef` param ) (SFYWidget から継承) 背景の色を設定します。
`Void`	SetDistributer( `SFYDistributerPtr` param ) (SFYResponder から継承) 配信エンジンを設定します。
`Void`	SetEscapeKey( `AVKType` param ) (SFZDialog から継承) ESCAPE キーを設定します。
`Void`	SetID( `UInt32` param ) (SFYResponder から継承) ID を設定します。
`Void`	SetOperateKey( `AVKType` param ) (SFZDialog から継承) 操作キーを設定します。
`Void`	SetPageDownKey( `AVKType` param ) (SFYContainer から継承) 仮想領域を下方向に１ページ分スクロールするキーを設定します。
`Void`	SetPageUpKey( `AVKType` param ) (SFYContainer から継承) 仮想領域を上方向に１ページ分スクロールするキーを設定します。
`SFCError`	SetParent( `SFYResponderSmpConstRef` param ) (SFYResponder から継承) 親レスポンダを設定します。
`Void`	SetProperty( `Bool` transparent ) (SFYResponder から継承) 属性をまとめて設定します。
`Void`	SetPropertyTransparent( `Bool` param ) (SFYResponder から継承) 透過属性を設定します。
`Void`	SetRealBound( `SFXRectangleConstRef` param ) (SFYResponder から継承) 実領域を設定します。
`Void`	SetReference( `VoidPtr` param ) (SFYResponder から継承) リファレンス値を設定します。
`Void`	SetRenderer( `SFYRendererPtr` param ) (SFYResponder から継承) 描画エンジンを設定します。
`Void`	SetScrollDownKey( `AVKType` param ) (SFYContainer から継承) 仮想領域を下方向にスクロールするキーを設定します。
`Void`	SetScrollRepeat( `Bool` param ) (SFYContainer から継承) 連続スクロールフラグの設定をします。
`Void`	SetScrollStep( `SInt16` param ) (SFYContainer から継承) スクロールステップを設定します。
`Void`	SetScrollUpKey( `AVKType` param ) (SFYContainer から継承) 仮想領域を上方向にスクロールするキーを設定します。
`Void`	SetSnapDownKey( `AVKType` param ) (SFYContainer から継承) 仮想領域を下端までスクロールするキーを設定します。
`Void`	SetSnapUpKey( `AVKType` param ) (SFYContainer から継承) 仮想領域を上端までスクロールするキーを設定します。
`Void`	SetState( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 状態をまとめて設定します。
`Void`	SetStateActive( `Bool` param ) (SFYResponder から継承) 活性状態を設定します。
`Void`	SetStateEnable( `Bool` param ) (SFYResponder から継承) 操作可能状態を設定します。
`Void`	SetStateFocus( `Bool` param ) (SFYResponder から継承) フォーカス状態を設定します。
`Void`	SetStateVisible( `Bool` param ) (SFYResponder から継承) 可視状態を設定します。
`Void`	SetVirtualBound( `SFXRectangleConstRef` param ) (SFYResponder から継承) 仮想領域を設定します。
`Bool`	SnapDown( `Void` ) (SFYContainer から継承) 仮想領域を下端までスクロールします。
`Bool`	SnapUp( `Void` ) (SFYContainer から継承) 仮想領域を上端までスクロールします。
`Void`	Terminate( `Void` ) (SFYResponder から継承) レスポンダの終了処理をします。
`Void`	ToBack( `Void` ) (SFYResponder から継承) ToBack( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) ToBack( `UInt32` id ) (SFYResponder から継承) ToBack( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダを姉妹レスポンダのなかで最背面に移動します。
`Void`	ToFront( `Void` ) (SFYResponder から継承) ToFront( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) ToFront( `UInt32` id ) (SFYResponder から継承) ToFront( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダを姉妹レスポンダのなかで最前面に移動します。
`Void`	ToNthBackward( `SInt32` index ) (SFYResponder から継承) ToNthBackward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) ToNthBackward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) ToNthBackward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダを背面から数えて指定された順番に移動します。
`Void`	ToNthForward( `SInt32` index ) (SFYResponder から継承) ToNthForward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) ToNthForward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) ToNthForward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダを前面から数えて指定された順番に移動します。
`Void`	UnregisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::RuleRecConstRef` rule ) (SFYResponder から継承) UnregisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::HandlerSPPConstPtr` spp , `VoidPtrConstPtr` reference , `SInt32` length ) (SFYResponder から継承) UnregisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::RuleRecConstPtr` rule , `SInt32` length ) (SFYResponder から継承) UnregisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::HandlerSPP` spp , `VoidPtr` reference ) (SFYResponder から継承) ハンドラの登録を解除します。
`Void`	UnregisterTracer( `SFXEventRangeConstRef` range ) (SFYResponder から継承) UnregisterTracer( `SFXEventRangeConstPtr` range , `SInt32` length ) (SFYResponder から継承) トレーサの登録を解除します。
`T const &`	static_catch( `Void` ) (static_exception から継承) 現在保持している例外を取得します。

プロテクト関数
`Void`	HandleBoundOptimize( `SFXRectanglePtr` rectangle ) 指定した矩形に収まる範囲内で最適なサイズを計算します。
`Void`	HandleBoundReal( `Void` ) 実領域の変更処理を行います。
`Void`	HandleBoundRequest( `SFXRectanglePtr` rectangle ) 最適な矩形を計算します。
`Void`	HandleBoundVirtual( `Void` ) 仮想領域の変更処理を行います。
static `SFYResponderSmp`	Factory( `SFYResponderPtr` responder , `SFCErrorPtr` exception = null ) (SFYResponder から継承) NewInstance 関数の実装を補助します。
`SFYResponderSmp`	GetThis( `Void` ) (SFYResponder から継承) スマートポインタで保持された this を取得します。
`Void`	HandleBoundGlobal( `SFXRectangleConstRef` rectangle ) (SFYWidget から継承) グローバル領域の変更処理を行います。
`Void`	HandleEscapeKey( `Void` ) (SFZDialog から継承) ESCAPE キーが押されたときに実行される処理です。
`Void`	HandleOperateKey( `Void` ) (SFZDialog から継承) 操作キーが押されたときに実行される処理です。
`Bool`	HandlePageDownKey( `Void` ) (SFYContainer から継承) PageDown キーが押されたときに実行される処理です。
`Bool`	HandlePageUpKey( `Void` ) (SFYContainer から継承) PageUp キーが押されたときに実行される処理です。
`Void`	HandleRenderRequest( `SFXGraphicsPtr` graphics ) (SFYWidget から継承) レスポンダを描画します。
`Bool`	HandleScrollDownKey( `Void` ) (SFYContainer から継承) ScrollDown キーが押されたときに実行される処理です。
`Bool`	HandleScrollUpKey( `Void` ) (SFYContainer から継承) ScrollUp キーが押されたときに実行される処理です。
`Bool`	HandleSnapDownKey( `Void` ) (SFYContainer から継承) SnapDown キーが押されたときに実行される処理です。
`Bool`	HandleSnapUpKey( `Void` ) (SFYContainer から継承) SnapUp キーが押されたときに実行される処理です。
`Void`	SetType( `SFCType` param ) (SFYResponder から継承) タイプを設定します。
`Void`	static_throw( `static_exception< T > const &` param ) (static_exception から継承) static_throw( `T const &` param ) (static_exception から継承) 例外を設定します。
`Bool`	static_try( `Void` ) (static_exception から継承) 例外が保持されているかどうかを確かめます。

型
CodeEnum SFZMessageDialog クラスを表す定数です。
DefaultEnum FRAME 定数と SPACE 定数のデフォルト値です。

SFZMessageDialog::SFZMessageDialog

SFZMessageDialog クラスのコンストラクタです。

[ protected, explicit ]
SFZMessageDialog(Void);

SFZMessageDialog::~SFZMessageDialog

SFZMessageDialog クラスのデストラクタです。

[ protected, virtual ]
virtual ~SFZMessageDialog(Void);

SFZMessageDialog::GetButton

ダイアログのボタンコントロールを取得します。

[ public, const ]
SFZTextButtonControlSmpConstRef GetButton(Void);

戻り値

ダイアログのボタンコントロール。

解説

ダイアログのボタン(SFZTextButtonControl)の背景やテキストの色の変更などが行えます。

参照

SFZTextButtonControl

SFZMessageDialog::GetButtonText

ボタンのテキストを取得します。

[ public, const ]
SFXWideStringConstRef GetButtonText(Void);

戻り値

ボタンのテキスト。

参照

SFZMessageDialog::SetButtonText

SFZMessageDialog::GetFrameSize

フレームマージンのサイズを取得します。

[ public, const ]
SInt16 GetFrameSize(Void);

戻り値

ダイアログのフレームマージンのサイズ。

解説

ダイアログのフレームマージンのサイズを取得します。

	フレームマージン
ダイアログの枠と、ダイアログが内包しているコントロールまでのマージン。このマージンはダイアログの枠から上下左右同じ値だけ効きます。アイコンイメージとメッセージテキストは上から、ボタンは下からフレームマージンの間隔を空けてダイアログ内に配置されます。

フレームマージン

ダイアログの枠と、ダイアログが内包しているコントロールまでのマージン。このマージンはダイアログの枠から上下左右同じ値だけ効きます。

アイコンイメージとメッセージテキストは上から、ボタンは下からフレームマージンの間隔を空けてダイアログ内に配置されます。

参照

SFZMessageDialog::SetFrameSize

SFZMessageDialog::GetIcon

ダイアログのアイコンを取得します。

[ public, const ]
SFZImageLabelControlSmpConstRef GetIcon(Void);

戻り値

ダイアログのアイコン。

SFZMessageDialog::GetIconImage

ダイアログのアイコン画像を取得します。

[ public, const ]
SFBImageSmpConstRef GetIconImage(Void);

戻り値

ダイアログのアイコン画像。

参照

SFZMessageDialog::GetIconImage

SFZMessageDialog::GetMessage

ダイアログのテキストラベルを取得します。

[ public, const ]
SFZMultipleTextLabelControlSmpConstRef GetMessage(Void);

戻り値

ダイアログのテキストラベル。

解説

ダイアログのテキストラベル(SFZMultipleTextLabelControl)の色の変更などが行えます。

参照

SFZMultipleTextLabelControl

SFZMessageDialog::GetMessageText

ダイアログのメッセージテキストを取得します。

[ public, const ]
SFXWideStringConstRef GetMessageText(Void);

戻り値

ダイアログのメッセージテキスト。

参照

SFZMessageDialog::SetMessageText

SFZMessageDialog::GetSpaceSize

フレームのスペースマージンのサイズを取得します。

[ public, const ]
SInt16 GetFrameSize(Void);

戻り値

ダイアログのスペースマージンのサイズ。

解説

ダイアログのスペースマージンのサイズを取得します。

ダイアログに最適なサイズを自動計算する場合、スペースマージンのサイズの間隔でコントロールは配置されます。

	スペースマージン
コントロール同士のマージン。アイコンイメージとメッセージテキスト、ボタンとメッセージテキストの間のスペースです。ダイアログの縦幅が大きい場合、ボタンとメッセージテキストの間隔はスペースマージンより大きくなります。

スペースマージン

コントロール同士のマージン。

アイコンイメージとメッセージテキスト、ボタンとメッセージテキストの間のスペースです。

ダイアログの縦幅が大きい場合、ボタンとメッセージテキストの間隔はスペースマージンより大きくなります。

参照

SFZMessageDialog::SetSpaceSize

SFZMessageDialog::HandleBoundOptimize

指定した矩形に収まる範囲内で最適なサイズを計算します。

[ protected, virtual, const ]
Void HandleBoundOptimize(
    SFXRectanglePtr rectangle   // 矩形
);

解説

(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベントを受信したときに呼び出される関数です。

指定した矩形に収まる範囲内で最適なサイズを計算します。

SFZMessageDialog::HandleBoundReal

実領域の変更処理を行います。

[ protected, virtual ]
Void HandleBoundReal(Void);

解説

(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベントを受信したときに呼び出される関数です。

実領域の変更処理を行います。

デフォルトの実装では、仮想領域を実領域に一致させます。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベントの送信
	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベントは `SFYResponder::SetRealBound` 関数を呼び出したときなどに発生します。

	実領域の変更処理
この仮想関数をオーバーライドする以外に、領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装しレスポンダに登録して行うことも可能です。実領域の変更処理は、最初に仮想関数を実行し、次に領域イベント専用ハンドラを登録した順に実行して行われます。領域イベント専用ハンドラを宣言し登録する手間が省けるので、通常はこの仮想関数をオーバーライドだけして実領域の変更処理を行います。

実領域の変更処理

この仮想関数をオーバーライドする以外に、領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装しレスポンダに登録して行うことも可能です。

実領域の変更処理は、最初に仮想関数を実行し、次に領域イベント専用ハンドラを登録した順に実行して行われます。

領域イベント専用ハンドラを宣言し登録する手間が省けるので、通常はこの仮想関数をオーバーライドだけして実領域の変更処理を行います。

参照

SFYResponder::SetRealBound | 領域イベント(SFEVT_RESPONDER_BOUND) | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]

SFZMessageDialog::HandleBoundRequest

最適な矩形を計算します。

[ protected, virtual, const ]
Void HandleBoundRequest(
    SFXRectanglePtr rectangle   // 計算された座標
);

解説

(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベントを受信したときに呼び出される関数です。

ダイアログの表示に最適な大きさの矩形を計算して返します。

SFZMessageDialog::HandleBoundVirtual

仮想領域の変更処理を行います。

[ protected, virtual ]
Void HandleBoundVirtual(Void);

解説

(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントを受信したときに呼び出される関数です。

仮想領域の変更処理を行います。

デフォルトの実装ではボタンやアイコン、メッセージの再配置を行います。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントの送信
	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントは `SFYResponder::SetRealBound` または `SFYResponder::SetVirtualBound` 関数を呼び出したときなどに発生します。

	仮想領域の変更処理
この仮想関数をオーバーライドする以外に、領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装しレスポンダに登録して行うことも可能です。仮想領域の変更処理は、最初に仮想関数を実行し、次に領域イベント専用ハンドラを登録した順に実行して行われます。領域イベント専用ハンドラを宣言し登録する手間が省けるので、通常はこの仮想関数をオーバーライドだけして仮想領域の変更処理を行います。

仮想領域の変更処理

仮想領域の変更処理は、最初に仮想関数を実行し、次に領域イベント専用ハンドラを登録した順に実行して行われます。

領域イベント専用ハンドラを宣言し登録する手間が省けるので、通常はこの仮想関数をオーバーライドだけして仮想領域の変更処理を行います。

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 領域イベント(SFEVT_RESPONDER_BOUND) | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]

SFZMessageDialog::NewInstance

新しいインスタンスを作成します。

[ public, static ]
SFZMessageDialogSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);

引数

exception: 関数内部で発生したエラー値を返します。

戻り値

成功したとき : null 以外のポインタ
失敗したとき : null ポインタ

解説

SFZMessageDialog クラスの新しいインスタンスを作成します。

作成に成功した場合は null 以外のポインタを返し、exception 引数は常に SFERR_NO_ERROR になります。メモリ不足などで作成に失敗した場合は null ポインタを返し、exception 引数にエラー値が返ります。

使用例

ダイアログを作成する方法

SFZMessageDialogSmp dialog;
SFCError error;

if ((dialog = SFZMessageDialog::NewInstance(&error)) != null) {
    ...
}

SFZMessageDialog::SetButtonText

ボタンのテキストを設定します。

[ public ]
SFCError SetButtonText(
    ButtonEnum button      // 設定するボタンの定数
    SFXPathConstRef path   // リソースファイルのパス
    UInt16 id              // テキスト オブジェクト ID
);

[ public ]
SFCError SetButtonText(
    ButtonEnum button             // 設定するボタンの定数
    SFXWideStringConstRef param   // 設定するテキスト
);

解説

ダイアログのボタンのテキストを設定します。

参照

SFZMessageDialog::GetButtonText

SFZMessageDialog::SetFrameSize

フレームマージンのサイズを設定します。

[ public ]
Void SetFrameSize(
    SInt16 param   // 設定する値
);

解説

ダイアログのフレームマージンのサイズを設定します。

デフォルト値: DEFAULT_FRAME(5)

	フレームマージン
ダイアログの枠と、ダイアログが内包しているコントロールまでのマージン。このマージンはダイアログの枠から上下左右同じ値だけ効きます。アイコンイメージとメッセージテキストは上から、ボタンは下からフレームマージンの間隔を空けてダイアログ内に配置されます。

フレームマージン

ダイアログの枠と、ダイアログが内包しているコントロールまでのマージン。このマージンはダイアログの枠から上下左右同じ値だけ効きます。

アイコンイメージとメッセージテキストは上から、ボタンは下からフレームマージンの間隔を空けてダイアログ内に配置されます。

参照

SFZMessageDialog::GetFrameSize

SFZMessageDialog::SetIconImage

ダイアログのアイコン画像を設定します。

[ public ]
SFCError SetIconImage(
    SFXPathConstRef path   // リソースファイルのパス
);

[ public ]
SFCError SetIconImage(
    SFXPathConstRef path   // リソースファイルのパス
    UInt16 id              // 画像 オブジェクト ID
);

[ public ]
SFCError SetIconImage(
    SFBImageSmpConstRef param   // 設定する画像
);

解説

ダイアログのアイコン画像を設定します。

参照

SFZMessageDialog::SetIconImage

SFZMessageDialog::SetMessageText

ダイアログのメッセージテキストを設定します。

[ public ]
SFCError SetMessageText(
    SFXPathConstRef path   // リソースファイルのパス
    UInt16 id              // テキスト オブジェクト ID
);

[ public ]
SFCError SetMessageText(
    SFXWideStringConstRef param   // 設定するテキスト
);

参照

SFZMessageDialog::GetMessageText

SFZMessageDialog::SetSpaceSize

ダイアログのスペースマージンのサイズを設定します。

[ public ]
Void SetSpaceSize(
    SInt16 param   // 設定する値
);

解説

ダイアログのスペースマージンのサイズを設定します。

ダイアログに最適なサイズを自動計算する場合、スペースマージンのサイズの間隔でコントロールは配置されます。

デフォルト値: DEFAULT_SPACE(5)

	スペースマージン
コントロール同士のマージン。アイコンイメージとメッセージテキスト、ボタンとメッセージテキストの間のスペースです。ダイアログの縦幅が大きい場合、ボタンとメッセージテキストの間隔はスペースマージンより大きくなります。

スペースマージン

コントロール同士のマージン。

アイコンイメージとメッセージテキスト、ボタンとメッセージテキストの間のスペースです。

ダイアログの縦幅が大きい場合、ボタンとメッセージテキストの間隔はスペースマージンより大きくなります。

参照

SFZMessageDialog::GetSpaceSize

SFZMessageDialog::CodeEnum

SFZMessageDialog クラスを表す定数です。

enum CodeEnum {
    CODE_TYPE = four_char_code('d', 'm', 's', 'g')
};
SFMTYPEDEFTYPE(CodeEnum)

参照

SFYResponder::GetType | SFYResponder::SetType

SFZMessageDialog::DefaultEnum

FRAME 定数と SPACE 定数のデフォルト値です。

  
enum DefaultEnum {
    DEFAULT_FRAME  = 5,  // ダイアログの枠と、ダイアログが内包しているコントロールまでのマージン
    DEFAULT_SPACE  = 5   // コントロール同士のマージン
};
SFMTYPEDEFTYPE(CodeEnum)