Inheritance diagram

Collaboration diagram

Description

How to use

Box control to display a single editable text(SFZSingleEditBoxControl) can be focused. In the focused state, it will transit to the text input screen if the operation key set with the SFYBoxControl::SetOperateKey function is pressed. After text input, it will receive the result event [if text input succeeds, SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue()), otherwise SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ERROR, Error Value)].

	Note
	This result event will occur in the SFZSingleEditBoxControl::HandleOperateKey function.

If there are more characters than can be displayed in the box area of a box control, this control will start to scroll automatically when it is in the focused state.

	If the text input control is suspended [applicable only to BREW 2.0 / 2.1 / 3.1 ]
	In case of BREW 2.0 / 2.1 / 3.1, if the text input control of BREW is suspended, it will finish and return to your applet. This is the specification of SophiaFramework UNIVERSE.

Figure 375. Execution Result(Standard Input Mode)

Figure 376. Execution Result(Password Input Mode)

Reference

Box Control to Display a Single Editable Text [SFZSingleEditBoxControl] | SFYControl | SFYBoxControl | SFYSingleTextWidget

Member

Description

This constructor performs the initializations as follows:

	Note
	In a responder inheriting from SFZSingleEditBoxControl, the corresponding handler will be called when one of the above events occurs.

Reference

SFYResponder::SetType | SFZSingleEditBoxControl::CodeEnum | SFYResponder::SetParent | SFYResponder::SetState | SFZSingleEditBoxControl::SetText | SFZSingleEditBoxControl::SetFont | SFZSingleEditBoxControl::SetTextColor | SFZSingleEditBoxControl::SetHorizontalAlign | SFZSingleEditBoxControl::SetVerticalAlign | SFZSingleEditBoxControl::SetScrollDirection | SFZSingleEditBoxControl::SetScrollInterval | SFZSingleEditBoxControl::SetScrollStep | SFZSingleEditBoxControl::SetWaitInterval | SFZSingleEditBoxControl::HorizontalEnum | SFZSingleEditBoxControl::VerticalEnum | SFZSingleEditBoxControl::DirectionEnum | SFZSingleEditBoxControl::DefaultEnum | SFYSingleEditWidget::NewInstance | SFYSingleEditWidget | SFXRGBColor | Type | State | Event | State Event[SFEVT_RESPONDER_STATE]

Description

This destructor does nothing.

Description

This function gets the font.

Reference

SFZSingleEditBoxControl::SetFont

Return value

Value of the horizontal alignment.

Reference

SFZSingleEditBoxControl::SetHorizontalAlign | SFZSingleEditBoxControl::HorizontalEnum

Return value

Text input mode.

Reference

SFZSingleEditBoxControl::SetInputMode

Reference

SFZSingleEditBoxControl::SetMaximumLength

Return value

Reference

SFZSingleEditBoxControl::SetPasswordMode

Description

	DEPRECATED
	This API will be discontinued in SophiaFramework UNIVERSE 6.0. It is recommended to get the class ID by calling the SFXBaseEditor::GetSFBMenuCtlClassID function of the text input control editor, which is gotten by calling the SFYApplication::GetEditor function.

Reference

SFZSingleEditBoxControl::SetSFBMenuCtlClassID | SFBMenuCtl

Description

	DEPRECATED
	This API will be discontinued in SophiaFramework UNIVERSE 6.0. It is recommended to get the class ID by calling the SFXBaseEditor::GetSFBTextCtlClassID function of the text input control editor, which is gotten by calling the SFYApplication::GetEditor function.

Reference

SFZSingleEditBoxControl::SetSFBTextCtlClassID | SFBTextCtl

Reference

SFZSingleEditBoxControl::SetScrollDirection

Return value

Scroll-interval. [milliseconds]

Reference

SFZSingleEditBoxControl::SetScrollInterval

Return value

Scroll-step. [pixels]

Reference

SFZSingleEditBoxControl::SetScrollStep

Reference

SFZSingleEditBoxControl::SetText

Reference

SFZSingleEditBoxControl::SetTextColor | SFXRGBColor

Return value

Value of the vertical alignment.

Reference

SFZSingleEditBoxControl::SetVerticalAlign | SFZSingleEditBoxControl::VerticalEnum

Return value

Waiting time to start to scroll. [milliseconds]

Reference

SFZSingleEditBoxControl::SetWaitInterval

Description

This function gets the instance of the SFYSingleEditWidget class, which is contained as a child responder internally for editing a single text.

The editing of the single text is delegated to the SFYSingleEditWidget class.

Reference

SFYSingleEditWidget

Description

This function will be called when the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] is received.

This function calculates the suitable rectangle size of this responder within the specified hint rectangle[i.e., rectangle element (P32 parameter) of the region event].

The suitable rectangle size is stored into the size element of the rectangle argument as a result of calculation. It is recommended not to change the origin of the rectangle argument in this function.

	Region event[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) event]
	If the rectangle argument of the hint region is specified, the SFYResponder::GetSuitableBound function will send the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] to this responder. Then, the SFYWidget::HandleBoundOptimize virtual function will be called. The rectangle element (P32 parameter) of the region event is set to the hint region as an initial value.

Reference: SFYSingleEditWidget::HandleBoundOptimize

Example

Implementation of the SFZSingleEditBoxControl::HandleBoundOptimize function is as follows:

SFYSingleEditWidgetSmp          _widget;

/*protected virtual */Void SFZSingleEditBoxControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    rectangle->Deflate(GetBoxMargin());
    rectangle->SetSize(_widget->GetSuitableBound(*rectangle).GetSize());
    rectangle->Inflate(GetBoxMargin());
    return;
}// SFZSingleEditBoxControl::HandleBoundOptimize //

Reference

SFYResponder::GetSuitableBound | SFYBoxControl::GetBoxMargin | SFZSingleEditBoxControl::SetText | SFZSingleEditBoxControl::SetFont | SFYSingleEditWidget::HandleBoundOptimize | SFYSingleEditWidget | SFXEvent | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

This function will be called when the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] is received.

This function calculates the suitable rectangle size of this responder.

The suitable rectangle size is stored into the size element of the rectangle argument as a result of calculation. It is recommended not to change the origin element of the rectangle argument within this function.

Region event[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) event]

If the rectangle argument of the hint region is not specified, the SFYResponder::GetSuitableBound function will send the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] to this responder. Then, the SFYWidget::HandleBoundRequest virtual function will be called. The rectangle element (P32 parameter) of the region event is set to the real region as an initial value. Tip Default value of the real region: SFXRectangle(0, 0, 0, 0)

Reference: SFYSingleEditWidget::HandleBoundRequest

Internal Implementation

Internal implementation of the SFZSingleEditBoxControl::HandleBoundRequest function is as follows:

SFYSingleEditWidgetSmp          _widget;

/*protected virtual */Void SFZSingleEditBoxControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    rectangle->Deflate(GetBoxMargin());
    rectangle->SetSize(_widget->GetSuitableBound().GetSize());
    rectangle->Inflate(GetBoxMargin());
    return;
}// SFZSingleEditBoxControl::HandleBoundRequest //

Reference

SFYResponder::GetSuitableBound | SFYBoxControl::GetBoxMargin | SFZSingleEditBoxControl::SetText | SFZSingleEditBoxControl::SetFont | SFYSingleEditWidget::HandleBoundRequest | SFYSingleEditWidget | SFXEvent | Real Region Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event is received.

In case you want to perform your own processing when the virtual region is changed, override this virtual function.

The default implementation is to equalize the real region with the new local region and relocate this responder to fit into the new virtual region.

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event will occur when the virtual region is changed by calling the SFYResponder::SetRealBound or SFYResponder::SetVirtualBound function.

Another method when the virtual region is changed

Other than overriding this virtual function, it is possible to define and implement the handler for region event[XANDLER_DECLARE_VOIDBOUND], and register it into the responder. In the processing when the virtual region is updated, this virtual function is executed first, and next the handlers for region event are executed in the registered order. In almost all cases, the method to override this virtual function is adopted since defining, implementing and registering the handler for region event can be omitted.

Internal Implementation

Internal implementation of the SFZSingleTextBoxControl::HandleBoundVirtual function is as follows:

SFYSingleTextWidgetSmp          _widget;

/*protected virtual */Void SFZSingleTextBoxControl::HandleBoundVirtual(Void)
{
    Relocate();
    return;
}// SFZSingleTextBoxControl::HandleBoundVirtual //

/*private */Void SFZSingleTextBoxControl::Relocate(Void)
{
    _widget->SetRealBound(GetLocalBound().Deflate(GetBoxMargin()));
    return;
}// SFZSingleTextBoxControl::Relocate //

Reference

SFZSingleEditBoxControl::SetText | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | SFYSingleEditWidget | SFXEvent | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND] | Virtual Region | Real Region | Local Region

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the operaion key set with the SFYLabelControl::SetOperateKey function is received.

In case you want to perform your own processing, override this function.

The default implementation is to initialize the scroll position, transit to the text input screen, and send the result event [if text input succeeds, SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue()), otherwise SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ERROR, error value)] to itself.

Internal Implementation

Internal implementation of the SFZSingleEditBoxControl::HandleOperateKey function is as follows:

SFYSingleEditWidgetSmp          _widget;

/*protected virtual */Void SFZSingleEditBoxControl::HandleOperateKey(Void)
{
    _widget->StopScroll();
    _widget->StartScroll();
    InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, GetCurrentValue()), false);
    return;
}// SFZSingleEditBoxControl::HandleOperateKey //

Reference

SFYBoxControl::SetOperateKey | SFYSingleEditWidget | SFXEvent | SFYControl::GetCurrentValue | Key Event[SFEVT_KEY] | Result Event[SFEVT_RESPONDER_RESULT]

Description

This function will be called when the (SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) event is received.

In case you want to perform your own drawing of this responder, override this function.

The default implementation is to draw this responder.

The method to darw a responder

In addition to overriding this virtual function, it is possible to define and implement the handler for drawing event(drawing handler)[XANDLER_DECLARE_VOIDRENDER], and register it into the responder. Then, the overridden virtual function will be called first, and next the drawing handlers registered into the responder will be booted up in the registered order. In almost all cases, the method to override this function is used to draw the responder since there is no need to declare and register the drawing handler.

Procedure of drawing a responder

The drawing handler will be booted up when the drawing event(SFEVT_RESPONDER_RENDER) occurs. And then the drawing handler draw the responder actually. The drawing event will be sent to only the responders including the region to be redrawn out of the redraw regions registered into the renderer using the SFYResponder::InvokeBackward function after the SFYResponder::Render function boots up the renderer. Here, the SFYResponder::Render function will be called at the following situations: At the end of the event loop At the applet start / resume or the end of a highest priority event handler In the callback, which is outside the event loop. If calling the SFYResponder::Render function with specifying "true" as an argument, the drawing event will be sent to all the responders to be actually displayed on the screen which are located below the responder in the responder tree, regardless of the registration of redraw region.

Internal Implementation

Internal implementation of the SFZSingleEditBoxControl::HandleRenderRequest function is as follows:

/*protected virtual */Void SFZSingleEditBoxControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawBox(graphics, GetLocalBound());
    return;
}// SFZSingleEditBoxControl::HandleRenderRequest //

Reference

SFYBoxControl::DrawBox | SFZSingleEditBoxControl::SetText | SFZSingleEditBoxControl::SetHorizontalAlign | SFZSingleEditBoxControl::SetVerticalAlign | SFZSingleEditBoxControl::SetFont | SFZSingleEditBoxControl::SetTextColor | SFYSingleTextWidget::HandleRenderRequest | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | SFYSingleEditWidget | SFYSingleTextWidget | SFXEvent | Drawing Event[SFEVT_RESPONDER_RENDER] | Handler for the Drawing Event[XANDLER_DECLARE_VOIDRENDER] | Rendering | Event Loop | Responder Tree

Argument

Return value

Description

This function creates a new instance of this responder class.

If succeeds, a not null pointer will be returned, and the "exception" argument is SFERR_NO_ERROR. If fails such as insufficient memory, a null pointer will be returned, and the "exception" argument holds the error value.

Example

The code to create a new instance of this responder class is as follows:

SFZSingleEditBoxControlSmp _singleeditbox;
SFCError error;

if (( _singleeditbox = SFZSingleEditBoxControl::NewInstance(&error)) != null) {

    ...
}

Description

Default: AEE_FONT_NORMAL

Reference

SFZSingleEditBoxControl::GetFont

Description

This function sets the horizontal alignment to the specified value.

Default: SFYSingleEditWidget::DEFAULT_HORIZONTAL

For the value of SFYSingleEditWidget::DEFAULT_HORIZONTAL, refer to SFYSingleEditWidget::HorizontalEnum.

Reference

SFZSingleEditBoxControl::GetHorizontalAlign | SFZSingleEditBoxControl::HorizontalEnum | SFYSingleEditWidget::HorizontalEnum

Description

This function sets the text input mode for the text input control of the standard BREW to the specified value. For more derail, refer to ITEXTCTL_SetInputMode() and AEETextInputMode of the BREW reference.

Default: AEE_TM_CURRENT(currently active input mode).

Reference

SFZSingleEditBoxControl::GetInputMode | SFYSingleEditWidget::SetInputMode | SFXEditProperty::SetInputMode | BREW API ITEXTCTL_SetInputMode | BREW API AEETextInputMode

Description

This function sets the maximum number of characters for the text input control of the standard BREW to the specified value. For more derail, refer to ITEXTCTL_SetMaxSize() of the BREW reference.

Default: SINT16_MAXIMUM - 1.

Reference

SFZSingleEditBoxControl::GetMaximumLength | SFYSingleEditWidget::SetMaximumLength | SFXEditProperty::SetMaximumLength | BREW API ITEXTCTL_SetMaxSize

Description

If "true" is specified as an argument, TP_PASSWORD is set to the property of the text input control of the standard BREW. At this time, every input character is displayed as "*". And the actual input string is managed in the buffer. For more derail, refer to ITEXTCTL_SetProperties() and AEE ITextCtl Properties of the BREW reference.

Default: false

Reference

SFZSingleEditBoxControl::GetPasswordMode | SFYSingleEditWidget::SetPasswordMode | SFXEditProperty::SetPasswordMode | BREW API ITEXTCTL_SetProperties | BREW API AEE ITextCtl Properties

Description

	DEPRECATED
	This API will be discontinued in SophiaFramework UNIVERSE 6.0. It is recommended to set the class ID by calling the SFXBaseEditor::SetSFBMenuCtlClassID function of the text input control editor, which is gotten by calling the SFYApplication::GetEditor function.

Reference

SFZSingleEditBoxControl::GetSFBMenuCtlClassID | SFBMenuCtl

Description

	DEPRECATED
	This API will be discontinued in SophiaFramework UNIVERSE 6.0. It is recommended to set the class ID by calling the SFXBaseEditor::SetSFBTextCtlClassID function of the text input control editor, which is gotten by calling the SFYApplication::GetEditor function.

Reference

SFZSingleEditBoxControl::GetSFBTextCtlClassID | SFBTextCtl

Description

This function sets the scroll direction to the specified value.

Default: SFYSingleEditWidget::DEFAULT_DIRECTION

For the value of SFYSingleEditWidget::DEFAULT_DIRECTION, refer to SFYSingleEditWidget::DirectionEnum.

Reference

SFZSingleEditBoxControl::GetScrollDirection | SFZSingleEditBoxControl::DirectionEnum | SFYSingleEditWidget::DirectionEnum

Description

Default: SFYSingleEditWidget::DEFAULT_SCROLL [milliseconds]

For the value of SFYSingleEditWidget::DEFAULT_SCROLL, refer to SFYSingleEditWidget::DefaultEnum.

Reference

SFZSingleEditBoxControl::GetScrollInterval | SFZSingleEditBoxControl::DefaultEnum | SFYSingleEditWidget::DefaultEnum

Description

This function sets the number of pixels of each scroll. If "-1"(this is default value) is set, the scroll-step will be set to the width of the " " character of the currently used font.

Default: SFYSingleEditWidget::DEFAULT_STEP [pixels]

For the value of SFYSingleEditWidget::DEFAULT_STEP, refer to SFYSingleEditWidget::DefaultEnum.

Reference

SFZSingleEditBoxControl::GetScrollStep | SFZSingleEditBoxControl::DefaultEnum | SFYSingleEditWidget::DefaultEnum

Return value

Description

This function sets the text to be displayed to the specified value.

The string value is set directly in the argument, or read from the resource file.

Reference

SFZSingleEditBoxControl::GetText | SFZSingleEditBoxControl::SetHorizontalAlign | SFZSingleEditBoxControl::SetVerticalAlign SFZSingleEditBoxControl::SetTextColor | SFZSingleEditBoxControl::SetFont

Description

Default: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[black color]

In the "inactive" state, the text will be drawn in the color of which each RGB value is subtracted 0x44 from the color set with this function if the brightness of this color is greater than 0x7F. Otherwise it will be drawn in the color of which each RGB value is added 0x44 on the color set with this function.

The brightness of color can be obtained by calling the SFXRGBColor::GetBrightness function.

Reference

SFZSingleEditBoxControl::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | State

Description

This function sets the vertical alignment to the specified value.

Default: SFYSingleEditWidget::DEFAULT_VERTICAL

For the value of SFYSingleEditWidget::DEFAULT_VERTICAL, refer to SFYSingleEditWidget::VerticalEnum.

Reference

SFZSingleEditBoxControl::GetVerticalAlign | SFZSingleEditBoxControl::VerticalEnum | SFYSingleEditWidget::VerticalEnum

Description

Default: SFYSingleEditWidget::DEFAULT_WAIT [milliseconds]

For the value of SFYSingleEditWidget::DEFAULT_WAIT, refer to SFYSingleEditWidget::DefaultEnum.

Reference

SFZSingleEditBoxControl::GetWaitInterval | SFZSingleEditBoxControl::DefaultEnum | SFYSingleEditWidget::DefaultEnum

Description

If the width of the text is greater than that of the virtual region, the text will start to scroll.

Otherwise, the text will not scroll.

Though the SFEVT_APP_SUSPEND event and the SFEVT_APP_RESUME event will be automatically handled, the behaviour of this function is not defined when called between the SFEVT_APP_SUSPEND event and the SFEVT_APP_RESUME event.

Reference

SFZSingleEditBoxControl::StopScroll | Virtual Region

Reference

SFZSingleEditBoxControl::StartScroll

Reference

SFYResponder::GetType | SFYResponder::SetType

Reference

SFYSingleEditWidget::DefaultEnum

Reference

SFYSingleEditWidget::DirectionEnum

Reference

SFYSingleEditWidget::HorizontalEnum

Reference

SFYSingleEditWidget::VerticalEnum