継承図

協調図

解説

■ 仕様と使い方

SFYSingleEditWidget は、単一行テキストの編集に必要な機能だけが実装されているレスポンダです。 通常、単一行テキストの編集を扱うレスポンダで内部的に保持する子レスポンダとして使います。

たとえば、SFYSingleEditWidget は SFZSingleEditLabelControl や SFZSingleEditBoxControl クラスの単一行テキストの編集を扱うコントロールの子レスポンダとして内部的に利用されます。

単一行テキストを編集するこれらのコントロールでは、 単一行テキストの入力や設定、色の設定、フォントの設定、配置、スクロールなどの処理はすべて SFYSingleEditWidget に委譲して行われます。

単一行テキストを編集する必要がある場合、SFYSingleEditWidget を利用すれば、 その処理を記述することなく簡単に実装することが可能です。 また、SFYSingleEditWidget に単一行テキストの編集処理が一元化されるので保守性の優れたコードになります。

	SFYSingleEditWidget の内部処理
	SFYSingleEditWidget が行うテキスト入力と描画は、 それぞれ SFYSingleEditWidget が内部で保持する SFXEditor と SFYSingleTextWidget に委譲されて処理されます。

	使用するときの状態の値
	このクラスを利用するときは、 可視状態:ON、活性状態:ON、操作可能状態:OFF、フォーカス状態:OFF の状態に設定します。 通常、このクラスはキーイベントに応答しないクラスとして使用します。

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

	仮想領域
	SFYSingleEditWidget では、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ≧ [テキストの横幅] ＞ [実領域の横幅] の関係が成り立ちテキスト全体が画面に表示されないとき、 SFYSingleEditWidget::StartScroll 関数を呼び出してもスクロールは開始しません。

参照

SFZSingleEditLabelControl | SFZSingleEditBoxControl | SFYSingleTextWidget | SFXEditor | 仮想領域 | 実領域 | ローカル領域

メンバ

解説

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

内部実装

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

/*protected */SFYSingleEditWidget::SFYSingleEditWidget(Void) static_throws
{
    static SFXEventRange::AtomRecConst          crange[] = {
        { SFEVT_RESPONDER_STYLE,  SFEVT_RESPONDER_STYLE,          SFP16_BEGIN,            SFP16_END}
    };
    SFYHandler::RuleRec                         crule[lengthof(crange)];
    SFCError                                    error;

    if (static_try()) {
        if ((_editor = SFYApplication::GetEditor()) != null) {
            SetType(CODE_TYPE);
            if ((_widget = SFYSingleTextWidget::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()) {
                        static_throw(_text.Set(_property.GetText()));
                        if (static_try()) {
                            static_throw(SetWidgetText(_text, _property.GetPasswordMode()));
                            if (static_try()) {
                                SetPropertyTransparent(true);
                                _widget->SetState(true, true, false, false);
                                _maximum = _property.GetMaximumLength();
                                Relocate();
                            }
                        }
                    }
                }
            }
            else {
                static_throw(error);
            }
        }
        else {
            static_throw(SFERR_INVALID_STATE);
        }
    }
}// SFYSingleEditWidget::SFYSingleEditWidget //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFYSingleEditWidget, OnWidgetStyle, invoker, reason)
{
    unused(invoker);
    switch (reason) {
        case SFP16_STYLE_TEXT:
            break;
        default:
            InvokeBackward(SFXEvent(SFEVT_RESPONDER_STYLE, reason, 0), true);
            break;
    }
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFYSingleEditWidget, OnWidgetStyle) //

/*private */SFCError SFYSingleEditWidget::SetWidgetText(SFXWideStringConstRef text, Bool password)
{
    SFXWideString                               string;
    SFCError                                    error(SFERR_NO_ERROR);

    if (password) {
        if ((error = string.Set(text)) == SFERR_NO_ERROR) {
            #if defined TARGET_LANGUAGE_JAPANESE
            error = SFXShiftJIS::ToPassword(&string);
            #else
            string.Fill(PASSWORD_ASCII);
            #endif
            if (error == SFERR_NO_ERROR) {
                error = _widget->SetText(string);
            }
        }
    }
    else {
        error = _widget->SetText(text);
    }
    return error;
}// SFYSingleEditWidget::SetWidgetText //

/*private */Void SFYSingleEditWidget::Relocate(Void)
{
    _widget->SetRealBound(GetLocalBound());
    return;
}// SFYSingleEditWidget::Relocate //

参照

SFYResponder::SetType | SFYSingleEditWidget::CodeEnum | SFYResponder::SetPropertyTransparent | SFYSingleEditWidget::SetInputMode | SFYSingleEditWidget::SetMaximumLength | SFYSingleEditWidget::SetPasswordMode | SFYSingleEditWidget::GetWidget | SFYResponder::SetParent | SFYResponder::SetState | SFYSingleEditWidget::SetText | SFYSingleEditWidget::SetFont | SFYSingleEditWidget::SetTextColor | SFYSingleEditWidget::SetHorizontalAlign | SFYSingleEditWidget::SetVerticalAlign | SFYSingleEditWidget::SetScrollDirection | SFYSingleEditWidget::SetScrollInterval | SFYSingleEditWidget::SetScrollStep | SFYSingleEditWidget::SetWaitInterval | SFYSingleTextWidget::NewInstance | SFYSingleTextWidget::HorizontalEnum | SFYSingleTextWidget::VerticalEnum | SFYSingleTextWidget::DirectionEnum | SFYSingleTextWidget::DefaultEnum | SFYSingleTextWidget | SFXRGBColor | タイプ | 属性 | 状態

内部実装

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

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

戻り値

解説

この関数は、ネイティブテキスト入力に遷移します（FEP を起動します）。

内部実装

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

// テキスト入力コントロールに遷移する関数
/*public */SFCError SFYSingleEditWidget::Edit(Void)
{
    SFCError  error(SFERR_NO_ERROR);

    // テキスト入力コントロールのテキストサイズの最大値を設定する
    if ((error = _property.SetMaximumLength(_maximum)) == SFERR_NO_ERROR) { 

        // テキスト入力コントロールの初期値を設定する
        if ((error = _property.SetText(_text)) == SFERR_NO_ERROR) { 

            // テキスト入力コントロールを起動する(標準 BREW に含まれる ITextCtl)
            // OnEditor は、テキスト入力コントロール終了時に起動されるコールバック関数
            error = _editor.Open(XALLBACK_INTERNAL(OnEditor));
        }
    }

    return error;
}// SFYSingleEditWidget::Edit //

/*private */XALLBACK_IMPLEMENT_SFXEDITOR(SFYSingleEditWidget, OnEditor, context)
{
    SFCError                                    error;

    if ((error = context) == SFERR_NO_ERROR) {

        if ((error = SetTextMaximumLength(_property.GetText(), _property.GetMaximumLength())) == SFERR_NO_ERROR) {

            InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, 0), false);
        }
    }
    if (error != SFERR_NO_ERROR) {

        InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ERROR, error), false);
    }
    return;
}// XALLBACK_IMPLEMENT_SFXEDITOR(SFYSingleEditWidget, OnEditor) //

参照

SFXEditor::Open

戻り値

フォント。

解説

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

参照

SFYSingleEditWidget::SetFont | BREW API AEEFont

戻り値

フォントの大きさ。

解説

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

設定されているフォントの半角 1 文字分（' ' で計算）の大きさを取得します。

参照

SFYSingleEditWidget::SetFont | BREW API AEEFont

戻り値

水平アライメントの値。

解説

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

参照

SFYSingleEditWidget::SetHorizontalAlign | SFYSingleEditWidget::HorizontalEnum

戻り値

テキスト入力モード。

解説

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

参照

SFYSingleEditWidget::SetInputMode | BREW API AEETextInputMode

戻り値

最大文字入力数。

解説

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

参照

SFYSingleEditWidget::SetMaximumLength

戻り値

解説

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

参照

SFYSingleEditWidget::SetPasswordMode

解説

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

参照

SFYSingleEditWidget::SetSFBMenuCtlClassID | SFBMenuCtl

解説

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

参照

SFYSingleEditWidget::SetSFBTextCtlClassID | SFBTextCtl

戻り値

スクロールの移動方向。

解説

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

参照

SFYSingleEditWidget::SetScrollDirection

戻り値

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

解説

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

参照

SFYSingleEditWidget::SetScrollInterval

戻り値

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

解説

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

参照

SFYSingleEditWidget::SetScrollStep

戻り値

テキスト。

解説

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

参照

SFYSingleEditWidget::SetText

戻り値

テキストの色。

解説

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

参照

SFYSingleEditWidget::SetTextColor | SFXRGBColor

戻り値

テキストの大きさ。

解説

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

設定されているフォントで描画した場合のテキストの大きさを取得します。

参照

SFYSingleEditWidget::SetFont | BREW API AEEFont

戻り値

垂直アライメントの値。

解説

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

参照

SFYSingleEditWidget::SetVerticalAlign | SFYSingleEditWidget::VerticalEnum

戻り値

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

解説

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

参照

SFYSingleEditWidget::SetWaitInterval

戻り値

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

解説

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

単一行テキストの描画は、SFYSingleTextWidget インスタンスに委譲して処理します。

参照

SFYSingleTextWidget

解説

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

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

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

デフォルトの実装は、以下のサイズを返します。

ここで、w、h、sw、sh、fw、fh は以下のように定義されます。

	単一行テキストのサイズ : sw の計算方法
	単一行テキストのサイズは、 SFYSingleEditWidget::SetFont 関数で設定したフォント、 SFYSingleEditWidget::SetText 関数で設定したテキストの内容から SFXGraphics::MeasureSingleText 関数を使用して計算します。

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

内部実装

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

SFYSingleTextWidgetSmp          _widget;

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

参照

SFYResponder::GetSuitableBound | SFYSingleTextWidget::HandleBoundOptimize | SFYSingleTextWidget | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

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

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

	仮想領域
	SFYSingleEditWidget クラスでは、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ≧ [テキストの横幅] ＞ [実領域の横幅] の関係が成り立ちテキスト全体が画面に表示されないとき、 SFYSingleEditWidget::StartScroll 関数を呼び出してもスクロールは開始しません。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベント]
	SFYResponder::SetRealBound 関数は、この関数内の処理により実領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundReal 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の実領域が設定されています。

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

内部実装

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

/*protected virtual */Void SFYSingleEditWidget::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFYSingleEditWidget::HandleBoundReal //

参照

SFYResponder::SetRealBound | SFYSingleTextWidget::HandleBoundReal | 領域イベント[SFEVT_RESPONDER_BOUND] | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND] | 仮想領域 | 実領域 | ローカル領域

解説

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

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

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

デフォルトの実装は、単一行テキストの矩形領域を返します。

単一行テキストの矩形領域のサイズは、 SFYSingleEditWidget::SetFont 関数で設定されたフォントと SFYSingleEditWidget::SetText 関数で設定されたテキストの内容から SFXGraphics::MeasureSingleText 関数を使用して計算します。

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

内部実装

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

SFYSingleTextWidgetSmp          _widget;

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

参照

SFYResponder::GetSuitableBound | SFYSingleTextWidget::HandleBoundRequest | SFYSingleTextWidget | SFXEvent | 実領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

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

デフォルトの実装は、 テキストウィジェット(SFYSingleEditWidget)のローカル領域をテキストウィジェット(SFYSingleTextWidget)の実領域として設定します。

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

	仮想領域
	SFYSingleEditWidget クラスでは、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ≧ [テキストの横幅] ＞ [実領域の横幅] の関係が成り立ちテキスト全体が画面に表示されないとき、 SFYSingleEditWidget::StartScroll 関数を呼び出してもスクロールは開始しません。

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

内部実装

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

SFYSingleTextWidgetSmp          _widget;

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

/*private */Void SFYSingleEditWidget::Relocate(Void)
{
    _widget->SetRealBound(GetLocalBound());
    return;
}// SFYSingleEditWidget::Relocate //

参照

SFYSingleEditWidget::SetText | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | SFYSingleTextWidget | 領域イベント[SFEVT_RESPONDER_BOUND] | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND] | 仮想領域 | 実領域 | ローカル領域

引数

戻り値

解説

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

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

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

使用例

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

// 単一行エディットウィジェットのインスタンスを生成する
SFCError error;
SFYSingleEditWidgetSmp _singleeditwidget;

if ((_singleeditwidget = SFYSingleEditWidget::NewInstance(&error)) != null) {
    // ...
}

解説

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

デフォルト値: AEE_FONT_NORMAL

参照

SFYSingleEditWidget::GetFont | BREW API AEEFont

解説

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

デフォルト値: SFYSingleTextWidget::DEFAULT_HORIZONTAL

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

参照

SFYSingleEditWidget::GetHorizontalAlign | SFYSingleEditWidget::HorizontalEnum | SFYSingleTextWidget::HorizontalEnum

解説

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

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

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

参照

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

戻り値

解説

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

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

デフォルト値: SINT16_MAXIMUM - 1。

参照

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

戻り値

解説

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

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

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

デフォルト値: false

参照

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

解説

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

参照

SFYSingleEditWidget::GetSFBMenuCtlClassID | SFBMenuCtl

解説

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

参照

SFYSingleEditWidget::GetSFBTextCtlClassID | SFBTextCtl

解説

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

デフォルト値: SFYSingleTextWidget::DEFAULT_DIRECTION

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

参照

SFYSingleEditWidget::GetScrollDirection | SFYSingleEditWidget::DirectionEnum | SFYSingleTextWidget::DirectionEnum

解説

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

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

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

参照

SFYSingleEditWidget::GetScrollInterval | SFYSingleEditWidget::DefaultEnum | SFYSingleTextWidget::DefaultEnum

解説

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

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

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

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

参照

SFYSingleEditWidget::GetScrollStep | SFYSingleEditWidget::DefaultEnum | SFYSingleTextWidget::DefaultEnum

戻り値

解説

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

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

参照

SFYSingleEditWidget::GetText | SFYSingleEditWidget::SetHorizontalAlign | SFYSingleEditWidget::SetVerticalAlign SFYSingleEditWidget::SetTextColor | SFYSingleEditWidget::SetFont

解説

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

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

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

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

参照

SFYSingleEditWidget::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

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

デフォルト値: SFYSingleTextWidget::DEFAULT_VERTICAL

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

参照

SFYSingleEditWidget::GetVerticalAlign | SFYSingleEditWidget::VerticalEnum | SFYSingleTextWidget::VerticalEnum

解説

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

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

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

参照

SFYSingleEditWidget::GetWaitInterval | SFYSingleEditWidget::DefaultEnum | SFYSingleTextWidget::DefaultEnum

解説

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

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

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

参照

SFYSingleEditWidget::StopScroll

解説

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

参照

SFYSingleEditWidget::StartScroll

参照

SFYResponder::GetType | SFYResponder::SetType

参照

SFYSingleTextWidget::DefaultEnum

参照

SFYSingleTextWidget::DirectionEnum

参照

SFYSingleTextWidget::HorizontalEnum

参照

SFYSingleTextWidget::VerticalEnum