Inheritance diagram

Collaboration diagram

Description

How to use

There are 2 types of modes (i.e., "enable" and "disable") in a label control to display a multiple uneditable text(SFZMultipleTextLabelControl) depending on its enable state.

In the "enable" mode(when the state is enable), this control can be focused. In the focused state, it will receive the result event [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())] if the operation key set with the SFYLabelControl::SetOperateKey function is pressed.

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

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

This control will behave as a normal label control in the "disable" mode(when the state is disable).

Figure 354. Execution Result(Left: Unenable Mode, Right: Enable Mode)

	Default value of the transparency attribute
	Since the transparency attribute of this class is set to "true" by default, the background will not be filled in the color set with the SFYWidget::SetBackgroundColor function unless this transparency attribute is set to "false".

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

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

Member

Description

This constructor performs the initializations as follows:

Reference

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

Description

This destructor does nothing.

Description

This function gets the font.

Reference

SFZMultipleTextLabelControl::SetFont

Return value

Value of the horizontal alignment.

Reference

SFZMultipleTextLabelControl::SetHorizontalAlign | SFZMultipleTextLabelControl::HorizontalEnum

Return value

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

Reference

SFZMultipleTextLabelControl::SetPageDownKey

Return value

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

Reference

SFZMultipleTextBoxControl::SetPageUpKey

Return value

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

Reference

SFZMultipleTextLabelControl::SetScrollDownKey | SFZMultipleTextLabelControl::SetScrollStep

Return value

Scroll-step. [pixels]

Reference

SFZMultipleTextLabelControl::SetScrollStep

Return value

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

Reference

SFZMultipleTextLabelControl::SetScrollUpKey | SFZMultipleTextLabelControl::SetScrollStep

Return value

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

Reference

SFZMultipleTextLabelControl::SetSnapDownKey

Return value

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

Reference

SFZMultipleTextLabelControl::SetSnapUpKey

Reference

SFZMultipleTextLabelControl::SetText

Reference

SFZMultipleTextLabelControl::SetTextColor | SFXRGBColor

Return value

Value of the vertical alignment.

Reference

SFZMultipleTextLabelControl::SetVerticalAlign | SFZMultipleTextLabelControl::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.

Reference: SFYMultipleTextWidget::HandleBoundOptimize

Internal Implementation

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

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYLabelControl::GetFocusMargin | SFZMultipleTextLabelControl::SetText | SFZMultipleTextLabelControl::SetFont | 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 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: SFYMultipleTextWidget::HandleBoundRequest

Internal Implementation

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

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYLabelControl::GetFocusMargin | SFZMultipleTextLabelControl::SetText | SFZMultipleTextLabelControl::SetFont | SFYMultipleTextWidget::HandleBoundRequest | SFYLabelControl::GetFocusMargin | SFYMultipleTextWidget | 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 SFZMultipleTextLabelControl::HandleBoundVirtual function is as follows:

SFYMultipleTextWidgetSmp        _widget;

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

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

Reference

SFZMultipleTextLabelControl::SetText | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | SFYMultipleTextWidget | 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 and send the result event [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())] to itself.

Internal Implementation

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

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFYLabelControl::SetOperateKey | SFYControl::GetCurrentValue | SFYMultipleTextWidget | 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 SFZMultipleTextLabelControl::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 SFZMultipleTextLabelControl::PageDown function.

Internal Implementation

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

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFZMultipleTextLabelControl::SetPageDownKey | SFZMultipleTextLabelControl::PageDown | SFYMultipleTextWidget | 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 xref linkend="meth.SFZMultipleTextLabelControl.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 SFZMultipleTextLabelControl::PageUp function.

Internal Implementation

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

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFZMultipleTextLabelControl::SetPageUpKey | SFZMultipleTextLabelControl::PageUp | SFYMultipleTextWidget | 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 SFZMultipleTextLabelControl::HandleRenderRequest function is as follows:

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

Reference

SFYLabelControl::DrawFocus | SFZMultipleTextLabelControl::SetText | SFZMultipleTextLabelControl::SetHorizontalAlign | SFZMultipleTextLabelControl::SetVerticalAlign | SFZMultipleTextLabelControl::SetFont | SFZMultipleTextLabelControl::SetTextColor | SFYMultipleTextWidget::HandleRenderRequest | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | SFYMultipleTextWidget | 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 SFZMultipleTextLabelControl::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 SFZMultipleTextLabelControl::SetScrollStep function by booting up the SFZMultipleTextLabelControl::ScrollDown function.

Internal Implementation

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

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFZMultipleTextLabelControl::SetScrollDownKey | SFZMultipleTextLabelControl::ScrollDown | SFZMultipleTextLabelControl::SetScrollStep | SFYMultipleTextWidget | 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 SFZMultipleTextLabelControl::SetScrollUpKey function is received.

This function will be called when the ScrollUp key set with the function is pressed.

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 SFZMultipleTextLabelControl::SetScrollStep function by booting up the SFZMultipleTextLabelControl::ScrollUp function.

Internal Implementation

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

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFZMultipleTextLabelControl::SetScrollUpKey | SFZMultipleTextLabelControl::ScrollUp | SFZMultipleTextLabelControl::SetScrollStep | SFYMultipleTextWidget | 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 SFZMultipleTextLabelControl::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 SFZMultipleTextLabelControl::SnapDown function.

Internal Implementation

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

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFZMultipleTextLabelControl::SetSnapDownKey | SFZMultipleTextLabelControl::SnapDown | SFYMultipleTextWidget | 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 SFZMultipleTextLabelControl::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 SFZMultipleTextLabelControl::SnapUp function.

Internal Implementation

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

SFYMultipleTextWidgetSmp        _widget;

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

Reference

SFZMultipleTextLabelControl::SetSnapUpKey | SFZMultipleTextLabelControl::SnapUp | SFYMultipleTextWidget | 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:

SFZMultipleTextLabelControlSmp _multipletextlabel;
SFCError error;

if ((_multipletextlabel = SFZMultipleTextLabelControl::NewInstance(&error)) != null) {

    ...
}

Return value

Reference

SFZMultipleTextLabelControl::PageUp | SFYMultipleTextWidget::PageDown

Return value

Reference

SFZMultipleTextLabelControl::PageDown | SFYMultipleTextWidget::PageUp

Return value

Reference

SFZMultipleTextLabelControl::SetScrollStep | SFZMultipleTextLabelControl::ScrollUp | SFYMultipleTextWidget::ScrollDown

Return value

Reference

SFZMultipleTextLabelControl::SetScrollStep | SFZMultipleTextLabelControl::ScrollDown | SFYMultipleTextWidget::ScrollUp

Description

Default: AEE_FONT_NORMAL

Reference

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

SFZMultipleTextLabelControl::GetHorizontalAlign | SFZMultipleTextLabelControl::HorizontalEnum | SFYMultipleTextWidget::HorizontalEnum

Description

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

Default: AVK_TXPGDOWN

Reference

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

SFZMultipleTextLabelControl::GetPageUpKey

Description

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

Default: AVK_DOWN

Reference

SFZMultipleTextLabelControl::GetScrollDownKey | SFZMultipleTextLabelControl::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: SFYMultipleTextWidget::DEFAULT_STEP [pixels]

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

Reference

SFZMultipleTextLabelControl::GetScrollStep | SFZMultipleTextLabelControl::DefaultEnum | SFYMultipleTextWidget::DefaultEnum

Description

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

Default: AVK_UP

Reference

SFZMultipleTextLabelControl::GetScrollUpKey | SFZMultipleTextLabelControl::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

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

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

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

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

SFZMultipleTextLabelControl::GetVerticalAlign | SFZMultipleTextLabelControl::VerticalEnum | SFYMultipleTextWidget::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

SFZMultipleTextLabelControl::SetVerticalAlign | SFYMultipleTextWidget::SnapAlign

Return value

Reference

SFZMultipleTextLabelControl::SnapUp | SFYMultipleTextWidget::SnapDown

Return value

Reference

SFZMultipleTextLabelControl::SnapDown | SFYMultipleTextWidget::SnapUp

Reference

SFYResponder::GetType | SFYResponder::SetType

Reference

SFYMultipleTextWidget::DefaultEnum

Reference

SFYMultipleTextWidget::HorizontalEnum

Reference

SFYMultipleTextWidget::VerticalEnum