前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFZMultipleTextLabelControl
複数行の編集不可能なテキストを表示するラベルコントロールです。
#include <SFZMultipleTextLabelControl.h.hpp>
class SFZMultipleTextLabelControl : public SFYLabelControl;
SFMTYPEDEFCLASS(SFZMultipleTextLabelControl)

継承図

SFZMultipleTextLabelControl クラスの継承図

協調図

SFZMultipleTextLabelControl クラスの協調図

解説

■ 仕様と使い方

複数行の編集不可能なテキストを表示するラベルコントロール(SFZMultipleTextLabelControl)には、 操作可能状態に応じて、 操作可能モードと操作不能モードの 2 種類の使用方法があります。

操作可能モードでは(状態が操作可能であるとき)、コントロールをフォーカスすることができます。 そのとき、SFYLabelControl::SetOperateKey 関数で設定する操作キーを押下すると、 結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())] を受信します。

[Note] 注意
この結果イベントは SFZMultipleTextLabelControl::HandleOperateKey 関数内で発生します。

行数が多くスクロールして表示する必要がある場合には、 SFZMultipleTextLabelControl::SetScrollDownKey / SFZMultipleTextLabelControl::SetScrollUpKey / SFZMultipleTextLabelControl::SetPageDownKey / SFZMultipleTextLabelControl::SetPageUpKey / SFZMultipleTextLabelControl::SetSnapDownKey / SFZMultipleTextLabelControl::SetSnapUpKey 関数で設定するスクロールキーを押下してスクロールできます。

操作不能モードでは(状態が操作不能であるとき)、普通のラベルコントロールとして動作します。

図 397. 動作例(左:操作不能モード、右:操作可能モード)

動作例(左:操作不能モード、右:操作可能モード)
[Caution] 透過属性のデフォルト値

このクラスの透過属性のデフォルト値は true なので、 SFYResponder::SetPropertyTransparent 関数で透過属性を false に設定しない限り、 SFYWidget::SetBackgroundColor 関数で設定した色で背景が塗り潰されることはありません。

[Caution] 引数(矩形領域)を指定しないで GetSuitableBound 関数を呼び出すときの注意

このレスポンダの SFYResponder::GetSuitableBound 関数を呼び出すときに引数(矩形領域)を指定しない場合は、 予め SFYResponder::SetRealBound 関数を使用して実領域(=ローカル領域※)を設定する必要があります。 設定された実領域の横幅は領域計算に必要なヒント値として利用されます。 通常、実領域の横幅には [ 使用しているフォントの横幅 + ラベル枠の幅 × 2 ](ラベル枠の幅は 2 ピクセル)以上の値を設定します。

仮想領域を設定しない限り、 実領域はローカル領域と同じです。また、ヒント値として使われる実領域を設定する際は、 SFYLabelControl::GetFocusMargin 関数で取得できるラベル枠の幅も考慮する必要があります。

参照: 複数行のテキストを表示するレスポンダに最適な大きさを取得する

参照

複数行の編集不可能なテキストを表示するラベルコントロール [SFZMultipleTextLabelControl] | SFYControl | SFYLabelControl | SFYMultipleTextWidget | 実領域 | ローカル領域 | 仮想領域 | 複数行のテキストを表示するレスポンダに最適な大きさを取得する | SFYLabelControl::GetFocusMargin | SFYLabelControl::SetOperateKey | SFZMultipleTextLabelControl::SetScrollDownKey | SFZMultipleTextLabelControl::SetScrollUpKey | SFZMultipleTextLabelControl::SetPageDownKey | SFZMultipleTextLabelControl::SetPageUpKey | SFZMultipleTextLabelControl::SetSnapDownKey | SFZMultipleTextLabelControl::SetSnapUpKey

メンバ

コンストラクタ/デストラクタ
SFZMultipleTextLabelControl( Void )
SFZMultipleTextLabelControl クラスのコンストラクタです。
~SFZMultipleTextLabelControl( Void )
SFZMultipleTextLabelControl クラスのデストラクタです。
パブリック関数
AEEFont GetFont( Void )
フォントを取得します。
HorizontalEnum GetHorizontalAlign( Void )
水平アライメントの値を取得します。
AVKType GetPageDownKey( Void )
複数行テキストを下方向に 1 ページ分スクロールする PageDown キーを取得します。
AVKType GetPageUpKey( Void )
複数行テキストを上方向に 1 ページ分スクロールする PageUp キーを取得します。
AVKType GetScrollDownKey( Void )
複数行テキストを下方向にスクロールステップ分スクロールする ScrollDown キーを取得します。
SInt16 GetScrollStep( Void )
スクロール移動量を取得します。[単位:ピクセル]
AVKType GetScrollUpKey( Void )
複数行テキストを上方向にスクロールステップ分スクロールする ScrollUp キーを取得します。
AVKType GetSnapDownKey( Void )
複数行テキストを下端までスクロールする SnapDown キーを取得します。
AVKType GetSnapUpKey( Void )
複数行テキストを上端までスクロールする SnapUp キーを取得します。
SFXWideStringConstRef GetText( Void )
テキストを取得します。
SFXRGBColorConstRef GetTextColor( Void )
テキストの色を取得します。
VerticalEnum GetVerticalAlign( Void )
垂直アライメントの値を取得します。
static
SFZMultipleTextLabelControlSmp
NewInstance( SFCErrorPtr exception = null )
新しいインスタンスを作成します。
Bool PageDown( Void )
複数行テキストを下方向に 1 ページ分スクロールします。
Bool PageUp( Void )
複数行テキストを上方向に 1 ページ分スクロールします。
Bool ScrollDown( Void )
複数行テキストを下方向にスクロールステップ分スクロールします。
Bool ScrollUp( Void )
複数行テキストを上方向にスクロールステップ分スクロールします。
Void SetFont( AEEFont param )
フォントを設定します。
Void SetHorizontalAlign( HorizontalEnum param )
水平アライメントを設定します。
Void SetPageDownKey( AVKType param )
複数行テキストを下方向に 1 ページ分スクロールする PageDown キーを設定します。
Void SetPageUpKey( AVKType param )
複数行テキストを上方向に 1 ページ分スクロールする PageUp キーを設定します。
Void SetScrollDownKey( AVKType param )
複数行テキストを下方向にスクロールステップ分スクロールする ScrollDown キーを設定します。
Void SetScrollStep( SInt16 param )
スクロール移動量を設定します。[単位:ピクセル]
Void SetScrollUpKey( AVKType param )
複数行テキストを上方向にスクロールステップ分スクロールする ScrollUp キーを設定します。
Void SetSnapDownKey( AVKType param )
複数行テキストを下端までスクロールする SnapDown キーを設定します。
Void SetSnapUpKey( AVKType param )
複数行テキストを上端までスクロールする SnapUp キーを設定します。
SFCError SetText( SFXPathConstRef path , UInt16 id )
テキストを設定します。
SFCError 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 から継承)
指定された配信型イベントを SFYDistributer インスタンスと、このレスポンダ以下のレスポンダツリーに配信します。
SFXRGBColorConstRef GetBackgroundColor( Void ) (SFYWidget から継承)
背景の色を取得します。
SFYResponderSmp GetChildBack( Void ) (SFYResponder から継承)
最背面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
最背面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBack( UInt32 id ) (SFYResponder から継承)
最背面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
最背面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBackward( SInt32 index ) (SFYResponder から継承)
背面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
背面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBackward( SInt32 index , UInt32 id ) (SFYResponder から継承)
背面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
背面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SInt32 GetChildCount( Void ) (SFYResponder から継承)
このレスポンダの子レスポンダの数を取得します。
SInt32 GetChildCount( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダの子レスポンダの数を取得します。
SInt32 GetChildCount( UInt32 id ) (SFYResponder から継承)
このレスポンダの子レスポンダの数を取得します。
SInt32 GetChildCount( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダの子レスポンダの数を取得します。
SFYResponderSmp GetChildForward( SInt32 index ) (SFYResponder から継承)
前面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
前面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildForward( SInt32 index , UInt32 id ) (SFYResponder から継承)
前面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
前面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildFront( Void ) (SFYResponder から継承)
最前面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
最前面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildFront( UInt32 id ) (SFYResponder から継承)
最前面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
最前面に位置するこのレスポンダの子レスポンダを取得します。
SInt32 GetCurrentValue( Void ) (SFYControl から継承)
コントロールの現在値を取得します。
SFYDistributerPtr GetDistributer( Void ) (SFYResponder から継承)
このレスポンダに設定されている配信エンジンを取得します。
SFXRGBColorConstRef GetFocusColor( Void ) (SFYLabelControl から継承)
フォーカス状態にあるときのラベルコントロールの枠を描画する色を取得します。
SFYResponderSmp GetFrame( Void ) (SFYResponder から継承)
このレスポンダに装着されたフレームを取得します。
SFXRectangle GetGlobalBound( Void ) (SFYResponder から継承)
このレスポンダのグローバル領域を取得します。
UInt32 GetID( Void ) (SFYResponder から継承)
このレスポンダの ID を取得します。
SFXRectangle GetLocalBound( Void ) (SFYResponder から継承)
このレスポンダのローカル領域を取得します。
SInt32 GetMaximumValue( Void ) (SFYControl から継承)
コントロールの最大値を取得します。
SInt32 GetMinimumValue( Void ) (SFYControl から継承)
コントロールの最小値を取得します。
SInt32 GetNthBackward( Void ) (SFYResponder から継承)
このレスポンダが背面から数えて何番目に位置するかを取得します。
SInt32 GetNthBackward( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが背面から数えて何番目に位置するかを取得します。
SInt32 GetNthBackward( UInt32 id ) (SFYResponder から継承)
このレスポンダが背面から数えて何番目に位置するかを取得します。
SInt32 GetNthBackward( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが背面から数えて何番目に位置するかを取得します。
SInt32 GetNthForward( Void ) (SFYResponder から継承)
このレスポンダが前面から数えて何番目に位置するかを取得します。
SInt32 GetNthForward( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが前面から数えて何番目に位置するかを取得します。
SInt32 GetNthForward( UInt32 id ) (SFYResponder から継承)
このレスポンダが前面から数えて何番目に位置するかを取得します。
SInt32 GetNthForward( UInt32 id , 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 GetStateValid( Bool inherit = false ) (SFYResponder から継承)
このレスポンダの有効状態を取得します。
Bool GetStateVisible( Bool inherit = false ) (SFYResponder から継承)
このレスポンダの可視状態を取得します。
SFXRectangle GetSuitableBound( Void ) (SFYResponder から継承)
このレスポンダの最適な領域(サイズ)を取得します。
SFXRectangle GetSuitableBound( SFXRectangleConstRef rectangle ) (SFYResponder から継承)
このレスポンダの最適な領域(サイズ)を取得します。
SFXRectangle GetSuitableBound( SFXRectangleConstRef param , HorizontalEnum horizontal , VerticalEnum vertical ) (SFYResponder から継承)
このレスポンダの最適な領域(サイズ)を取得します。
SFXMargin GetSuitableMargin( Void ) (SFYResponder から継承)
このレスポンダのフレーム余白領域を取得します。
SFCType GetType( Void ) (SFYResponder から継承)
このレスポンダのタイプを取得します。
SFXRectangleConstRef GetVirtualBound( Void ) (SFYResponder から継承)
このレスポンダの仮想領域を取得します。
Bool HasFrame( Void ) (SFYResponder から継承)
このレスポンダがコンテントレスポンダであるかどうかを判定します。
Void Initialize( Void ) (SFYResponder から継承)
このレスポンダを初期化します。
Void Invalidate( Void ) (SFYResponder から継承)
指定された領域を再描画領域に登録します。
Void 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 から継承)
このレスポンダが最背面に位置するかどうかを判定します。
Bool IsBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが最背面に位置するかどうかを判定します。
Bool IsBack( UInt32 id ) (SFYResponder から継承)
このレスポンダが最背面に位置するかどうかを判定します。
Bool IsBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが最背面に位置するかどうかを判定します。
Bool IsFrame( Void ) (SFYResponder から継承)
このレスポンダがアタッチメントフレームであるかどうかを判定します。
Bool IsFront( Void ) (SFYResponder から継承)
このレスポンダが最前面に位置するかどうかを判定します。
Bool IsFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが最前面に位置するかどうかを判定します。
Bool IsFront( UInt32 id ) (SFYResponder から継承)
このレスポンダが最前面に位置するかどうかを判定します。
Bool IsFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが最前面に位置するかどうかを判定します。
Bool IsNthBackward( SInt32 index ) (SFYResponder から継承)
このレスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthBackward( SInt32 index , UInt32 id ) (SFYResponder から継承)
このレスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthForward( SInt32 index ) (SFYResponder から継承)
このレスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthForward( SInt32 index , UInt32 id ) (SFYResponder から継承)
このレスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
Bool IsRoot( Void ) (SFYResponder から継承)
このレスポンダがルートレスポンダであるかどうかを判定します。
SFCError Recover( Void ) (SFYResponder から継承)
デバイス画面保存用ビットマップを使用してこのレスポンダとレスポンダ空間との交差領域を復元します。
SFCError RegisterHandler( SFXEventRangeConstRef range , SFYHandler::RuleRecConstRef rule ) (SFYResponder から継承)
指定されたハンドラをこのレスポンダに登録します。
SFCError RegisterHandler( SFXEventRangeConstRef range , SFYHandler::HandlerSPP spp , VoidPtr reference ) (SFYResponder から継承)
指定されたハンドラをこのレスポンダに登録します。
SFCError RegisterHandler( SFXEventRangeConstPtr range , SFYHandler::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承)
指定されたハンドラをこのレスポンダに登録します。
SFCError RegisterHandler( SFXEventRangeConstPtr range , SFYHandler::HandlerSPPConstPtr spp , VoidPtrConstPtr reference , SInt32 length ) (SFYResponder から継承)
指定されたハンドラをこのレスポンダに登録します。
SFCError RegisterTracer( SFXEventRangeConstRef range , SFYTracer::RuleRecConstRef rule ) (SFYResponder から継承)
指定された配信規則をこのレスポンダのトレーサに登録します。
SFCError RegisterTracer( SFXEventRangeConstRef range , SFYTracer::OrderEnum order , SFYTracer::StateEnum state , Bool overload ) (SFYResponder から継承)
指定された配信規則をこのレスポンダのトレーサに登録します。
SFCError RegisterTracer( SFXEventRangeConstPtr range , SFYTracer::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承)
指定された配信規則をこのレスポンダのトレーサに登録します。
SFCError RegisterTracer( SFXEventRangeConstPtr range , SFYTracer::OrderEnumConstPtr order , SFYTracer::StateEnumConstPtr state , BoolConstPtr overload , SInt32 length ) (SFYResponder から継承)
指定された配信規則をこのレスポンダのトレーサに登録します。
SFCError Render( Bool force = false ) (SFYResponder から継承)
このレスポンダ以下のレスポンダツリーをレスポンダ空間に再描画します。
Void SetBackgroundColor( SFXRGBColorConstRef param ) (SFYWidget から継承)
背景の色を設定します。
Void SetCurrentValue( SInt32 param ) (SFYControl から継承)
コントロールの現在値を設定します。
Void SetDistributer( SFYDistributerPtr param ) (SFYResponder から継承)
指定された配信エンジンをこのレスポンダに設定します。
Void SetFocusColor( SFXRGBColorConstRef param ) (SFYLabelControl から継承)
フォーカス状態にあるときのラベルコントロールの内枠の色を設定します。
SFCError SetFrame( SFYResponderSmpConstRef param ) (SFYResponder から継承)
このレスポンダにフレームを装着します。
Void SetID( UInt32 param ) (SFYResponder から継承)
指定された ID をこのレスポンダに設定します。
Void SetMaximumValue( SInt32 param ) (SFYControl から継承)
コントロールの最大値を設定します。
Void SetMinimumValue( SInt32 param ) (SFYControl から継承)
コントロールの最小値を設定します。
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 から継承)
指定された領域をこのレスポンダの仮想領域に設定します。
SFCError Snapshot( SFBBitmapSmpConstRef bitmap ) (SFYResponder から継承)
デバイス画面保存用ビットマップからこのレスポンダとレスポンダ空間との交差領域のスナップショットを取得します。
Void Terminate( Void ) (SFYResponder から継承)
このレスポンダの終了処理を行います。
Void ToBack( Void ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最背面に移動します。
Void ToBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最背面に移動します。
Void ToBack( UInt32 id ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最背面に移動します。
Void ToBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最背面に移動します。
Void ToFront( Void ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最前面に移動します。
Void ToFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最前面に移動します。
Void ToFront( UInt32 id ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最前面に移動します。
Void ToFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最前面に移動します。
Void ToNthBackward( SInt32 index ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで背面から数えて指定された位置に移動します。
Void ToNthBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで背面から数えて指定された位置に移動します。
Void ToNthBackward( SInt32 index , UInt32 id ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで背面から数えて指定された位置に移動します。
Void ToNthBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで背面から数えて指定された位置に移動します。
Void ToNthForward( SInt32 index ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで前面から数えて指定された位置に移動します。
Void ToNthForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで前面から数えて指定された位置に移動します。
Void ToNthForward( SInt32 index , UInt32 id ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで前面から数えて指定された位置に移動します。
Void ToNthForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで前面から数えて指定された位置に移動します。
Void UnregisterHandler( SFXEventRangeConstRef range , SFYHandler::RuleRecConstRef rule ) (SFYResponder から継承)
このレスポンダから指定されたハンドラの登録を解除します。
Void UnregisterHandler( SFXEventRangeConstRef range , SFYHandler::HandlerSPP spp , VoidPtr reference ) (SFYResponder から継承)
このレスポンダから指定されたハンドラの登録を解除します。
Void UnregisterHandler( SFXEventRangeConstPtr range , SFYHandler::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承)
このレスポンダから指定されたハンドラの登録を解除します。
Void UnregisterHandler( SFXEventRangeConstPtr range , SFYHandler::HandlerSPPConstPtr spp , VoidPtrConstPtr reference , SInt32 length ) (SFYResponder から継承)
このレスポンダから指定されたハンドラの登録を解除します。
Void UnregisterTracer( SFXEventRangeConstRef range ) (SFYResponder から継承)
このレスポンダのトレーサから指定された配信規則の登録を解除します。
Void UnregisterTracer( SFXEventRangeConstPtr range , SInt32 length ) (SFYResponder から継承)
このレスポンダのトレーサから指定された配信規則の登録を解除します。
プロテクト関数
SFYMultipleTextWidgetSmpConstRef GetWidget( Void )
複数行テキスト描画用に内部で保持しているテキストウィジェットを取得します。
Void HandleBoundOptimize( SFXRectanglePtr rectangle )
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベントを受信したときに呼び出される関数です(指定した矩形に収まる範囲内で最適な領域を計算します)。
Void HandleBoundRequest( SFXRectanglePtr rectangle )
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベントを受信したときに呼び出される関数です(最適な領域を計算します)。
Void HandleBoundVirtual( Void )
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントを受信したときに呼び出される関数です (仮想領域が変化したときの処理を行います)。
Void HandleOperateKey( Void )
操作キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
Bool HandlePageDownKey( Void )
PageDown キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
Bool HandlePageUpKey( Void )
PageUp キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
Void HandleRenderRequest( SFXGraphicsPtr graphics )
描画イベントを受信したときに呼び出される関数です(レスポンダを描画します)。
Bool HandleScrollDownKey( Void )
ScrollDown キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
Bool HandleScrollUpKey( Void )
ScrollUp キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
Bool HandleSnapDownKey( Void )
SnapDown キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
Bool HandleSnapUpKey( Void )
SnapUp キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
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 から継承)
このレスポンダのスマートポインタを取得します。
Void HandleBoundGlobal( SFXRectangleConstRef rectangle ) (SFYWidget から継承)
[非推奨(廃止予定 API)] グローバル領域が変化したときに呼び出される関数です。
Void HandleBoundReal( Void ) (SFYControl から継承)
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベントを受信したときに呼び出される関数です (実領域が変化したときの処理を行います)。
Void SetType( SFCType param ) (SFYResponder から継承)
指定された値をこのレスポンダのタイプに設定します。
CodeEnum
SFZMultipleTextLabelControl クラスを表す定数です。
DefaultEnum
各種パラメータのデフォルト値を表します。
HorizontalEnum
水平方向のアライメントを表す定数です。
VerticalEnum
垂直方向のアライメントを表す定数です。

SFZMultipleTextLabelControl::SFZMultipleTextLabelControl
SFZMultipleTextLabelControl クラスのコンストラクタです。
[ protected, explicit ]
SFZMultipleTextLabelControl(Void);

解説

このコンストラクタは、以下の初期化処理を行います。

  1. タイプを "cmtl" に設定します。
  2. テキスト描画用に内部で子レスポンダとして保持する SFYMultipleTextWidget インスタンスを生成します。
  3. SFYMultipleTextWidget インスタンスの状態を「可視+活性+操作不能+非フォーカス」に設定します。
  4. テキストの文字列を ""[空文字列] に設定します。
  5. テキストのフォントを AEE_FONT_NORMAL に設定します。
  6. テキストの色を SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色] に設定します。
  7. テキストの水平アライメントを SFZMultipleTextLabelControl::DEFAULT_HORIZONTAL に設定します。
  8. テキストの垂直アライメントを SFZMultipleTextLabelControl::DEFAULT_VERTICAL に設定します。
  9. テキストのスクロール移動量を SFZMultipleTextLabelControl::DEFAULT_STEP に設定します。

内部実装

このコンストラクタの内部実装は以下の通りです。

/*protected */SFZMultipleTextLabelControl::SFZMultipleTextLabelControl(Void) static_throws
{
    static SFXEventRange::AtomRecConst          trange[] = {
        #if TARGET_VERSION_GE(3, 0, 0)
        {       SFEVT_KEY_PRESS,      SFEVT_KEY_RELEASE,          SFP16_BEGIN,            SFP16_END},
        #else
        {       SFEVT_KEY_PRESS,         SFEVT_KEY_HELD,          SFP16_BEGIN,            SFP16_END},
        #endif
        {             SFEVT_KEY,              SFEVT_KEY,          SFP16_BEGIN,            SFP16_END},
        { SFEVT_RESPONDER_FOCUS,  SFEVT_RESPONDER_FOCUS,  SFP16_FOCUS_FORWARD,  SFP16_FOCUS_FORWARD},
        { SFEVT_RESPONDER_FOCUS,  SFEVT_RESPONDER_FOCUS, SFP16_FOCUS_BACKWARD, SFP16_FOCUS_BACKWARD}
    };
    static SFXEventRange::AtomRecConst          crange[] = {
        { SFEVT_RESPONDER_STYLE,  SFEVT_RESPONDER_STYLE,          SFP16_BEGIN,            SFP16_END}
    };
    SFYHandler::RuleRec                         trule[lengthof(trange)];
    SFYHandler::RuleRec                         crule[lengthof(crange)];
    SFCError                                    error;

    if (static_try()) {
        SetType(CODE_TYPE);
        trule[0].spp = XANDLER_FUNCTION(OnShield);
        trule[0].reference = this;
        trule[1].spp = XANDLER_FUNCTION(OnKey);
        trule[1].reference = this;
        trule[2].spp = XANDLER_FUNCTION(OnFocusForward);
        trule[2].reference = this;
        trule[3].spp = XANDLER_FUNCTION(OnFocusBackward);
        trule[3].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
        if (static_try()) {
            if ((_widget = SFYMultipleTextWidget::NewInstance(&error)) != null) {
                crule[0].spp = XANDLER_FUNCTION(OnWidgetStyle);
                crule[0].reference = this;
                static_throw(_widget->RegisterHandler(atomic_cast(crange), crule, lengthof(crange)));
                if (static_try()) {
                    static_throw(_widget->SetParent(GetThis()));
                    if (static_try()) {
                        SetPropertyTransparent(true);
                        _widget->SetState(true, true, false, false);
                        _key.sup = AVK_UP;
                        _key.sdown = AVK_DOWN;
                        _key.pup = AVK_TXPGUP;
                        _key.pdown = AVK_TXPGDOWN;
                        _key.nup = AVK_TXHOME;
                        _key.ndown = AVK_END;
                        Relocate();
                    }
                }
            }
            else {
                static_throw(error);
            }
        }
    }
}// SFZMultipleTextLabelControl::SFZMultipleTextLabelControl //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFZMultipleTextLabelControl, OnShield, invoker, event)
{
    unused(invoker);
    return (event.GetP16() == _key.sup || event.GetP16() == _key.sdown || event.GetP16() == _key.pup || event.GetP16() == _key.pdown || event.GetP16() == _key.nup || event.GetP16() == _key.ndown);
}// XANDLER_IMPLEMENT_BOOLEVENT(SFZMultipleTextLabelControl, OnShield) //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFZMultipleTextLabelControl, OnKey, invoker, event)
{
    Bool                                        result(false);

    unused(invoker);
    if (event.GetP16() == _key.sup) {
        result = HandleScrollUpKey();
    }
    else if (event.GetP16() == _key.sdown) {
        result = HandleScrollDownKey();
    }
    else if (event.GetP16() == _key.pup) {
        result = HandlePageUpKey();
    }
    else if (event.GetP16() == _key.pdown) {
        result = HandlePageDownKey();
    }
    else if (event.GetP16() == _key.nup) {
        result = HandleSnapUpKey();
    }
    else if (event.GetP16() == _key.ndown) {
        result = HandleSnapDownKey();
    }
    return result;
}// XANDLER_IMPLEMENT_BOOLEVENT(SFZMultipleTextLabelControl, OnKey) //

/*private */XANDLER_IMPLEMENT_VOIDFOCUS(SFZMultipleTextLabelControl, OnFocusForward, invoker, reason, focus)
{
    unused(invoker);
    unused(reason);
    if (focus) {
        _widget->SnapUp();
    }
    return;
}// XANDLER_IMPLEMENT_VOIDFOCUS(SFZMultipleTextLabelControl, OnFocusForward) //

/*private */XANDLER_IMPLEMENT_VOIDFOCUS(SFZMultipleTextLabelControl, OnFocusBackward, invoker, reason, focus)
{
    unused(invoker);
    unused(reason);
    if (focus) {
        _widget->SnapDown();
    }
    return;
}// XANDLER_IMPLEMENT_VOIDFOCUS(SFZMultipleTextLabelControl, OnFocusBackward) //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZMultipleTextLabelControl, OnWidgetStyle, invoker, reason)
{
    unused(invoker);
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_STYLE, reason, 0), true);
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZMultipleTextLabelControl, OnWidgetStyle) //

/*private */Void SFZMultipleTextLabelControl::Relocate(Void)
{
    _widget->SetRealBound(GetLocalBound().Deflate(GetFocusMargin()));
    return;
}// SFZMultipleTextLabelControl::Relocate //

参照

SFYResponder::SetType | SFZMultipleTextLabelControl::CodeEnum | SFYResponder::SetParent | SFYResponder::SetState | SFZMultipleTextLabelControl::SetText | SFZMultipleTextLabelControl::SetFont | SFZMultipleTextLabelControl::SetTextColor | SFZMultipleTextLabelControl::SetHorizontalAlign | SFZMultipleTextLabelControl::SetVerticalAlign | SFZMultipleTextLabelControl::SetScrollStep | SFZMultipleTextLabelControl::HorizontalEnum | SFZMultipleTextLabelControl::VerticalEnum | SFZMultipleTextLabelControl::DefaultEnum | SFYMultipleTextWidget::NewInstance | SFYMultipleTextWidget | SFXRGBColor | タイプ | 状態


SFZMultipleTextLabelControl::~SFZMultipleTextLabelControl
SFZMultipleTextLabelControl クラスのデストラクタです。
[ protected, virtual ]
virtual ~SFZMultipleTextLabelControl(Void);

解説

このデストラクタは、何も行いません。

内部実装

このデストラクタの内部実装は以下の通りです。

/*protected virtual */SFZMultipleTextLabelControl::~SFZMultipleTextLabelControl(Void)
{
}// SFZMultipleTextLabelControl::~SFZMultipleTextLabelControl //

SFZMultipleTextLabelControl::GetFont
フォントを取得します。
[ public, const ]
AEEFont GetFont(Void);

戻り値

フォント。

解説

この関数は、フォントを取得します。

参照

SFZMultipleTextLabelControl::SetFont | BREW API AEEFont


SFZMultipleTextLabelControl::GetHorizontalAlign
水平アライメントの値を取得します。
[ public, const ]
HorizontalEnum GetHorizontalAlign(Void);

戻り値

水平アライメントの値。

解説

この関数は、水平アライメントの値を取得します。

参照

SFZMultipleTextLabelControl::SetHorizontalAlign | SFZMultipleTextLabelControl::HorizontalEnum


SFZMultipleTextLabelControl::GetPageDownKey
複数行テキストを下方向に 1 ページ分スクロールする PageDown キーを取得します。
[ public, const ]
AVKType GetPageDownKey(Void);

戻り値

複数行テキストを下方向に 1 ページ分スクロールする PageDown キー。

解説

この関数は、複数行テキストを下方向に 1 ページ分スクロールする PageDown キーを取得します。

参照

SFZMultipleTextLabelControl::SetPageDownKey


SFZMultipleTextLabelControl::GetPageUpKey
複数行テキストを上方向に 1 ページ分スクロールする PageUp キーを取得します。
[ public, const ]
AVKType GetPageUpKey(Void);

戻り値

複数行テキストを上方向に 1 ページ分スクロールする PageUp キー。

解説

この関数は、複数行テキストを上方向に 1 ページ分スクロールする PageUp キーを取得します。

参照

SFZMultipleTextBoxControl::SetPageUpKey


SFZMultipleTextLabelControl::GetScrollDownKey
複数行テキストを下方向にスクロールステップ分スクロールする ScrollDown キーを取得します。
[ public, const ]
AVKType GetScrollDownKey(Void);

戻り値

複数行テキストを下方向にスクロールステップ分スクロールする ScrollDown キー。

解説

この関数は、複数行テキストを下方向にスクロールステップ分スクロールする ScrollDown キーを取得します。

参照

SFZMultipleTextLabelControl::SetScrollDownKey | SFZMultipleTextLabelControl::SetScrollStep


SFZMultipleTextLabelControl::GetScrollStep
スクロール移動量を取得します。[単位:ピクセル]
[ public, const ]
SInt16 GetScrollStep(Void);

戻り値

スクロール移動量。[単位:ピクセル]

解説

この関数は、スクロール移動量を取得します。[単位:ピクセル]

参照

SFZMultipleTextLabelControl::SetScrollStep


SFZMultipleTextLabelControl::GetScrollUpKey
複数行テキストを上方向にスクロールステップ分スクロールする ScrollUp キーを取得します。
[ public, const ]
AVKType GetScrollUpKey(Void);

戻り値

複数行テキストを上方向にスクロールステップ分スクロールする ScrollUp キー。

解説

この関数は、複数行テキストを上方向にスクロールステップ分スクロールする ScrollUp キーを取得します。

参照

SFZMultipleTextLabelControl::SetScrollUpKey | SFZMultipleTextLabelControl::SetScrollStep


SFZMultipleTextLabelControl::GetSnapDownKey
複数行テキストを下端までスクロールする SnapDown キーを取得します。
[ public, const ]
AVKType GetSnapDownKey(Void);

戻り値

複数行テキストを下端までスクロールする SnapDown キー。

解説

この関数は、複数行テキストを下端までスクロールする SnapDown キーを取得します。

参照

SFZMultipleTextLabelControl::SetSnapDownKey


SFZMultipleTextLabelControl::GetSnapUpKey
複数行テキストを上端までスクロールする SnapUp キーを取得します。
[ public, const ]
AVKType GetSnapUpKey(Void);

戻り値

複数行テキストを上端までスクロールする SnapUp キー。

解説

この関数は、複数行テキストを上端までスクロールする SnapUp キーを取得します。

参照

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);

戻り値

複数行テキスト描画用に子レスポンダとして内部で保持する SFYMultipleTextWidget インスタンス。

解説

この関数は、 複数行テキスト描画用に子レスポンダとして内部で保持する SFYMultipleTextWidget インスタンスを返します。

複数行テキストの描画は、SFYMultipleTextWidget インスタンスに委譲して処理します。

参照

SFYMultipleTextWidget


SFZMultipleTextLabelControl::HandleBoundOptimize
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベントを受信したときに呼び出される関数です(指定した矩形に収まる範囲内で最適な領域を計算します)。
[ protected, virtual, const ]
Void HandleBoundOptimize(
    SFXRectanglePtr rectangle   // 矩形
);

解説

この関数は、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] を受信したときに呼び出されます。

引数 rectangle で指定した矩形領域に収まる範囲内で、レスポンダの最適な領域を計算します。

計算結果のレスポンダに最適なサイズは、rectangle 引数の size 要素(サイズ)に格納されます。 なお、領域イベントの P32 パラメータとして渡された rectangle 引数の origin 要素(始点)はこの関数内で変更しないことを推奨します。

デフォルトの実装は以下の通りです。

  1. 引数の矩形をフォーカス枠用に上下左右に 1 ピクセルずつ縮小した矩形を計算します。
  2. 1. で計算した矩形を使用して、 SFYMultipleTextWidget::HandleBoundOptimize 関数と同等の方法で、 SFZMultipleTextLabelControl::SetText 関数と SFZMultipleTextLabelControl::SetFont 関数で設定した複数行テキストの最適な矩形サイズを計算します。
  3. 2. で計算した矩形をフォーカス枠用に上下左右に 1 ピクセルずつ拡大した矩形を計算します。
  4. 3.で計算した矩形を返します。
[Note] 領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベント]

SFYResponder::GetSuitableBound 関数は、 引数にヒント領域を指定した場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] をレスポンダに送信します。

SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundOptimize 仮想関数が呼び出されます。

※ 領域イベントの P32 パラメータ rectangle にはヒント領域が初期設定されています。

[Note] (SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベント受信時の最適な領域計算

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

最適な領域の計算は、最初に SFYWidget::HandleBoundOptimize 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。

領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundOptimize 仮想関数をオーバーライドして処理を記述します。

参照: SFYMultipleTextWidget::HandleBoundOptimize

内部実装

この関数の内部実装は以下の通りです。

SFYMultipleTextWidgetSmp        _widget;

/*protected virtual */Void SFZMultipleTextLabelControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    rectangle->Deflate(GetFocusMargin());
    rectangle->SetSize(_widget->GetSuitableBound(*rectangle).GetSize());
    rectangle->Inflate(GetFocusMargin());
    return;
}// SFZMultipleTextLabelControl::HandleBoundOptimize //

参照

SFYResponder::GetSuitableBound | SFYLabelControl::GetFocusMargin | SFZMultipleTextLabelControl::SetText | SFZMultipleTextLabelControl::SetFont | SFYMultipleTextWidget::HandleBoundOptimize | SFYMultipleTextWidget | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND]


SFZMultipleTextLabelControl::HandleBoundRequest
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベントを受信したときに呼び出される関数です(最適な領域を計算します)。
[ protected, virtual, const ]
Void HandleBoundRequest(
    SFXRectanglePtr rectangle   // 計算された座標
);

解説

この関数は、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] を受信したときに呼び出されます。

レスポンダの最適な領域を計算します。

計算結果のレスポンダに最適なサイズは、rectangle 引数の size 要素(サイズ)に格納されます。 なお、領域イベントの P32 パラメータとして渡された rectangle 引数の origin 要素(始点)はこの関数内で変更しないことを推奨します。

デフォルトの実装は以下の通りです。

  1. SFYMultipleTextWidget::HandleBoundRequest 関数と同等の方法で、 SFZMultipleTextLabelControl::SetText 関数と SFZMultipleTextLabelControl::SetFont 関数で設定した複数行テキストの最適な矩形サイズを計算します。
  2. 1. で計算した矩形をフォーカス枠用に上下左右に 1 ピクセルずつ拡大した矩形を計算します。
  3. 2. で計算した矩形を返します。
[Caution] 前提条件

予め SFYResponder::SetRealBound 関数を使用して実領域(=ローカル領域※)を設定する必要があります。 設定された実領域の横幅は領域計算に必要なヒント値として利用されます。 通常、実領域の横幅には [ 使用しているフォントの横幅 + ラベル枠の幅 × 2 ](ラベル枠の幅は 2 ピクセル)以上の値を設定します。

仮想領域を設定しない限り、 実領域はローカル領域と同じです。また、ヒント値として使われる実領域を設定する際は、 SFYLabelControl::GetFocusMargin 関数で取得できるラベル枠の幅も考慮する必要があります。

参照: 複数行のテキストを表示するレスポンダに最適な大きさを取得する

[Note] 領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント]

SFYResponder::GetSuitableBound 関数は、 引数に何も指定しない場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] をレスポンダに送信します。

SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundRequest 仮想関数が呼び出されます。

※ 領域イベントの P32 パラメータ rectangle には実領域が初期設定されています。

[Tip] Tip
実領域のデフォルト値は SFXRectangle(0, 0, 0, 0) です。

[Note] (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント受信時の最適な領域計算

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

最適な領域の計算は、最初に SFYWidget::HandleBoundRequest 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。

領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundRequest 仮想関数をオーバーライドして処理を記述します。

参照: SFYMultipleTextWidget::HandleBoundRequest

内部実装

この関数の内部実装は以下の通りです。

SFYMultipleTextWidgetSmp        _widget;

/*protected virtual */Void SFZMultipleTextLabelControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    rectangle->Deflate(GetFocusMargin());
    rectangle->SetSize(_widget->GetSuitableBound().GetSize());
    rectangle->Inflate(GetFocusMargin());
    return;
}// SFZMultipleTextLabelControl::HandleBoundRequest //

参照

SFYResponder::GetSuitableBound | SFYLabelControl::GetFocusMargin | SFZMultipleTextLabelControl::SetText | SFZMultipleTextLabelControl::SetFont | SFYMultipleTextWidget::HandleBoundRequest | SFYLabelControl::GetFocusMargin | SFYMultipleTextWidget | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND] | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND] | 実領域 | ローカル領域 | 仮想領域 | 複数行のテキストを表示するレスポンダに最適な大きさを取得する


SFZMultipleTextLabelControl::HandleBoundVirtual
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントを受信したときに呼び出される関数です (仮想領域が変化したときの処理を行います)。
[ protected, virtual ]
Void HandleBoundVirtual(Void);

解説

この関数は、領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] を受信したときに呼び出されます。

仮想領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、 ラベルコントロールのコンテンツ領域を内部で保持するテキストウィジェット(SFYMultipleTextWidget)の実領域として設定します。

SFZMultipleTextLabelControl::SetText 関数によって設定されたテキストは、 内部でテキストウィジェット(SFYMultipleTextWidget)として保持されます。

[Note] 領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベント]

SFYResponder::SetRealBound / SFYResponder::SetVirtualBound 関数は、 この関数内の処理により仮想領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] をレスポンダに送信します。

SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundVirtual 仮想関数が呼び出されます。

※ 領域イベントの P32 パラメータ rectangle には変更後の仮想領域が設定されています。

[Note] 仮想領域の変更処理

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

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

領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

SFYMultipleTextWidgetSmp        _widget;

/*protected virtual */Void SFZMultipleTextLabelControl::HandleBoundVirtual(Void)
{
    Relocate();
    return;
}// SFZMultipleTextLabelControl::HandleBoundVirtual //

/*private */Void SFZMultipleTextLabelControl::Relocate(Void)
{
    _widget->SetRealBound(GetLocalBound().Deflate(GetFocusMargin()));
    return;
}// SFZMultipleTextLabelControl::Relocate //

参照

SFZMultipleTextLabelControl::SetText | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | SFYMultipleTextWidget | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND]


SFZMultipleTextLabelControl::HandleOperateKey
操作キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
[ protected, virtual ]
Void HandleOperateKey(Void);

解説

この関数は、SFYLabelControl::SetOperateKey 関数で設定した操作キーの SFEVT_KEY イベント (キーイベント[SFEVT_KEY])を受信したときに呼び出されます。

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

デフォルトの実装では、テキストのスクロール位置を初期化し、 自分自身に結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())] を送信します。

内部実装

この関数の内部実装は以下の通りです。

SFYMultipleTextWidgetSmp        _widget;

/*protected virtual */Void SFZMultipleTextLabelControl::HandleOperateKey(Void)
{
    _widget->SnapAlign();
    InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, GetCurrentValue()), false);
    return;
}// SFZMultipleTextLabelControl::HandleOperateKey //

参照

SFYLabelControl::SetOperateKey | SFYControl::GetCurrentValue | SFYMultipleTextWidget | SFXEvent | キーイベント[SFEVT_KEY] | 結果イベント [SFEVT_RESPONDER_RESULT]


SFZMultipleTextLabelControl::HandlePageDownKey
PageDown キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
[ protected, virtual ]
Bool HandlePageDownKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetPageDownKey 関数で設定した PageDown キーの SFEVT_KEY イベント (キーイベント[SFEVT_KEY])を受信したときに呼び出されます。

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

デフォルトの実装では、SFZMultipleTextLabelControl::PageDown 関数を呼び出して、複数行テキストを下方向に 1 ページスクロールします。

内部実装

この関数の内部実装は以下の通りです。

SFYMultipleTextWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleTextLabelControl::HandlePageDownKey(Void)
{
    return _widget->PageDown();
}// SFZMultipleTextLabelControl::HandlePageDownKey //

参照

SFZMultipleTextLabelControl::SetPageDownKey | SFZMultipleTextLabelControl::PageDown | SFYMultipleTextWidget | SFXEvent | キーイベント[SFEVT_KEY]


SFZMultipleTextLabelControl::HandlePageUpKey
PageUp キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
[ protected, virtual ]
Bool HandlePageUpKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetPageUpKey 関数で設定した PageUp キーの SFEVT_KEY イベント (キーイベント[SFEVT_KEY])を受信したときに呼び出されます。

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

デフォルトの実装では、SFZMultipleTextLabelControl::PageUp 関数を呼び出して、複数行テキストを上方向に 1 ページスクロールします。

内部実装

この関数の内部実装は以下の通りです。

SFYMultipleTextWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleTextLabelControl::HandlePageUpKey(Void)
{
    return _widget->PageUp();
}// SFZMultipleTextLabelControl::HandlePageUpKey //

参照

SFZMultipleTextLabelControl::SetPageUpKey | SFZMultipleTextLabelControl::PageUp | SFYMultipleTextWidget | SFXEvent | キーイベント[SFEVT_KEY]


SFZMultipleTextLabelControl::HandleRenderRequest
描画イベントを受信したときに呼び出される関数です(レスポンダを描画します)。
[ protected, virtual, const ]
Void HandleRenderRequest(
    SFXGraphicsPtr graphics   // グラフィックスオブジェクト
);

解説

この関数は、 描画イベント [SFXEvent(SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST, graphics)] を受信したときに呼び出されます。

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

デフォルトの実装は以下の通りです。

  1. SFYLabelControl::DrawFocus 関数を呼び出してフォーカス状態にあるときのラベルコントロールの枠を描画します。
  2. ラベルコントロールの枠で囲まれるコンテンツ領域に SFYSingleTextWidget::HandleRenderRequest 関数による処理によってテキストを描画します。
  3. テキストは、 SFZMultipleTextLabelControl::SetText 関数で設定します。
  4. コンテンツ領域内でのテキストの配置は、 SFZMultipleTextLabelControl::SetHorizontalAlign 関数、 SFZMultipleTextLabelControl::SetVerticalAlign 関数で設定します。
  5. テキストのフォントと色は、 SFZMultipleTextLabelControl::SetFont 関数、 SFZMultipleTextLabelControl::SetTextColor 関数で設定します。
  6. 非活性状態のとき、テキストの色は SFZMultipleTextLabelControl::SetTextColor 関数の説明にある方法で計算された色になります。
  7. 実際のテキストの描画は、 このクラスが内部で保持する SFYMultipleTextWidget クラスに委譲して行われます。
[Note] レスポンダの描画手順

  1. SFYResponder::Invalidate 関数を使用して再描画領域を登録します。
  2. イベントループの最後、 アプリ開始/レジュームまたは優先的イベントハンドラ終了のタイミング、 あるいは、コールバックなどのイベントループの外で、 自動的に、あるいは、明示的に SFYResponder::Render 関数を呼び出します。
  3. 描画エンジンが起動されます。
  4. 再描画が必要なレスポンダだけが描画イベントを受信します。
  5. SFYWidget クラスを継承するレスポンダが描画イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した描画ハンドラの処理により、 SFYWidget::HandleRenderRequest 仮想関数が呼び出されます。 その後、描画ハンドラが登録した順に呼び出されます。
  6. 実際にレスポンダが描画されます。

[Tip] Tip
描画ハンドラの宣言と登録の手間を省けるので、 通常は SFYWidget::HandleRenderRequest 仮想関数だけを利用してレスポンダを描画します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZMultipleTextLabelControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawFocus(graphics, GetLocalBound());
    return;
}// SFZMultipleTextLabelControl::HandleRenderRequest //

参照

SFYLabelControl::DrawFocus | SFZMultipleTextLabelControl::SetText | SFZMultipleTextLabelControl::SetHorizontalAlign | SFZMultipleTextLabelControl::SetVerticalAlign | SFZMultipleTextLabelControl::SetFont | SFZMultipleTextLabelControl::SetTextColor | SFYMultipleTextWidget::HandleRenderRequest | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | SFYMultipleTextWidget | SFXEvent | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理


SFZMultipleTextLabelControl::HandleScrollDownKey
ScrollDown キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
[ protected, virtual ]
Bool HandleScrollDownKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetScrollDownKey 関数で設定した ScrollDown キーの SFEVT_KEY イベント (キーイベント[SFEVT_KEY])を受信したときに呼び出されます。

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

デフォルトの実装では、SFZMultipleTextLabelControl::ScrollDown 関数を呼び出して、複数行テキストを下方向にスクロールステップ分スクロールします。

内部実装

この関数の内部実装は以下の通りです。

SFYMultipleTextWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleTextLabelControl::HandleScrollDownKey(Void)
{
    return _widget->ScrollDown();
}// SFZMultipleTextLabelControl::HandleScrollDownKey //

参照

SFZMultipleTextLabelControl::SetScrollDownKey | SFZMultipleTextLabelControl::ScrollDown | SFYMultipleTextWidget | SFXEvent | キーイベント[SFEVT_KEY]


SFZMultipleTextLabelControl::HandleScrollUpKey
ScrollUp キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
[ protected, virtual ]
Bool HandleScrollUpKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetScrollUpKey 関数で設定した ScrollUp キーの SFEVT_KEY イベント (キーイベント[SFEVT_KEY])を受信したときに呼び出されます。

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

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

内部実装

この関数の内部実装は以下の通りです。

SFYMultipleTextWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleTextLabelControl::HandleScrollUpKey(Void)
{
    return _widget->ScrollUp();
}// SFZMultipleTextLabelControl::HandleScrollUpKey //

参照

SFZMultipleTextLabelControl::SetScrollUpKey | SFZMultipleTextLabelControl::ScrollUp | SFYMultipleTextWidget | SFXEvent | キーイベント[SFEVT_KEY]


SFZMultipleTextLabelControl::HandleSnapDownKey
SnapDown キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
[ protected, virtual ]
Bool HandleSnapDownKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetSnapDownKey 関数で設定した SnapDown キーの SFEVT_KEY イベント (キーイベント[SFEVT_KEY])を受信したときに呼び出されます。

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

デフォルトの実装では、SFZMultipleTextLabelControl::SnapDown 関数を呼び出して、複数行テキストを下端までスクロールします。

内部実装

この関数の内部実装は以下の通りです。

SFYMultipleTextWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleTextLabelControl::HandleSnapDownKey(Void)
{
    return _widget->SnapDown();
}// SFZMultipleTextLabelControl::HandleSnapDownKey //

参照

SFZMultipleTextLabelControl::SetSnapDownKey | SFZMultipleTextLabelControl::SnapDown | SFYMultipleTextWidget | SFXEvent | キーイベント[SFEVT_KEY]


SFZMultipleTextLabelControl::HandleSnapUpKey
SnapUp キーの SFEVT_KEY イベントを受信したときに呼び出される関数です。
[ protected, virtual ]
Bool HandleSnapUpKey(Void);

解説

この関数は、SFZMultipleTextLabelControl::SetSnapUpKey 関数で設定した SnapUp キーの SFEVT_KEY イベント (キーイベント[SFEVT_KEY])を受信したときに呼び出されます。

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

デフォルトの実装では、SFZMultipleTextLabelControl::SnapUp 関数を呼び出して、複数行テキストを上端までスクロールします。

内部実装

この関数の内部実装は以下の通りです。

SFYMultipleTextWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleTextLabelControl::HandleSnapUpKey(Void)
{
    return _widget->SnapUp();
}// SFZMultipleTextLabelControl::HandleSnapUpKey //

参照

SFZMultipleTextLabelControl::SetSnapUpKey | SFZMultipleTextLabelControl::SnapUp | SFYMultipleTextWidget | SFXEvent | キーイベント[SFEVT_KEY]


SFZMultipleTextLabelControl::NewInstance
新しいインスタンスを作成します。
[ public, static ]
SFZMultipleTextLabelControlSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);

引数

exception

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

戻り値

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

解説

この関数は、SFZMultipleTextLabelControl クラスの新しいインスタンスを作成します。

インスタンスの作成に成功した場合は null 以外のポインタを返します。 失敗した場合は、null ポインタを返します。

exception 引数を指定した場合、 この引数にはエラー値が返ります。

使用例

以下は、複数行テキストラベルのインスタンスを生成するためのコードです。

// 複数行テキストラベルのインスタンスを生成する
SFZMultipleTextLabelControlSmp _multipletextlabel;
SFCError error;

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

SFZMultipleTextLabelControl::PageDown
複数行テキストを下方向に 1 ページ分スクロールします。
[ public ]
Bool PageDown(Void);

戻り値

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

解説

この関数は、複数行テキストを下方向に 1 ページ分スクロールします。

参照

SFZMultipleTextLabelControl::PageUp | SFYMultipleTextWidget::PageDown


SFZMultipleTextLabelControl::PageUp
複数行テキストを上方向に 1 ページ分スクロールします。
[ public ]
Bool PageUp(Void);

戻り値

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

解説

この関数は、複数行テキストを上方向に 1 ページ分スクロールします。

参照

SFZMultipleTextLabelControl::PageDown | SFYMultipleTextWidget::PageUp


SFZMultipleTextLabelControl::ScrollDown
複数行テキストを下方向にスクロールステップ分スクロールします。
[ public ]
Bool ScrollDown(Void);

戻り値

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

解説

この関数は、複数行テキストを下方向にスクロールステップ分スクロールします

参照

SFZMultipleTextLabelControl::SetScrollStep | SFZMultipleTextLabelControl::ScrollUp | SFYMultipleTextWidget::ScrollDown


SFZMultipleTextLabelControl::ScrollUp
複数行テキストを上方向にスクロールステップ分スクロールします。
[ public ]
Bool ScrollUp(Void);

戻り値

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

解説

この関数は、複数行テキストを上方向にスクロールステップ分スクロールします。

参照

SFZMultipleTextLabelControl::SetScrollStep | SFZMultipleTextLabelControl::ScrollDown | SFYMultipleTextWidget::ScrollUp


SFZMultipleTextLabelControl::SetFont
フォントを設定します。
[ public ]
Void SetFont(
    AEEFont param   // 設定する値
);

解説

この関数は、フォントを設定します。

デフォルト値: AEE_FONT_NORMAL

参照

SFZMultipleTextLabelControl::GetFont | BREW API AEEFont


SFZMultipleTextLabelControl::SetHorizontalAlign
水平アライメントを設定します。
[ public ]
Void SetHorizontalAlign(
    HorizontalEnum param   // 設定する値
);

解説

この関数は、水平アライメントを設定します。

デフォルト値: SFYMultipleTextWidget::DEFAULT_HORIZONTAL

SFYMultipleTextWidget::DEFAULT_HORIZONTAL の値は SFYMultipleTextWidget::HorizontalEnum を参照してください。

参照

SFZMultipleTextLabelControl::GetHorizontalAlign | SFZMultipleTextLabelControl::HorizontalEnum | SFYMultipleTextWidget::HorizontalEnum


SFZMultipleTextLabelControl::SetPageDownKey
複数行テキストを下方向に 1 ページ分スクロールする PageDown キーを設定します。
[ public ]
Void SetPageDownKey(
    AVKType param   // 設定するキー
);

解説

この関数は、複数行テキストを下方向に 1 ページ分スクロールする PageDown キーを設定します。

デフォルト値: AVK_TXPGDOWN

参照

SFZMultipleTextLabelControl::GetPageDownKey


SFZMultipleTextLabelControl::SetPageUpKey
複数行テキストを上方向に 1 ページ分スクロールする PageUp キーを設定します。
[ public ]
Void SetPageUpKey(
    AVKType param   // 設定するキー
);

解説

この関数は、 複数行テキストを上方向に 1 ページ分スクロールする PageUp キーを設定します。

デフォルト値: AVK_TXPGUP

参照

SFZMultipleTextLabelControl::GetPageUpKey


SFZMultipleTextLabelControl::SetScrollDownKey
複数行テキストを下方向にスクロールステップ分スクロールする ScrollDown キーを設定します。
[ public ]
Void SetScrollDownKey(
    AVKType param   // 設定するキー
);

解説

この関数は、 複数行テキストを下方向にスクロールステップ分スクロールする ScrollDown キーを設定します。

デフォルト値: AVK_DOWN

参照

SFZMultipleTextLabelControl::GetScrollDownKey | SFZMultipleTextLabelControl::SetScrollStep


SFZMultipleTextLabelControl::SetScrollStep
スクロール移動量を設定します。[単位:ピクセル]
[ public ]
Void SetScrollStep(
    SInt16 param   // 設定する値
);

解説

この関数は、1 回のスクロールで移動するピクセル数を設定します。

−1(デフォルト値)を設定すると、使用しているフォントの高さがスクロール移動量となります。

デフォルト値: SFYMultipleTextWidget::DEFAULT_STEP [単位:ピクセル]

SFYMultipleTextWidget::DEFAULT_STEP の値は SFYMultipleTextWidget::DefaultEnum を参照してください。

参照

SFZMultipleTextLabelControl::GetScrollStep | SFZMultipleTextLabelControl::DefaultEnum | SFYMultipleTextWidget::DefaultEnum


SFZMultipleTextLabelControl::SetScrollUpKey
複数行テキストを上方向にスクロールステップ分スクロールする ScrollUp キーを設定します。
[ public ]
Void SetScrollUpKey(
    AVKType param   // 設定するキー
);

解説

この関数は、 複数行テキストを上方向にスクロールステップ分スクロールする ScrollUp キーを設定します。

デフォルト値: AVK_UP

参照

SFZMultipleTextLabelControl::GetScrollUpKey | SFZMultipleTextLabelControl::SetScrollStep


SFZMultipleTextLabelControl::SetSnapDownKey
複数行テキストを下端までスクロールする SnapDown キーを設定します。
[ public ]
Void SetSnapDownKey(
    AVKType param   // 設定するキー
);

解説

この関数は、 複数行テキストを下端までスクロールする SnapDown キーを設定します。

デフォルト値: AVK_TXEND

参照

SFZMultipleTextLabelControl::GetSnapDownKey


SFZMultipleTextLabelControl::SetSnapUpKey
複数行テキストを上端までスクロールする SnapUp キーを設定します。
[ public ]
Void SetSnapUpKey(
    AVKType param   // 設定するキー
);

解説

この関数は、 複数行テキストを上端までスクロールする SnapUp キーを設定します。

デフォルト値: AVK_TXHOME

参照

SFZMultipleTextLabelControl::GetSnapUpKey


SFZMultipleTextLabelControl::SetText
テキストを設定します。
[ public ]
SFCError SetText(
    SFXPathConstRef path   // リソースファイルパス
    UInt16 id              // リソース ID
);
[ public ]
SFCError SetText(
    SFXWideStringConstRef param   // 文字列
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • BREW API IShell インターフェースのインスタンスが取得できないとき: SFERR_FAILED

解説

この関数は、テキストを設定します。

テキストを直接、あるいは、リソースファイルから読み込むように指定します。

デフォルト値: ""[空文字列]

参照

SFZMultipleTextLabelControl::GetText SFZMultipleTextLabelControl::SetHorizontalAlign | SFZMultipleTextLabelControl::SetVerticalAlign SFZMultipleTextLabelControl::SetTextColor | SFZMultipleTextLabelControl::SetFont | BREW API AEEFont


SFZMultipleTextLabelControl::SetTextColor
テキストの色を設定します。
[ public ]
Void SetTextColor(
    SFXRGBColorConstRef param   // 設定する値
);

解説

この関数は、テキストの色を設定します。

デフォルト値: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]

非活性状態にあるときは、この関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色でテキストは描画されます。

色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

参照

SFZMultipleTextLabelControl::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態


SFZMultipleTextLabelControl::SetVerticalAlign
垂直アライメントを設定します。
[ public ]
Void SetVerticalAlign(
    VerticalEnum param   // 設定する値
);

解説

この関数は、垂直アライメントを設定します。

デフォルト値: SFYMultipleTextWidget::DEFAULT_VERTICAL

SFYMultipleTextWidget::DEFAULT_VERTICAL の値は SFYMultipleTextWidget::VerticalEnum を参照してください。

参照

SFZMultipleTextLabelControl::GetVerticalAlign | SFZMultipleTextLabelControl::VerticalEnum | SFYMultipleTextWidget::VerticalEnum


SFZMultipleTextLabelControl::SnapAlign
複数行テキストのスクロール位置を初期状態に戻します。
[ public ]
Bool SnapAlign(Void);

解説

この関数は、 スクロール位置を SFZMultipleTextLabelControl::SetVerticalAlign 関数で設定した初期状態に戻します。

たとえば、上端に設定していた場合、SnapAlign 関数を呼び出すと、スクロール位置は上端に戻ります。 また、下端あるいは中央に設定していた場合、SnapAlign 関数を呼び出すと、スクロール位置はそれぞれ下端あるいは中央に戻ります。

参照

SFZMultipleTextLabelControl::SetVerticalAlign | SFYMultipleTextWidget::SnapAlign


SFZMultipleTextLabelControl::SnapDown
複数行テキストを下端までスクロールします。
[ public ]
Bool SnapDown(Void);

戻り値

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

解説

この関数は、複数行テキストを下端までスクロールします。

参照

SFZMultipleTextLabelControl::SnapUp | SFYMultipleTextWidget::SnapDown


SFZMultipleTextLabelControl::SnapUp
複数行テキストを上端までスクロールします。
[ public ]
Bool SnapUp(Void);

戻り値

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

解説

この関数は、複数行テキストを上端までスクロールします。

参照

SFZMultipleTextLabelControl::SnapDown | SFYMultipleTextWidget::SnapUp


SFZMultipleTextLabelControl::CodeEnum
SFZMultipleTextLabelControl クラスを表す定数です。
enum CodeEnum {
    CODE_TYPE = four_char_code('c', 'm', 't', 'l')
};
SFMTYPEDEFTYPE(CodeEnum)

参照

SFYResponder::GetType | SFYResponder::SetType


SFZMultipleTextLabelControl::DefaultEnum
各種パラメータのデフォルト値を表します。
enum DefaultEnum {
    DEFAULT_STEP   = SFYMultipleTextWidget::DEFAULT_STEP     // スクロール移動量(単位:ピクセル)
};
SFMTYPEDEFTYPE(DefaultEnum)

参照

SFYMultipleTextWidget::DefaultEnum


SFZMultipleTextLabelControl::HorizontalEnum
水平方向のアライメントを表す定数です。
enum HorizontalEnum {
    HORIZONTAL_LEFT    = SFYMultipleTextWidget::HORIZONTAL_LEFT,   // 左詰め
    HORIZONTAL_CENTER  = SFYMultipleTextWidget::HORIZONTAL_CENTER, // 中央揃え
    HORIZONTAL_RIGHT   = SFYMultipleTextWidget::HORIZONTAL_RIGHT,  // 右詰め
    DEFAULT_HORIZONTAL = SFYMultipleTextWidget::DEFAULT_HORIZONTAL // デフォルト設定: 中央揃え
};
SFMTYPEDEFTYPE(HorizontalEnum)

参照

SFYMultipleTextWidget::HorizontalEnum


SFZMultipleTextLabelControl::VerticalEnum
垂直方向のアライメントを表す定数です。
enum VerticalEnum {
    VERTICAL_TOP     = SFYMultipleTextWidget::VERTICAL_TOP,     // 上詰め
    VERTICAL_MIDDLE  = SFYMultipleTextWidget::VERTICAL_MIDDLE,  // 中央揃え
    VERTICAL_BOTTOM  = SFYMultipleTextWidget::VERTICAL_BOTTOM,  // 下詰め
    DEFAULT_VERTICAL = SFYMultipleTextWidget::DEFAULT_VERTICAL  // デフォルト値: 中央揃え
};
SFMTYPEDEFTYPE(VerticalEnum)

参照

SFYMultipleTextWidget::VerticalEnum