Inheritance diagram

Collaboration diagram

Description

How to use

SFYSingleTextWidget is a responder with the function of displaying a single uneditable text.

In general, this class is used as a child responder contained internally by the parent responder such as SFZTextButtonControl, SFZSingleTextLabelControl, or SFZSingleTextBoxControl, which will display a single text.

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

	The state of this responder when used
	When this class is used, its state is set to "visible"+"active"+"disable"+"unfocus". In general, this class is used as a responder which will not handle the key event.

	Default value of the transparency attribute
	Since the default value of the transparency attribute of this class is set to "true", the background will be never drawn in the color set with the SFYWidget::SetBackgroundColor function unless the transparency attribute is set to "false" using the SFYResponder::SetPropertyTransparent function.

	About the virtual region
	In this class, it is recommended to equalize the virtual region with the real region for the intuitive text alignment or scroll. For instance, though all the text is not displayed, the text will not start to scroll even if the SFYSingleTextWidget::StartScroll function is called when the following relation stands up. [Width of virtual region] ≧ [Width of single text] ＞ [Width of real region]

Reference

SFZTextButtonControl | SFZSingleTextLabelControl | SFZSingleTextBoxControl | SFZComboBoxControl | SFZCheckboxControl | SFZRadiobuttonControl | SFZTitlePlainFrame | SFZTitleFlatFrame | SFZTitleBevelFrame | SFYSingleEditWidget | Virtual Region | Real Region | Local Region

Member

Description

This constructor performs the initializations as follows:

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

Reference

SFYResponder::SetType | SFYResponder::SetPropertyTransparent | SFYSingleTextWidget::CodeEnum | SFYSingleTextWidget::SetFont | SFYSingleTextWidget::SetText | SFYSingleTextWidget::SetTextColor | SFYSingleTextWidget::SetHorizontalAlign | SFYSingleTextWidget::SetScrollDirection | SFYSingleTextWidget::SetScrollInterval | SFYSingleTextWidget::SetScrollStep | SFYSingleTextWidget::SetTextColor | SFYSingleTextWidget::SetVerticalAlign | SFYSingleTextWidget::SetWaitInterval | SFYSingleTextWidget::HorizontalEnum | SFYSingleTextWidget::VerticalEnum | SFYSingleTextWidget::DirectionEnum | SFYSingleTextWidget::DefaultEnum | SFXRGBColor | Type | Attribute | Event | Applet-Suspend Event[SFEVT_APP_SUSPEND] | Applet-Resume Event[SFEVT_APP_RESUME]

Description

This destructor stops to scroll the text.

Reference

SFYSingleTextWidget::StopScroll

Description

This function draws the single text.

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

	Note
	This function is called in the SFYSingleTextWidget::HandleRenderRequest function

Internal Implementation

Internal implementation of the SFYSingleTextWidget::DrawText function is as follows:

/*protected */Void SFYSingleTextWidget::DrawText(SFXGraphicsPtr graphics, SFXGridConstRef grid) const
{
    SFXGrid                                     origin;
    SFXRGBColor                                 rgb;

    origin.Set(grid);
    origin.AddX(_offset);
    rgb.Set(_color.text);
    if (!GetStateActive(true)) {
        if (rgb.GetBrightness() > 0x7F) {
            rgb.SubRGB(0x44);
        }
        else {
            rgb.AddRGB(0x44);
        }
    }
    graphics->SetFont(_font);
    graphics->DrawSingleText(_text, origin, rgb);
    return;
}// SFYSingleTextWidget::DrawText //

Reference

SFYSingleTextWidget::HandleRenderRequest

Description

This function gets the font.

Reference

SFYSingleTextWidget::SetFont

Description

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

Reference

SFYSingleTextWidget::SetFont

Return value

Value of the horizontal alignment.

Reference

SFYSingleTextWidget::SetHorizontalAlign | SFYSingleTextWidget::HorizontalEnum

Return value

Scroll direction set with the SFYSingleTextWidget::SetScrollDirection function.

Reference

SFYSingleTextWidget::SetScrollDirection

Return value

Scroll-interval set with the SFYSingleTextWidget::SetScrollInterval function. [milliseconds]

Reference

SFYSingleTextWidget::SetScrollInterval

Return value

Value of the scroll-offset.

Description

This function gets the offset from the origin as a result of scroll.

Return value

Scroll-step set with the SFYSingleTextWidget::SetScrollStep function. [pixels]

Reference

SFYSingleTextWidget::SetScrollStep

Reference

SFYSingleTextWidget::SetText

Reference

SFYSingleTextWidget::SetTextColor | SFXRGBColor

Description

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

Reference

SFYSingleTextWidget::SetFont

Return value

Value of the vertical alignment.

Reference

SFYSingleTextWidget::SetVerticalAlign | SFYSingleTextWidget::VerticalEnum

Return value

Waiting time to start the scroll set with the SFYSingleTextWidget::SetWaitInterval function. [milliseconds]

Reference

SFYSingleTextWidget::SetWaitInterval

Description

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

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

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

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

Internal Implementation

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

/*protected virtual */Void SFYSingleTextWidget::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    if (rectangle->GetWidth() > _bound.GetWidth()) {
        rectangle->SetWidth(_bound.GetWidth());
    }
    else if (rectangle->GetWidth() > _size.GetWidth()) {
        rectangle->DivWidth(_size.GetWidth());
        rectangle->MulWidth(_size.GetWidth());
    }
    if (rectangle->GetHeight() > _bound.GetHeight()) {
        rectangle->SetHeight(_bound.GetHeight());
    }
    else if (rectangle->GetHeight() > _size.GetHeight()) {
        rectangle->DivHeight(_size.GetHeight());
        rectangle->MulHeight(_size.GetHeight());
    }
    return;
}// SFYSingleTextWidget::HandleBoundOptimize //

Reference

SFYResponder::GetSuitableBound | SFYSingleTextWidget::SetText | SFYSingleTextWidget::SetFont | SFXGraphics::MeasureSingleText | SFXEvent | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

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

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

The default implementation is to equalize the virtual region with the real region.

	About the virtual region
	In this class, it is recommended to equalize the virtual region with the real region for the intuitive text alignment or scroll. For instance, though all the text is not displayed, the text will not start to scroll even if the SFYSingleTextWidget::StartScroll function is called when the following relation stands up. [Width of virtual region] ≧ [Width of text] ＞ [Width of real region]

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) event will occur when the real region is changed by calling the SFYResponder::SetRealBound function.

	Processing when the real region is changed
	Other than overriding this virtual function, there is another method to define and implement the handler for the region event[XANDLER_DECLARE_VOIDBOUND], and register it into the responder. In the processing when the real region is updated, this virtual function is executed first, and next the handlers for the region event are executed in the registered order.

Internal Implementation

Internal implementation of the SFYSingleTextWidget::HandleBoundReal function is as follows:

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

Reference

SFYResponder::SetRealBound | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND] | Real Region | Virtual Region | Local Region

Description

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

This function calculates the suitable rectangle size of this responder.

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

Region event[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) event]

If the rectangle argument of the hint region is not specified, the SFYResponder::GetSuitableBound function will send the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] to this responder. Then, the SFYWidget::HandleBoundRequest virtual function will be called. The rectangle element (P32 parameter) of the region event is set to the real region as an initial value. Tip Default value of the real region: SFXRectangle(0, 0, 0, 0)

Internal Implementation

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

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

/*private */SInt16 SFYSingleTextWidget::Measure(Void)
{
    _bound.SetSize(SFXSize::ZeroInstance());
    _size.Set(SFXGraphics::MeasureSingleText(_font, " "), SFXGraphics::GetFontHeight(_font));
    if (!_text.IsEmpty()) {
        _bound.SetSize(SFXGraphics::MeasureSingleText(_font, _text), _size.GetHeight());
    }
    return _size.GetWidth();
}// SFYSingleTextWidget::Measure //

Reference

SFYResponder::GetSuitableBound | SFYSingleTextWidget::SetText | SFYSingleTextWidget::SetFont | SFXGraphics::MeasureSingleText | 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.

	About the virtual region
	In this class, it is recommended to equalize the virtual region with the real region for the intuitive text alignment or scroll. For instance, though all the text is not displayed, the text will not start to scroll even if the SFYSingleTextWidget::StartScroll function is called when the following relation stands up. [Width of virtual region] ≧ [Width of text] ＞ [Width of real 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 SFYSingleTextWidget::HandleBoundVirtual function is as follows:

/*protected virtual */Void SFYSingleTextWidget::HandleBoundVirtual(Void)
{
    StateEnum                                   state;

    state = _state;
    StopScroll();
    Relocate();
    if (state != STATE_IDLE) {
 StartScroll();
    }
    return;
}// SFYSingleTextWidget::HandleBoundVirtual //

/*private */Void SFYSingleTextWidget::Relocate(Void)
{
    SFXRectangle                                lx;

    lx.Set(GetLocalBound());
    _bound.SetOrigin(lx.GetOrigin());
    _offset = 0;
    if (lx.GetWidth() > _bound.GetWidth()) {
        switch (_align.horizontal) {
            case HORIZONTAL_LEFT:
                _bound.AddX(0);
                break;
            case HORIZONTAL_RIGHT:
                _bound.AddX(lx.GetWidth() - _bound.GetWidth());
                break;
            case HORIZONTAL_CENTER:
            default:
                _bound.AddX((lx.GetWidth() - _bound.GetWidth()) / 2);
                break;
        }
    }
    else {
        switch (_align.horizontal) {
            case HORIZONTAL_LEFT:
                _offset += 0;
                break;
            case HORIZONTAL_RIGHT:
                _offset += lx.GetWidth() - _bound.GetWidth();
                break;
            case HORIZONTAL_CENTER:
            default:
                _offset += (lx.GetWidth() - _bound.GetWidth()) / 2;
                break;
        }
    }
    switch (_align.vertical) {
        case VERTICAL_TOP:
            _bound.AddY(0);
            break;
        case VERTICAL_BOTTOM:
            _bound.AddY(lx.GetHeight() - _bound.GetHeight());
            break;
        case VERTICAL_MIDDLE:
        default:
            _bound.AddY((lx.GetHeight() - _bound.GetHeight()) / 2);
            break;
    }
    _bound.AddY(SFXGraphics::GetFontDescent(_font) / 2);
    return;
}// SFYSingleTextWidget::Relocate //

Reference

SFYSingleTextWidget::SetHorizontalAlign | SFYSingleTextWidget::SetVerticalAlign | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 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_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 SFYSingleTextWidget::HandleRenderRequest function is as follows:

/*protected virtual */Void SFYSingleTextWidget::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawText(graphics, _bound.GetOrigin());
    return;
}// SFYSingleTextWidget::HandleRenderRequest //

Reference

SFYSingleTextWidget::SetText | SFYSingleTextWidget::SetHorizontalAlign | SFYSingleTextWidget::SetVerticalAlign | SFYSingleTextWidget::SetTextColor | SFYSingleTextWidget::SetFont | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | Drawing Event[SFEVT_RESPONDER_RENDER] | Handler for the Drawing Event[XANDLER_DECLARE_VOIDRENDER] | Rendering | Event Loop | Responder Tree | Virtual Region | Real Region | Local Region

Argument

Return value

Description

This function creates a new instance of this responder class.

If succeeds, a not null pointer will be returned, and the "exception" argument is SFERR_NO_ERROR. If fails such as insufficient memory, a null pointer will be returned, and the "exception" argument holds the error value.

Example

The code to create a new instance of this responder class is as follows:

SFYSingleTextWidgetSmp _singletextwidget;
SFCError error;

if ((_singletextwidget = SFYSingleTextWidget::NewInstance(&error)) != null) {

    ...
}

Description

Default: AEE_FONT_NORMAL

Reference

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

SFYSingleTextWidget::GetHorizontalAlign | 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

SFYSingleTextWidget::GetScrollDirection | SFYSingleTextWidget::DirectionEnum

Description

Default: SFYSingleTextWidget::DEFAULT_SCROLL [milliseconds]

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

Reference

SFYSingleTextWidget::GetScrollInterval | 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

SFYSingleTextWidget::GetScrollStep | SFYSingleTextWidget::DefaultEnum

Return value

Description

This function sets the text to be displayed to the specified value.

The value of string is set directly in the argument, or read from the resource file.

Reference

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

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

SFYSingleTextWidget::GetVerticalAlign | SFYSingleTextWidget::VerticalEnum

Description

Default: SFYSingleTextWidget::DEFAULT_SCROLL [milliseconds]

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

Reference

SFYSingleTextWidget::GetWaitInterval | 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

SFYSingleTextWidget::StopScroll | Virtual Region

Reference

SFYSingleTextWidget::StartScroll

Reference

SFYResponder::GetType | SFYResponder::SetType

Description

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

Description

For the horizontal alignment:

Reference

SFYSingleTextWidget::SetHorizontalAlign | Local Region

Description

For the vertical alignment:

Reference

SFYSingleTextWidget::SetVerticalAlign | Local Region