Inheritance diagram

Collaboration diagram

Description

How to use

SFZRoot is the responder designed to be located at the top position of the responder tree.

This class constructs the responder tree and binds it with the distributer(SFYDistributer) and the renderer(SFYRenderer).

When making an applet by inheriting from the SFYApplication class, there is no need to make the root and operate it explicitly since the SFYApplication class contains the root(SFZRoot) by default.

In case an applet is implemented by inheriting from the SFCApplication class or more than one responder tree are needed, it is necessary to make and operate the root explicitly.

The concrete root(SFZRoot) is the part class which can be used as it is in the applet development.

	Note
	Since SFZRoot is the optimized responder as the root responder, there is no need to define a new root responder inheriting from SFZRoot when using it as the root responder.

	IMPORTANT
	In the concrete root, the SFYResponder::SetState, SFYResponder::SetRealBound, SFYResponder::SetDistributer, and SFYResponder::SetRenderer functions must be always called. Other functions are optionally called.

SFZRoot is the general purpose root to place a window, dialog, menu, or frame.

In the applet develoment using the application class inheriting from SFYApplication, you don't have to declare another root explicitly since SFZRoot(default root) has already been contained by SFYApplication.

In case the application class inheriting from SFCApplication or more than one responder tree is used, you have to declare the root explicitly.

Figure 374. Execution Result

Reference

Responder Tree | Distributer | Renderer | SFYDistributer | SFYRenderer | Root(Basic) | Window(Basic) | Dialog(Basic) | Menu(Basic) | Frame | SFYApplication

Member

Description

This constructor sets the type of this responder to "root".

Reference

SFYResponder::SetType | SFZRoot::CodeEnum | Type

Description

This destructor does nothing.

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, override this function.

The default implementation is as follows:

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

/*protected virtual */Void SFZRoot::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    SFYRendererPtr   renderer;
    SFYResponderSmp  parent;

    if ((parent = GetParent()) != null) {
        rectangle->SetSize(parent->GetVirtualBound().GetSize());
    }
    else if ((renderer = GetRenderer()) != null) {
        rectangle->SetSize(renderer->GetGlobalBound().GetSize());
    }
    else {
        rectangle->SetSize(SFXGraphics::GetDeviceSize());
    }
    return;
}// SFZRoot::HandleBoundRequest //

Reference

SFYRenderer::Initialize | Parent Responder | Virtual Region | Renderer | Responder Space

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:

SFZRootSmp _root;
SFCError error;

if ((_root = SFZRoot::NewInstance(&error)) != null) {

    ...
}

Reference

SFYResponder::GetType | SFYResponder::SetType