Inheritance diagram

Collaboration diagram

Description

How to use

Box control to display a single uneditable text(SFZSingleTextBoxControl) will receive the result event [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())] if the operation key set with the SFYBoxControl::SetOperateKey function is pressed.

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

If there are more characters than can be displayed in the box area of a box control, this control will start to scroll automatically when it is in the focused state.

Figure 379. Execution Result

Reference

Box Control to Display a Single Uneditable Text [SFZSingleTextBoxControl] | SFYControl | SFYBoxControl | SFYSingleTextWidget

Member

Description

This constructor performs the initializations as follows:

	Note
	In a responder inheriting from SFZSingleTextBoxControl, the corresponding handler will be called when one of the above events occurs.

Reference

SFYResponder::SetType | SFZSingleTextBoxControl::CodeEnum | SFYResponder::SetParent | SFYResponder::SetState | SFZSingleTextBoxControl::SetText | SFZSingleTextBoxControl::SetFont | SFZSingleTextBoxControl::SetTextColor | SFZSingleTextBoxControl::SetHorizontalAlign | SFZSingleTextBoxControl::SetVerticalAlign | SFZSingleTextBoxControl::SetScrollDirection | SFZSingleTextBoxControl::SetScrollInterval | SFZSingleTextBoxControl::SetScrollStep | SFZSingleTextBoxControl::SetWaitInterval | SFZSingleTextBoxControl::HorizontalEnum | SFZSingleTextBoxControl::VerticalEnum | SFZSingleTextBoxControl::DirectionEnum | SFZSingleTextBoxControl::DefaultEnum | SFYSingleTextWidget::NewInstance | SFYSingleTextWidget | SFXRGBColor | Type | State | Event | State Event[SFEVT_RESPONDER_STATE]

Description

This destructor does nothing.

Description

This function gets the font.

Reference

SFZSingleTextBoxControl::SetFont

Return value

Value of the horizontal alignment.

Reference

SFZSingleTextBoxControl::SetHorizontalAlign | SFZSingleTextBoxControl::HorizontalEnum

Reference

SFZSingleTextBoxControl::SetScrollDirection

Return value

Scroll-interval. [milliseconds]

Reference

SFZSingleTextBoxControl::SetScrollInterval

Return value

Scroll-step. [pixels]

Reference

SFZSingleTextBoxControl::SetScrollStep

Reference

SFZSingleTextBoxControl::SetText

Reference

SFZSingleTextBoxControl::SetTextColor | SFXRGBColor

Return value

Value of the vertical alignment.

Reference

SFZSingleTextBoxControl::SetVerticalAlign | SFZSingleTextBoxControl::VerticalEnum

Return value

Waiting time to start to scroll. [milliseconds]

Reference

SFZSingleTextBoxControl::SetWaitInterval

Description

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

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

Reference

SFYSingleTextWidget

Description

This function will be called when the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] is received.

This function calculates the suitable rectangle size of this responder within the specified hint rectangle[i.e., rectangle element (P32 parameter) of the region event].

The suitable rectangle size is stored into the size element of the rectangle argument as a result of calculation. It is recommended not to change the origin of the rectangle argument in this function.

	Region event[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) event]
	If the rectangle argument of the hint region is specified, the SFYResponder::GetSuitableBound function will send the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] to this responder. Then, the SFYWidget::HandleBoundOptimize virtual function will be called. The rectangle element (P32 parameter) of the region event is set to the hint region as an initial value.

Reference: SFYSingleTextWidget::HandleBoundOptimize

Example

Implementation of the SFZSingleTextBoxControl::HandleBoundOptimize function is as follows:

SFYSingleTextWidgetSmp          _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYBoxControl::GetBoxMargin | SFZSingleTextBoxControl::SetText | SFZSingleTextBoxControl::SetFont | SFYSingleTextWidget::HandleBoundOptimize | SFYSingleTextWidget | SFXEvent | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

This function will be called when the 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: SFYSingleTextWidget::HandleBoundRequest

Internal Implementation

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

SFYSingleTextWidgetSmp          _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYBoxControl::GetBoxMargin | SFZSingleTextBoxControl::SetText | SFZSingleTextBoxControl::SetFont | SFYSingleTextWidget::HandleBoundRequest | SFYSingleTextWidget | SFXEvent | Real Region Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event is received.

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

The default implementation is to equalize the real region with the new local region and relocate this responder to fit into the new virtual region.

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

SFYSingleTextWidgetSmp          _widget;

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

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

Reference

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

SFYSingleTextWidgetSmp          _widget;

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

Reference

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

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

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

Reference

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

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:

SFZSingleTextBoxControlSmp _singletextbox;
SFCError error;

if ((_singletextbox = SFZSingleTextBoxControl::NewInstance(&error)) != null) {

    ...
}

Description

Default: AEE_FONT_NORMAL

Reference

SFZSingleTextBoxControl::GetFont

Description

This function sets the horizontal alignment to the specified value.

Default: SFYSingleTextWidget::DEFAULT_HORIZONTAL

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

Reference

SFZSingleTextBoxControl::GetHorizontalAlign | SFZSingleTextBoxControl::HorizontalEnum | SFYSingleTextWidget::HorizontalEnum

Description

This function sets the scroll direction to the specified value.

Default: SFYSingleTextWidget::DEFAULT_DIRECTION

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

Reference

SFZSingleTextBoxControl::GetScrollDirection | SFZSingleTextBoxControl::DirectionEnum | SFYSingleTextWidget::DirectionEnum

Description

Default: SFYSingleTextWidget::DEFAULT_SCROLL [milliseconds]

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

Reference

SFZSingleTextBoxControl::GetScrollInterval | SFZSingleTextBoxControl::DefaultEnum | SFYSingleTextWidget::DefaultEnum

Description

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

Default: SFYSingleTextWidget::DEFAULT_STEP [pixels]

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

Reference

SFZSingleTextBoxControl::GetScrollStep | SFZSingleTextBoxControl::DefaultEnum | SFYSingleTextWidget::DefaultEnum

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

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

SFZSingleTextBoxControl::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | State

Description

This function sets the vertical alignment to the specified value.

Default: SFYSingleTextWidget::DEFAULT_VERTICAL

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

Reference

SFZSingleTextBoxControl::GetVerticalAlign | SFZSingleTextBoxControl::VerticalEnum | SFYSingleTextWidget::VerticalEnum

Description

Default: SFYSingleTextWidget::DEFAULT_WAIT [milliseconds]

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

Reference

SFZSingleTextBoxControl::GetWaitInterval | SFZSingleTextBoxControl::DefaultEnum | SFYSingleTextWidget::DefaultEnum

Description

If the width of the text is greater than that of the virtual region, the text will start to scroll.

Otherwise, the text will not scroll.

Though the SFEVT_APP_SUSPEND event and the SFEVT_APP_RESUME event will be automatically handled, the behaviour of this function is not defined when called between the SFEVT_APP_SUSPEND event and the SFEVT_APP_RESUME event.

Reference

SFZSingleTextBoxControl::StopScroll | Virtual Region

Reference

SFZSingleTextBoxControl::StartScroll

Reference

SFYResponder::GetType | SFYResponder::SetType

Reference

SFYSingleTextWidget::DefaultEnum

Reference

SFYSingleTextWidget::DirectionEnum

Reference

SFYSingleTextWidget::HorizontalEnum

Reference

SFYSingleTextWidget::VerticalEnum