SFXEditor

ネイティブテキスト入力コントロールを簡単に扱うためのクラスです。

#include <SFXEditor.h.hpp>

class SFXEditor;

SFMTYPEDEFCLASS(SFXEditor)

協調図

解説

ネイティブテキスト入力コントロールを扱うためのクラスです。

参照

BREW API ITEXTCTL | BREW API IMenuCtl | BREW API AEETextInputMode

メンバ

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

パブリック関数
`Void`	Close( `Void` ) ネイティブテキスト入力コントロールを終了します。
`AEETextInputMode`	GetInputMode( `Void` ) ネイティブテキスト入力コントロールの入力モードを取得します。
`UInt16`	GetMaximumLength( `Void` ) ネイティブテキスト入力コントロールがサポートするテキストサイズの最大値を取得します。
`Bool`	GetPasswordMode( `Void` ) パスワードモードを取得します。
`AEECLSID`	GetSFBMenuCtlClassID( `Void` ) メニューコントロールのクラス ID を取得します。
`AEECLSID`	GetSFBTextCtlClassID( `Void` ) ネイティブテキスト入力コントロールのクラス ID を取得します。
`SFXWideStringConstRef`	GetText( `Void` ) ネイティブテキスト入力コントロールに設定された文字列を取得します。
`SFCError`	Open( `CallbackSPP` spp , `VoidPtr` reference ) ネイティブテキスト入力コントロールを開始します。
`Void`	SetInputMode( `AEETextInputMode` param ) ネイティブテキスト入力の入力モードを設定します。
`SFCError`	SetMaximumLength( `UInt16` param ) ネイティブテキスト入力コントロールがサポートするテキストサイズの最大値を設定します。
`Void`	SetPasswordMode( `Bool` param ) パスワードモードを設定します。
`Void`	SetSFBMenuCtlClassID( `AEECLSID` param ) メニューコントロールのクラス ID を設定します。
`Void`	SetSFBTextCtlClassID( `AEECLSID` param ) ネイティブテキスト入力コントロールのクラス ID を設定します。
`SFCError`	SetText( `SFXWideStringConstRef` param ) 指定した文字列をネイティブテキスト入力コントロールのテキスト文字列に設定します。

型
CallbackSPP コールバック関数を表す型です。

SFXEditor::SFXEditor

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

[ public, explicit ]
SFXEditor(Void);

SFXEditor::~SFXEditor

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

[ public ]
~SFXEditor(Void);

SFXEditor::Close

ネイティブテキスト入力コントロールを終了します。

[ public ]
Void Close(Void);

解説

SFXEditor::SetSFBMenuCtlClassID 関数と、SFXEditor::SetSFBTextCtlClassID 関数で設定したメニューコントロールとネイティブテキスト入力コントロールを非アクティブにし解放します。また、ネイティブテキスト入力コントロール用イベントハンドラとしてイベントを優先して処理するコールバック関数の登録を解除します。

参照

SFXEditor::Open | SFXEditor::SetSFBMenuCtlClassID | SFXEditor::SetSFBTextCtlClassID | SFCApplication::UnregisterBypass

SFXEditor::GetInputMode

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

[ public, const ]
AEETextInputMode GetInputMode(Void);

戻り値

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

解説

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

参照

SFXEditor::SetInputMode | BREW API ITEXTCTL_GetInputMode | BREW API AEETextInputMode

SFXEditor::GetMaximumLength

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

[ public, const ]
UInt16 GetMaximumLength(Void);

戻り値

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

解説

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

参照

SFXEditor::SetMaximumLength | BREW API ITEXTCTL_SetMaxSize

SFXEditor::GetPasswordMode

パスワードモードを取得します。

[ public, const ]
Bool GetPasswordMode(Void);

戻り値

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

解説

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

参照

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

SFXEditor::GetSFBMenuCtlClassID

メニューコントロールのクラス ID を取得します。

[ public, const ]
AEECLSID GetSFBMenuCtlClassID(Void);

戻り値

メニューコントロールのクラス ID。

解説

SFXEditor::SetSFBMenuCtlClassID 関数によって設定されたネイティブテキスト入力コントロールのメニューコントロールのクラス ID を取得します。詳細は、BREW リファレンスの IMenuCtl 及び ITEXTCTL_SetSoftKeyMenu() の説明をご覧ください。

参照

SFXEditor::SetSFBMenuCtlClassID | BREW API IMenuCtl | BREW API ITEXTCTL_SetSoftKeyMenu

SFXEditor::GetSFBTextCtlClassID

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

[ public, const ]
AEECLSID GetSFBTextCtlClassID(Void);

戻り値

ネイティブテキスト入力コントロールのクラス ID。

解説

SFXEditor::SetSFBTextCtlClassID 関数によって設定されたネイティブテキスト入力コントロールのクラス ID を返します。詳細は、BREW リファレンスの ITEXTCTL の説明をご覧ください。

参照

SFXEditor::SetSFBTextCtlClassID | BREW API ITEXTCTL

SFXEditor::GetText

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

[ public, const ]
SFXWideStringConstRef GetText(Void);

戻り値

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

解説

詳細は、BREW リファレンスの ITEXTCTL_GetText() の説明をご覧ください。

参照

SFXEditor::SetText | BREW API ITEXTCTL_GetText

SFXEditor::Open

ネイティブテキスト入力コントロールを開始します。

[ public ]
SFCError Open(
    CallbackSPP spp     // コールバック関数
    VoidPtr reference   // ユーザーデータ
);

解説

SFXEditor::SetSFBMenuCtlClassID、 SFXEditor::SetSFBTextCtlClassID、 SFXEditor::SetPasswordMode、 SFXEditor::SetInputMode、 SFXEditor::SetMaximumLength、 SFXEditor::SetText 関数で設定された内容でネイティブテキスト入力コントロールを作成します。同時に、ネイティブテキスト入力コントロール用イベントハンドラとしてイベントを優先して処理するコールバック関数を登録します。引数には、ネイティブテキスト入力コントロールでの処理完了後に呼び出されるコールバック関数を指定します。

参照

SFXEditor::SetInputMode

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

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

解説

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

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

参照

SFXEditor::GetInputMode | BREW API ITEXTCTL_SetInputMode | BREW API AEETextInputMode

SFXEditor::SetMaximumLength

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

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

解説

ネイティブテキスト入力コントロールがサポートするテキストサイズの最大値を設定します。詳細は、BREW リファレンスの ITEXTCTL_SetMaxSize() の説明をご覧ください。

デフォルト値 : SINT16_MAXIMUM - 1。

参照

SFXEditor::GetMaximumLength | SFXEditor::SetText | BREW API ITEXTCTL_SetMaxSize

SFXEditor::SetPasswordMode

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

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

解説

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

デフォルト値 : false

参照

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

SFXEditor::SetSFBMenuCtlClassID

メニューコントロールのクラス ID を設定します。

[ public ]
Void SetSFBMenuCtlClassID(
    AEECLSID param   // メニューコントロールのクラス ID
);

解説

ネイティブテキスト入力コントロールのソフトキーメニューを、指定されたクラス ID のメニューコントロールに設定します。詳細は、BREW リファレンスの IMenuCtl 及び ITEXTCTL_SetSoftKeyMenu() の説明をご覧ください。

デフォルト値 : AEECLSID_SOFTKEYCTL

参照

SFXEditor::GetSFBMenuCtlClassID | BREW API IMenuCtl | BREW API ITEXTCTL_SetSoftKeyMenu

SFXEditor::SetSFBTextCtlClassID

ネイティブテキスト入力コントロールのクラス ID を設定します。

[ public ]
Void SetSFBTextCtlClassID(
    AEECLSID param   // ネイティブテキスト入力コントロールのクラス ID
);

解説

ネイティブテキスト入力コントロールを指定されたクラス ID のネイティブテキスト入力コントロールに設定します。詳細は、BREW リファレンスの ITEXTCTL の説明をご覧ください。

デフォルト値 : AEECLSID_TEXTCTL

参照

SFXEditor::GetSFBTextCtlClassID | BREW API ITEXTCTL

SFXEditor::SetText

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

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

解説

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

参照

SFXEditor::GetText | SFXEditor::SetMaximumLength | BREW API ITEXTCTL_SetText

SFXEditor::CallbackSPP

コールバック関数を表す型です。

typedef Void(*) SFXEditor::CallbackSPP(SFCError error, VoidPtr reference)