Inheritance diagram

Collaboration diagram

Description

How to use

Box control to display a multiple editable text(SFZMultipleEditBoxControl) can 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 SFZMultipleEditBoxControl::HandleOperateKey function.

If there are more rows than can be displayed in the box area, this control can be scrolled up and down by pressing the scroll keys set with the SFZMultipleEditBoxControl::SetScrollDownKey / SFZMultipleEditBoxControl::SetScrollUpKey / SFZMultipleEditBoxControl::SetPageDownKey / SFZMultipleEditBoxControl::SetPageUpKey / SFZMultipleEditBoxControl::SetSnapDownKey / SFZMultipleEditBoxControl::SetSnapUpKey functions.

	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 349. Execution Result(Standard Input Mode)

Figure 350. Execution Result(Password Input Mode)

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

Box Control to Display a Multiple Editable Text [SFZMultipleEditBoxControl] | SFYControl | SFYBoxControl | SFYMultipleTextWidget | Virtual Region | Real Region | Local Region | Getting the Suitable Size of Responder for Displaying a Multiple Text SFYBoxControl::SetOperateKey | SFZMultipleEditBoxControl::SetScrollDownKey | SFZMultipleEditBoxControl::SetScrollUpKey | SFZMultipleEditBoxControl::SetPageDownKey | SFZMultipleEditBoxControl::SetPageUpKey | SFZMultipleEditBoxControl::SetSnapDownKey | SFZMultipleEditBoxControl::SetSnapUpKey

Member

Description

This constructor performs the initializations as follows:

Reference

SFYResponder::SetType | SFZMultipleEditBoxControl::CodeEnum | SFYResponder::SetParent | SFYResponder::SetState | SFZMultipleEditBoxControl::SetText | SFZMultipleEditBoxControl::SetFont | SFZMultipleEditBoxControl::SetTextColor | SFZMultipleEditBoxControl::SetHorizontalAlign | SFZMultipleEditBoxControl::SetScrollStep | SFZMultipleEditBoxControl::SetVerticalAlign | SFZMultipleEditBoxControl::HorizontalEnum | SFZMultipleEditBoxControl::VerticalEnum | SFZMultipleEditBoxControl::DefaultEnum | SFYMultipleEditWidget::NewInstance | SFYMultipleEditWidget | SFXRGBColor | Type | State

Description

This destructor does nothing.

Description

This function gets the font.

Reference

SFZMultipleEditBoxControl::SetFont

Return value

Value of the horizontal alignment.

Reference

SFZMultipleEditBoxControl::SetHorizontalAlign | SFZMultipleEditBoxControl::HorizontalEnum

Return value

Text input mode.

Reference

SFZMultipleEditBoxControl::SetInputMode

Reference

SFZMultipleEditBoxControl::SetMaximumLength

Return value

PageDown key to scroll down the multiple text by one page.

Reference

SFZMultipleEditBoxControl::SetPageDownKey

Return value

PageUp key to scroll up the multiple text by one page.

Reference

SFZMultipleEditBoxControl::SetPageUpKey

Return value

Reference

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

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

SFZMultipleEditBoxControl::SetSFBTextCtlClassID | SFBTextCtl

Return value

ScrollDown key to scroll down the multiple text by the scroll-step.

Reference

SFZMultipleEditBoxControl::SetScrollDownKey | SFZMultipleEditBoxControl::SetScrollStep

Return value

Scroll-step. [pixels]

Reference

SFZMultipleEditBoxControl::SetScrollStep

Return value

ScrollUp key to scroll up the multiple text by the scroll-step.

Reference

SFZMultipleEditBoxControl::SetScrollUpKey | SFZMultipleEditBoxControl::SetScrollStep

Return value

SnapDown key to scroll down the multiple text to the bottom.

Reference

SFZMultipleEditBoxControl::SetSnapDownKey

Return value

SnapUp key to scroll up the multiple text to the top.

Reference

SFZMultipleEditBoxControl::SetSnapUpKey

Reference

SFZMultipleEditBoxControl::SetText

Reference

SFZMultipleEditBoxControl::SetTextColor | SFXRGBColor

Return value

Value of the vertical alignment.

Reference

SFZMultipleEditBoxControl::SetVerticalAlign | SFZMultipleEditBoxControl::VerticalEnum

Description

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

The editing of the multiple text is delegated to the SFYMultipleEditWidget class.

Reference

SFYMultipleEditWidget

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

Internal Implementation

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

SFYMultipleEditWidgetSmp        _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYBoxControl::GetBoxMargin | SFZMultipleEditBoxControl::SetText | SFZMultipleEditBoxControl::SetFont | SFYMultipleEditWidget::HandleBoundOptimize | SFYMultipleEditWidget | 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: SFYMultipleEditWidget::HandleBoundRequest

Internal Implementation

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

SFYMultipleEditWidgetSmp        _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYBoxControl::GetBoxMargin | SFZMultipleEditBoxControl::SetText | SFZMultipleEditBoxControl::SetFont | SFYMultipleEditWidget::HandleBoundRequest | SFYBoxControl::GetBoxMargin | SFYMultipleEditWidget | SFXEvent | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND] | Real Region | Local Region | Virtual Region | Getting the Suitable Size of Responder for Displaying a Multiple Text

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

SFYMultipleEditWidgetSmp        _widget;

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

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

Reference

SFZMultipleEditBoxControl::SetText | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | SFYMultipleEditWidget | 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 SFZMultipleEditBoxControl::HandleOperateKey function is as follows:

SFYMultipleEditWidgetSmp        _widget;

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

Reference

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

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the PageDown key set with the SFZMultipleEditBoxControl::SetPageDownKey function is received.

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

The default implementation is to scroll down the multiple text by one page by booting up the SFZMultipleEditBoxControl::PageDown function.

Internal Implementation

Internal implementation of the SFZMultipleEditBoxControl::HandlePageDownKey function is as follows:

SFYMultipleEditWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleEditBoxControl::HandlePageDownKey(Void)
{
    return _widget->PageDown();
}// SFZMultipleEditBoxControl::HandlePageDownKey //

Reference

SFZMultipleEditBoxControl::SetPageDownKey | SFZMultipleEditBoxControl::PageDown | SFYMultipleEditWidget | SFXEvent | Key Event[SFEVT_KEY]

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the PageUp key set with the SFZMultipleEditBoxControl::SetPageUpKey function is received.

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

The default implementation is to scroll up the multiple text by one page by booting up the SFZMultipleEditBoxControl::PageUp function.

Internal Implementation

Internal implementation of the SFZMultipleEditBoxControl::HandlePageUpKey function is as follows:

SFYMultipleEditWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleEditBoxControl::HandlePageUpKey(Void)
{
    return _widget->PageUp();
}// SFZMultipleEditBoxControl::HandlePageUpKey //

Reference

SFZMultipleEditBoxControl::SetPageUpKey | SFZMultipleEditBoxControl::PageUp | SFYMultipleEditWidget | SFXEvent | Key Event[SFEVT_KEY]

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 SFZMultipleEditBoxControl::HandleRenderRequest function is as follows:

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

Reference

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

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the ScrollDown key set with the SFZMultipleEditBoxControl::SetScrollDownKey function is received.

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

The default implementation is to scroll down the multiple text by the scroll-step set with the SFZMultipleEditBoxControl::SetScrollStep function by booting up the SFZMultipleEditBoxControl::ScrollDown function.

Internal Implementation

Internal implementation of the SFZMultipleEditBoxControl::HandleScrollDownKey function is as follows:

SFYMultipleEditWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleEditBoxControl::HandleScrollDownKey(Void)
{
    return _widget->ScrollDown();
}// SFZMultipleEditBoxControl::HandleScrollDownKey //

Reference

SFZMultipleEditBoxControl::SetScrollDownKey | SFZMultipleEditBoxControl::ScrollDown | SFZMultipleEditBoxControl::SetScrollStep | SFYMultipleEditWidget | SFXEvent | Key Event[SFEVT_KEY]

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the ScrollUp key set with the SFZMultipleEditBoxControl::SetScrollUpKey function is received.

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

The default implementation is to scroll up the multiple text by the scroll-step set with the SFZMultipleEditBoxControl::SetScrollStep function by booting up the SFZMultipleEditBoxControl::ScrollUp function.

Internal Implementation

Internal implementation of the SFZMultipleEditBoxControl::HandleScrollUpKey function is as follows:

SFYMultipleEditWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleEditBoxControl::HandleScrollUpKey(Void)
{
    return _widget->ScrollUp();
}// SFZMultipleEditBoxControl::HandleScrollUpKey //

Reference

SFZMultipleEditBoxControl::SetScrollUpKey | SFZMultipleEditBoxControl::ScrollUp | SFZMultipleEditBoxControl::SetScrollStep | SFYMultipleEditWidget | SFXEvent | Key Event[SFEVT_KEY]

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the SnapDown key set with the SFZMultipleEditBoxControl::SetSnapDownKey function is received.

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

The default implementation is to scroll down the multiple text to the bottom by booting up the SFZMultipleEditBoxControl::SnapDown function.

Internal Implementation

Internal implementation of the SFZMultipleEditBoxControl::HandleSnapDownKey function is as follows:

SFYMultipleEditWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleEditBoxControl::HandleSnapDownKey(Void)
{
    return _widget->SnapDown();
}// SFZMultipleEditBoxControl::HandleSnapDownKey //

Reference

SFZMultipleEditBoxControl::SetSnapDownKey | SFZMultipleEditBoxControl::SnapDown | SFYMultipleEditWidget | SFXEvent | Key Event[SFEVT_KEY]

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the SnapUp key set with the SFZMultipleEditBoxControl::SetSnapUpKey function is received.

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

The default implementation is to scroll up the multiple text to the top by booting up the SFZMultipleEditBoxControl::SnapUp function.

Internal Implementation

Internal implementation of the SFZMultipleEditBoxControl::HandleSnapUpKey function is as follows:

SFYMultipleEditWidgetSmp        _widget;

/*protected virtual */Bool SFZMultipleEditBoxControl::HandleSnapUpKey(Void)
{
    return _widget->SnapUp();
}// SFZMultipleEditBoxControl::HandleSnapUpKey //

Reference

SFZMultipleEditBoxControl::SetSnapUpKey | SFZMultipleEditBoxControl::SnapUp | SFYMultipleEditWidget | SFXEvent | Key Event[SFEVT_KEY]

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:

SFZMultipleEditBoxControlSmp _multipleeditbox;
SFCError error;

if ((_multipleeditbox = SFZMultipleEditBoxControl::NewInstance(&error)) != null) {

    ...
}

Return value

Reference

SFZMultipleEditBoxControl::PageUp | SFYMultipleEditWidget::PageDown

Return value

Reference

SFZMultipleEditBoxControl::PageDown | SFYMultipleEditWidget::PageUp

Return value

Reference

SFZMultipleEditBoxControl::SetScrollStep | SFZMultipleEditBoxControl::ScrollUp | SFYMultipleEditWidget::ScrollDown

Return value

Reference

SFZMultipleEditBoxControl::SetScrollStep | SFZMultipleEditBoxControl::ScrollDown | SFYMultipleEditWidget::ScrollUp

Description

Default: AEE_FONT_NORMAL

Reference

SFZMultipleEditBoxControl::GetFont

Description

This function sets the horizontal alignment to the specified value.

Default: SFYMultipleEditWidget::DEFAULT_HORIZONTAL

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

Reference

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

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

SFZMultipleEditBoxControl::GetMaximumLength | SFYMultipleEditWidget::SetMaximumLength | SFXEditProperty::SetMaximumLength | BREW API ITEXTCTL_SetMaxSize

Description

This function sets the PageDown key to scroll down the multiple text by one page to the specified value.

Default: AVK_TXPGDOWN

Reference

SFZMultipleEditBoxControl::GetPageDownKey

Description

This function sets the PageUp key to scroll up the multiple text by one page to the specified value.

Default: AVK_TXPGUP

Reference

SFZMultipleEditBoxControl::GetPageUpKey

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

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

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

SFZMultipleEditBoxControl::GetSFBTextCtlClassID | SFBTextCtl

Description

This function sets the ScrollDown key to scroll down the multiple text by the scroll-step set with the SFZMultipleEditBoxControl::SetScrollStep function to the specified value.

Default: AVK_DOWN

Reference

SFZMultipleEditBoxControl::GetScrollDownKey | SFZMultipleEditBoxControl::SetScrollStep

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: SFYMultipleEditWidget::DEFAULT_STEP [pixels]

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

Reference

SFZMultipleEditBoxControl::GetScrollStep | SFZMultipleEditBoxControl::DefaultEnum | SFYMultipleEditWidget::DefaultEnum

Description

This function sets the ScrollUp key to scroll up the multiple text by the scroll-step set with the SFZMultipleEditBoxControl::SetScrollStep function to the specified value.

Default: AVK_UP

Reference

SFZMultipleEditBoxControl::GetScrollUpKey | SFZMultipleEditBoxControl::SetScrollStep

Description

This function sets the SnapDown key to scroll down the multiple text to the bottom to the specified value.

Default: AVK_TXEND

Reference

SFZMultipleEditBoxControl::GetSnapDownKey

Description

This function sets the SnapUp key to scroll up the multiple text to the top to the specified value.

Default: AVK_TXHOME

Reference

SFZMultipleEditBoxControl::GetSnapUpKey

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

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

SFZMultipleEditBoxControl::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | State

Description

This function sets the vertical alignment to the specified value.

Default: SFYMultipleEditWidget::DEFAULT_VERTICAL

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

Reference

SFZMultipleEditBoxControl::GetVerticalAlign | SFZMultipleEditBoxControl::VerticalEnum | SFYMultipleEditWidget::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

SFZMultipleEditBoxControl::SetVerticalAlign | SFYMultipleEditWidget::SnapAlign

Return value

Reference

SFZMultipleEditBoxControl::SnapUp | SFYMultipleEditWidget::SnapDown

Return value

Reference

SFZMultipleEditBoxControl::SnapDown | SFYMultipleEditWidget::SnapUp

Reference

SFYResponder::GetType | SFYResponder::SetType

Reference

SFYMultipleEditWidget::DefaultEnum

Reference

SFYMultipleEditWidget::HorizontalEnum

Reference

SFYMultipleEditWidget::VerticalEnum