SFXEditProperty

ネイティブテキスト入力コントロールのプロパティを編集するためのクラスです。

#include <SFXEditProperty.h.hpp>

class SFXEditProperty;

<link linkend="sec.macro.core.typedef.SFMTYPEDEFCLASS">SFMTYPEDEFCLASS</link>(SFXEditProperty)

協調図

解説

SFXEditProperty クラスは、 BREW ネイティブテキスト入力コントロール(BREW API ITextCtl と BREW API IMenuCtl)のプロパティを編集するためのクラスです。

SFZSingleEditLabelControl クラスと SFZSingleEditBoxControl クラス、 SFZMultipleEditLabelControl クラスと SFZMultipleEditBoxControl クラスが、それぞれ内部で子レスポンダとして保持する SFYSingleEditWidget クラス、SFYMultipleEditWidget クラスで内部的に利用されます。

SophiaFramework UNIVERSE では、BREW ネイティブテキスト入力コントロールの処理は SFXBaseEditor、 SFXEditor、 SFXEditProperty クラスに一元化されています。そして、BREW SDK のバージョンや、シミュレータ、実機に関係なく、単一の同じコードを記述するだけで良いように実装されています。

参照

メンバ

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

パブリック関数
`AEETextInputMode`	GetInputMode( `Void` ) ネイティブテキスト入力コントロールの入力モードを取得します。
`UInt16`	GetMaximumLength( `Void` ) ネイティブテキスト入力コントロールがサポートするテキストサイズの最大値を取得します。
`Bool`	GetPasswordMode( `Void` ) ネイティブテキスト入力コントロールのパスワードモードを取得します。
`SFXWideStringConstRef`	GetText( `Void` ) ネイティブテキスト入力コントロールに設定された文字列を取得します。
`Void`	SetInputMode( `AEETextInputMode` param ) ネイティブテキスト入力の入力モードを設定します。
`SFCError`	SetMaximumLength( `UInt16` param ) ネイティブテキスト入力コントロールがサポートするテキストサイズの最大値を設定します。
`Void`	SetPasswordMode( `Bool` param ) パスワードモードを設定します。
`SFCError`	SetText( `SFXWideStringConstRef` param ) 指定した文字列をネイティブテキスト入力コントロールのテキスト文字列に設定します。

SFXEditProperty::SFXEditProperty

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

[ public, explicit ]
SFXEditProperty(Void);

解説

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

ネイティブテキスト入力コントロールがサポートするテキストサイズの最大値を "SINT16_MAXIMUM - 1" に設定します。
ネイティブテキスト入力の入力モードを AEE_TM_CURRENT に設定します。
パスワードモードを false に設定します。

参照

SFXEditProperty::SetMaximumLength | SFXEditProperty::SetInputMode | SFXEditProperty::SetPasswordMode | SFXEditProperty::SetText

SFXEditProperty::~SFXEditProperty

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

[ public ]
~SFXEditProperty(Void);

SFXEditProperty::GetInputMode

ネイティブテキスト入力コントロールの入力モードを取得します。

[ public, const ]
AEETextInputMode GetInputMode(Void);

戻り値

ネイティブテキスト入力コントロールの入力モード。

解説

SFXEditProperty::SetInputMode 関数によって設定されたネイティブテキスト入力コントロールに使用できるテキスト入力モードを取得します。詳細は、BREW リファレンスの ITEXTCTL_GetInputMode() および AEETextInputMode の説明を参照してください。

参照

SFXEditProperty::SetInputMode | BREW API ITEXTCTL_GetInputMode | BREW API AEETextInputMode

SFXEditProperty::GetMaximumLength

ネイティブテキスト入力コントロールがサポートするテキストサイズの最大値を取得します。

[ public, const ]
UInt16 GetMaximumLength(Void);

戻り値

ネイティブテキスト入力コントロールがサポートするテキストサイズの最大値。

解説

SFXEditProperty::SetMaximumLength 関数によって設定されたネイティブテキスト入力コントロールがサポートするテキストサイズの最大値を取得します。詳細は、BREW リファレンスの ITEXTCTL_SetMaxSize() の説明を参照してください。

参照

SFXEditProperty::SetMaximumLength | BREW API ITEXTCTL_SetMaxSize

SFXEditProperty::GetPasswordMode

ネイティブテキスト入力コントロールのパスワードモードを取得します。

[ public, const ]
Bool GetPasswordMode(Void);

戻り値

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

解説

SFXEditProperty::SetPasswordMode 関数で設定したネイティブテキスト入力コントロールのパスワードモードに関するプロパティ値を返します。詳細は、BREW リファレンスの ITEXTCTL_SetProperties() および AEE ITextCtl のプロパティを参照してください。

参照

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

SFXEditProperty::GetText

ネイティブテキスト入力コントロールに設定された文字列を取得します。

[ public, const ]
SFXWideStringConstRef GetText(Void);

戻り値

ネイティブテキスト入力コントロールに設定された文字列。

解説

詳細は、BREW リファレンスの ITEXTCTL_GetText() の説明を参照してください。

参照

SFXEditProperty::SetText | BREW API ITEXTCTL_GetText

SFXEditProperty::SetInputMode

ネイティブテキスト入力の入力モードを設定します。

[ public ]
Void SetInputMode(
    AEETextInputMode param   // 設定する入力モード
);

解説

ネイティブテキスト入力コントロールに使用できるテキスト入力モードを指定します。詳細は、BREW リファレンスの ITEXTCTL_SetInputMode() および AEETextInputMode の説明を参照してください。

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

使用例

以下は、SFYSingleEditWidget::SetInputMode 関数の実装における使用例です。

class SFYSingleEditWidget : public SFYWidget {
    private:

        ...

        SFXEditProperty  _property;

        ...

};

/*public */Void SFYSingleEditWidget::SetInputMode(AEETextInputMode param)
{
    if (param != _property.GetInputMode()) {

        _property.SetInputMode(param);
        Invalidate();
    }

    return;
}// SFYSingleEditWidget::SetInputMode //

参照

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

SFXEditProperty::SetMaximumLength

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

[ public ]
SFCError SetMaximumLength(
    UInt16 param   // 設定する文字数
);

戻り値

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

解説

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

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

デフォルト値: SINT16_MAXIMUM - 1。

使用例

以下は、SFYSingleEditWidget::Edit 関数の実装における使用例です。

class SFYSingleEditWidget : public SFYWidget {
    private:

        ...

        SFXBaseEditorPtr _editor;
        SFXEditProperty  _property;

        ...

};

// テキスト入力コントロールに遷移する関数
/*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 //

参照

SFXEditProperty::GetMaximumLength | SFXEditProperty::SetText | BREW API ITEXTCTL_SetMaxSize

SFXEditProperty::SetPasswordMode

パスワードモードを設定します。

[ public ]
Void SetPasswordMode(
    Bool param   // 設定する値(入力文字列を *** で表示するなら true、さもなければ false)
);

戻り値

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

解説

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

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

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

デフォルト値: false

使用例

以下は、SFYSingleEditWidget::SetPasswordMode 関数の実装における使用例です。

class SFYSingleEditWidget : public SFYWidget {
    private:

        ...

        SFXEditProperty  _property;

        ...

};

/*public */SFCError SFYSingleEditWidget::SetPasswordMode(Bool param)
{
    SFCError  error(SFERR_NO_ERROR);

    if (param != _property.GetPasswordMode()) {

        if ((error = SetWidgetText(_text, param)) == SFERR_NO_ERROR) {

            _property.SetPasswordMode(param);
            Invalidate();
        }
    }

    return error;
}// SFYSingleEditWidget::SetPasswordMode //

参照

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

SFXEditProperty::SetText

指定した文字列をネイティブテキスト入力コントロールのテキスト文字列に設定します。

[ public ]
SFCError SetText(
    SFXWideStringConstRef param   // 文字列
);

解説

ネイティブテキスト入力コントロールのテキスト文字列に、最大 SFXEditProperty::SetMaximumLength 関数で指定した文字数まで引数でしていた文字列を設定します。詳細は、BREW リファレンスの ITEXTCTL_SetText() の説明を参照してください。

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

使用例

以下は、SFYSingleEditWidget::Edit 関数の実装における使用例です。

class SFYSingleEditWidget : public SFYWidget {
    private:

        ...

        SFXBaseEditorPtr _editor;
        SFXEditProperty  _property;

        ...

};

// テキスト入力コントロールに遷移する関数
/*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 //

参照

SFXEditProperty::GetText | SFXEditProperty::SetMaximumLength | BREW API ITEXTCTL_SetText