Inheritance diagram

Collaboration diagram

Description

How to use

Box control to display an image(SFZImageBoxControl) 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 SFYBoxControl::HandleOperateKey function.

Figure 330. Execution Result

In the default implementation, the image box control is drawn as below depending on the state.

Figure 331. Expanded figure of the image box control[In the "active" or "enable" state, when not pressed]

The image is drawn within the content region which is surrounded by the inner border("focus frame").

For more details: SFYBoxControl::DrawBox

Figure 332. Expanded figure of the image box control[in the "inactive" state]

For more details: SFYBoxControl::DrawBox

Figure 333. Expanded figure of the image box control[in the "focus" state]

For more details: SFYBoxControl::DrawBox

Reference

Box Control to Display an Image [SFZImageBoxControl] | State | SFYControl | SFYBoxControl | SFYImageWidget

Member

Description

This constructor performs the initializations as follows:

Reference

SFYResponder::SetType | SFZImageBoxControl::CodeEnum | SFYResponder::SetParent | SFYResponder::SetState | SFZImageBoxControl::SetHorizontalAlign | SFZImageBoxControl::SetVerticalAlign | SFZImageBoxControl::HorizontalEnum | SFZImageBoxControl::VerticalEnum | SFYImageWidget::NewInstance | SFYImageWidget | Type | State

Description

This destructor does nothing.

Return value

Value of the horizontal alignment.

Reference

SFZImageBoxControl::SetHorizontalAlign | SFZImageBoxControl::HorizontalEnum

Reference

SFZImageBoxControl::SetImage | SFBImage

Return value

Value of the vertical alignment.

Reference

SFZImageBoxControl::SetVerticalAlign | SFZImageBoxControl::VerticalEnum

Description

This function gets the instance of the SFYImageWidget class, which is contained as a child responder internally for drawing an image.

The drawing of the image is delegated to the SFYImageWidget class.

Reference

SFYImageWidget

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

Internal Implementation

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

SFYImageWidgetSmp               _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYBoxControl::GetBoxMargin | SFZImageBoxControl::SetImage | SFYImageWidget::HandleBoundOptimize | SFYImageWidget | 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: SFYImageWidget::HandleBoundRequest

Internal Implementation

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

SFYImageWidgetSmp               _widget;

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

Reference

SFYResponder::GetSuitableBound | SFYBoxControl::GetBoxMargin | SFZImageBoxControl::SetImage | SFYImageWidget::HandleBoundRequest | SFYImageWidget | 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 SFZImageBoxControl::HandleBoundVirtual function is as follows:

SFYImageWidgetSmp               _widget;

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

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

Reference

SFYImageWidget | SFZImageBoxControl::SetImage | 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 SFZImageBoxControl::HandleRenderRequest function is as follows:

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

Reference

SFYBoxControl::DrawBox | SFZImageBoxControl::SetImage | SFZImageBoxControl::SetHorizontalAlign | SFZImageBoxControl::SetVerticalAlign | SFYImageWidget | SFYImageWidget::HandleRenderRequest | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | SFXEvent | Drawing Event[SFEVT_RESPONDER_RENDER] | Handler for the Drawing Event[XANDLER_DECLARE_VOIDRENDER] | Rendering | Event Loop | Responder Tree | State

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:

SFZImageBoxControlSmp _imagebox;
SFCError error;

if ((_imagebox = SFZImageBoxControl::NewInstance(&error)) != null) {

    ...
}

Description

This function sets the horizontal alignment to the specified value.

Default: SFYImageWidget::DEFAULT_HORIZONTAL

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

Reference

SFZImageBoxControl::GetHorizontalAlign | SFZImageBoxControl::HorizontalEnum | SFYImageWidget::HorizontalEnum

Return value

Description

This function sets the image to the specified value.

The image is set directly in the argument, or read from the resource file.

This function cannot be used with the image such as the image of invalid size or the animation bitmap.

Reference

SFZImageBoxControl::GetImage | SFZImageBoxControl::SetHorizontalAlign | SFZImageBoxControl::SetVerticalAlign | SFBImage | BREW API IImage

Description

This function sets the vertical alignment to the specified value.

Default: SFYImageWidget::DEFAULT_VERTICAL

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

Reference

SFZImageBoxControl::GetVerticalAlign | SFZImageBoxControl::VerticalEnum | SFYImageWidget::VerticalEnum

Reference

SFYResponder::GetType | SFYResponder::SetType

Reference

SFYImageWidget::HorizontalEnum

Reference

SFYImageWidget::VerticalEnum