Inheritance diagram

Collaboration diagram

Description

How to use

SFYMultipleEditWidget is a responder with the function of displaying a multiple editable text.

In general, this class is used as a child responder contained internally by the parent responder such as SFZMultipleEditLabelControl or SFZMultipleEditBoxControl, which will edit a multiple text.

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

	Internal processing of the SFYMultipleEditWidget class
	The text input and its drawing of the SFYMultipleEditWidget class will be delegated to the SFXEditor class and the SFYMultipleTextWidget 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, when [Width of virtual region] ＞ [Width of real region] stands up, the left edge, the right edge, or both the edges of the row which is longer than [width of virtual region] cannot be displayed on the device screen since the text is turned down by this width. And tt cannot be displayed by scrolling left or right. Suppose the following relation stands up. [Height of virtual region] ≧ [Height of multiple text] ＞ [Height of real region] In this case, though all the text is not displayed, the multiple text will not scroll even if the UP key or the DOWN key is pressed.

Calling GetSuitableBound() without specifying its argument

When calling the SFYResponder::GetSuitableBound function of this responder without specifying its argument, it is necessary to set the real region (local region*) using the SFYResponder::SetRealBound function in advance. The width of this real region will be used as a hint value for calculating the suitable region size of this responder. In almost all cases, the value more than the width of currently used font is set. * Unless the virtual region is set, the real region is the same with the local region. Reference: Getting the Suitable Size of Responder for Displaying a Multiple Text

Reference

SFZMultipleEditLabelControl | SFZMultipleEditBoxControl | SFYMultipleTextWidget | SFXEditor | Virtual Region | Real Region | Local Region | Getting the Suitable Size of Responder for Displaying a Multiple Text

Member

Description

This constructor performs the initializations as follows:

Reference

SFYResponder::SetType | SFYMultipleEditWidget::CodeEnum | SFYResponder::SetPropertyTransparent | SFYMultipleEditWidget::SetInputMode | SFYMultipleEditWidget::SetMaximumLength | SFYMultipleEditWidget::SetPasswordMode | SFYMultipleEditWidget::GetWidget | SFYResponder::SetParent | SFYResponder::SetState | SFYMultipleEditWidget::SetText | SFYMultipleEditWidget::SetFont | SFYMultipleEditWidget::SetTextColor | SFYMultipleEditWidget::SetHorizontalAlign | SFYMultipleEditWidget::SetVerticalAlign | SFYMultipleEditWidget::SetScrollStep | SFYMultipleTextWidget::NewInstance | SFYMultipleTextWidget::HorizontalEnum | SFYMultipleTextWidget::VerticalEnum | SFYMultipleTextWidget::DefaultEnum | SFYMultipleTextWidget | SFXRGBColor | Type | Attribute | State

Description

This destructor does nothing.

Description

This function gets the font.

Reference

SFYMultipleEditWidget::SetFont

Description

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

Reference

SFYMultipleEditWidget::SetFont

Return value

Value of the horizontal alignment.

Reference

SFYMultipleEditWidget::SetHorizontalAlign | SFYMultipleEditWidget::HorizontalEnum

Return value

Text input mode.

Reference

SFYMultipleEditWidget::SetInputMode

Reference

SFYMultipleEditWidget::SetMaximumLength

Return value

Reference

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

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

SFYMultipleEditWidget::SetSFBTextCtlClassID | SFBTextCtl

Return value

Scroll-step. [pixels]

Reference

SFYMultipleEditWidget::SetScrollStep

Reference

SFYMultipleEditWidget::SetText

Reference

SFYMultipleEditWidget::SetTextColor | SFXRGBColor

Description

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

Reference

SFYMultipleEditWidget::SetFont

Return value

Value of the vertical alignment.

Reference

SFYMultipleEditWidget::SetVerticalAlign | SFYMultipleEditWidget::VerticalEnum

Description

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

The drawing of the multiple text is delegated to the SFYMultipleTextWidget class.

Reference

SFYMultipleTextWidget

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 SFYMultipleEditWidget::HandleBoundOptimize function is as follows:

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYMultipleTextWidget::HandleBoundOptimize | SFYMultipleTextWidget | 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, when [Width of virtual region] ＞ [Width of real region] stands up, the left edge, the right edge, or both the edges of the row which is longer than [width of virtual region] cannot be displayed on the device screen since the text is turned down by this width. And tt cannot be displayed by scrolling left or right. Suppose the following relation stands up. [Height of virtual region] ≧ [Height of multiple text] ＞ [Height of real region] In this case, though all the text is not displayed, the multiple text will not scroll even if the UP key or the DOWN key is pressed.

	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 SFYMultipleEditWidget::HandleBoundReal function is as follows:

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

Reference

SFYResponder::SetRealBound | 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 SFYMultipleEditWidget::HandleBoundRequest function is as follows:

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYMultipleTextWidget::HandleBoundRequest | SFYMultipleTextWidget | SFXEvent | Real Region | Local Region | Virtual Region | Getting the Suitable Size of Responder for Displaying a Multiple Text | 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, when [Width of virtual region] ＞ [Width of real region] stands up, the left edge, the right edge, or both the edges of the row which is longer than [width of virtual region] cannot be displayed on the device screen since the text is turned down by this width. And tt cannot be displayed by scrolling left or right. Suppose the following relation stands up. [Height of virtual region] ≧ [Height of multiple text] ＞ [Height of real region] In this case, though all the text is not displayed, the multiple text will not scroll even if the UP key or the DOWN key is pressed.

	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 SFYMultipleEditWidget::HandleBoundVirtual function is as follows:

SFYMultipleTextWidgetSmp        _widget;

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

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

Reference

SFYMultipleTextWidget | SFYMultipleEditWidget::SetText | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | SFYMultipleTextWidget | 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:

SFYMultipleEditWidgetSmp _multipleeditwidget;
SFCError error;

if ((_multipleeditwidget = SFYMultipleEditWidget::NewInstance(&error)) != null) {

    ...
}

Return value

Reference

SFYMultipleEditWidget::PageUp | SFYMultipleTextWidget::PageDown

Return value

Reference

SFYMultipleEditWidget::PageDown | SFYMultipleTextWidget::PageUp

Return value

Reference

SFYMultipleEditWidget::ScrollUp | SFYMultipleEditWidget::SetScrollStep | SFYMultipleTextWidget::ScrollDown

Return value

Reference

SFYMultipleEditWidget::ScrollDown | SFYMultipleEditWidget::SetScrollStep | SFYMultipleTextWidget::ScrollUp

Description

Default: AEE_FONT_NORMAL

Reference

SFYMultipleEditWidget::GetFont

Description

This function sets the horizontal alignment to the specified value.

Default: SFYMultipleTextWidget::DEFAULT_HORIZONTAL

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

Reference

SFYMultipleEditWidget::GetHorizontalAlign | SFYMultipleEditWidget::HorizontalEnum | SFYMultipleTextWidget::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

SFYMultipleEditWidget::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.

Reference

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

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

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

SFYMultipleEditWidget::GetSFBTextCtlClassID | SFBTextCtl

Description

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

Default: SFYMultipleTextWidget::DEFAULT_STEP [pixels]

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

Reference

SFYMultipleEditWidget::GetScrollStep | SFYMultipleEditWidget::DefaultEnum | SFYMultipleTextWidget::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

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

SFYMultipleEditWidget::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | State

Description

This function sets the vertical alignment to the specified value.

Default: SFYMultipleTextWidget::DEFAULT_VERTICAL

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

Reference

SFYMultipleEditWidget::GetVerticalAlign | SFYMultipleEditWidget::VerticalEnum | SFYSingleTextWidget::VerticalEnum

Description

This function puts back the scroll position of the multiple text to the initial state, which is set with the SetVerticalAlign() function.

The execution result of this function differs as below depending on the settings of the SetVerticalAlign() function.

If both of the top and the bottom of the multiple text are placed in the local region, the scroll position will be the same.

Reference

SFYMultipleEditWidget::SetVerticalAlign | SFYMultipleTextWidget::SnapAlign

Return value

Reference

SFYMultipleEditWidget::SnapUp | SFYMultipleTextWidget::SnapDown

Return value

Reference

SFYMultipleEditWidget::SnapDown | SFYMultipleTextWidget::SnapUp

Reference

SFYResponder::GetType | SFYResponder::SetType

Reference

SFYMultipleTextWidget::DefaultEnum

Reference

SFYMultipleTextWidget::HorizontalEnum

Reference

SFYMultipleTextWidget::VerticalEnum