Inheritance diagram

Collaboration diagram

Description

How to use

SFYWidget is the abstract base class for all responders which perform the basic processing for the drawing event and the region event as below.

	Note
	All the responder classes except SFYResponder inherit from the SFYWidget class

Events and their handlers

In the SFYWidget class, the following handlers(virtual functions) are registered for region event[SFEVT_RESPONDER_BOUND] and drawing event[SFEVT_RESPONDER_RENDER].

In a class inheriting from SFYWidget, the following handlers(virtual functions) are booted up first.

* "-" in the default behaviour column represents that nothing is implemented.

	Processing order of handlers for the region event and the drawing event
	The each handler above for the SFYWidget class is the one that has been registered first for the corresponding event. Therefore, the overridden virtual function will be first booted up as handler function when one of these events is received except the processing of filling background when the drawing event[SFEVT_RESPONDER_RENDER] is received.

Reference

Region Event[SFEVT_RESPONDER_BOUND] | Drawing Event[SFEVT_RESPONDER_RENDER]

Member

Description

This constructor performs the initializations as follows:

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

Reference

SFYResponder::SetType | SFYWidget::CodeEnum | SFYWidget::SetBackgroundColor | SFYWidget::HandleBoundRequest | SFYWidget::HandleBoundOptimize | SFYWidget::HandleBoundReal | SFYWidget::HandleBoundVirtual | SFYWidget::HandleBoundGlobal | SFYWidget::HandleRenderRequest | SFYWidget::SetBackgroundColor | SFXEvent | SFXRGBColor | Type | Event | Region Event[SFEVT_RESPONDER_BOUND] | Drawing Event[SFEVT_RESPONDER_RENDER]

Description

This destructor does nothing.

Description

This function gets the background color.

Reference

SFYWidget::SetBackgroundColor

Description

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

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

The default implementation does nothing.

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL) event will occur when the global region is changed by calling the SFYResponder::SetRealBound or SFYResponder::SetVirtualBound function. Then, the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL) event will be sent by the renderer immediately after booting up the renderer.

Another method to process when the global 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 global 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 SFYWidget::HandleBoundGlobal function is as follows:

/*protected virtual */Void SFYWidget::HandleBoundGlobal(SFXRectangleConstRef /*rectangle*/)
{
    return;
}// SFYWidget::HandleBoundGlobal //

Reference

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | Global Region | 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_OPTIMIZE, rectangle)] is received.

In case you want to calculate the suitable rectangle size of this responder within the specified hint rectangle[i.e., rectangle element (P32 parameter) of the region event], override this function.

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.

The default implementation does nothing.

	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 SFYWidget::HandleBoundOptimize function is as follows:

/*protected virtual */Void SFYWidget::HandleBoundOptimize(SFXRectangleConstRef /*rectangle*/)
{
    return;
}// SFYWidget::HandleBoundOptimize //

Reference

SFYResponder::GetSuitableBound | 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 does nothing.

	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 SFYWidget::HandleBoundReal function is as follows:

/*protected virtual */Void SFYWidget::HandleBoundReal(Void)
{
    return;
}// SFYWidget::HandleBoundReal //

Reference

SFYResponder::SetRealBound | Real Region | 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.

In case you want to calculate the suitable rectangle size of this responder[i.e., rectangle element (P32 parameter) of the region event], override this function.

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.

The default implementation does nothing.

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 SFYWidget::HandleBoundRequest function is as follows:

/*protected virtual */Void SFYWidget::HandleBoundRequest(SFXRectanglePtr /*rectangle*/) const
{
    return;
}// SFYWidget::HandleBoundRequest //

Reference

SFYResponder::GetSuitableBound | 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 does nothing.

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

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

Reference

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

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 does nothing.

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

/*protected virtual */Void SFYWidget::HandleRenderRequest(SFXGraphicsPtr /*graphics*/) const
{
    return;
}// SFYWidget::HandleRenderRequest //

Reference

SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | Drawing Event[SFEVT_RESPONDER_RENDER] | Handler for the Drawing Event[XANDLER_DECLARE_VOIDRENDER] | Rendering | Event Loop | Responder Tree

Description

This function sets the color to paint out the background of this responder with non-transparency attribute to the specified value.

The local region of responder inheriting from SFYWidget is filled in the color set with this function before executing the drawing handler. Therefore there is no need to fill the background inside the drawing handler.

However, when the transparency attribute is set using the SFYResponder::SetPropertyTransparent function, the background will be never filled.

Default: SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00) [White color]

	Background color of the SoftKey control
	The default background color of the SoftKey control(SFZSoftKeyControl) is set to SFXRGBColor(0xCC, 0xCC, 0xCC, 0x00) [gray color].

Classes of which the transparency attribute is set "true" to

In the below classes, their transparency attribute is set "true" to by default. In these classes, the background will be never filled in the color set with the SFYWidget::SetBackgroundColor function by default. SFYImageWidget | SFYSingleTextWidget | SFYSingleEditWidget | SFYMultipleTextWidget | SFYMultipleEditWidget | SFZSingleTextLabelControl | SFZSingleEditLabelControl | SFZMultipleTextLabelControl | SFZMultipleEditLabelControl | SFZImageLabelControl | SFZCheckboxControl | SFZRadiobuttonControl

Set the color to paint out the background of responder with non-transparency attribute. This setting is ignored in case of transparency attribute since then the background is not painted out.

Reference

SFYWidget::GetBackgroundColor | Local Region | Drawing Handler | Attribute | SFYResponder::SetPropertyTransparent | SFXRGBColor

Reference

SFYResponder::GetType | SFYResponder::SetType