Inheritance diagram

Collaboration diagram

Description

SFREditboxControl is a control that represents an editable box for text input.

Since based on the ITextCtl of the standard BREW API, the specification of SFREditboxControl class depends on the BREW implementation.

After creating the SFREditboxControl object, never forget to set the maximum number of input characters by using the SetMaxSize function.

And text can be inputted only when the SFREditboxControl object is at the foremost.

The code to use an editbox control is as below:

SFMTYPEDEFCLASS(MyWindow)
class MyWindow : public SFRTitleWindow {
    SFMSEALCOPY(MyWindow)
public:
    MyWindow(Void) static_throws;
    virtual ~MyWindow(Void) { return; }
    
    // text box is defined as a member variable of the SFREditboxControlPtr type
    SFREditboxControlPtr     _editbox;      // text box
    
    HANDLER_DECLARE_VOIDCONTROL(OnEditboxControl)
};

// constructor (error handling is omitted)
MyWindow::MyWindow(Void) : SFRTitleWindow(SFRApplication::GetInstance(),
    SFXRectangle(20, 20, 200, 250), "my window") static_throws
{

    // creation of text box
    // first argument  : parent responder
    // second argument : position and size of text box
    // third argument  : name of text box
     _editbox = new SFREditboxControl(this, 
                              SFXRectangle(20, 50, 150, 25), 
                                     "Editbox");
                                     
    // specify the maximum number of characters
    _editbox->SetMaxSize(255);

    // set the event handler when input processing is completed or the text box is unfocused
    editbox->RegisterHandler(SREVT_CONTROL, 
                             HANDLER_BEFORE,
                             HANDLER_FUNCTION(OnEditboxControl)));
    }

    // switch to input mode when the SELECT key is pressed over the text box
    // ( SelectHandler is the select handler which is available in SophiaFramework )
    RegisterHandler(SFEVT_KEY, 
                    AVK_SELECT, 
                    HANDLER_AFTER,
                    HANDLER_FUNCTION(SelectHandler)));
    }
    
    return;
}

Event after Text Input

When input processing is completed or the editbox is unfocused, the event of SFEVT_CONTROL is sent to the editbox control.

The P16 value of SFEVT_CONTROL event is as below:

// the event handler when the input processing is completed or the text box is unfocused
HANDLER_IMPLEMENT_VOIDCONTROL(MyWindow, OnEditboxControl, result, control)
{
    // release the target
    control->SetStatusTarget(false);

    if (result) { // if the input is finished
        
        // focus the next
        FocusNext();

    } // if it is unfocused
    else {
        //..
    }
}

Reference

SFRResponder | SFRApplication | SFRWindow | SFRDialog | SFRControl | Text Box

Member

Description

Class ID for BREW text control which is used in the SFREditboxControl class can be specified. By default it is AEECLSID_TEXTCTL.

	When using the BREW SDK 3.1.2
	Specify the id augument with the value of AEECLSID_TEXTCTL_10 explicitly.

Description

First it is necessary to call the EnumModeInit function before enumerating the text mode of control.

Reference

SFREditboxControl::EnumNextMode

Return value

At the completion of enumerating the mode of text control, AEE_TM_NONE is returned.

Reference

SFREditboxControl::EnumModeInit

Argument

Description

The behavior is not defined when the specified palette index is invalid.

Example

Get the base color

SFREditboxControlPtr  textcontrol;
SFXRGBColor           color;

textcontrol = new SFREditboxControl(window, SFXRectangle(5, 5, 48, 16), "sample");
color = textcontrol->GetColor(SFREditboxControl::COLOR_BUTTON_BASE);

Reference

SFREditboxControl::SetColor | SFREditboxControl::ColorEnum

Reference

SFREditboxControl::SetCursorPos

Return value

Return the current mode of text input.

Reference

SFREditboxControl::SetInputMode

Reference

SFREditboxControl::SetProperties

Reference

SFREditboxControl::SetText

Argument

Description

The behavior is not defined when the specified palette index is invalid.

Reference

SFREditboxControl::GetColor | SFREditboxControl::ColorEnum

Reference

SFRResponder::GetContentBound

Reference

SFREditboxControl::GetCursorPos

Return value

Return the mode of text input to be set.

Reference

SFREditboxControl::GetInputMode

Reference

SFREditboxControl::GetProperties

Reference

SFREditboxControl::GetText

Reference

SFRResponder::GetVirtualBound

Description

SFREditboxControl::ColorEnum is used to set or get the color of specific part of SFREditboxControl object.

Reference

SFREditboxControl::SetColor | SFREditboxControl::GetColor