Inheritance diagram

Collaboration diagram

Description

How to use

SFYSingleEditWidget is a responder with the function of displaying a single editable text.

In general, this class is used as a child responder contained internally by the parent responder such as SFZSingleEditLabelControl or SFZSingleEditBoxControl, which will edit a single text.

In these responders, all processings such as setting a single text, its color, its font, its alignment, or its scroll are delegated to this class.

	Internal processing of the SFYSingleEditWidget class
	The text input and its drawing of the SFYSingleEditWidget class will be delegated to the SFXEditor class and the SFYSingleTextWidget class which the SFYSingleEditWidget class contains internally, respectively.

	The state of this responder when used
	When this class is used, its state is set to "visible"+"active"+"disable"+"unfocus". In general, this class is used as a responder which will not handle the key event.

	Default value of the transparency attribute
	Since the default value of the transparency attribute of this class is set to "true", the background will be never drawn in the color set with the SFYWidget::SetBackgroundColor function unless the transparency attribute is set to "false" using the SFYResponder::SetPropertyTransparent function.

	About the virtual region
	In this class, it is recommended to equalize the virtual region with the real region for the intuitive text alignment or scroll. For instance, though all the text is not displayed, the text will not start to scroll even if the SFYSingleTextWidget::StartScroll function is called when the following relation stands up. [Width of virtual region] ≧ [Width of text] ＞ [Width of real region]

Reference

SFZSingleEditLabelControl | SFZSingleEditBoxControl | SFYSingleTextWidget | SFXEditor | Virtual Region | Real Region | Local Region

Member

Description

This constructor performs the initializations as follows:

Reference

SFYResponder::SetType | SFYSingleEditWidget::CodeEnum | SFYResponder::SetPropertyTransparent | SFYSingleEditWidget::SetInputMode | SFYSingleEditWidget::SetMaximumLength | SFYSingleEditWidget::SetPasswordMode | SFYSingleEditWidget::GetWidget | SFYResponder::SetParent | SFYResponder::SetState | SFYSingleEditWidget::SetText | SFYSingleEditWidget::SetFont | SFYSingleEditWidget::SetTextColor | SFYSingleEditWidget::SetHorizontalAlign | SFYSingleEditWidget::SetScrollDirection | SFYSingleEditWidget::SetScrollInterval | SFYSingleEditWidget::SetScrollStep | SFYSingleEditWidget::SetVerticalAlign | SFYSingleEditWidget::SetWaitInterval | SFYSingleTextWidget::NewInstance | SFYSingleTextWidget::HorizontalEnum | SFYSingleTextWidget::VerticalEnum | SFYSingleTextWidget::DirectionEnum | SFYSingleTextWidget::DefaultEnum | SFYSingleTextWidget | SFXRGBColor | Type | Attribute | State

Description

This destructor does nothing.

Description

This function gets the font.

Reference

SFYSingleEditWidget::SetFont

Description

This function gets the size of one character of the current font(the ' ' character is used).

Reference

SFYSingleEditWidget::SetFont

Return value

Value of the horizontal alignment.

Reference

SFYSingleEditWidget::SetHorizontalAlign | SFYSingleEditWidget::HorizontalEnum

Return value

Text input mode.

Reference

SFYSingleEditWidget::SetInputMode

Reference

SFYSingleEditWidget::SetMaximumLength

Return value

Reference

SFYSingleEditWidget::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

SFYSingleEditWidget::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

SFYSingleEditWidget::SetSFBTextCtlClassID | SFBTextCtl

Return value

Scroll direction set with the SFYSingleEditWidget::SetScrollDirection function.

Reference

SFYSingleEditWidget::SetScrollDirection

Return value

Scroll-interval set with the SFYSingleEditWidget::SetScrollInterval function. [milliseconds]

Reference

SFYSingleEditWidget::SetScrollInterval

Return value

Scroll-step set with the SFYSingleEditWidget::SetScrollStep function. [pixels]

Reference

SFYSingleEditWidget::SetScrollStep

Reference

SFYSingleEditWidget::SetText

Reference

SFYSingleEditWidget::SetTextColor | SFXRGBColor

Description

This function gets the size of the text when it will be drawn with the current font.

Reference

SFYSingleEditWidget::SetFont

Return value

Value of the vertical alignment.

Reference

SFYSingleEditWidget::SetVerticalAlign | SFYSingleEditWidget::VerticalEnum

Return value

Waiting time to start the scroll set with the SFYSingleEditWidget::SetWaitInterval function. [milliseconds]

Reference

SFYSingleEditWidget::SetWaitInterval

Description

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

The drawing of the single text is delegated to the SFYSingleTextWidget class.

Reference

SFYSingleTextWidget

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.

Internal Implementation

Internal implementation of the SFYSingleEditWidget::HandleBoundOptimize function is as follows:

SFYSingleTextWidgetSmp          _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYSingleTextWidget::HandleBoundOptimize | SFYSingleTextWidget | SFXEvent | 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_REAL) event is received.

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

The default implementation is to equalize the virtual region with the real region.

	About the virtual region
	In this class, it is recommended to equalize the virtual region with the real region for the intuitive text alignment or scroll. For instance, though all the text is not displayed, the text will not start to scroll even if the SFYSingleTextWidget::StartScroll function is called when the following relation stands up. [Width of virtual region] ≧ [Width of text] ＞ [Width of real region]

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) event will occur when the real region is changed by calling the SFYResponder::SetRealBound function.

Processing when the real region is changed

Other than overriding this virtual function, there is another method to define and implement the handler for the region event[XANDLER_DECLARE_VOIDBOUND], and register it into the responder. In the processing when the real region is updated, this virtual function is executed first, and next the handlers for the 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 the region event can be omitted.

Internal Implementation

Internal implementation of the SFYSingleEditWidget::HandleBoundReal function is as follows:

/*protected virtual */Void SFYSingleEditWidget::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFYSingleEditWidget::HandleBoundReal //

Reference

SFYResponder::SetRealBound | SFYSingleTextWidget::HandleBoundReal | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND] | Real Region | Virtual Region | Local Region

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)

Internal Implementation

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

SFYSingleTextWidgetSmp          _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYSingleTextWidget::HandleBoundRequest | SFYSingleTextWidget | 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.

	About the virtual region
	In this class, it is recommended to equalize the virtual region with the real region for the intuitive text alignment or scroll. For instance, though all the text is not displayed, the text will not start to scroll even if the SFYSingleTextWidget::StartScroll function is called when the following relation stands up. [Width of virtual region] ≧ [Width of text] ＞ [Width of real 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 SFYSingleEditWidget::HandleBoundVirtual function is as follows:

SFYSingleTextWidgetSmp          _widget;

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

/*private */Void SFYSingleEditWidget::Relocate(Void)
{
    _widget->SetRealBound(GetLocalBound());
    return;
}// SFYSingleEditWidget::Relocate //

Reference

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

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:

SFYSingleEditWidgetSmp _singleeditwidget;
SFCError error;

if ((_singleeditwidget = SFYSingleEditWidget::NewInstance(&error)) != null) {

    ...
}

Description

Default: AEE_FONT_NORMAL

Reference

SFYSingleEditWidget::GetFont

Description

This function sets the horizontal alignment to the specified value.

Default: SFYSingleTextWidget::DEFAULT_HORIZONTAL

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

Reference

SFYSingleEditWidget::GetHorizontalAlign | SFYSingleEditWidget::HorizontalEnum | SFYSingleTextWidget::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

SFYSingleEditWidget::GetInputMode | 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

SFYSingleEditWidget::GetMaximumLength | 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

SFYSingleEditWidget::GetPasswordMode | 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

SFYSingleEditWidget::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

SFYSingleEditWidget::GetSFBTextCtlClassID | SFBTextCtl

Description

This function sets the scroll direction to the specified value.

Default: SFYSingleTextWidget::DEFAULT_DIRECTION

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

Reference

SFYSingleEditWidget::GetScrollDirection | SFYSingleEditWidget::DirectionEnum | SFYSingleTextWidget::DirectionEnum

Description

Default: SFYSingleTextWidget::DEFAULT_SCROLL [milliseconds]

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

Reference

SFYSingleEditWidget::GetScrollInterval | SFYSingleEditWidget::DefaultEnum | SFYSingleTextWidget::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: SFYSingleTextWidget::DEFAULT_STEP [pixels]

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

Reference

SFYSingleEditWidget::GetScrollStep | SFYSingleEditWidget::DefaultEnum | SFYSingleTextWidget::DefaultEnum

Return value

Description

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

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

Reference

SFYSingleEditWidget::GetText | SFYSingleEditWidget::SetHorizontalAlign | SFYSingleEditWidget::SetVerticalAlign SFYSingleEditWidget::SetTextColor | SFYSingleEditWidget::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

SFYSingleEditWidget::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | State

Description

This function sets the vertical alignment to the specified value.

Default: SFYSingleTextWidget::DEFAULT_VERTICAL

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

Reference

SFYSingleEditWidget::GetVerticalAlign | SFYSingleEditWidget::VerticalEnum | SFYSingleTextWidget::VerticalEnum

Description

Default: SFYSingleTextWidget::DEFAULT_WAIT [milliseconds]

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

Reference

SFYSingleEditWidget::GetWaitInterval | SFYSingleEditWidget::DefaultEnum | SFYSingleTextWidget::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

SFYSingleEditWidget::StopScroll | Virtual Region

Reference

SFYSingleEditWidget::StartScroll

Reference

SFYResponder::GetType | SFYResponder::SetType

Reference

SFYSingleTextWidget::DefaultEnum

Reference

SFYSingleTextWidget::DirectionEnum

Reference

SFYSingleTextWidget::HorizontalEnum

Reference

SFYSingleTextWidget::VerticalEnum