Inheritance diagram

Collaboration diagram

Description

What is a Frame?

SFYFrame is the most abstract base class of the frame.

How to Attach a Frame to a Responder

A frame can be attached to a responder with the SFYResponder::SetFrame function.

	Note
	The frame which is attached to the responder is called as the "attachment-frame". On the other hand, the responder to which the frame is attached is called as the "content-responder".

As in the followings, you have only to operate the content-responder. The corresponding operations of the attachment-frame will be performed automatically.

If the real region of a content-responder is set, that of the corresonding attachment-frame will be automatically calculated and set too.

If a content-responder is moved foremost with the SFYResponder::ToFront function, the attachment-frame will be automatically moved foremost together with it too.

If a content-responder will be closed, the corresponding attachment-frame will be detached from it, become invisible, and restore to the normal frame which can be attached to other responders.

From the point of view of the state and the distributer, the attachment-frame behaves as the child responder of the content-responder.

For more details, see the description of the frame.

About the Margin Event [SFEVT_RESPONDER_MARGIN]

In the SFYFrame class, the handler for the margin event [(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST) event] is registered.

The SFYResponder::GetSuitableMargin function sends the margin event to a concrete frame responder inheriting from SFYFrame. Then, this frame responder calls the HandleMarginRequest() virtual function to calculate the frame margin.

That is to say, the frame margin of a concrete frame responder can be obtained by calling the SFYResponder::GetSuitableMargin function.

Reference

SFYPlainFrame | SFYFlatFrame | SFYBevelFrame | SFZPlainFrame | SFZFlatFrame | SFZBevelFrame | SFZTitlePlainFrame | SFZTitleFlatFrame | SFZTitleBevelFrame | Margin Event[SFEVT_RESPONDER_MARGIN] | SFYResponder::GetSuitableMargin | Frame

Member

Description

This constructor performs the initializations as follows:

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

Reference

SFYResponder::SetType | SFYFrame::CodeEnum | SFYFrame::HandleMarginRequest | SFXEvent | Type | Margin Event[SFEVT_RESPONDER_MARGIN]

Description

This destructor does nothing.

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.

	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. In almost all cases, the method to override this virtual function is adopted since defining, implementing and registering the handler for the region event can be omitted.

Internal Implementation

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

/*protected virtual */Void SFYFrame::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFYFrame::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 margin event [SFXEvent(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST, rectangle)] is received.

This function calculates the frame margin of this responder. The outer frame or/and the title of this responder will be drawn in this frame margin.

In case you want to calculate the frame margin of this responder when the margin event [SFXEvent(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST, rectangle)] is received, override this virtual function.

The default implementation does nothing.

	Margin event[(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST) event]
	The SFYResponder::GetSuitableMargin function will send the margin event [SFXEvent(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST, margin)] to this responder. Then, the SFYFrame::HandleMarginRequest virtual function will be called. The margin element (P32 parameter) of the margin event is set to SFXMargin::ZeroInstance() as an initial value.

Internal Implementation

Internal implementation of the SFYFrame::HandleMarginRequest function is as follows:

/*protected virtual */Void SFYFrame::HandleMarginRequest(SFXMarginPtr /*margin*/) const
{
    return;
}// SFYFrame::HandleMarginRequest //

Reference

SFYResponder::GetSuitableMargin | SFXMargin | SFXEvent | Margin Event[SFEVT_RESPONDER_MARGIN] | Handler for the Margin Event[XANDLER_DECLARE_VOIDMARGIN]

Reference

SFYResponder::GetType | SFYResponder::SetType