PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFZMultipleTextLabelControl
Responder which represents a label control to display a multiple uneditable text.
#include <SFZMultipleTextLabelControl.h.hpp>
class SFZMultipleTextLabelControl : public SFYLabelControl;
SFMTYPEDEFCLASS(SFZMultipleTextLabelControl)

Inheritance diagram

 Inheritance diagram of SFZMultipleTextLabelControlClass

Collaboration diagram

 Collaboration diagram of SFZMultipleTextLabelControlClass

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] 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)

Execution Result(Left: Unenable Mode, Right: Enable Mode)
[Caution] 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".

[Caution] 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

Constructor/Destructor
SFZMultipleTextLabelControl( Void )
Constructor of the SFZMultipleTextLabelControl class.
~SFZMultipleTextLabelControl( Void )
Destructor of the SFZMultipleTextLabelControl class.
Public Functions
AEEFont GetFont( Void )
Get the font.
HorizontalEnum GetHorizontalAlign( Void )
Get the horizontal alignment.
AVKType GetPageDownKey( Void )
Get the PageDown key to scroll down the multiple text by one page.
AVKType GetPageUpKey( Void )
Get the PageUp key to scroll up the multiple text by one page.
AVKType GetScrollDownKey( Void )
Get the ScrollDown key to scroll down the multiple text by the scroll-step.
SInt16 GetScrollStep( Void )
Get the scroll-step. [pixels]
AVKType GetScrollUpKey( Void )
Get the ScrollUp key to scroll up the multiple text by the scroll-step.
AVKType GetSnapDownKey( Void )
Get the SnapDown key to scroll down the multiple text to the bottom.
AVKType GetSnapUpKey( Void )
Get the SnapUp key to scroll up the multiple text to the top.
SFXWideStringConstRef GetText( Void )
Get the text.
SFXRGBColorConstRef GetTextColor( Void )
Get the color of text.
VerticalEnum GetVerticalAlign( Void )
Get the vertical alignment.
static
SFZMultipleTextLabelControlSmp
NewInstance( SFCErrorPtr exception = null )
Create a new instance of this responder class.
Bool PageDown( Void )
Scroll down the multiple text by one page.
Bool PageUp( Void )
Scroll up the multiple text by one page.
Bool ScrollDown( Void )
Scroll down the multiple text by the scroll-step.
Bool ScrollUp( Void )
Scroll up the multiple text by the scroll-step.
Void SetFont( AEEFont param )
Set the font to the specified value .
Void SetHorizontalAlign( HorizontalEnum param )
Set the horizontal alignment to the specified value.
Void SetPageDownKey( AVKType param )
Set the PageDown key to scroll down the multiple text by one page to the specified value.
Void SetPageUpKey( AVKType param )
Set the PageUp key to scroll up the multiple text by one page to the specified value.
Void SetScrollDownKey( AVKType param )
Set the ScrollDown key to scroll down the multiple text by the scroll-step to the specified value.
Void SetScrollStep( SInt16 param )
Set the scroll-step to the specified value. [pixels]
Void SetScrollUpKey( AVKType param )
Set the ScrollUp key to scroll up the multiple text by the scroll-step to the specified value.
Void SetSnapDownKey( AVKType param )
Set the SnapDown key to scroll down the multiple text to the bottom to the specified value.
Void SetSnapUpKey( AVKType param )
Set the SnapUp key to scroll up the multiple text to the top to the specified value.
SFCError SetText( SFXPathConstRef path , UInt16 id )
Set the text to the specified value.
SFCError SetText( SFXWideStringConstRef param )
Set the text to the specified value.
Void SetTextColor( SFXRGBColorConstRef param )
Set the color of text to the specified value.
Void SetVerticalAlign( VerticalEnum param )
Set the vertical alignment to the specified value.
Bool SnapAlign( Void )
Put back the scroll position of the multiple text to the initial state.
Bool SnapDown( Void )
Scroll down the multiple text to the bottom.
Bool SnapUp( Void )
Scroll down the multiple text to the top.
Void ClearHandler( Void ) (inherits from SFYResponder)
Unregister all handlers from this responder.
Void ClearTracer( Void ) (inherits from SFYResponder)
Unregister all dispatching rules from the tracer of this responder.
SFCError Distribute( SFXEventConstRef event , BoolPtr result = null ) (inherits from SFYResponder)
Distribute the specified event.
SFXRGBColorConstRef GetBackgroundColor( Void ) (inherits from SFYWidget)
Get the background color.
SFYResponderSmp GetChildBack( Void ) (inherits from SFYResponder)
Get the backmost child responder of this responder, which matches the specified search condition.
SFYResponderSmp GetChildBack( Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the backmost child responder of this responder, which matches the specified search condition.
SFYResponderSmp GetChildBack( UInt32 id ) (inherits from SFYResponder)
Get the backmost child responder of this responder, which matches the specified search condition.
SFYResponderSmp GetChildBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the backmost child responder of this responder, which matches the specified search condition.
SFYResponderSmp GetChildBackward( SInt32 index ) (inherits from SFYResponder)
Get the child responder of this responder at the specified position from the back side, which matches the specified search condition.
SFYResponderSmp GetChildBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the child responder of this responder at the specified position from the back side, which matches the specified search condition.
SFYResponderSmp GetChildBackward( SInt32 index , UInt32 id ) (inherits from SFYResponder)
Get the child responder of this responder at the specified position from the back side, which matches the specified search condition.
SFYResponderSmp GetChildBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the child responder of this responder at the specified position from the back side, which matches the specified search condition.
SInt32 GetChildCount( Void ) (inherits from SFYResponder)
Get the number of child responders of this responder, which match the specified search condition.
SInt32 GetChildCount( Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the number of child responders of this responder, which match the specified search condition.
SInt32 GetChildCount( UInt32 id ) (inherits from SFYResponder)
Get the number of child responders of this responder, which match the specified search condition.
SInt32 GetChildCount( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the number of child responders of this responder, which match the specified search condition.
SFYResponderSmp GetChildForward( SInt32 index ) (inherits from SFYResponder)
Get the child responder of this responder at the specified position from the front side, which matches the specified search condition.
SFYResponderSmp GetChildForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the child responder of this responder at the specified position from the front side, which matches the specified search condition.
SFYResponderSmp GetChildForward( SInt32 index , UInt32 id ) (inherits from SFYResponder)
Get the child responder of this responder at the specified position from the front side, which matches the specified search condition.
SFYResponderSmp GetChildForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the child responder of this responder at the specified position from the front side, which matches the specified search condition.
SFYResponderSmp GetChildFront( Void ) (inherits from SFYResponder)
Get the foremost child responder of this responder, which matches the specified search condition.
SFYResponderSmp GetChildFront( Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the foremost child responder of this responder, which matches the specified search condition.
SFYResponderSmp GetChildFront( UInt32 id ) (inherits from SFYResponder)
Get the foremost child responder of this responder, which matches the specified search condition.
SFYResponderSmp GetChildFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the foremost child responder of this responder, which matches the specified search condition.
SInt32 GetCurrentValue( Void ) (inherits from SFYControl)
Get the current value of this control.
SFYDistributerPtr GetDistributer( Void ) (inherits from SFYResponder)
Get the distributer bound with this responder.
SFXRGBColorConstRef GetFocusColor( Void ) (inherits from SFYLabelControl)
Get the color of frame of this label control in the "focus" state.
SFYResponderSmp GetFrame( Void ) (inherits from SFYResponder)
Get the frame which has been attached to this responder.
SFXRectangle GetGlobalBound( Void ) (inherits from SFYResponder)
Get the globle region of this responder.
UInt32 GetID( Void ) (inherits from SFYResponder)
Get the ID of this responder instance.
SFXRectangle GetLocalBound( Void ) (inherits from SFYResponder)
Get the local region of this responder.
SInt32 GetMaximumValue( Void ) (inherits from SFYControl)
Get the maximum value of this control.
SInt32 GetMinimumValue( Void ) (inherits from SFYControl)
Get the minimum value of this control.
SInt32 GetNthBackward( Void ) (inherits from SFYResponder)
Get the position counted from the back side of this responder among a group of sibling responders, which match the specified search condition.
SInt32 GetNthBackward( Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the position counted from the back side of this responder among a group of sibling responders, which match the specified search condition.
SInt32 GetNthBackward( UInt32 id ) (inherits from SFYResponder)
Get the position counted from the back side of this responder among a group of sibling responders, which match the specified search condition.
SInt32 GetNthBackward( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the position counted from the back side of this responder among a group of sibling responders, which match the specified search condition.
SInt32 GetNthForward( Void ) (inherits from SFYResponder)
Get the position counted from the front side of this responder among a group of sibling responders, which match the specified search condition.
SInt32 GetNthForward( Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the position counted from the front side of this responder among a group of sibling responders, which match the specified search condition.
SInt32 GetNthForward( UInt32 id ) (inherits from SFYResponder)
Get the position counted from the front side of this responder among a group of sibling responders, which match the specified search condition.
SInt32 GetNthForward( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Get the position counted from the front side of this responder among a group of sibling responders, which match the specified search condition.
AVKType GetOperateKey( Void ) (inherits from SFYLabelControl)
Get the operation key of this label control.
SFYResponderSmp GetParent( Void ) (inherits from SFYResponder)
Get the parent responder of this responder.
Bool GetPropertyTransparent( Void ) (inherits from SFYResponder)
Get the transparency attribute of this responder.
SFXRectangleConstRef GetRealBound( Void ) (inherits from SFYResponder)
Get the real region of this responder.
VoidPtr GetReference( Void ) (inherits from SFYResponder)
Get the reference of this responder.
SFYRendererPtr GetRenderer( Void ) (inherits from SFYResponder)
Get the renderer bound with this responder.
SFYResponderSmp GetRoot( Void ) (inherits from SFYResponder)
Get the root responder.
Bool GetStateActive( Bool inherit = false ) (inherits from SFYResponder)
Get the active state of this responder.
Bool GetStateEnable( Bool inherit = false ) (inherits from SFYResponder)
Get the enable state of this responder.
Bool GetStateFocus( Bool inherit = false ) (inherits from SFYResponder)
Get the focus state of this responder.
Bool GetStateValid( Bool inherit = false ) (inherits from SFYResponder)
Get the valid state of this responder.
Bool GetStateVisible( Bool inherit = false ) (inherits from SFYResponder)
Get the visible state of this responder.
SFXRectangle GetSuitableBound( Void ) (inherits from SFYResponder)
Get the suitable region of this responder.
SFXRectangle GetSuitableBound( SFXRectangleConstRef rectangle ) (inherits from SFYResponder)
Get the suitable region of this responder.
SFXRectangle GetSuitableBound( SFXRectangleConstRef param , HorizontalEnum horizontal , VerticalEnum vertical ) (inherits from SFYResponder)
Get the suitable region of this responder.
SFXMargin GetSuitableMargin( Void ) (inherits from SFYResponder)
Get the suitable frame margin region of this responder.
SFCType GetType( Void ) (inherits from SFYResponder)
Get the type of this responder class.
SFXRectangleConstRef GetVirtualBound( Void ) (inherits from SFYResponder)
Get the virtual region of this responder.
Bool HasFrame( Void ) (inherits from SFYResponder)
Check whether or not this responder is a content-responder.
Void Initialize( Void ) (inherits from SFYResponder)
Initialize this responder.
Bool IsBack( Void ) (inherits from SFYResponder)
Check whether or not this responder is the backmost responder among a group of the sibling responders which match the specified search condition.
Bool IsBack( Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Check whether or not this responder is the backmost responder among a group of the sibling responders which match the specified search condition.
Bool IsBack( UInt32 id ) (inherits from SFYResponder)
Check whether or not this responder is the backmost responder among a group of the sibling responders which match the specified search condition.
Bool IsBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Check whether or not this responder is the backmost responder among a group of the sibling responders which match the specified search condition.
Bool IsFrame( Void ) (inherits from SFYResponder)
Check whether or not this responder is an attachment-frame.
Bool IsFront( Void ) (inherits from SFYResponder)
Check whether or not this responder is the foremost responder among a group of the sibling responders which match the specified search condition.
Bool IsFront( Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Check whether or not this responder is the foremost responder among a group of the sibling responders which match the specified search condition.
Bool IsFront( UInt32 id ) (inherits from SFYResponder)
Check whether or not this responder is the foremost responder among a group of the sibling responders which match the specified search condition.
Bool IsFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Check whether or not this responder is the foremost responder among a group of the sibling responders which match the specified search condition.
Bool IsNthBackward( SInt32 index ) (inherits from SFYResponder)
Check whether or not this responder is at the specified position from the back side among a group of the sibling responders which match the specified search condition.
Bool IsNthBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Check whether or not this responder is at the specified position from the back side among a group of the sibling responders which match the specified search condition.
Bool IsNthBackward( SInt32 index , UInt32 id ) (inherits from SFYResponder)
Check whether or not this responder is at the specified position from the back side among a group of the sibling responders which match the specified search condition.
Bool IsNthBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Check whether or not this responder is at the specified position from the back side among a group of the sibling responders which match the specified search condition.
Bool IsNthForward( SInt32 index ) (inherits from SFYResponder)
Check whether or not this responder is at the specified position from the front side among a group of the sibling responders which match the specified search condition.
Bool IsNthForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Check whether or not this responder is at the specified position from the front side among a group of the sibling responders which match the specified search condition.
Bool IsNthForward( SInt32 index , UInt32 id ) (inherits from SFYResponder)
Check whether or not this responder is at the specified position from the front side among a group of the sibling responders which match the specified search condition.
Bool IsNthForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Check whether or not this responder is at the specified position from the front side among a group of the sibling responders which match the specified search condition.
Bool IsRoot( Void ) (inherits from SFYResponder)
Check whether or not this responder is the root responder.
SFCError Recover( Void ) (inherits from SFYResponder)
Recover the intersection region between this responder and the responder space by using the saved bitmap to restore the device bitmap.
SFCError RegisterHandler( SFXEventRangeConstRef range , SFYHandler::RuleRecConstRef rule ) (inherits from SFYResponder)
Register specified handlers into this responder.
SFCError RegisterHandler( SFXEventRangeConstRef range , SFYHandler::HandlerSPP spp , VoidPtr reference ) (inherits from SFYResponder)
Register specified handlers into this responder.
SFCError RegisterHandler( SFXEventRangeConstPtr range , SFYHandler::RuleRecConstPtr rule , SInt32 length ) (inherits from SFYResponder)
Register specified handlers into this responder.
SFCError RegisterHandler( SFXEventRangeConstPtr range , SFYHandler::HandlerSPPConstPtr spp , VoidPtrConstPtr reference , SInt32 length ) (inherits from SFYResponder)
Register specified handlers into this responder.
SFCError RegisterTracer( SFXEventRangeConstRef range , SFYTracer::RuleRecConstRef rule ) (inherits from SFYResponder)
Register specified dispatching rules into the tracer of this responder.
SFCError RegisterTracer( SFXEventRangeConstRef range , SFYTracer::OrderEnum order , SFYTracer::StateEnum state , Bool overload ) (inherits from SFYResponder)
Register specified dispatching rules into the tracer of this responder.
SFCError RegisterTracer( SFXEventRangeConstPtr range , SFYTracer::RuleRecConstPtr rule , SInt32 length ) (inherits from SFYResponder)
Register specified dispatching rules into the tracer of this responder.
SFCError RegisterTracer( SFXEventRangeConstPtr range , SFYTracer::OrderEnumConstPtr order , SFYTracer::StateEnumConstPtr state , BoolConstPtr overload , SInt32 length ) (inherits from SFYResponder)
Register specified dispatching rules into the tracer of this responder.
SFCError Render( Bool force = false ) (inherits from SFYResponder)
Boot up the renderer for redrawing this responder and its descendant responders.
Void SetBackgroundColor( SFXRGBColorConstRef param ) (inherits from SFYWidget)
Set the background color to the specified value.
Void SetCurrentValue( SInt32 param ) (inherits from SFYControl)
Set the current value of this control to the specified value.
Void SetDistributer( SFYDistributerPtr param ) (inherits from SFYResponder)
Bind this responder with the specified distributer.
Void SetFocusColor( SFXRGBColorConstRef param ) (inherits from SFYLabelControl)
Set the color of the inner frame of this label control in the "focus" state to the specified value.
SFCError SetFrame( SFYResponderSmpConstRef param ) (inherits from SFYResponder)
Attach the specified frame to this frame.
Void SetID( UInt32 param ) (inherits from SFYResponder)
Set the ID value of this responder to the specified value.
Void SetMaximumValue( SInt32 param ) (inherits from SFYControl)
Set the maximum value of the control to the specified value.
Void SetMinimumValue( SInt32 param ) (inherits from SFYControl)
Set the minimum value of the control to the specified value.
Void SetOperateKey( AVKType param ) (inherits from SFYLabelControl)
Set the operation key of this label control to the specified value.
SFCError SetParent( SFYResponderSmpConstRef param ) (inherits from SFYResponder)
Set the parent responder of this responder to the specified responder.
Void SetProperty( Bool transparent ) (inherits from SFYResponder)
Set the property of this responder to the specified value.
Void SetPropertyTransparent( Bool param ) (inherits from SFYResponder)
Set the transparency attribute of this responder to the specified value.
Void SetRealBound( SFXRectangleConstRef param ) (inherits from SFYResponder)
Set the real region of this responder to the specified region.
Void SetReference( VoidPtr param ) (inherits from SFYResponder)
Set the reference value of this responder to the specified value.
Void SetRenderer( SFYRendererPtr param ) (inherits from SFYResponder)
Bind this responder with the specified renderer.
Void SetState( Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Set all states of this responder to specified values together.
Void SetStateActive( Bool param ) (inherits from SFYResponder)
Set the active state of this responder to the specified value.
Void SetStateEnable( Bool param ) (inherits from SFYResponder)
Set the enable state of this responder to the specified value.
Void SetStateFocus( Bool param ) (inherits from SFYResponder)
Set the focus state of this responder to the specified value.
Void SetStateVisible( Bool param ) (inherits from SFYResponder)
Set the visible state of this responder to the specified value.
Void SetVirtualBound( SFXRectangleConstRef param ) (inherits from SFYResponder)
Set the virtual region of this responder to the specified value.
SFCError Snapshot( SFBBitmapSmpConstRef bitmap ) (inherits from SFYResponder)
Get a snapshot image of the intersection region between this responder and the responder space by using the saved bitmap.
Void Terminate( Void ) (inherits from SFYResponder)
Terminate this responder.
Void ToBack( Void ) (inherits from SFYResponder)
Move this responder to the backmost position among a group of the sibling responders which match the specified search condition.
Void ToBack( Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Move this responder to the backmost position among a group of the sibling responders which match the specified search condition.
Void ToBack( UInt32 id ) (inherits from SFYResponder)
Move this responder to the backmost position among a group of the sibling responders which match the specified search condition.
Void ToBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Move this responder to the backmost position among a group of the sibling responders which match the specified search condition.
Void ToFront( Void ) (inherits from SFYResponder)
Move this responder to the foremost position among a group of the sibling responders which match the specified search condition.
Void ToFront( Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Move this responder to the foremost position among a group of the sibling responders which match the specified search condition.
Void ToFront( UInt32 id ) (inherits from SFYResponder)
Move this responder to the foremost position among a group of the sibling responders which match the specified search condition.
Void ToFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Move this responder to the foremost position among a group of the sibling responders which match the specified search condition.
Void ToNthBackward( SInt32 index ) (inherits from SFYResponder)
Move this responder to the specified position from the back side among a group of the sibling responders which match the specified search condition.
Void ToNthBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Move this responder to the specified position from the back side among a group of the sibling responders which match the specified search condition.
Void ToNthBackward( SInt32 index , UInt32 id ) (inherits from SFYResponder)
Move this responder to the specified position from the back side among a group of the sibling responders which match the specified search condition.
Void ToNthBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Move this responder to the specified position from the back side among a group of the sibling responders which match the specified search condition.
Void ToNthForward( SInt32 index ) (inherits from SFYResponder)
Move this responder to the specified position from the front side among a group of the sibling responders which match the specified search condition.
Void ToNthForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Move this responder to the specified position from the front side among a group of the sibling responders which match the specified search condition.
Void ToNthForward( SInt32 index , UInt32 id ) (inherits from SFYResponder)
Move this responder to the specified position from the front side among a group of the sibling responders which match the specified search condition.
Void ToNthForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (inherits from SFYResponder)
Move this responder to the specified position from the front side among a group of the sibling responders which match the specified search condition.
Void UnregisterHandler( SFXEventRangeConstRef range , SFYHandler::RuleRecConstRef rule ) (inherits from SFYResponder)
Unregister the handler from this responder which matches the specified condition.
Void UnregisterHandler( SFXEventRangeConstRef range , SFYHandler::HandlerSPP spp , VoidPtr reference ) (inherits from SFYResponder)
Unregister the handler from this responder which matches the specified condition.
Void UnregisterHandler( SFXEventRangeConstPtr range , SFYHandler::RuleRecConstPtr rule , SInt32 length ) (inherits from SFYResponder)
Unregister the handler from this responder which matches the specified condition.
Void UnregisterHandler( SFXEventRangeConstPtr range , SFYHandler::HandlerSPPConstPtr spp , VoidPtrConstPtr reference , SInt32 length ) (inherits from SFYResponder)
Unregister the handler from this responder which matches the specified condition.
Void UnregisterTracer( SFXEventRangeConstRef range ) (inherits from SFYResponder)
Unregister the dispatching rule from the tracer of this responder which matches the specified condition.
Void UnregisterTracer( SFXEventRangeConstPtr range , SInt32 length ) (inherits from SFYResponder)
Unregister the dispatching rule from the tracer of this responder which matches the specified condition.
T const & static_catch( Void ) (inherits from static_exception)
Get the current exception.
Protected Functions
SFYMultipleTextWidgetSmpConstRef GetWidget( Void )
Get the widget which is contained internally for drawing a multiple text.
Void HandleBoundOptimize( SFXRectanglePtr rectangle )
This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) event is received. [Calculate the suitable rectangle size of this responder within the specified hint rectangle.]
Void HandleBoundRequest( SFXRectanglePtr rectangle )
This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) event is received. [Calculate the suitable rectangle size of this responder.]
Void HandleBoundVirtual( Void )
This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event is received. [Perform the processing when the virtual region is changed.]
Void HandleOperateKey( Void )
This function will be called when the SFEVT_KEY event of the operation key is received.
Bool HandlePageDownKey( Void )
This function will be called when the SFEVT_KEY event of the PageDown key is received.
Bool HandlePageUpKey( Void )
This function will be called when the SFEVT_KEY event of the PageUp key is received.
Void HandleRenderRequest( SFXGraphicsPtr graphics )
This function will be called when the (SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) event is received. [Draw this responder.]
Bool HandleScrollDownKey( Void )
This function will be called when the SFEVT_KEY event of the ScrollDown key is received.
Bool HandleScrollUpKey( Void )
This function will be called when the SFEVT_KEY event of the ScrollUp key is received.
Bool HandleSnapDownKey( Void )
This function will be called when the SFEVT_KEY event of the SnapDown key is received.
Bool HandleSnapUpKey( Void )
This function will be called when the SFEVT_KEY event of the SnapUp key is received.
Void DrawFocus( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle ) (inherits from SFYLabelControl)
Draw the frame of this label control in the "focus" state.
static
SFYResponderSmp
Factory( SFYResponderPtr responder , SFCErrorPtr exception = null ) (inherits from SFYResponder)
This function is used to implement the NewInstance function.
static
SFXMarginConstRef
GetFocusMargin( Void ) (inherits from SFYLabelControl)
Get the margin between the border and the label text of this label control in the "focus" state.
SFYResponderSmp GetThis( Void ) (inherits from SFYResponder)
Get the smart pointer of this responder.
Void HandleBoundGlobal( SFXRectangleConstRef rectangle ) (inherits from SFYWidget)
This function will be called when the global region is changed.
Void HandleBoundReal( Void ) (inherits from SFYControl)
This function will be called when the real region is changed.
Void Invalidate( Void ) (inherits from SFYResponder)
Register the specified redraw region of this responder.
Void Invalidate( SFXRectangleConstRef param ) (inherits from SFYResponder)
Register the specified redraw region of this responder.
Void InvokeBackward( SFXEventConstRef event , Bool overload , BoolPtr result = null ) (inherits from SFYResponder)
Call the handlers for the specified event from the end of the handler list registered into this responder.
Void InvokeForward( SFXEventConstRef event , Bool overload , BoolPtr result = null ) (inherits from SFYResponder)
Call the handlers for the specified event from the head of the handler list registered into this responder.
Void SetType( SFCType param ) (inherits from SFYResponder)
Set the Type value of this responder to the specified 4-character value.
Void static_throw( static_exception< T > const & param ) (inherits from static_exception)
Set an exception.
Void static_throw( T const & param ) (inherits from static_exception)
Set an exception.
Bool static_try( Void ) (inherits from static_exception)
Confirm whether or not the exception is retained.
Types
CodeEnum
Constant that represents the SFZMultipleTextLabelControl class.
DefaultEnum
Constants that represent the default value for various parameters.
HorizontalEnum
Constants that represent the horizontal alignment.
VerticalEnum
Constants that represent the vertical alignment.

SFZMultipleTextLabelControl::SFZMultipleTextLabelControl
Constructor of the SFZMultipleTextLabelControl class.
[ protected, explicit ]
SFZMultipleTextLabelControl(Void);

Description

This constructor performs the initializations as follows:

  1. Set the type of this responder to "cmtl".
  2. Create the SFYMultipleTextWidget instance which is internally contained as a child responder for drawing the text.
  3. Set the state of the SFYMultipleTextWidget instance to "visible" + "active" + "disable" + "unfocus".
  4. Set the text to ""[null string].
  5. Set the text font to AEE_FONT_NORMAL.
  6. Set the color of the text to SFXRGBColor(0x00, 0x00, 0x00, 0x00)[black color]
  7. Set the horizontal alignment of the text to SFZMultipleTextLabelControl::DEFAULT_HORIZONTAL.
  8. Set the vertical alignment of the text to SFZMultipleTextLabelControl::DEFAULT_VERTICAL.
  9. Set the scroll-step of the text to SFZMultipleTextLabelControl::DEFAULT_STEP [pixels].

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


SFZMultipleTextLabelControl::~SFZMultipleTextLabelControl
Destructor of the SFZMultipleTextLabelControl class.
[ protected, virtual ]
virtual ~SFZMultipleTextLabelControl(Void);

Description

This destructor does nothing.


SFZMultipleTextLabelControl::GetFont
Get the font.
[ public, const ]
AEEFont GetFont(Void);

Description

This function gets the font.

Reference

SFZMultipleTextLabelControl::SetFont


SFZMultipleTextLabelControl::GetHorizontalAlign
Get the horizontal alignment.
[ public, const ]
HorizontalEnum GetHorizontalAlign(Void);

Return value

Value of the horizontal alignment.

Reference

SFZMultipleTextLabelControl::SetHorizontalAlign | SFZMultipleTextLabelControl::HorizontalEnum


SFZMultipleTextLabelControl::GetPageDownKey
Get the PageDown key to scroll down the multiple text by one page.
[ public, const ]
AVKType GetPageDownKey(Void);

Return value

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

Reference

SFZMultipleTextLabelControl::SetPageDownKey


SFZMultipleTextLabelControl::GetPageUpKey
Get the PageUp key to scroll up the multiple text by one page.
[ public, const ]
AVKType GetPageUpKey(Void);

Return value

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

Reference

SFZMultipleTextBoxControl::SetPageUpKey


SFZMultipleTextLabelControl::GetScrollDownKey
Get the ScrollDown key to scroll down the multiple text by the scroll-step.
[ public, const ]
AVKType GetScrollDownKey(Void);

Return value

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

Reference

SFZMultipleTextLabelControl::SetScrollDownKey | SFZMultipleTextLabelControl::SetScrollStep


SFZMultipleTextLabelControl::GetScrollStep
Get the scroll-step. [pixels]
[ public, const ]
SInt16 GetScrollStep(Void);

Return value

Scroll-step. [pixels]

Reference

SFZMultipleTextLabelControl::SetScrollStep


SFZMultipleTextLabelControl::GetScrollUpKey
Get the ScrollUp key to scroll up the multiple text by the scroll-step.
[ public, const ]
AVKType GetScrollUpKey(Void);

Return value

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

Reference

SFZMultipleTextLabelControl::SetScrollUpKey | SFZMultipleTextLabelControl::SetScrollStep


SFZMultipleTextLabelControl::GetSnapDownKey
Get the SnapDown key to scroll down the multiple text to the bottom.
[ public, const ]
AVKType GetSnapDownKey(Void);

Return value

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

Reference

SFZMultipleTextLabelControl::SetSnapDownKey


SFZMultipleTextLabelControl::GetSnapUpKey
Get the SnapUp key to scroll up the multiple text to the top.
[ public, const ]
AVKType GetSnapUpKey(Void);

Return value

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

Reference

SFZMultipleTextLabelControl::SetSnapUpKey


SFZMultipleTextLabelControl::GetText
Get the text.
[ public, const ]
SFXWideStringConstRef GetText(Void);

Reference

SFZMultipleTextLabelControl::SetText


SFZMultipleTextLabelControl::GetTextColor
Get the color of text.
[ public, const ]
SFXRGBColorConstRef GetTextColor(Void);

Reference

SFZMultipleTextLabelControl::SetTextColor | SFXRGBColor


SFZMultipleTextLabelControl::GetVerticalAlign
Get the vertical alignment.
[ public, const ]
VerticalEnum GetVerticalAlign(Void);

Return value

Value of the vertical alignment.

Reference

SFZMultipleTextLabelControl::SetVerticalAlign | SFZMultipleTextLabelControl::VerticalEnum


SFZMultipleTextLabelControl::GetWidget
Get the widget which is contained internally for drawing a multiple text.
[ protected, const ]
SFYMultipleTextWidgetSmpConstRef GetWidget(Void);

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


SFZMultipleTextLabelControl::HandleBoundOptimize
This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) event is received. [Calculate the suitable rectangle size of this responder within the specified hint rectangle.]
[ protected, virtual, const ]
Void HandleBoundOptimize(
    SFXRectanglePtr rectangle   // hint region and calculated region
);

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.

[Note] 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]


SFZMultipleTextLabelControl::HandleBoundRequest
This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) event is received. [Calculate the suitable rectangle size of this responder.]
[ protected, virtual, const ]
Void HandleBoundRequest(
    SFXRectanglePtr rectangle   // calculated 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.

[Note] 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] 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


SFZMultipleTextLabelControl::HandleBoundVirtual
This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event is received. [Perform the processing when the virtual region is changed.]
[ protected, virtual ]
Void HandleBoundVirtual(Void);

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.

[Note] 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.

[Note] 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


SFZMultipleTextLabelControl::HandleOperateKey
This function will be called when the SFEVT_KEY event of the operation key is received.
[ protected, virtual ]
Void HandleOperateKey(Void);

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]


SFZMultipleTextLabelControl::HandlePageDownKey
This function will be called when the SFEVT_KEY event of the PageDown key is received.
[ protected, virtual ]
Bool HandlePageDownKey(Void);

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]


SFZMultipleTextLabelControl::HandlePageUpKey
This function will be called when the SFEVT_KEY event of the PageUp key is received.
[ protected, virtual ]
Bool HandlePageUpKey(Void);

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]


SFZMultipleTextLabelControl::HandleRenderRequest
This function will be called when the (SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) event is received. [Draw this responder.]
[ protected, virtual, const ]
Void HandleRenderRequest(
    SFXGraphicsPtr graphics   // graphics object
);

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.

[Note] 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.

[Note] 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:

  1. At the end of the event loop
  2. At the applet start / resume or the end of a highest priority event handler
  3. 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


SFZMultipleTextLabelControl::HandleScrollDownKey
This function will be called when the SFEVT_KEY event of the ScrollDown key is received.
[ protected, virtual ]
Bool HandleScrollDownKey(Void);

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]


SFZMultipleTextLabelControl::HandleScrollUpKey
This function will be called when the SFEVT_KEY event of the ScrollUp key is received.
[ protected, virtual ]
Bool HandleScrollUpKey(Void);

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]


SFZMultipleTextLabelControl::HandleSnapDownKey
This function will be called when the SFEVT_KEY event of the SnapDown key is received.
[ protected, virtual ]
Bool HandleSnapDownKey(Void);

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]


SFZMultipleTextLabelControl::HandleSnapUpKey
This function will be called when the SFEVT_KEY event of the SnapUp key is received.
[ protected, virtual ]
Bool HandleSnapUpKey(Void);

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]


SFZMultipleTextLabelControl::NewInstance
Create a new instance of this responder class.
[ public, static ]
SFZMultipleTextLabelControlSmp NewInstance(
    SFCErrorPtr exception = null   // error value
);

Argument

exception

Return the error value generated inside the function.

Return value

  • If succeeds: not null pointer
  • Otherwise: null pointer

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) {

    ...
}

SFZMultipleTextLabelControl::PageDown
Scroll down the multiple text by one page.
[ public ]
Bool PageDown(Void);

Return value

  • If succeeds: true
  • Otherwise: false

Reference

SFZMultipleTextLabelControl::PageUp | SFYMultipleTextWidget::PageDown


SFZMultipleTextLabelControl::PageUp
Scroll up the multiple text by one page.
[ public ]
Bool PageUp(Void);

Return value

  • If succeeds: true
  • Otherwise: false

Reference

SFZMultipleTextLabelControl::PageDown | SFYMultipleTextWidget::PageUp


SFZMultipleTextLabelControl::ScrollDown
Scroll down the multiple text by the scroll-step.
[ public ]
Bool ScrollDown(Void);

Return value

  • If succeeds: true
  • Otherwise: false

Reference

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


SFZMultipleTextLabelControl::ScrollUp
Scroll up the multiple text by the scroll-step.
[ public ]
Bool ScrollUp(Void);

Return value

  • If succeeds: true
  • Otherwise: false

Reference

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


SFZMultipleTextLabelControl::SetFont
Set the font to the specified value .
[ public ]
Void SetFont(
    AEEFont param   // value to set
);

Description

Default: AEE_FONT_NORMAL

Reference

SFZMultipleTextLabelControl::GetFont


SFZMultipleTextLabelControl::SetHorizontalAlign
Set the horizontal alignment to the specified value.
[ public ]
Void SetHorizontalAlign(
    HorizontalEnum param   // value to set
);

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


SFZMultipleTextLabelControl::SetPageDownKey
Set the PageDown key to scroll down the multiple text by one page to the specified value.
[ public ]
Void SetPageDownKey(
    AVKType param   // key to set
);

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


SFZMultipleTextLabelControl::SetPageUpKey
Set the PageUp key to scroll up the multiple text by one page to the specified value.
[ public ]
Void SetPageUpKey(
    AVKType param   // key to set
);

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


SFZMultipleTextLabelControl::SetScrollDownKey
Set the ScrollDown key to scroll down the multiple text by the scroll-step to the specified value.
[ public ]
Void SetScrollDownKey(
    AVKType param   // key to set
);

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


SFZMultipleTextLabelControl::SetScrollStep
Set the scroll-step to the specified value. [pixels]
[ public ]
Void SetScrollStep(
    SInt16 param   // value to set
);

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


SFZMultipleTextLabelControl::SetScrollUpKey
Set the ScrollUp key to scroll up the multiple text by the scroll-step to the specified value.
[ public ]
Void SetScrollUpKey(
    AVKType param   // key to set
);

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


SFZMultipleTextLabelControl::SetSnapDownKey
Set the SnapDown key to scroll down the multiple text to the bottom to the specified value.
[ public ]
Void SetSnapDownKey(
    AVKType param   // key to set
);

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


SFZMultipleTextLabelControl::SetSnapUpKey
Set the SnapUp key to scroll up the multiple text to the top to the specified value.
[ public ]
Void SetSnapUpKey(
    AVKType param   // key to set
);

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


SFZMultipleTextLabelControl::SetText
Set the text to the specified value.
[ public ]
SFCError SetText(
    SFXPathConstRef path   // path of resource file
    UInt16 id              // resource ID
);
[ public ]
SFCError SetText(
    SFXWideStringConstRef param   // text
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • If insufficient memory: SFERR_NO_MEMORY
  • Otherwise: SFERR_FAILED

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


SFZMultipleTextLabelControl::SetTextColor
Set the color of text to the specified value.
[ public ]
Void SetTextColor(
    SFXRGBColorConstRef param   // value to set
);

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


SFZMultipleTextLabelControl::SetVerticalAlign
Set the vertical alignment to the specified value.
[ public ]
Void SetVerticalAlign(
    VerticalEnum param   // value to set
);

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


SFZMultipleTextLabelControl::SnapAlign
Put back the scroll position of the multiple text to the initial state.
[ public ]
Bool SnapAlign(Void);

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.

  1. In case of top-aligned: the scroll position will be put back to the top.
  2. In case of center-aligned: the scroll position will be put back to the center.
  3. In case of right-aligned: the scroll position will be put back to the bottom.

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


SFZMultipleTextLabelControl::SnapDown
Scroll down the multiple text to the bottom.
[ public ]
Bool SnapDown(Void);

Return value

  • If succeeds: true
  • Otherwise: false

Reference

SFZMultipleTextLabelControl::SnapUp | SFYMultipleTextWidget::SnapDown


SFZMultipleTextLabelControl::SnapUp
Scroll down the multiple text to the top.
[ public ]
Bool SnapUp(Void);

Return value

  • If succeeds: true
  • Otherwise: false

Reference

SFZMultipleTextLabelControl::SnapDown | SFYMultipleTextWidget::SnapUp


SFZMultipleTextLabelControl::CodeEnum
Constant that represents the SFZMultipleTextLabelControl class.
enum CodeEnum {
    CODE_TYPE = four_char_code('c', 'm', 't', 'l')
};
SFMTYPEDEFTYPE(CodeEnum)

Reference

SFYResponder::GetType | SFYResponder::SetType


SFZMultipleTextLabelControl::DefaultEnum
Constants that represent the default value for various parameters.
enum DefaultEnum {
    DEFAULT_STEP   = SFYMultipleTextWidget::DEFAULT_STEP     // scroll-step [pixels]
};
SFMTYPEDEFTYPE(DefaultEnum)

Reference

SFYMultipleTextWidget::DefaultEnum


SFZMultipleTextLabelControl::HorizontalEnum
Constants that represent the horizontal alignment.
enum HorizontalEnum {
    HORIZONTAL_LEFT    = SFYMultipleTextWidget::HORIZONTAL_LEFT,   // left-aligned
    HORIZONTAL_CENTER  = SFYMultipleTextWidget::HORIZONTAL_CENTER, // center-aligned
    HORIZONTAL_RIGHT   = SFYMultipleTextWidget::HORIZONTAL_RIGHT,  // right-aligned
    DEFAULT_HORIZONTAL = SFYMultipleTextWidget::DEFAULT_HORIZONTAL // default: center-aligned
};
SFMTYPEDEFTYPE(HorizontalEnum)

Reference

SFYMultipleTextWidget::HorizontalEnum


SFZMultipleTextLabelControl::VerticalEnum
Constants that represent the vertical alignment.
enum VerticalEnum {
    VERTICAL_TOP     = SFYMultipleTextWidget::VERTICAL_TOP,     // top-aligned
    VERTICAL_MIDDLE  = SFYMultipleTextWidget::VERTICAL_MIDDLE,  // center-aligned
    VERTICAL_BOTTOM  = SFYMultipleTextWidget::VERTICAL_BOTTOM,  // bottom-aligned
    DEFAULT_VERTICAL = SFYMultipleTextWidget::DEFAULT_VERTICAL  // default: center-aligned
};
SFMTYPEDEFTYPE(VerticalEnum)

Reference

SFYMultipleTextWidget::VerticalEnum