前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFZSingleEditBoxControl
単一行の編集可能なテキストを表示するボックスコントロールです。
#include <SFZSingleEditBoxControl.h.hpp>
class SFZSingleEditBoxControl : public SFYBoxControl;
SFMTYPEDEFCLASS(SFZSingleEditBoxControl)

継承図

SFZSingleEditBoxControl クラスの継承図

協調図

SFZSingleEditBoxControl クラスの協調図

解説

■ 仕様と使い方

単一行の編集可能なテキストを表示するボックスコントロール(SFZSingleEditBoxControl)は、 SFYBoxControl::SetOperateKey 関数で設定する操作キーを押下すると、 テキスト入力画面に遷移します。 そして、テキスト入力終了時に、 結果イベント [テキスト入力が成功した場合は、SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())、 失敗した場合は SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ERROR, エラー値)] を受信します。

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

文字数が多くスクロールして表示する必要がある場合には、 フォーカスされているときに自動的にスクロールを開始します。

[Caution] テキスト入力画面でサスペンドした場合(BREW 2.0 / 2.1 / 3.1)

BREW 2.0 / 2.1 / 3.1 では、 テキスト入力画面でサスペンドした場合、サスペンドしたときのテキスト入力画面の内容で一旦入力が確定します。 これは SophiaFramework UNIVERSE の仕様です。

図 426. 動作例(標準入力モード)

動作例(標準入力モード)

図 427. 動作例(パスワード入力モード)

動作例(パスワード入力モード)

参照

単一行の編集可能なテキストを表示するボックスコントロール[SFZSingleEditBoxControl] | SFYControl | SFYBoxControl | SFYSingleTextWidget

メンバ

コンストラクタ/デストラクタ
SFZSingleEditBoxControl( Void )
SFZSingleEditBoxControl クラスのコンストラクタです。
~SFZSingleEditBoxControl( Void )
SFZSingleEditBoxControl クラスのデストラクタです。
パブリック関数
AEEFont GetFont( Void )
フォントを取得します。
HorizontalEnum GetHorizontalAlign( Void )
水平アライメントの値を取得します。
AEETextInputMode GetInputMode( Void )
テキスト入力モードを取得します。
UInt16 GetMaximumLength( Void )
最大文字入力数を取得します。
Bool GetPasswordMode( Void )
パスワードモードの値を取得します。
AEECLSID GetSFBMenuCtlClassID( Void )
[非推奨 (廃止予定 API)] SFBMenuCtl のクラス ID を取得します。
AEECLSID GetSFBTextCtlClassID( Void )
[非推奨 (廃止予定 API)] SFBTextCtl のクラス ID を取得します。
DirectionEnum GetScrollDirection( Void )
スクロールの移動方向を取得します。
UInt32 GetScrollInterval( Void )
スクロールインターバルを取得します。[単位:ミリ秒]
SInt16 GetScrollStep( Void )
スクロール移動量を取得します。[単位:ピクセル]
SFXWideStringConstRef GetText( Void )
テキストを取得します。
SFXRGBColorConstRef GetTextColor( Void )
テキストの色を取得します。
VerticalEnum GetVerticalAlign( Void )
垂直アライメントの値を取得します。
UInt32 GetWaitInterval( Void )
スクロール開始までの待ち時間を取得します。[単位:ミリ秒]
static
SFZSingleEditBoxControlSmp
NewInstance( SFCErrorPtr exception = null )
新しいインスタンスを作成します。
Void SetFont( AEEFont param )
フォントを設定します。
Void SetHorizontalAlign( HorizontalEnum param )
水平アライメントを設定します。
Void SetInputMode( AEETextInputMode param )
テキスト入力モードを設定します。
SFCError SetMaximumLength( UInt16 param )
最大文字入力数を設定します。
SFCError SetPasswordMode( Bool param )
パスワードモードを設定します。
Void SetSFBMenuCtlClassID( AEECLSID param )
[非推奨 (廃止予定 API)] SFBMenuCtl のクラス ID を設定します。
Void SetSFBTextCtlClassID( AEECLSID param )
[非推奨 (廃止予定 API)] SFBTextCtl のクラス ID を設定します。
Void SetScrollDirection( DirectionEnum param )
スクロールの移動方向を設定します。
Void SetScrollInterval( UInt32 param )
スクロールインターバルを設定します。[単位:ミリ秒]
Void SetScrollStep( SInt16 param )
スクロール移動量を設定します。[単位:ピクセル]
SFCError SetText( SFXPathConstRef path , UInt16 id )
テキストを設定します。
SFCError SetText( SFXWideStringConstRef param )
テキストを設定します。
Void SetTextColor( SFXRGBColorConstRef param )
テキストの色を設定します。
Void SetVerticalAlign( VerticalEnum param )
垂直アライメントを設定します。
Void SetWaitInterval( UInt32 param )
スクロール開始までの待ち時間を設定します。[単位:ミリ秒]
Void StartScroll( Void )
テキストのスクロールを開始します。
Void StopScroll( Void )
テキストのスクロールを停止します。
Void ClearHandler( Void ) (SFYResponder から継承)
このレスポンダのハンドラの登録をすべて解除します。
Void ClearTracer( Void ) (SFYResponder から継承)
このレスポンダのトレーサの配信規則の登録をすべて解除します。
SFCError Distribute( SFXEventConstRef event , BoolPtr result = null ) (SFYResponder から継承)
指定された配信型イベントを SFYDistributer インスタンスと、このレスポンダ以下のレスポンダツリーに配信します。
SFXRGBColorConstRef GetBackgroundColor( Void ) (SFYWidget から継承)
背景の色を取得します。
SFXBevelColorConstRef GetBevelColor( Void ) (SFYBoxControl から継承)
ボックスコントロールの外枠を描画するためのベベルカラーを取得します。
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 ) (SFYBoxControl から継承)
フォーカス状態にあるときの内枠の色を取得します。
SFYResponderSmp GetFrame( Void ) (SFYResponder から継承)
このレスポンダに装着されたフレームを取得します。
SFXRGBColorConstRef GetFrameColor( Void ) (SFYBoxControl から継承)
中枠の色を取得します。
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 ) (SFYBoxControl から継承)
操作キーを取得します。
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 SetBevelColor( SFXBevelColorConstRef param ) (SFYBoxControl から継承)
ボックスコントロールの外枠を描画するためのベベルカラーを設定します。
Void SetCurrentValue( SInt32 param ) (SFYControl から継承)
コントロールの現在値を設定します。
Void SetDistributer( SFYDistributerPtr param ) (SFYResponder から継承)
指定された配信エンジンをこのレスポンダに設定します。
Void SetFocusColor( SFXRGBColorConstRef param ) (SFYBoxControl から継承)
フォーカス状態にあるときの内枠の色を設定します。
SFCError SetFrame( SFYResponderSmpConstRef param ) (SFYResponder から継承)
このレスポンダにフレームを装着します。
Void SetFrameColor( SFXRGBColorConstRef param ) (SFYBoxControl から継承)
中枠の色を設定します。
Void SetID( UInt32 param ) (SFYResponder から継承)
指定された ID をこのレスポンダに設定します。
Void SetMaximumValue( SInt32 param ) (SFYControl から継承)
コントロールの最大値を設定します。
Void SetMinimumValue( SInt32 param ) (SFYControl から継承)
コントロールの最小値を設定します。
Void SetOperateKey( AVKType param ) (SFYBoxControl から継承)
操作キーを設定します。
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 から継承)
このレスポンダのトレーサから指定された配信規則の登録を解除します。
プロテクト関数
SFYSingleEditWidgetSmpConstRef 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 イベントを受信したときに呼び出される関数です。
Void HandleRenderRequest( SFXGraphicsPtr graphics )
描画イベントを受信したときに呼び出される関数です(レスポンダを描画します)。
Void DrawBox( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle ) (SFYBoxControl から継承)
ボックスコントロールを描画します。
static
SFYResponderSmp
Factory( SFYResponderPtr responder , SFCErrorPtr exception = null ) (SFYResponder から継承)
NewInstance 関数の実装を補助します。
static
SFXMarginConstRef
GetBoxMargin( Void ) (SFYBoxControl から継承)
ボックスコントロールのマージンの値を取得します。
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
SFZSingleEditBoxControl クラスを表す定数です。
DefaultEnum
各種パラメータのデフォルト値を表します。
DirectionEnum
スクロールの移動方向を表します。
HorizontalEnum
水平方向のアライメントを表す定数です。
VerticalEnum
垂直方向のアライメントを表す定数です。

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

解説

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

  1. タイプを "cseb" に設定します。
  2. テキスト描画用に内部で子レスポンダとして保持する SFYSingleEditWidget インスタンスを生成します。
  3. SFYSingleEditWidget インスタンスの状態を「可視+活性+操作不能+非フォーカス」に設定します。
  4. テキストの文字列を ""[空文字列] に設定します。
  5. テキストのフォントを AEE_FONT_NORMAL に設定します。
  6. テキストの色を SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色] に設定します。
  7. テキストの水平アライメントを SFYSingleTextWidget::DEFAULT_HORIZONTAL に設定します。
  8. テキストの垂直アライメントを SFYSingleTextWidget::DEFAULT_VERTICAL に設定します。
  9. テキストのスクロール開始までの待ち時間を SFYSingleTextWidget::DEFAULT_WAIT に設定します。
  10. テキストのスクロール移動方向を SFYSingleTextWidget::DEFAULT_DIRECTION に設定します。
  11. テキストのスクロールインターバルを SFYSingleTextWidget::DEFAULT_SCROLL に設定します。
  12. テキストのスクロール移動量を SFYSingleTextWidget::DEFAULT_STEP に設定します。
  13. 下表にあるハンドラをレスポンダに登録します。

表 268. イベントハンドラ

イベント ハンドラの内容
フォーカス状態になったときの状態イベント[SFEVT_RESPONDER_STATE] テキストのスクロールを開始します。
非フォーカス状態になったときの状態イベント[SFEVT_RESPONDER_STATE] テキストのスクロールを停止します。
[Note] 注意
SFZSingleEditBoxControl クラスを継承するレスポンダでは、 上記イベントが発生すると、それに対応するハンドラが呼び出されます。

内部実装

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

/*protected */SFZSingleEditBoxControl::SFZSingleEditBoxControl(Void) static_throws
{
    static SFXEventRange::AtomRecConst          trange[] = {
        { SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,    SFP16_STATE_FOCUS,    SFP16_STATE_FOCUS}
    };
    static SFXEventRange::AtomRecConst          crange[] = {
        { SFEVT_RESPONDER_STYLE,  SFEVT_RESPONDER_STYLE,          SFP16_BEGIN,            SFP16_END},
        {SFEVT_RESPONDER_RESULT, SFEVT_RESPONDER_RESULT,          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(OnStateFocus);
        trule[0].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
        if (static_try()) {
            if ((_widget = SFYSingleEditWidget::NewInstance(&error)) != null) {
                crule[0].spp = XANDLER_FUNCTION(OnWidgetStyle);
                crule[0].reference = this;
                crule[1].spp = XANDLER_FUNCTION(OnWidgetResult);
                crule[1].reference = this;
                static_throw(_widget->RegisterHandler(atomic_cast(crange), crule, lengthof(crange)));
                if (static_try()) {
                    static_throw(_widget->SetParent(GetThis()));
                    if (static_try()) {
                        _widget->SetState(true, true, false, false);
                        Relocate();
                    }
                }
            }
            else {
                static_throw(error);
            }
        }
    }
}// SFZSingleEditBoxControl::SFZSingleEditBoxControl //

/*private */XANDLER_IMPLEMENT_VOIDSTATE(SFZSingleEditBoxControl, OnStateFocus, invoker, reason, state)
{
    unused(invoker);
    unused(reason);
    (state) ? (_widget->StartScroll()) : (_widget->StopScroll());
    return;
}// XANDLER_IMPLEMENT_VOIDSTATE(SFZSingleEditBoxControl, OnStateFocus) //

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

/*private */XANDLER_IMPLEMENT_VOIDRESULT(SFZSingleEditBoxControl, OnWidgetResult, invoker, reason, result)
{
    unused(invoker);
    switch (reason) {
        case SFP16_RESULT_OK:
            result = GetCurrentValue();
            break;
        default:
            break;
    }
    _widget->StartScroll();
    InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, reason, result), false);
    return;
}// XANDLER_IMPLEMENT_VOIDRESULT(SFZSingleEditBoxControl, OnWidgetResult) //

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

参照

SFYResponder::SetType | SFZSingleEditBoxControl::CodeEnum | SFYResponder::SetParent | SFYResponder::SetState | SFZSingleEditBoxControl::SetText | SFZSingleEditBoxControl::SetFont | SFZSingleEditBoxControl::SetTextColor | SFZSingleEditBoxControl::SetHorizontalAlign | SFZSingleEditBoxControl::SetVerticalAlign | SFZSingleEditBoxControl::SetScrollDirection | SFZSingleEditBoxControl::SetScrollInterval | SFZSingleEditBoxControl::SetScrollStep | SFZSingleEditBoxControl::SetWaitInterval | SFZSingleEditBoxControl::HorizontalEnum | SFZSingleEditBoxControl::VerticalEnum | SFZSingleEditBoxControl::DirectionEnum | SFZSingleEditBoxControl::DefaultEnum | SFYSingleEditWidget::NewInstance | SFYSingleEditWidget | SFXRGBColor | タイプ | 状態 | イベント | 状態イベント[SFEVT_RESPONDER_STATE]


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

解説

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

内部実装

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

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

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

戻り値

フォント。

解説

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

参照

SFZSingleEditBoxControl::SetFont | BREW API AEEFont


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

戻り値

水平アライメントの値。

解説

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

参照

SFZSingleEditBoxControl::SetHorizontalAlign | SFZSingleEditBoxControl::HorizontalEnum


SFZSingleEditBoxControl::GetInputMode
テキスト入力モードを取得します。
[ public, const ]
AEETextInputMode GetInputMode(Void);

戻り値

テキスト入力モード。

解説

この関数は、テキスト入力モードを取得します。

参照

SFZSingleEditBoxControl::SetInputMode


SFZSingleEditBoxControl::GetMaximumLength
最大文字入力数を取得します。
[ public, const ]
UInt16 GetMaximumLength(Void);

戻り値

最大文字入力数。

解説

この関数は、最大文字入力数を取得します。

参照

SFZSingleEditBoxControl::SetMaximumLength


SFZSingleEditBoxControl::GetPasswordMode
パスワードモードの値を取得します。
[ public, const ]
Bool GetPasswordMode(Void);

戻り値

  • パスワードモードである: true
  • そうでないとき: false

解説

この関数は、パスワードモードの値を取得します。

参照

SFZSingleEditBoxControl::SetPasswordMode


SFZSingleEditBoxControl::GetSFBMenuCtlClassID
[非推奨 (廃止予定 API)] SFBMenuCtl のクラス ID を取得します。
[ public, const ]
AEECLSID GetSFBMenuCtlClassID(Void);

解説

[Note] 廃止予定

この API は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。

SFYApplication::GetEditor 関数を呼び出してテキスト入力コントロールエディタを取得し、 このエディタに対して SFXBaseEditor::GetSFBMenuCtlClassID 関数を呼び出して取得することを推奨します。

参照

SFZSingleEditBoxControl::SetSFBMenuCtlClassID | SFBMenuCtl


SFZSingleEditBoxControl::GetSFBTextCtlClassID
[非推奨 (廃止予定 API)] SFBTextCtl のクラス ID を取得します。
[ public, const ]
AEECLSID GetSFBTextCtlClassID(Void);

解説

[Note] 廃止予定

この API は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。

SFYApplication::GetEditor 関数を呼び出してテキスト入力コントロールエディタを取得し、 このエディタに対して SFXBaseEditor::GetSFBTextCtlClassID 関数を呼び出して取得することを推奨します。

参照

SFZSingleEditBoxControl::SetSFBTextCtlClassID | SFBTextCtl


SFZSingleEditBoxControl::GetScrollDirection
スクロールの移動方向を取得します。
[ public, const ]
DirectionEnum GetScrollDirection(Void);

戻り値

スクロールの移動方向。

解説

この関数は、スクロールの移動方向を取得します。

参照

SFZSingleEditBoxControl::SetScrollDirection


SFZSingleEditBoxControl::GetScrollInterval
スクロールインターバルを取得します。[単位:ミリ秒]
[ public, const ]
UInt32 GetScrollInterval(Void);

戻り値

スクロールインターバル。[単位:ミリ秒]

解説

この関数は、スクロールインターバルを取得します。[単位:ミリ秒]

参照

SFZSingleEditBoxControl::SetScrollInterval


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

戻り値

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

解説

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

参照

SFZSingleEditBoxControl::SetScrollStep


SFZSingleEditBoxControl::GetText
テキストを取得します。
[ public, const ]
SFXWideStringConstRef GetText(Void);

戻り値

テキスト。

解説

この関数は、テキストを取得します。

参照

SFZSingleEditBoxControl::SetText


SFZSingleEditBoxControl::GetTextColor
テキストの色を取得します。
[ public, const ]
SFXRGBColorConstRef GetTextColor(Void);

戻り値

テキストの色。

解説

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

参照

SFZSingleEditBoxControl::SetTextColor | SFXRGBColor


SFZSingleEditBoxControl::GetVerticalAlign
垂直アライメントの値を取得します。
[ public, const ]
VerticalEnum GetVerticalAlign(Void);

戻り値

垂直アライメントの値。

解説

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

参照

SFZSingleEditBoxControl::SetVerticalAlign | SFZSingleEditBoxControl::VerticalEnum


SFZSingleEditBoxControl::GetWaitInterval
スクロール開始までの待ち時間を取得します。[単位:ミリ秒]
[ public, const ]
UInt32 GetWaitInterval(Void);

戻り値

スクロール開始までの待ち時間。[単位:ミリ秒]

解説

この関数は、スクロール開始までの待ち時間を取得します。[単位:ミリ秒]

参照

SFZSingleEditBoxControl::SetWaitInterval


SFZSingleEditBoxControl::GetWidget
単一行テキスト編集用に内部で保持しているテキストウィジェットを取得します。
[ protected, const ]
SFYSingleEditWidgetSmpConstRef GetWidget(Void);

戻り値

単一行テキスト編集用に子レスポンダとして内部で保持する SFYSingleEditWidget インスタンス。

解説

この関数は、 単一行テキスト編集用に子レスポンダとして内部で保持する SFYSingleEditWidget インスタンスを取得します。

単一行テキストの編集は、SFYSingleEditWidget インスタンスに委譲して処理します。

参照

SFYSingleEditWidget


SFZSingleEditBoxControl::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. 引数の矩形をボックス枠用に上下左右に 3 ピクセルずつ縮小した矩形を計算します。
  2. 1. で計算した矩形を使用して、 SFYSingleEditWidget::HandleBoundOptimize 関数と同等の方法で、 SFZSingleEditBoxControl::SetText 関数と SFZSingleEditBoxControl::SetFont 関数で設定した単一行テキストの最適な矩形サイズを計算します。
  3. 2. で計算した矩形をボックス枠用に上下左右に 3 ピクセルずつ拡大した矩形を計算します。
  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 仮想関数をオーバーライドして処理を記述します。

参照: SFYSingleEditWidget::HandleBoundOptimize

内部実装

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

SFYSingleEditWidgetSmp          _widget;

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

参照

SFYResponder::GetSuitableBound | SFYBoxControl::GetBoxMargin | SFZSingleEditBoxControl::SetText | SFZSingleEditBoxControl::SetFont | SFYSingleEditWidget::HandleBoundOptimize | SFYSingleEditWidget | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND]


SFZSingleEditBoxControl::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. SFYSingleEditWidget::HandleBoundRequest 関数と同等の方法で、 SFZSingleEditBoxControl::SetText 関数と SFZSingleEditBoxControl::SetFont 関数で設定した単一行テキストの最適な矩形サイズを計算します。
  2. 1. で計算した矩形をボックス枠用に上下左右に 3 ピクセルずつ拡大した矩形を計算します。
  3. 2. で計算した矩形を返します。
[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 仮想関数をオーバーライドして処理を記述します。

参照: SFYSingleEditWidget::HandleBoundRequest

内部実装

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

SFYSingleEditWidgetSmp          _widget;

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

参照

SFYResponder::GetSuitableBound | SFYBoxControl::GetBoxMargin | SFZSingleEditBoxControl::SetText | SFZSingleEditBoxControl::SetFont | SFYSingleEditWidget::HandleBoundRequest | SFYSingleEditWidget | SFXEvent | 実領域 | 領域イベント[SFEVT_RESPONDER_BOUND]


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

解説

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

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

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

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

[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 仮想関数をオーバーライドして処理を記述します。

内部実装

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

SFYSingleEditWidgetSmp          _widget;

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

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

参照

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


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

解説

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

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

デフォルトの実装では、テキストのスクロール位置を初期化し、 テキスト入力画面に遷移します。 そして、テキスト入力終了時、 自分自身に結果イベント [テキスト入力が成功した場合は、SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())、 失敗した場合は SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ERROR, エラー値)] を送信します。

内部実装

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

SFYSingleEditWidgetSmp          _widget;

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

参照

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


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

解説

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

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

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

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

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

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

内部実装

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

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

参照

SFYBoxControl::DrawBox | SFZSingleEditBoxControl::SetText | SFZSingleEditBoxControl::SetHorizontalAlign | SFZSingleEditBoxControl::SetVerticalAlign | SFZSingleEditBoxControl::SetFont | SFZSingleEditBoxControl::SetTextColor | SFYSingleTextWidget::HandleRenderRequest | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | SFYSingleTextWidget | SFYSingleEditWidget | SFXEvent | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理


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

引数

exception

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

戻り値

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

解説

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

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

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

使用例

以下は、単一行エディットボックスのインスタンスを生成するためのコードです。

// 単一行エディットボックスのインスタンスを生成する
SFZSingleEditBoxControlSmp _singleeditbox;
SFCError error;

if ((_singleeditbox = SFZSingleEditBoxControl::NewInstance(&error)) != null) {
    // ...
}

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

解説

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

デフォルト値: AEE_FONT_NORMAL

参照

SFZSingleEditBoxControl::GetFont | BREW API AEEFont


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

解説

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

デフォルト値: SFYSingleEditWidget::DEFAULT_HORIZONTAL

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

参照

SFZSingleEditBoxControl::GetHorizontalAlign | SFZSingleEditBoxControl::HorizontalEnum | SFYSingleEditWidget::HorizontalEnum


SFZSingleEditBoxControl::SetInputMode
テキスト入力モードを設定します。
[ public ]
Void SetInputMode(
    AEETextInputMode param   // テキスト入力モード
);

解説

この関数は、ネイティブテキスト入力コントロールに使用できるテキスト入力モードを設定します。

詳細は、 BREW API ITEXTCTL_SetInputMode および BREW API AEETextInputMode の説明を参照してください。

デフォルト値: AEE_TM_CURRENT(現在アクティブな入力モードを指定する)。

[Note] 注意

使用可能なテキスト入力モードは、デバイスごとに異なります。

参照

SFZSingleEditBoxControl::GetInputMode | SFYSingleEditWidget::SetInputMode | SFXEditProperty::SetInputMode | BREW API ITEXTCTL_SetInputMode | BREW API AEETextInputMode


SFZSingleEditBoxControl::SetMaximumLength
最大文字入力数を設定します。
[ public ]
SFCError SetMaximumLength(
    UInt16 param   // 最大文字入力数
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、ネイティブテキスト入力コントロールがサポートするテキストサイズの最大値を設定します。

詳細は、 BREW API ITEXTCTL_SetMaxSize の説明を参照してください。

デフォルト値: SINT16_MAXIMUM - 1。

参照

SFZSingleEditBoxControl::GetMaximumLength | SFYSingleEditWidget::SetMaximumLength | SFXEditProperty::SetMaximumLength | BREW API ITEXTCTL_SetMaxSize


SFZSingleEditBoxControl::SetPasswordMode
パスワードモードを設定します。
[ public ]
SFCError SetPasswordMode(
    Bool param   // 設定する値(パスワードモードなら true、さもなければ false)
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、パスワードモードを設定します。

引数が true の場合、ネイティブテキスト入力コントロールのプロパティ値に TP_PASSWORD を設定します。 このとき、入力した文字はすべて'*'(アスタリスク)で表示されます。また、実際の文字列はバッファして管理されます。

詳細は、 BREW API ITEXTCTL_SetProperties および BREW API AEE ITextCtl のプロパティ を参照してください。

デフォルト値: false

参照

SFZSingleEditBoxControl::GetPasswordMode | SFYSingleEditWidget::SetPasswordMode | SFXEditProperty::SetPasswordMode | BREW API ITEXTCTL_SetProperties | BREW API AEE ITextCtl のプロパティ


SFZSingleEditBoxControl::SetSFBMenuCtlClassID
[非推奨 (廃止予定 API)] SFBMenuCtl のクラス ID を設定します。
[ public ]
Void SetSFBMenuCtlClassID(
    AEECLSID param   // 設定するクラス ID
);

解説

[Note] 廃止予定

この API は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。

SFYApplication::GetEditor 関数を呼び出してテキスト入力コントロールエディタを取得し、 このエディタに対して SFXBaseEditor::SetSFBMenuCtlClassID 関数を呼び出して設定することを推奨します。

参照

SFZSingleEditBoxControl::GetSFBMenuCtlClassID | SFBMenuCtl


SFZSingleEditBoxControl::SetSFBTextCtlClassID
[非推奨 (廃止予定 API)] SFBTextCtl のクラス ID を設定します。
[ public ]
Void SetSFBTextCtlClassID(
    AEECLSID param   // 設定するクラス ID
);

解説

[Note] 廃止予定

この API は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。

SFYApplication::GetEditor 関数を呼び出してテキスト入力コントロールエディタを取得し、 このエディタに対して SFXBaseEditor::SetSFBTextCtlClassID 関数を呼び出して設定することを推奨します。

参照

SFZSingleEditBoxControl::GetSFBTextCtlClassID | SFBTextCtl


SFZSingleEditBoxControl::SetScrollDirection
スクロールの移動方向を設定します。
[ public ]
Void SetScrollDirection(
    DirectionEnum param   // 設定する値
);

解説

この関数は、スクロール移動方向を設定します。

デフォルト値: SFYSingleEditWidget::DEFAULT_DIRECTION

SFYSingleEditWidget::DEFAULT_DIRECTION の値は SFYSingleEditWidget::DirectionEnum を参照してください。

参照

SFZSingleEditBoxControl::GetScrollDirection | SFZSingleEditBoxControl::DirectionEnum | SFYSingleEditWidget::DirectionEnum


SFZSingleEditBoxControl::SetScrollInterval
スクロールインターバルを設定します。[単位:ミリ秒]
[ public ]
Void SetScrollInterval(
    UInt32 param   // 設定する値
);

解説

この関数は、スクロールインターバルを設定します。[単位:ミリ秒]

デフォルト値: SFYSingleEditWidget::DEFAULT_SCROLL ミリ秒

SFYSingleEditWidget::DEFAULT_SCROLL の値は SFYSingleEditWidget::DefaultEnum を参照してください。

参照

SFZSingleEditBoxControl::GetScrollInterval | SFZSingleEditBoxControl::DefaultEnum | SFYSingleEditWidget::DefaultEnum


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

解説

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

−1(デフォルト値)を設定すると、使用しているフォントの半角空白文字 1 文字分(" ")の幅がスクロール移動量となります。

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

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

参照

SFZSingleEditBoxControl::GetScrollStep | SFZSingleEditBoxControl::DefaultEnum | SFYSingleEditWidget::DefaultEnum


SFZSingleEditBoxControl::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

解説

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

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

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

参照

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


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

解説

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

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

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

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

参照

SFZSingleEditBoxControl::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態


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

解説

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

デフォルト値: SFYSingleEditWidget::DEFAULT_VERTICAL

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

参照

SFZSingleEditBoxControl::GetVerticalAlign | SFZSingleEditBoxControl::VerticalEnum | SFYSingleEditWidget::VerticalEnum


SFZSingleEditBoxControl::SetWaitInterval
スクロール開始までの待ち時間を設定します。[単位:ミリ秒]
[ public ]
Void SetWaitInterval(
    UInt32 param   // 設定する値
);

解説

デフォルト値: SFYSingleEditWidget::DEFAULT_WAIT ミリ秒

SFYSingleEditWidget::DEFAULT_WAIT の値は SFYSingleEditWidget::DefaultEnum を参照してください。

参照

SFZSingleEditBoxControl::GetWaitInterval | SFZSingleEditBoxControl::DefaultEnum | SFYSingleEditWidget::DefaultEnum


SFZSingleEditBoxControl::StartScroll
テキストのスクロールを開始します。
[ public ]
Void StartScroll(Void);

解説

この関数は、テキストのスクロールを開始します。

仮想領域の幅がテキストの幅よりも大きいときは何もしません。

SFEVT_APP_SUSPEND イベントと SFEVT_APP_RESUME イベントに自動的に応答しますが、 SFEVT_APP_SUSPEND イベントの受信後から SFEVT_APP_RESUME イベントの受信までの間にこの関数を呼び出したときの動作は未定です。

参照

SFZSingleEditBoxControl::StopScroll


SFZSingleEditBoxControl::StopScroll
テキストのスクロールを停止します。
[ public ]
Void StopScroll(Void);

解説

この関数は、テキストのスクロールを停止します。

参照

SFZSingleEditBoxControl::StartScroll


SFZSingleEditBoxControl::CodeEnum
SFZSingleEditBoxControl クラスを表す定数です。
enum CodeEnum {
    CODE_TYPE = four_char_code('c', 's', 'e', 'b')
};
SFMTYPEDEFTYPE(CodeEnum)

参照

SFYResponder::GetType | SFYResponder::SetType


SFZSingleEditBoxControl::DefaultEnum
各種パラメータのデフォルト値を表します。
enum DefaultEnum {
    DEFAULT_WAIT   = SFYSingleEditWidget::DEFAULT_WAIT,    // スクロール開始までの待ち時間(単位:ミリ秒)
    DEFAULT_SCROLL = SFYSingleEditWidget::DEFAULT_SCROLL,  // スクロールインターバル(単位:ミリ秒)
    DEFAULT_STEP   = SFYSingleEditWidget::DEFAULT_STEP     // スクロール移動量(単位:ピクセル)
};
SFMTYPEDEFTYPE(DefaultEnum)

参照

SFYSingleEditWidget::DefaultEnum


SFZSingleEditBoxControl::DirectionEnum
スクロールの移動方向を表します。
enum DirectionEnum {
    DIRECTION_LEFT    = SFYSingleEditWidget::DIRECTION_LEFT,    // 左へスクロール
    DIRECTION_RIGHT   = SFYSingleEditWidget::DIRECTION_RIGHT,   // 右へスクロール
    DEFAULT_DIRECTION = SFYSingleEditWidget::DEFAULT_DIRECTION  // デフォルト値: 左へスクロール
};
SFMTYPEDEFTYPE(DirectionEnum)

参照

SFYSingleEditWidget::DirectionEnum


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

参照

SFYSingleEditWidget::HorizontalEnum


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

参照

SFYSingleEditWidget::VerticalEnum