SFXBaseEditor

ネイティブテキスト入力コントロールエディタの基底クラスです。

#include <SFXBaseEditor.h.hpp>

class SFXBaseEditor;

SFMTYPEDEFCLASS(SFXBaseEditor)

協調図

解説

SFXBaseEditor クラスは、 BREW ネイティブテキスト入力コントロール(BREW API ITextCtl と BREW API IMenuCtl)をカプセル化して簡単に扱うための基底クラスです。

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

参照

SFXEditor | SFXEditProperty | BREW API ITextCtl | BREW API IMenuCtl | BREW API AEETextInputMode

メンバ

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

パブリック関数
`AEECLSID`	GetSFBMenuCtlClassID( `Void` ) ネイティブテキスト入力コントロールのメニューコントロールのクラス ID を取得します。
`AEECLSID`	GetSFBTextCtlClassID( `Void` ) ネイティブテキスト入力コントロールのクラス ID を取得します。
`SFCError`	Open( `SFXEditPropertyPtr` property , `CallbackSPP` spp , `VoidPtr` reference ) ネイティブテキスト入力コントロールを開始します。
`Void`	SetSFBMenuCtlClassID( `AEECLSID` param ) メニューコントロールのクラス ID を設定します。
`Void`	SetSFBTextCtlClassID( `AEECLSID` param ) ネイティブテキスト入力コントロールのクラス ID を設定します。

プロテクト関数
static `SFCError`	RegisterBypass( `SFCApplication::CallbackSPP` spp , `VoidPtr` reference ) 優先的イベントハンドラを登録します。
static `Void`	UnregisterBypass( `SFCApplication::CallbackSPP` spp , `VoidPtr` reference ) 優先的イベントハンドラの登録を解除します。

型
CallbackSPP ネイティブテキスト入力コントロール（FEP）終了時に呼び出されるコールバック関数を表す型です。

SFXBaseEditor::SFXBaseEditor

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

[ public, explicit ]
SFXBaseEditor(Void);

解説

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

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

参照

BREW API ITextCtl | BREW API IMenuCtl

SFXBaseEditor::~SFXBaseEditor

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

[ public, virtual ]
~SFXBaseEditor(Void);

解説

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

SFXBaseEditor::GetSFBMenuCtlClassID

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

[ public, const ]
AEECLSID GetSFBMenuCtlClassID(Void);

戻り値

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

解説

この関数は、 SFXBaseEditor::SetSFBMenuCtlClassID 関数によって設定されたネイティブテキスト入力コントロールのメニューコントロールのクラス ID を取得します。

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

参照

SFXBaseEditor::SetSFBMenuCtlClassID | BREW API IMenuCtl | BREW API ITEXTCTL_SetSoftKeyMenu

SFXBaseEditor::GetSFBTextCtlClassID

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

[ public, const ]
AEECLSID GetSFBTextCtlClassID(Void);

戻り値

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

解説

この関数は、 SFXBaseEditor::SetSFBTextCtlClassID 関数によって設定されたネイティブテキスト入力コントロールのクラス ID を返します。

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

参照

SFXBaseEditor::SetSFBTextCtlClassID | BREW API ITextCtl

SFXBaseEditor::Open

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

[ public, virtual ]
SFCError Open(
    SFXEditPropertyPtr property   // ネイティブテキスト入力コントロールのプロパティ
    CallbackSPP spp               // ネイティブテキスト入力コントロール終了時に起動されるコールバック関数
    VoidPtr reference             // コールバック関数に渡されるデータ（参照値）
);

解説

この関数は、ネイティブテキスト入力コントロールを開始します。

spp 引数には、テキスト入力コントロール終了時に起動されるコールバック関数（SFXBaseEditor::CallbackSPP）を指定します。 reference 引数には、そのコールバック関数に渡すデータを指定します。

注意

	注意
この関数は、このクラスを継承してテキスト入力コントロールエディタの具象クラスを新たに定義するときに実装する必要があります。具体的な実装方法については、 `SFXEditor::Open` 関数の解説を参照してください。

この関数は、このクラスを継承してテキスト入力コントロールエディタの具象クラスを新たに定義するときに実装する必要があります。

具体的な実装方法については、 SFXEditor::Open 関数の解説を参照してください。

参照

SFXEditor::Open | SFXBaseEditor::CallbackSPP

SFXBaseEditor::RegisterBypass

優先的イベントハンドラを登録します。

[ protected, static ]
SFCError RegisterBypass(
    SFCApplication::CallbackSPP spp   // 優先的イベントハンドラ
    VoidPtr reference                 // 優先的イベントハンドラに渡すデータ（参照値）
);

戻り値

成功したとき: SFERR_NO_ERROR
アプリケーションクラスのインスタンスが取得できなかったとき: SFERR_INVALID_STATE

解説

この関数は、優先的イベントハンドラを SFCApplication クラスを継承するアプリケーションクラスのインスタンスに登録するための関数です。

	注意
	この処理は、内部的に `SFXEventBypass::Register` 関数を呼び出して実行されます。

	優先的イベントハンドラについて
	`SFXEventBypass::Register` にある解説を参照してください。

内部実装

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

/*protected static*/inline SFCError SFXBaseEditor::RegisterBypass(SFCApplication::CallbackSPP spp, VoidPtr reference)
{
    return SFXEventBypass::Register(spp, reference);
}// SFXBaseEditor::RegisterBypass //

参照

SFXBaseEditor::UnregisterBypass | SFXEventBypass::Register | SFCApplication::GetInstance

SFXBaseEditor::SetSFBMenuCtlClassID

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

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

解説

この関数は、ネイティブテキスト入力コントロールのソフトキーメニューを、指定されたクラス ID のメニューコントロールに設定します。

デフォルト値: AEECLSID_SOFTKEYCTL

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

参照

SFXBaseEditor::GetSFBMenuCtlClassID | BREW API IMenuCtl | BREW API ITEXTCTL_SetSoftKeyMenu

SFXBaseEditor::SetSFBTextCtlClassID

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

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

解説

この関数は、ネイティブテキスト入力コントロールを指定されたクラス ID のネイティブテキスト入力コントロールに設定します。

デフォルト値: AEECLSID_TEXTCTL

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

参照

SFXBaseEditor::GetSFBTextCtlClassID | BREW API ITextCtl

SFXBaseEditor::UnregisterBypass

優先的イベントハンドラの登録を解除します。

[ protected, static ]
Void UnregisterBypass(
    SFCApplication::CallbackSPP spp   // 優先的イベントハンドラ
    VoidPtr reference                 // ユーザーデータ
);

解説

この関数は、 SFCApplication クラスを継承するアプリケーションクラスのインスタンスへの優先的イベントハンドラの登録を解除するための関数です。

	注意
	この処理は、内部的に `SFXEventBypass::Unregister` 関数を呼び出して実行されます。

	優先的イベントハンドラについて
	`SFXEventBypass::Register` にある解説を参照してください。

内部実装

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

/*protected static*/inline Void SFXBaseEditor::UnregisterBypass(SFCApplication::CallbackSPP spp, VoidPtr reference)
{
    SFXEventBypass::Unregister(spp, reference);
    return;
}// SFXBaseEditor::UnregisterBypass //

参照

SFXBaseEditor::RegisterBypass | SFXEventBypass::Unregister | SFCApplication::UnregisterBypass

SFXBaseEditor::CallbackSPP

ネイティブテキスト入力コントロール（FEP）終了時に呼び出されるコールバック関数を表す型です。

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

解説

SFXBaseEditor::Open / SFXEditor::Open 関数の spp 引数に指定するコールバック関数の型です。

このコールバック関数は、ネイティブテキスト入力コントロール（FEP）終了時に SFXBaseEditor::Open / SFXEditor::Open 関数の内部処理によって呼び出されます。

参照

SFXBaseEditor::Open | SFXEditor::Open