![]() ![]() ![]() ![]() |
SophiaFramework UNIVERSE 5.3 |
#include <SFXBaseEditor.h.hpp>
class SFXBaseEditor;
<link linkend="sec.macro.core.typedef.SFMTYPEDEFCLASS">SFMTYPEDEFCLASS</link>(SFXBaseEditor)
SFXEditor is the base class with which you can use the text input control of the standard BREW (i.e., BREW API ITextCtl and BREW API IMenuCtl) easily by encapsulation.
In SophiaFramework UNIVERSE, processing of the text input control of the standard BREW is encapsulated into the SFXBaseEditor, SFXEditor, and SFXEditProperty classes. It is enough that the same one kind of code has only to be programmed regardless of BREW SDK version, simulator, and device.
SFXEditor | SFXEditProperty | BREW API ITextCtl | BREW API IMenuCtl | BREW API AEETextInputMode
Constructor/Destructor |
---|
SFXBaseEditor( Void ) Constructor of the SFXBaseEditor class.
|
~SFXBaseEditor( Void ) Destructor of the SFXBaseEditor class.
|
Public Functions | |
---|---|
AEECLSID |
GetSFBMenuCtlClassID( Void ) Get the Class ID of the menu control of the text input control of the standard BREW.
|
AEECLSID |
GetSFBTextCtlClassID( Void ) Get the Class ID of the text input control of the standard BREW.
|
SFCError |
Open(
SFXEditPropertyPtr property
, CallbackSPP spp
, VoidPtr reference
) Open the text input control of the standard BREW.
|
Void |
SetSFBMenuCtlClassID(
AEECLSID param
) Set the Class ID of the menu control of the text input control of the standard BREW.
|
Void |
SetSFBTextCtlClassID(
AEECLSID param
) Set the Class ID of the text input control of the standard BREW.
|
Protected Functions | |
---|---|
static SFCError |
RegisterBypass(
SFCApplication::CallbackSPP spp
, VoidPtr reference
) Register the highest priority event handler.
|
static Void |
UnregisterBypass(
SFCApplication::CallbackSPP spp
, VoidPtr reference
) Unregister the highest priority event handler.
|
Types |
---|
CallbackSPP Type of the callback function which will be called when the text input control(FEP) is finished.
|
[ public, explicit ] SFXBaseEditor(Void);
This constructor performs the initializations as follows:
[ public, virtual ] ~SFXBaseEditor(Void);
[ public, const ] AEECLSID GetSFBMenuCtlClassID(Void);
Class ID of the menu control of native BREW text input control
This function gets the Class ID of the menu control of the text input control of the standard BREW set with the SFXBaseEditor::SetSFBMenuCtlClassID function. For more details, see IMenuCtl and ITEXTCTL_SetSoftKeyMenu() of the BREW reference.
SFXBaseEditor::SetSFBMenuCtlClassID | BREW API IMenuCtl | BREW API ITEXTCTL_SetSoftKeyMenu
[ public, const ] AEECLSID GetSFBTextCtlClassID(Void);
Class ID of the native BREW text input control
This function gets the Class ID of the text input control of the standard BREW set with the SFXBaseEditor::SetSFBTextCtlClassID function. For more details, see ITextCtl of the BREW reference.
[ public, virtual ] SFCError Open( SFXEditPropertyPtr property // property for the text input control CallbackSPP spp // callback function which will be called when the text input control(FEP) is finished VoidPtr reference // user data which will be passed to the callback function );
This function must be implemented in the concrete class of the text input control which is newly defined by inheriting from the SFXBaseEditor class.
In the spp argument, the callback function which will be called when the text input finishes is specified.
For the method to implement this function, see the description of the SFXEditor::Open function.
[ protected, static ] SFCError RegisterBypass( SFCApplication::CallbackSPP spp // highest priority event handler VoidPtr reference // user data );
SFXBaseEditor::RegisterBypass is the function to register a highest priority event handler into the instance of an application class inheriting from SFCApplication.
![]() |
Note |
---|---|
This function is implemented by calling the SFCApplication::RegisterBypass function internally. |
![]() |
Highest Priority Event Handler |
---|---|
For more details, see the description of the SFCApplication::RegisterBypass function. |
The internal implemenation of this function is as follows.
/*protected static*/inline SFCError SFXBaseEditor::RegisterBypass(SFCApplication::CallbackSPP spp, VoidPtr reference) { return SFXEventBypass::Register(spp, reference); }// SFXBaseEditor::RegisterBypass //
[ public ] Void SetSFBMenuCtlClassID( AEECLSID param // Class ID of the menu control of the text input control of the standard BREW );
This function sets the Class ID of the menu control of the text input control of the standard BREW. For more details, see IMenuCtl and ITEXTCTL_SetSoftKeyMenu() of the BREW reference.
Default: AEECLSID_SOFTKEYCTL
SFXBaseEditor::GetSFBMenuCtlClassID | BREW API IMenuCtl | BREW API ITEXTCTL_SetSoftKeyMenu
[ public ] Void SetSFBTextCtlClassID( AEECLSID param // Class ID of the text input control of the standard BREW );
This function sets the Class ID of the text input control of the standard BREW. For more details, see BREW API ITextCtl of the BREW reference.
Default: AEECLSID_TEXTCTL
[ protected, static ] Void UnregisterBypass( SFCApplication::CallbackSPP spp // highest priority event handler VoidPtr reference // user data );
SFXBaseEditor::UnregisterBypass is the function to unregister a highest priority event handler from the instance of an application class inheriting from SFCApplication.
![]() |
Note |
---|---|
This function is implemented by calling the SFCApplication::UnregisterBypass function internally. |
![]() |
Highest Priority Event Handler |
---|---|
For more details, see the description of the SFCApplication::RegisterBypass function. |
SFXBaseEditor::RegisterBypass | SFXEventBypass::Unregister | SFCApplication::UnregisterBypass
typedef Void(*) SFXBaseEditor::CallbackSPP(SFCError error, VoidPtr reference)
This is the type of the callback function which will be called when the text input control(FEP) is finished, which is specified in the spp argument of the SFXBaseEditor::Open / SFXEditor::Open function.
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |
![]() ![]() ![]() ![]() |