SFZMultipleTextLabelControl

複数行の編集不可能なテキストを表示するラベルコントロールです。

#include <SFZMultipleTextLabelControl.h.hpp>

class SFZMultipleTextLabelControl : public SFYLabelControl;

SFMTYPEDEFCLASS(SFZMultipleTextLabelControl)

継承図

協調図

解説

SFZMultipleTextLabelControl クラスには、操作可能モードと操作不可能モードの２種類の使用方法があります。

操作可能モードではコントロールをフォーカスすることができ、操作キー押下時にイベントを受信することができます。

行数が多くスクロールして表示する必要がある場合には、上下キーでスクロールすることができます。

操作不可能モードでは単純なラベルコントロールとして動作します。

図 232. 動作例（左：操作不可能モード、右：操作可能モード）

	透過属性のデフォルト値
	このクラスの透過属性のデフォルト値は true です。

参照

複数行の編集不可能なテキストを表示するラベルコントロール [SFZMultipleTextLabelControl]

メンバ

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

パブリック関数
`AEEFont`	GetFont( `Void` ) フォントを取得します。
`HorizontalEnum`	GetHorizontalAlign( `Void` ) 水平アラインメントの値を取得します。
`AVKType`	GetPageDownKey( `Void` ) 仮想領域を下方向に１ページ分スクロールするキーを取得します。
`AVKType`	GetPageUpKey( `Void` ) 仮想領域を上方向に１ページ分スクロールするキーを取得します。
`AVKType`	GetScrollDownKey( `Void` ) 仮想領域を下方向にスクロールするキーを取得します。
`SInt16`	GetScrollStep( `Void` ) スクロールの移動量を取得します。
`AVKType`	GetScrollUpKey( `Void` ) 仮想領域を上方向にスクロールするキーを取得します。
`AVKType`	GetSnapDownKey( `Void` ) 仮想領域を下端までスクロールするキーを取得します。
`AVKType`	GetSnapUpKey( `Void` ) 仮想領域を上端までスクロールするキーを取得します。
`SFXWideStringConstRef`	GetText( `Void` ) テキストを取得します。
`SFXRGBColorConstRef`	GetTextColor( `Void` ) テキストの色を取得します。
`VerticalEnum`	GetVerticalAlign( `Void` ) 垂直アラインメントの値を取得します。
static `SFZMultipleTextLabelControlSmp`	NewInstance( `SFCErrorPtr` exception = null ) 新しいインスタンスを作成します。
`Bool`	PageDown( `Void` ) 仮想領域を下方向に１ページ分スクロールします。
`Bool`	PageUp( `Void` ) 仮想領域を上方向に１ページ分スクロールします。
`Bool`	ScrollDown( `Void` ) 仮想領域を下方向にスクロールします。
`Bool`	ScrollUp( `Void` ) 仮想領域を上方向にスクロールします。
`Void`	SetFont( `AEEFont` param ) フォントを設定します。
`Void`	SetHorizontalAlign( `HorizontalEnum` param ) 水平アラインメントを設定します。
`Void`	SetPageDownKey( `AVKType` param ) 仮想領域を下方向に１ページ分スクロールするキーを設定します。
`Void`	SetPageUpKey( `AVKType` param ) 仮想領域を上方向に１ページ分スクロールするキーを設定します。
`Void`	SetScrollDownKey( `AVKType` param ) 仮想領域を下方向にスクロールするキーを設定します。
`Void`	SetScrollStep( `SInt16` param ) スクロールの移動量を設定します。
`Void`	SetScrollUpKey( `AVKType` param ) 仮想領域を上方向にスクロールするキーを設定します。
`Void`	SetSnapDownKey( `AVKType` param ) 仮想領域を下端までスクロールするキーを設定します。
`Void`	SetSnapUpKey( `AVKType` param ) 仮想領域を上端までスクロールするキーを設定します。
`SFCError`	SetText( `SFXPathConstRef` path , `UInt16` id ) SetText( `SFXWideStringConstRef` param ) テキストを設定します。
`Void`	SetTextColor( `SFXRGBColorConstRef` param ) テキストの色を設定します。
`Void`	SetVerticalAlign( `VerticalEnum` param ) 垂直アラインメントを設定します。
`Bool`	SnapAlign( `Void` ) スクロール位置を初期状態に戻します。
`Bool`	SnapDown( `Void` ) 仮想領域の下端までスクロールします。
`Bool`	SnapUp( `Void` ) 仮想領域の上端までスクロールします。
`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 から継承) 配信エンジンを取得します。
`SFXRGBColorConstRef`	GetFocusColor( `Void` ) (SFYLabelControl から継承) フォーカス状態にあるときのラベルコントロールの枠を描画する色を取得します。
`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` ) (SFYLabelControl から継承) ラベルの操作キーを取得します。
`SFYResponderSmp`	GetParent( `Void` ) (SFYResponder から継承) 親レスポンダを取得します。
`Bool`	GetPropertyTransparent( `Void` ) (SFYResponder から継承) 透過属性を取得します。
`SFXRectangleConstRef`	GetRealBound( `Void` ) (SFYResponder から継承) 実領域を取得します。
`VoidPtr`	GetReference( `Void` ) (SFYResponder から継承) リファレンス値を取得します。
`SFYRendererPtr`	GetRenderer( `Void` ) (SFYResponder から継承) 描画エンジンを取得します。
`SFYResponderSmp`	GetRoot( `Void` ) (SFYResponder から継承) ルートレスポンダを取得します。
`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 から継承) 自レスポンダがルートレスポンダかどうかを判定します。
`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`	SetBackgroundColor( `SFXRGBColorConstRef` param ) (SFYWidget から継承) 背景の色を設定します。
`Void`	SetDistributer( `SFYDistributerPtr` param ) (SFYResponder から継承) 配信エンジンを設定します。
`Void`	SetFocusColor( `SFXRGBColorConstRef` param ) (SFYLabelControl から継承) フォーカス状態にあるときのラベルコントロールの枠を描画する色を設定します。
`Void`	SetID( `UInt32` param ) (SFYResponder から継承) ID を設定します。
`Void`	SetOperateKey( `AVKType` param ) (SFYLabelControl から継承) ラベルの操作キーを設定します。
`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`	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 から継承) 仮想領域を設定します。
`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 から継承) 現在保持している例外を取得します。

プロテクト関数
`SFYMultipleTextWidgetSmpConstRef`	GetWidget( `Void` ) ウィジェットを取得します。
`Void`	HandleBoundOptimize( `SFXRectanglePtr` rectangle ) 指定した矩形に収まる範囲内で最適なサイズを計算します。
`Void`	HandleBoundRequest( `SFXRectanglePtr` rectangle ) 最適な矩形を計算します。
`Void`	HandleBoundVirtual( `Void` ) 仮想領域の変更処理を行います。
`Void`	HandleOperateKey( `Void` ) 操作キーが押されたときに実行される処理です。
`Bool`	HandlePageDownKey( `Void` ) PageDown キーが押されたときに実行される処理です。
`Bool`	HandlePageUpKey( `Void` ) PageUp キーが押されたときに実行される処理です。
`Void`	HandleRenderRequest( `SFXGraphicsPtr` graphics ) レスポンダを描画します。
`Bool`	HandleScrollDownKey( `Void` ) ScrollDown キーが押されたときに実行される処理です。
`Bool`	HandleScrollUpKey( `Void` ) ScrollUp キーが押されたときに実行される処理です。
`Bool`	HandleSnapDownKey( `Void` ) SnapDown キーが押されたときに実行される処理です。
`Bool`	HandleSnapUpKey( `Void` ) SnapUp キーが押されたときに実行される処理です。
`Void`	DrawFocus( `SFXGraphicsPtr` graphics , `SFXRectangleConstRef` rectangle ) (SFYLabelControl から継承) フォーカス状態にあるときのラベルコントロールの枠を描画します。
static `SFYResponderSmp`	Factory( `SFYResponderPtr` responder , `SFCErrorPtr` exception = null ) (SFYResponder から継承) NewInstance 関数の実装を補助します。
static `SFXMarginConstRef`	GetFocusMargin( `Void` ) (SFYLabelControl から継承) フォーカス状態にあるときに描画されるラベルコントロールの枠とラベルテキスト間のマージンを取得します。
`SFYResponderSmp`	GetThis( `Void` ) (SFYResponder から継承) スマートポインタで保持された this を取得します。
`Void`	HandleBoundGlobal( `SFXRectangleConstRef` rectangle ) (SFYWidget から継承) グローバル領域の変更処理を行います。
`Void`	HandleBoundReal( `Void` ) (SFYWidget から継承) 実領域の変更処理を行います。
`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 SFZMultipleTextLabelControl クラスを表す定数です。
DefaultEnum 各種パラメータのデフォルト値を表します。
HorizontalEnum 水平方向のアラインメントを表す定数です。
VerticalEnum 垂直方向のアラインメントを表す定数です。

SFZMultipleTextLabelControl::SFZMultipleTextLabelControl

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

[ protected, explicit ]
SFZMultipleTextLabelControl(Void);

SFZMultipleTextLabelControl::~SFZMultipleTextLabelControl

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

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

SFZMultipleTextLabelControl::GetFont

フォントを取得します。

[ public, const ]
AEEFont GetFont(Void);

参照

SFZMultipleTextLabelControl::SetFont

SFZMultipleTextLabelControl::GetHorizontalAlign

水平アラインメントの値を取得します。

[ public, const ]
HorizontalEnum GetHorizontalAlign(Void);

戻り値

水平アラインメントの値。

参照

SFZMultipleTextLabelControl::SetHorizontalAlign | SFZMultipleTextLabelControl::HorizontalEnum

SFZMultipleTextLabelControl::GetPageDownKey

仮想領域を下方向に１ページ分スクロールするキーを取得します。

[ public, const ]
AVKType GetPageDownKey(Void);

戻り値

仮想領域を下方向に１ページ分スクロールするキー。

参照

SFZMultipleTextLabelControl::SetPageDownKey

SFZMultipleTextLabelControl::GetPageUpKey

仮想領域を上方向に１ページ分スクロールするキーを取得します。

[ public, const ]
AVKType GetPageUpKey(Void);

戻り値

仮想領域を上方向に１ページ分スクロールするキー。

参照

SFZMultipleTextBoxControl::SetPageUpKey

SFZMultipleTextLabelControl::GetScrollDownKey

仮想領域を下方向にスクロールするキーを取得します。

[ public, const ]
AVKType GetScrollDownKey(Void);

戻り値

仮想領域を下方向にスクロールするキー。

参照

SFZMultipleTextLabelControl::SetScrollDownKey

SFZMultipleTextLabelControl::GetScrollStep

スクロールの移動量を取得します。

[ public, const ]
SInt16 GetScrollStep(Void);

参照

SFZMultipleTextLabelControl::SetScrollStep

SFZMultipleTextLabelControl::GetScrollUpKey

仮想領域を上方向にスクロールするキーを取得します。

[ public, const ]
AVKType GetScrollUpKey(Void);

戻り値

仮想領域を上方向にスクロールするキー。

参照

SFZMultipleTextLabelControl::SetScrollUpKey

SFZMultipleTextLabelControl::GetSnapDownKey

仮想領域を下端までスクロールするキーを取得します。

[ public, const ]
AVKType GetSnapDownKey(Void);

戻り値

仮想領域を下端までスクロールするキー。

参照

SFZMultipleTextLabelControl::SetSnapDownKey

SFZMultipleTextLabelControl::GetSnapUpKey

仮想領域を上端までスクロールするキーを取得します。

[ public, const ]
AVKType GetSnapUpKey(Void);

戻り値

仮想領域を上端までスクロールするキー。

参照

SFZMultipleTextLabelControl::SetSnapUpKey

SFZMultipleTextLabelControl::GetText

テキストを取得します。

[ public, const ]
SFXWideStringConstRef GetText(Void);

参照

SFZMultipleTextLabelControl::SetText

SFZMultipleTextLabelControl::GetTextColor

テキストの色を取得します。

[ public, const ]
SFXRGBColorConstRef GetTextColor(Void);

参照

SFZMultipleTextLabelControl::SetTextColor | SFXRGBColor

SFZMultipleTextLabelControl::GetVerticalAlign

垂直アラインメントの値を取得します。

[ public, const ]
VerticalEnum GetVerticalAlign(Void);

戻り値

垂直アラインメントの値。

参照

SFZMultipleTextLabelControl::SetVerticalAlign | SFZMultipleTextLabelControl::VerticalEnum

SFZMultipleTextLabelControl::GetWidget

ウィジェットを取得します。

[ protected, const ]
SFYMultipleTextWidgetSmpConstRef GetWidget(Void);

-->

戻り値

テキストラベルコントロールのウィジェット。

解説

ウィジェットとは

	ウィジェットとは
ウィジェットはコントロールなどが内部的に利用するレスポンダです。イベントに直接反応せず、描画機能だけが実装されています。ただし、イベントへの応答や各種パラメータの設定のための API が用意されており、ウィジェットを利用するコントロールなどがイベントに応答してこれらの API を呼び出します。ウィジェットは同じ機能のコンポーネント化を目指して作成されています。たとえば、ボタンコントロールとラベルコントロールでスクロールするテキストを実際に描画しているのは、これらのコントロールが保持している `SFYSingleTextWidget` です。このように、スクロールするテキストなど基本的な機能を提供するのがウィジェットであり、新しいコントロールを作成する場合などに適宜ウィジェットを子レスポンダとして用いれば複雑な処理を記述せずに簡単に実装することができます。

ウィジェットはコントロールなどが内部的に利用するレスポンダです。イベントに直接反応せず、描画機能だけが実装されています。ただし、イベントへの応答や各種パラメータの設定のための API が用意されており、ウィジェットを利用するコントロールなどがイベントに応答してこれらの API を呼び出します。

ウィジェットは同じ機能のコンポーネント化を目指して作成されています。たとえば、ボタンコントロールとラベルコントロールでスクロールするテキストを実際に描画しているのは、これらのコントロールが保持している SFYSingleTextWidget です。

このように、スクロールするテキストなど基本的な機能を提供するのがウィジェットであり、新しいコントロールを作成する場合などに適宜ウィジェットを子レスポンダとして用いれば複雑な処理を記述せずに簡単に実装することができます。

参照

SFYMultipleTextWidget

SFZMultipleTextLabelControl::HandleBoundOptimize

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

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

解説

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

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

SFZMultipleTextLabelControl::HandleBoundRequest

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

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

解説

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

レスポンダに最適な大きさの矩形を計算して返したい場合は、この関数をオーバーライドします。

デフォルトの実装は、テキストの大きさを最適な矩形とします。

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

仮想領域の変更処理

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

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

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

参照

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

SFZMultipleTextLabelControl::HandleOperateKey

操作キーが押されたときに実行される処理です。

[ protected, virtual ]
Void HandleOperateKey(Void);

解説

SFEVT_KEY イベントを受信し、SetOperateKey 関数で設定した操作キーと一致したときに呼び出される関数です。

独自のキーイベント処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、テキストのスクロール位置を初期化します。

参照

SFYLabelControl::SetOperateKey

SFZMultipleTextLabelControl::HandlePageDownKey

PageDown キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandlePageDownKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetPageDownKey 関数によって設定された PageDown キーを受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、SFZMultipleTextLabelControl::PageDown 関数を呼び出して、仮想領域を下方向に１ページスクロールします。

参照

SFZMultipleTextLabelControl::SetPageDownKey | SFZMultipleTextLabelControl::PageDown

SFZMultipleTextLabelControl::HandlePageUpKey

PageUp キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandlePageUpKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetPageUpKey 関数によって設定された PageUp キーを受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、SFZMultipleTextLabelControl::PageUp 関数を呼び出して、仮想領域を上方向に１ページスクロールします。

参照

SFZMultipleTextLabelControl::SetPageDownKey | SFZMultipleTextLabelControl::PageUp

SFZMultipleTextLabelControl::HandleRenderRequest

レスポンダを描画します。

[ protected, virtual, const ]
Void HandleRenderRequest(
    SFXGraphicsPtr graphics   // グラフィックスオブジェクト
);

解説

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

独自の描画処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、テキストラベルコントロールを描画します。

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

描画処理の方法

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

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

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

描画処理の手順

	描画処理の手順
描画ハンドラは描画イベント(SFEVT_RESPONDER_RENDER)の発生によって起動されます。そして実際の描画は描画ハンドラによって行われます。描画イベント(SFEVT_RESPONDER_RENDER)自体は、 `SFYResponder::Render` 関数によって描画エンジンが起動してから描画エンジンが登録された再描画領域のなかから再描画が必要な領域を含むレスポンダだけに `SFYResponder::InvokeBackward` 関数を使って送信します。なお、`SFYResponder::Render` 関数はイベントループの最後で自動的に呼び出されるか、コールバックなどの処理なかから明示的に呼び出されるかのどちらかです。また、`SFYResponder::Render` 関数の引数を true にして呼び出すと、再描画領域の登録に関係無くレスポンダツリーの自レスポンダ以下の枝部分で実際に携帯電話の画面に描画されるすべてのレスポンダに描画イベントが送信されます。

描画ハンドラは描画イベント(SFEVT_RESPONDER_RENDER)の発生によって起動されます。そして実際の描画は描画ハンドラによって行われます。

描画イベント(SFEVT_RESPONDER_RENDER)自体は、 SFYResponder::Render 関数によって描画エンジンが起動してから描画エンジンが登録された再描画領域のなかから再描画が必要な領域を含むレスポンダだけに SFYResponder::InvokeBackward 関数を使って送信します。

なお、SFYResponder::Render 関数はイベントループの最後で自動的に呼び出されるか、コールバックなどの処理なかから明示的に呼び出されるかのどちらかです。

また、SFYResponder::Render 関数の引数を true にして呼び出すと、再描画領域の登録に関係無くレスポンダツリーの自レスポンダ以下の枝部分で実際に携帯電話の画面に描画されるすべてのレスポンダに描画イベントが送信されます。

参照

SFZMultipleTextLabelControl::HandleScrollDownKey

ScrollDown キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandleScrollDownKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetScrollDownKey 関数によって設定された ScrollDown キーを受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、SFZMultipleTextLabelControl::ScrollDown 関数を呼び出して、仮想領域を下方向にスクロールします。

参照

SFZMultipleTextLabelControl::SetScrollDownKey | SFZMultipleTextLabelControl::ScrollDown

SFZMultipleTextLabelControl::HandleScrollUpKey

ScrollUp キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandleScrollUpKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetScrollUpKey 関数によって設定された ScrollUp キーを受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、SFZMultipleTextLabelControl::ScrollUp 関数を呼び出して、仮想領域を上方向にスクロールします。

参照

SFZMultipleTextLabelControl::SetScrollUpKey | SFZMultipleTextLabelControl::ScrollUp

SFZMultipleTextLabelControl::HandleSnapDownKey

SnapDown キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandleSnapDownKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetSnapDownKey 関数によって設定された SnapDown キーを受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、SFZMultipleTextLabelControl::SnapDown 関数を呼び出して、仮想領域の下端までスクロールします。

参照

SFZMultipleTextLabelControl::SetSnapDownKey | SFZMultipleTextLabelControl::SnapDown

SFZMultipleTextLabelControl::HandleSnapUpKey

SnapUp キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandleSnapUpKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetSnapUpKey 関数によって設定された SnapUp キーを受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、SFZMultipleTextLabelControl::SnapUp 関数を呼び出して、仮想領域の上端までスクロールします。

参照

SFZMultipleTextLabelControl::SetSnapUpKey | SFZMultipleTextLabelControl::SnapUp

SFZMultipleTextLabelControl::NewInstance

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

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

引数

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

戻り値

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

解説

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

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

使用例

テキストラベルを作成する方法

SFZMultipleTextLabelControlSmp editlabel;
SFCError error;

if ((editlabel = SFZMultipleTextLabelControl::NewInstance(&error)) != null) {
    ...
}

SFZMultipleTextLabelControl::PageDown

仮想領域を下方向に１ページ分スクロールします。

[ public ]
Bool PageDown(Void);

戻り値

成功したとき : true
失敗したとき : false

参照

SFZMultipleTextLabelControl::PageUp

SFZMultipleTextLabelControl::PageUp

仮想領域を上方向に１ページ分スクロールします。

[ public ]
Bool PageUp(Void);

戻り値

成功したとき : true
失敗したとき : false

参照

SFZMultipleTextLabelControl::PageDown

SFZMultipleTextLabelControl::ScrollDown

仮想領域を下方向にスクロールします。

[ public ]
Bool ScrollDown(Void);

戻り値

成功したとき : true
失敗したとき : false

参照

SFZMultipleTextLabelControl::ScrollUp

SFZMultipleTextLabelControl::ScrollUp

仮想領域を上方向にスクロールします。

[ public ]
Bool ScrollUp(Void);

戻り値

成功したとき : true
失敗したとき : false

参照

SFZMultipleTextLabelControl::ScrollDown

SFZMultipleTextLabelControl::SetFont

フォントを設定します。

[ public ]
Void SetFont(
    AEEFont param   // 設定する値
);

解説

デフォルト値: AEE_FONT_NORMAL

参照

SFZMultipleTextLabelControl::GetFont

SFZMultipleTextLabelControl::SetHorizontalAlign

水平アラインメントを設定します。

[ public ]
Void SetHorizontalAlign(
    HorizontalEnum param   // 設定する値
);

解説

水平アラインメントを設定します。

デフォルト値: SFYMultipleTextWidget::DEFAULT_HORIZONTAL(中央揃え)

参照

SFZMultipleTextLabelControl::GetHorizontalAlign | SFZMultipleTextLabelControl::HorizontalEnum

SFZMultipleTextLabelControl::SetPageDownKey

仮想領域を下方向に１ページ分スクロールするキーを設定します。

[ public ]
Void SetPageDownKey(
    AVKType param   // 設定するキー
);

解説

仮想領域を下方向に１ページ分スクロールするキーを設定します。

デフォルト値: AVK_TXPGDOWN

参照

SFZMultipleTextLabelControl::GetPageDownKey

SFZMultipleTextLabelControl::SetPageUpKey

仮想領域を上方向に１ページ分スクロールするキーを設定します。

[ public ]
Void SetPageUpKey(