継承図

協調図

解説

■ 仕様と使い方

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

操作可能モードでは(状態が操作可能であるとき)、コントロールをフォーカスすることができます。 そのとき、SFYLabelControl::SetOperateKey 関数で設定する操作キーを押下すると、 テキスト入力画面に遷移します。 そして、テキスト入力終了時に、 結果イベント [テキスト入力が成功した場合は、SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())、 失敗した場合は SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ERROR, エラー値)] を受信します。

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

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

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

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

図 394. 動作例（標準入力モード）

図 395. 動作例（パスワード入力モード）

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

	引数（矩形領域）を指定しないで GetSuitableBound 関数を呼び出すときの注意
	このレスポンダの SFYResponder::GetSuitableBound 関数を呼び出すときに引数（矩形領域）を指定しない場合は、 予め SFYResponder::SetRealBound 関数を使用して実領域（＝ローカル領域※）を設定する必要があります。 設定された実領域の横幅は領域計算に必要なヒント値として利用されます。 通常、実領域の横幅には [ 使用しているフォントの横幅 ＋ ラベル枠の幅 × ２ ]（ラベル枠の幅は 2 ピクセル）以上の値を設定します。 ※仮想領域を設定しない限り、 実領域はローカル領域と同じです。また、ヒント値として使われる実領域を設定する際は、 SFYLabelControl::GetFocusMargin 関数で取得できるラベル枠の幅も考慮する必要があります。 参照: 複数行のテキストを表示するレスポンダに最適な大きさを取得する

参照

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

メンバ

解説

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

内部実装

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

/*protected */SFZMultipleEditLabelControl::SFZMultipleEditLabelControl(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},
        {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(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 = SFYMultipleEditWidget::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()) {
                        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);
            }
        }
    }
}// SFZMultipleEditLabelControl::SFZMultipleEditLabelControl //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFZMultipleEditLabelControl, 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(SFZMultipleEditLabelControl, OnShield) //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFZMultipleEditLabelControl, 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(SFZMultipleEditLabelControl, OnKey) //

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

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

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

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

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

参照

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

解説

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

内部実装

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

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

戻り値

フォント。

解説

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

参照

SFZMultipleEditLabelControl::SetFont | BREW API AEEFont

戻り値

水平アライメントの値。

解説

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

参照

SFZMultipleEditLabelControl::SetHorizontalAlign | SFZMultipleEditLabelControl::HorizontalEnum

戻り値

テキスト入力モード。

解説

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

参照

SFZMultipleEditLabelControl::SetInputMode

戻り値

最大文字入力数。

解説

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

参照

SFZMultipleEditLabelControl::SetMaximumLength

戻り値

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

解説

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

参照

SFZMultipleEditLabelControl::SetPageDownKey

戻り値

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

解説

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

参照

SFZMultipleEditLabelControl::SetPageUpKey

戻り値

解説

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

参照

SFZMultipleEditLabelControl::SetPasswordMode

解説

	廃止予定
	この API は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。 SFYApplication::GetEditor 関数を呼び出してテキスト入力コントロールエディタを取得し、 このエディタに対して SFXBaseEditor::GetSFBMenuCtlClassID 関数を呼び出して取得することを推奨します。

参照

SFZMultipleEditLabelControl::SetSFBMenuCtlClassID | SFBMenuCtl

解説

	廃止予定
	この API は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。 SFYApplication::GetEditor 関数を呼び出してテキスト入力コントロールエディタを取得し、 このエディタに対して SFXBaseEditor::GetSFBTextCtlClassID 関数を呼び出して取得することを推奨します。

参照

SFZMultipleEditLabelControl::SetSFBTextCtlClassID | SFBTextCtl

戻り値

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

解説

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

参照

SFZMultipleEditLabelControl::SetScrollDownKey | SFZMultipleEditLabelControl::SetScrollStep

戻り値

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

解説

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

参照

SFZMultipleEditLabelControl::SetScrollStep

戻り値

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

解説

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

参照

SFZMultipleEditLabelControl::SetScrollUpKey | SFZMultipleEditLabelControl::SetScrollStep

戻り値

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

解説

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

参照

SFZMultipleEditLabelControl::SetSnapDownKey

戻り値

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

解説

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

参照

SFZMultipleEditLabelControl::SetSnapUpKey

戻り値

テキスト。

解説

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

参照

SFZMultipleEditLabelControl::SetText

戻り値

テキストの色。

解説

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

参照

SFZMultipleEditLabelControl::SetTextColor | SFXRGBColor

戻り値

垂直アライメントの値。

解説

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

参照

SFZMultipleEditLabelControl::SetVerticalAlign | SFZMultipleEditLabelControl::VerticalEnum

戻り値

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

解説

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

複数行テキストの編集は、SFYMultipleEditWidget インスタンスに委譲して処理します。

参照

SFYMultipleEditWidget

解説

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

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

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

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

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベント]
	SFYResponder::GetSuitableBound 関数は、 引数にヒント領域を指定した場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundOptimize 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle にはヒント領域が初期設定されています。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベント受信時の最適な領域計算
	SFYWidget::HandleBoundOptimize 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 最適な領域の計算は、最初に SFYWidget::HandleBoundOptimize 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundOptimize 仮想関数をオーバーライドして処理を記述します。

参照: SFYMultipleEditWidget::HandleBoundOptimize

内部実装

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

SFYMultipleEditWidgetSmp        _widget;

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

参照

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

解説

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

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

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

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

	前提条件
	予め SFYResponder::SetRealBound 関数を使用して実領域（＝ローカル領域※）を設定する必要があります。 設定された実領域の横幅は領域計算に必要なヒント値として利用されます。 通常、実領域の横幅には [ 使用しているフォントの横幅 ＋ ラベル枠の幅 × ２ ]（ラベル枠の幅は 2 ピクセル）以上の値を設定します。 ※仮想領域を設定しない限り、 実領域はローカル領域と同じです。また、ヒント値として使われる実領域を設定する際は、 SFYLabelControl::GetFocusMargin 関数で取得できるラベル枠の幅も考慮する必要があります。 参照: 複数行のテキストを表示するレスポンダに最適な大きさを取得する

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント]
	SFYResponder::GetSuitableBound 関数は、 引数に何も指定しない場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundRequest 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には実領域が初期設定されています。 Tip 実領域のデフォルト値は SFXRectangle(0, 0, 0, 0) です。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント受信時の最適な領域計算
	SFYWidget::HandleBoundRequest 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 最適な領域の計算は、最初に SFYWidget::HandleBoundRequest 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundRequest 仮想関数をオーバーライドして処理を記述します。

参照: SFYMultipleEditWidget::HandleBoundRequest

内部実装

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

SFYMultipleEditWidgetSmp        _widget;

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

参照

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

解説

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

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

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

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

	領域イベント[(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 には変更後の仮想領域が設定されています。

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

内部実装

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

SFYMultipleEditWidgetSmp        _widget;

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

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

参照

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

解説

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

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

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

内部実装

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

SFYMultipleEditWidgetSmp        _widget;

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

参照

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

解説

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

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

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

内部実装

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

SFYMultipleEditWidgetSmp        _widget;

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

参照

SFZMultipleEditLabelControl::SetPageDownKey | SFZMultipleEditLabelControl::PageDown | SFYMultipleEditWidget | SFXEvent | キーイベント[SFEVT_KEY]

解説

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

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

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

内部実装

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

SFYMultipleEditWidgetSmp        _widget;

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

参照

SFZMultipleEditLabelControl::SetPageUpKey | SFZMultipleEditLabelControl::PageUp | SFYMultipleEditWidget | SFXEvent | キーイベント[SFEVT_KEY]

解説

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

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

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

レスポンダの描画手順

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

内部実装

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

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

参照

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

解説

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

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

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

内部実装

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

SFYMultipleEditWidgetSmp        _widget;

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

参照

SFZMultipleEditLabelControl::SetScrollDownKey | SFZMultipleEditLabelControl::ScrollDown | SFYMultipleEditWidget | SFXEvent | キーイベント[SFEVT_KEY]

解説

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

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

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

内部実装

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

SFYMultipleEditWidgetSmp        _widget;

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

参照

SFZMultipleEditLabelControl::SetScrollUpKey | SFZMultipleEditLabelControl::ScrollUp | SFYMultipleEditWidget | SFXEvent | キーイベント[SFEVT_KEY]

解説

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

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

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

内部実装

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

SFYMultipleEditWidgetSmp        _widget;

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

参照

SFZMultipleEditLabelControl::SetSnapDownKey | SFZMultipleEditLabelControl::SnapDown | SFYMultipleEditWidget | SFXEvent | キーイベント[SFEVT_KEY]

解説

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

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

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

内部実装

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

SFYMultipleEditWidgetSmp        _widget;

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

参照

SFZMultipleEditLabelControl::SetSnapUpKey | SFZMultipleEditLabelControl::SnapUp | SFYMultipleEditWidget | SFXEvent | キーイベント[SFEVT_KEY]

引数

戻り値

解説

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

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

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

使用例

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

// 複数行エディットラベルのインスタンスを生成する
SFZMultipleEditLabelControlSmp _multipleeditlabel;
SFCError error;

if ((_multipleeditlabel = SFZMultipleEditLabelControl::NewInstance(&error)) != null) {
    // ...
}

戻り値

解説

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

参照

SFZMultipleEditLabelControl::PageUp | SFYMultipleEditWidget::PageDown

戻り値

解説

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

参照

SFZMultipleEditLabelControl::PageDown | SFYMultipleEditWidget::PageUp

戻り値

解説

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

参照

SFZMultipleEditLabelControl::SetScrollStep | SFZMultipleEditLabelControl::ScrollUp | SFYMultipleEditWidget::ScrollDown

戻り値

解説

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

参照

SFZMultipleEditLabelControl::SetScrollStep | SFZMultipleEditLabelControl::ScrollDown | SFYMultipleEditWidget::ScrollUp

解説

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

デフォルト値: AEE_FONT_NORMAL

参照

SFZMultipleEditLabelControl::GetFont | BREW API AEEFont

解説

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

デフォルト値: SFYMultipleEditWidget::DEFAULT_HORIZONTAL

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

参照

SFZMultipleEditLabelControl::GetHorizontalAlign | SFZMultipleEditLabelControl::HorizontalEnum | SFYMultipleEditWidget::HorizontalEnum

解説

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

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

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

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

参照

SFZMultipleEditLabelControl::GetInputMode | SFYMultipleEditWidget::SetInputMode | SFXEditProperty::SetInputMode | BREW API ITEXTCTL_SetInputMode | BREW API AEETextInputMode

戻り値

解説

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

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

デフォルト値: SINT16_MAXIMUM - 1。

参照

SFZMultipleEditLabelControl::GetMaximumLength | SFYMultipleEditWidget::SetMaximumLength | SFXEditProperty::SetMaximumLength | BREW API ITEXTCTL_SetMaxSize

解説

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

デフォルト値: AVK_TXPGDOWN

参照

SFZMultipleEditLabelControl::GetPageDownKey

解説

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

デフォルト値: AVK_TXPGUP

参照

SFZMultipleEditLabelControl::GetPageUpKey

戻り値

解説

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

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

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

デフォルト値: false

参照

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

解説

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

参照

SFZMultipleEditLabelControl::GetSFBMenuCtlClassID | SFBMenuCtl

解説

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

参照

SFZMultipleEditLabelControl::GetSFBTextCtlClassID | SFBTextCtl

解説

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

デフォルト値: AVK_DOWN

参照

SFZMultipleEditLabelControl::GetScrollDownKey | SFZMultipleEditLabelControl::SetScrollStep

解説

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

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

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

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

参照

SFZMultipleEditLabelControl::GetScrollStep | SFZMultipleEditLabelControl::DefaultEnum | SFYMultipleEditWidget::DefaultEnum

解説

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

デフォルト値: AVK_UP

参照

SFZMultipleEditLabelControl::GetScrollUpKey | SFZMultipleEditLabelControl::SetScrollStep

解説

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

デフォルト値: AVK_TXEND

参照

SFZMultipleEditLabelControl::GetSnapDownKey

解説

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

デフォルト値: AVK_TXHOME

参照

SFZMultipleEditLabelControl::GetSnapUpKey

戻り値

解説

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

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

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

参照

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

解説

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

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

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

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

参照

SFZMultipleEditLabelControl::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

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

デフォルト値: SFYMultipleEditWidget::DEFAULT_VERTICAL

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

参照

SFZMultipleEditLabelControl::GetVerticalAlign | SFZMultipleEditLabelControl::VerticalEnum | SFYMultipleEditWidget::VerticalEnum

解説

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

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

参照

SFZMultipleEditLabelControl::SetVerticalAlign | SFYMultipleEditWidget::SnapAlign

戻り値

解説

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

参照

SFZMultipleEditLabelControl::SnapUp | SFYMultipleEditWidget::SnapDown

戻り値

解説

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

参照

SFZMultipleEditLabelControl::SnapDown | SFYMultipleEditWidget::SnapUp

参照

SFYResponder::GetType | SFYResponder::SetType

参照

SFYMultipleEditWidget::DefaultEnum

参照

SFYMultipleEditWidget::HorizontalEnum

参照

SFYMultipleEditWidget::VerticalEnum