SFZContainer

Responder which represents a general purpose container to place controls and/or containers.

#include <SFZContainer.h.hpp>

class SFZContainer : public SFYContainer;

SFMTYPEDEFCLASS(SFZContainer)

Inheritance diagram

Collaboration diagram

Description

How to use

SFZContainer is the general purpose container to place various controls and/or containers.

When controls and/or containers are placed in a container, the focus can be moved among responders in the container using the scroll key set with the SFYContainer::SetScrollDownKey / SFYContainer::SetScrollUpKey / SFYContainer::SetPageDownKey / SFYContainer::SetPageUpKey / SFYContainer::SetSnapDownKey / SFYContainer::SetSnapUpKey functions.

The virtual region larger than the real region can be scrolled up and down, and the focus can be moved among responders in the container. At this time, scrolling is performed in cooperation with moving the focus.

Figure 321. Execution Result

IMPORTANT

	IMPORTANT
In the concrete container, the `SFYResponder::SetParent`, `SFYResponder::SetState`, and `SFYResponder::SetRealBound` functions must be always called. Other functions are optionally called.

In the concrete container, the SFYResponder::SetParent, SFYResponder::SetState, and SFYResponder::SetRealBound functions must be always called.

Other functions are optionally called.

Difference between container and window or dialog

	Difference between container and window or dialog
Container is different from window or dialog as below. Container can be place in a container/window/dialog. Container can be place in a control. Container is not placed in the root[`SFZRoot`] nor the frame. * Window and dialog are placed in the root[`SFZRoot`] (in the frame if the frame is attached with).

Container is different from window or dialog as below.

Container can be place in a container/window/dialog.
Container can be place in a control.
Container is not placed in the root[SFZRoot] nor the frame.

* Window and dialog are placed in the root[SFZRoot] (in the frame if the frame is attached with).

Reference

Member

Constructor/Destructor
SFZContainer( `Void` ) Constructor of the SFZContainer class.
~SFZContainer( `Void` ) Destructor of the SFZContainer class.

Public Functions
static `SFZDialogSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new instance of this responder class.
`Void`	ClearHandler( `Void` ) (inherits from SFYResponder) Unregister all handlers from this responder.
`Void`	ClearTracer( `Void` ) (inherits from SFYResponder) Unregister all dispatching rules from the tracer of this responder.
`SFCError`	Distribute( `SFXEventConstRef` event , `BoolPtr` result = null ) (inherits from SFYResponder) Distribute the specified event.
`SFXRGBColorConstRef`	GetBackgroundColor( `Void` ) (inherits from SFYWidget) Get the background color.
`SFYResponderSmp`	GetChildBack( `Void` ) (inherits from SFYResponder) Get the backmost child responder of this responder, which matches the specified search condition.
`SFYResponderSmp`	GetChildBack( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the backmost child responder of this responder, which matches the specified search condition.
`SFYResponderSmp`	GetChildBack( `UInt32` id ) (inherits from SFYResponder) Get the backmost child responder of this responder, which matches the specified search condition.
`SFYResponderSmp`	GetChildBack( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the backmost child responder of this responder, which matches the specified search condition.
`SFYResponderSmp`	GetChildBackward( `SInt32` index ) (inherits from SFYResponder) Get the child responder of this responder at the specified position from the back side, which matches the specified search condition.
`SFYResponderSmp`	GetChildBackward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the child responder of this responder at the specified position from the back side, which matches the specified search condition.
`SFYResponderSmp`	GetChildBackward( `SInt32` index , `UInt32` id ) (inherits from SFYResponder) Get the child responder of this responder at the specified position from the back side, which matches the specified search condition.
`SFYResponderSmp`	GetChildBackward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the child responder of this responder at the specified position from the back side, which matches the specified search condition.
`SInt32`	GetChildCount( `Void` ) (inherits from SFYResponder) Get the number of child responders of this responder, which match the specified search condition.
`SInt32`	GetChildCount( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the number of child responders of this responder, which match the specified search condition.
`SInt32`	GetChildCount( `UInt32` id ) (inherits from SFYResponder) Get the number of child responders of this responder, which match the specified search condition.
`SInt32`	GetChildCount( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the number of child responders of this responder, which match the specified search condition.
`SFYResponderSmp`	GetChildForward( `SInt32` index ) (inherits from SFYResponder) Get the child responder of this responder at the specified position from the front side, which matches the specified search condition.
`SFYResponderSmp`	GetChildForward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the child responder of this responder at the specified position from the front side, which matches the specified search condition.
`SFYResponderSmp`	GetChildForward( `SInt32` index , `UInt32` id ) (inherits from SFYResponder) Get the child responder of this responder at the specified position from the front side, which matches the specified search condition.
`SFYResponderSmp`	GetChildForward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the child responder of this responder at the specified position from the front side, which matches the specified search condition.
`SFYResponderSmp`	GetChildFront( `Void` ) (inherits from SFYResponder) Get the foremost child responder of this responder, which matches the specified search condition.
`SFYResponderSmp`	GetChildFront( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the foremost child responder of this responder, which matches the specified search condition.
`SFYResponderSmp`	GetChildFront( `UInt32` id ) (inherits from SFYResponder) Get the foremost child responder of this responder, which matches the specified search condition.
`SFYResponderSmp`	GetChildFront( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the foremost child responder of this responder, which matches the specified search condition.
`SFYDistributerPtr`	GetDistributer( `Void` ) (inherits from SFYResponder) Get the distributer bound with this responder.
`SFYResponderSmp`	GetFrame( `Void` ) (inherits from SFYResponder) Get the frame which has been attached to this responder.
`SFXRectangle`	GetGlobalBound( `Void` ) (inherits from SFYResponder) Get the globle region of this responder.
`UInt32`	GetID( `Void` ) (inherits from SFYResponder) Get the ID of this responder instance.
`SFXRectangle`	GetLocalBound( `Void` ) (inherits from SFYResponder) Get the local region of this responder.
`SInt32`	GetNthBackward( `Void` ) (inherits from SFYResponder) Get the position counted from the back side of this responder among a group of sibling responders, which match the specified search condition.
`SInt32`	GetNthBackward( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the position counted from the back side of this responder among a group of sibling responders, which match the specified search condition.
`SInt32`	GetNthBackward( `UInt32` id ) (inherits from SFYResponder) Get the position counted from the back side of this responder among a group of sibling responders, which match the specified search condition.
`SInt32`	GetNthBackward( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the position counted from the back side of this responder among a group of sibling responders, which match the specified search condition.
`SInt32`	GetNthForward( `Void` ) (inherits from SFYResponder) Get the position counted from the front side of this responder among a group of sibling responders, which match the specified search condition.
`SInt32`	GetNthForward( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the position counted from the front side of this responder among a group of sibling responders, which match the specified search condition.
`SInt32`	GetNthForward( `UInt32` id ) (inherits from SFYResponder) Get the position counted from the front side of this responder among a group of sibling responders, which match the specified search condition.
`SInt32`	GetNthForward( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Get the position counted from the front side of this responder among a group of sibling responders, which match the specified search condition.
`AVKType`	GetPageDownKey( `Void` ) (inherits from SFYContainer) Get the PageDown key to scroll down the virtual region of this responder by one page.
`AVKType`	GetPageUpKey( `Void` ) (inherits from SFYContainer) Get the PageUp key to scroll up the virtual region of this responder by one page.
`SFYResponderSmp`	GetParent( `Void` ) (inherits from SFYResponder) Get the parent responder of this responder.
`Bool`	GetPropertyTransparent( `Void` ) (inherits from SFYResponder) Get the transparency attribute of this responder.
`SFXRectangleConstRef`	GetRealBound( `Void` ) (inherits from SFYResponder) Get the real region of this responder.
`VoidPtr`	GetReference( `Void` ) (inherits from SFYResponder) Get the reference of this responder.
`SFYRendererPtr`	GetRenderer( `Void` ) (inherits from SFYResponder) Get the renderer bound with this responder.
`SFYResponderSmp`	GetRoot( `Void` ) (inherits from SFYResponder) Get the root responder.
`AVKType`	GetScrollDownKey( `Void` ) (inherits from SFYContainer) Get the ScrollDown key to scroll down the virtual region of this responder.
`Bool`	GetScrollRepeat( `Void` ) (inherits from SFYContainer) Get the value of repeat-scroll flag.
`SInt16`	GetScrollStep( `Void` ) (inherits from SFYContainer) Get the scroll-step. [pixels]
`AVKType`	GetScrollUpKey( `Void` ) (inherits from SFYContainer) Get the ScrollUp key to scroll up the virtual region of this responder.
`AVKType`	GetSnapDownKey( `Void` ) (inherits from SFYContainer) Get the SnapDown key to scroll down the virtual region of this responder to the bottom.
`AVKType`	GetSnapUpKey( `Void` ) (inherits from SFYContainer) Get the SnapUp key to scroll up the virtual region of this responder to the top.
`Bool`	GetStateActive( `Bool` inherit = false ) (inherits from SFYResponder) Get the active state of this responder.
`Bool`	GetStateEnable( `Bool` inherit = false ) (inherits from SFYResponder) Get the enable state of this responder.
`Bool`	GetStateFocus( `Bool` inherit = false ) (inherits from SFYResponder) Get the focus state of this responder.
`Bool`	GetStateValid( `Bool` inherit = false ) (inherits from SFYResponder) Get the valid state of this responder.
`Bool`	GetStateVisible( `Bool` inherit = false ) (inherits from SFYResponder) Get the visible state of this responder.
`SFXRectangle`	GetSuitableBound( `Void` ) (inherits from SFYResponder) Get the suitable region of this responder.
`SFXRectangle`	GetSuitableBound( `SFXRectangleConstRef` rectangle ) (inherits from SFYResponder) Get the suitable region of this responder.
`SFXRectangle`	GetSuitableBound( `SFXRectangleConstRef` param , `HorizontalEnum` horizontal , `VerticalEnum` vertical ) (inherits from SFYResponder) Get the suitable region of this responder.
`SFXMargin`	GetSuitableMargin( `Void` ) (inherits from SFYResponder) Get the suitable frame margin region of this responder.
`SFCType`	GetType( `Void` ) (inherits from SFYResponder) Get the type of this responder class.
`SFXRectangleConstRef`	GetVirtualBound( `Void` ) (inherits from SFYResponder) Get the virtual region of this responder.
`Bool`	HasFrame( `Void` ) (inherits from SFYResponder) Check whether or not this responder is a content-responder.
`Void`	Initialize( `Void` ) (inherits from SFYResponder) Initialize this responder.
`Bool`	IsBack( `Void` ) (inherits from SFYResponder) Check whether or not this responder is the backmost responder among a group of the sibling responders which match the specified search condition.
`Bool`	IsBack( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Check whether or not this responder is the backmost responder among a group of the sibling responders which match the specified search condition.
`Bool`	IsBack( `UInt32` id ) (inherits from SFYResponder) Check whether or not this responder is the backmost responder among a group of the sibling responders which match the specified search condition.
`Bool`	IsBack( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Check whether or not this responder is the backmost responder among a group of the sibling responders which match the specified search condition.
`Bool`	IsFrame( `Void` ) (inherits from SFYResponder) Check whether or not this responder is an attachment-frame.
`Bool`	IsFront( `Void` ) (inherits from SFYResponder) Check whether or not this responder is the foremost responder among a group of the sibling responders which match the specified search condition.
`Bool`	IsFront( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Check whether or not this responder is the foremost responder among a group of the sibling responders which match the specified search condition.
`Bool`	IsFront( `UInt32` id ) (inherits from SFYResponder) Check whether or not this responder is the foremost responder among a group of the sibling responders which match the specified search condition.
`Bool`	IsFront( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Check whether or not this responder is the foremost responder among a group of the sibling responders which match the specified search condition.
`Bool`	IsNthBackward( `SInt32` index ) (inherits from SFYResponder) Check whether or not this responder is at the specified position from the back side among a group of the sibling responders which match the specified search condition.
`Bool`	IsNthBackward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Check whether or not this responder is at the specified position from the back side among a group of the sibling responders which match the specified search condition.
`Bool`	IsNthBackward( `SInt32` index , `UInt32` id ) (inherits from SFYResponder) Check whether or not this responder is at the specified position from the back side among a group of the sibling responders which match the specified search condition.
`Bool`	IsNthBackward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Check whether or not this responder is at the specified position from the back side among a group of the sibling responders which match the specified search condition.
`Bool`	IsNthForward( `SInt32` index ) (inherits from SFYResponder) Check whether or not this responder is at the specified position from the front side among a group of the sibling responders which match the specified search condition.
`Bool`	IsNthForward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Check whether or not this responder is at the specified position from the front side among a group of the sibling responders which match the specified search condition.
`Bool`	IsNthForward( `SInt32` index , `UInt32` id ) (inherits from SFYResponder) Check whether or not this responder is at the specified position from the front side among a group of the sibling responders which match the specified search condition.
`Bool`	IsNthForward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Check whether or not this responder is at the specified position from the front side among a group of the sibling responders which match the specified search condition.
`Bool`	IsRoot( `Void` ) (inherits from SFYResponder) Check whether or not this responder is the root responder.
`Bool`	PageDown( `Void` ) (inherits from SFYContainer) Scroll down a page of the virtual region.
`Bool`	PageUp( `Void` ) (inherits from SFYContainer) Scroll up a page of the virtual region.
`SFCError`	Recover( `Void` ) (inherits from SFYResponder) Recover the intersection region between this responder and the responder space by using the saved bitmap to restore the device bitmap.
`SFCError`	RegisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::RuleRecConstRef` rule ) (inherits from SFYResponder) Register specified handlers into this responder.
`SFCError`	RegisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::HandlerSPP` spp , `VoidPtr` reference ) (inherits from SFYResponder) Register specified handlers into this responder.
`SFCError`	RegisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::RuleRecConstPtr` rule , `SInt32` length ) (inherits from SFYResponder) Register specified handlers into this responder.
`SFCError`	RegisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::HandlerSPPConstPtr` spp , `VoidPtrConstPtr` reference , `SInt32` length ) (inherits from SFYResponder) Register specified handlers into this responder.
`SFCError`	RegisterTracer( `SFXEventRangeConstRef` range , `SFYTracer::RuleRecConstRef` rule ) (inherits from SFYResponder) Register specified dispatching rules into the tracer of this responder.
`SFCError`	RegisterTracer( `SFXEventRangeConstRef` range , `SFYTracer::OrderEnum` order , `SFYTracer::StateEnum` state , `Bool` overload ) (inherits from SFYResponder) Register specified dispatching rules into the tracer of this responder.
`SFCError`	RegisterTracer( `SFXEventRangeConstPtr` range , `SFYTracer::RuleRecConstPtr` rule , `SInt32` length ) (inherits from SFYResponder) Register specified dispatching rules into the tracer of this responder.
`SFCError`	RegisterTracer( `SFXEventRangeConstPtr` range , `SFYTracer::OrderEnumConstPtr` order , `SFYTracer::StateEnumConstPtr` state , `BoolConstPtr` overload , `SInt32` length ) (inherits from SFYResponder) Register specified dispatching rules into the tracer of this responder.
`SFCError`	Render( `Bool` force = false ) (inherits from SFYResponder) Boot up the renderer for redrawing this responder and its descendant responders.
`Bool`	ScrollDown( `Void` ) (inherits from SFYContainer) Scroll down the virtual region.
`Bool`	ScrollUp( `Void` ) (inherits from SFYContainer) Scroll up the virtual region.
`Void`	SetBackgroundColor( `SFXRGBColorConstRef` param ) (inherits from SFYWidget) Set the background color to the specified value.
`Void`	SetDistributer( `SFYDistributerPtr` param ) (inherits from SFYResponder) Bind this responder with the specified distributer.
`SFCError`	SetFrame( `SFYResponderSmpConstRef` param ) (inherits from SFYResponder) Attach the specified frame to this frame.
`Void`	SetID( `UInt32` param ) (inherits from SFYResponder) Set the ID value of this responder to the specified value.
`Void`	SetPageDownKey( `AVKType` param ) (inherits from SFYContainer) Set the PageDown key to scroll down the virtual region of this responder by one page to the specified value.
`Void`	SetPageUpKey( `AVKType` param ) (inherits from SFYContainer) Set the PageUp key to scroll up the virtual region of this responder by one page to the specified value.
`SFCError`	SetParent( `SFYResponderSmpConstRef` param ) (inherits from SFYResponder) Set the parent responder of this responder to the specified responder.
`Void`	SetProperty( `Bool` transparent ) (inherits from SFYResponder) Set the property of this responder to the specified value.
`Void`	SetPropertyTransparent( `Bool` param ) (inherits from SFYResponder) Set the transparency attribute of this responder to the specified value.
`Void`	SetRealBound( `SFXRectangleConstRef` param ) (inherits from SFYResponder) Set the real region of this responder to the specified region.
`Void`	SetReference( `VoidPtr` param ) (inherits from SFYResponder) Set the reference value of this responder to the specified value.
`Void`	SetRenderer( `SFYRendererPtr` param ) (inherits from SFYResponder) Bind this responder with the specified renderer.
`Void`	SetScrollDownKey( `AVKType` param ) (inherits from SFYContainer) Set the ScrollDown key to scroll down the virtual region of this responder to the specified value.
`Void`	SetScrollRepeat( `Bool` param ) (inherits from SFYContainer) Set the repeat-scroll flag to the specified value.
`Void`	SetScrollStep( `SInt16` param ) (inherits from SFYContainer) Set the scroll-step to the specified value. [pixels]
`Void`	SetScrollUpKey( `AVKType` param ) (inherits from SFYContainer) Set the ScrollUp key to scroll up the virtual region of this responder to the specified value.
`Void`	SetSnapDownKey( `AVKType` param ) (inherits from SFYContainer) Set the SnapDown key to scroll down the virtual region of this responder to the bottom to the specified value.
`Void`	SetSnapUpKey( `AVKType` param ) (inherits from SFYContainer) Set the SnapUp key to scroll up the virtual region of this responder to the top to the specified value.
`Void`	SetState( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Set all states of this responder to specified values together.
`Void`	SetStateActive( `Bool` param ) (inherits from SFYResponder) Set the active state of this responder to the specified value.
`Void`	SetStateEnable( `Bool` param ) (inherits from SFYResponder) Set the enable state of this responder to the specified value.
`Void`	SetStateFocus( `Bool` param ) (inherits from SFYResponder) Set the focus state of this responder to the specified value.
`Void`	SetStateVisible( `Bool` param ) (inherits from SFYResponder) Set the visible state of this responder to the specified value.
`Void`	SetVirtualBound( `SFXRectangleConstRef` param ) (inherits from SFYResponder) Set the virtual region of this responder to the specified value.
`Bool`	SnapDown( `Void` ) (inherits from SFYContainer) Scroll down to the bottom of the virtual region.
`Bool`	SnapUp( `Void` ) (inherits from SFYContainer) Scroll up to the top of the virtual region.
`SFCError`	Snapshot( `SFBBitmapSmpConstRef` bitmap ) (inherits from SFYResponder) Get a snapshot image of the intersection region between this responder and the responder space by using the saved bitmap.
`Void`	Terminate( `Void` ) (inherits from SFYResponder) Terminate this responder.
`Void`	ToBack( `Void` ) (inherits from SFYResponder) Move this responder to the backmost position among a group of the sibling responders which match the specified search condition.
`Void`	ToBack( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Move this responder to the backmost position among a group of the sibling responders which match the specified search condition.
`Void`	ToBack( `UInt32` id ) (inherits from SFYResponder) Move this responder to the backmost position among a group of the sibling responders which match the specified search condition.
`Void`	ToBack( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Move this responder to the backmost position among a group of the sibling responders which match the specified search condition.
`Void`	ToFront( `Void` ) (inherits from SFYResponder) Move this responder to the foremost position among a group of the sibling responders which match the specified search condition.
`Void`	ToFront( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Move this responder to the foremost position among a group of the sibling responders which match the specified search condition.
`Void`	ToFront( `UInt32` id ) (inherits from SFYResponder) Move this responder to the foremost position among a group of the sibling responders which match the specified search condition.
`Void`	ToFront( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Move this responder to the foremost position among a group of the sibling responders which match the specified search condition.
`Void`	ToNthBackward( `SInt32` index ) (inherits from SFYResponder) Move this responder to the specified position from the back side among a group of the sibling responders which match the specified search condition.
`Void`	ToNthBackward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Move this responder to the specified position from the back side among a group of the sibling responders which match the specified search condition.
`Void`	ToNthBackward( `SInt32` index , `UInt32` id ) (inherits from SFYResponder) Move this responder to the specified position from the back side among a group of the sibling responders which match the specified search condition.
`Void`	ToNthBackward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Move this responder to the specified position from the back side among a group of the sibling responders which match the specified search condition.
`Void`	ToNthForward( `SInt32` index ) (inherits from SFYResponder) Move this responder to the specified position from the front side among a group of the sibling responders which match the specified search condition.
`Void`	ToNthForward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Move this responder to the specified position from the front side among a group of the sibling responders which match the specified search condition.
`Void`	ToNthForward( `SInt32` index , `UInt32` id ) (inherits from SFYResponder) Move this responder to the specified position from the front side among a group of the sibling responders which match the specified search condition.
`Void`	ToNthForward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (inherits from SFYResponder) Move this responder to the specified position from the front side among a group of the sibling responders which match the specified search condition.
`Void`	UnregisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::RuleRecConstRef` rule ) (inherits from SFYResponder) Unregister the handler from this responder which matches the specified condition.
`Void`	UnregisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::HandlerSPP` spp , `VoidPtr` reference ) (inherits from SFYResponder) Unregister the handler from this responder which matches the specified condition.
`Void`	UnregisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::RuleRecConstPtr` rule , `SInt32` length ) (inherits from SFYResponder) Unregister the handler from this responder which matches the specified condition.
`Void`	UnregisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::HandlerSPPConstPtr` spp , `VoidPtrConstPtr` reference , `SInt32` length ) (inherits from SFYResponder) Unregister the handler from this responder which matches the specified condition.
`Void`	UnregisterTracer( `SFXEventRangeConstRef` range ) (inherits from SFYResponder) Unregister the dispatching rule from the tracer of this responder which matches the specified condition.
`Void`	UnregisterTracer( `SFXEventRangeConstPtr` range , `SInt32` length ) (inherits from SFYResponder) Unregister the dispatching rule from the tracer of this responder which matches the specified condition.
`T const &`	static_catch( `Void` ) (inherits from static_exception) Get the current exception.

Protected Functions
static `SFYResponderSmp`	Factory( `SFYResponderPtr` responder , `SFCErrorPtr` exception = null ) (inherits from SFYResponder) This function is used to implement the NewInstance function.
`SFYResponderSmp`	GetThis( `Void` ) (inherits from SFYResponder) Get the smart pointer of this responder.
`Void`	HandleBoundGlobal( `SFXRectangleConstRef` rectangle ) (inherits from SFYWidget) This function will be called when the global region is changed.
`Void`	HandleBoundOptimize( `SFXRectanglePtr` rectangle ) (inherits from SFYWidget) This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) event is received. [Calculate the suitable rectangle size of this responder within the specified hint rectangle.]
`Void`	HandleBoundReal( `Void` ) (inherits from SFYWidget) This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) event is received. [Perform the processing when the real region is changed.]
`Void`	HandleBoundRequest( `SFXRectanglePtr` rectangle ) (inherits from SFYWidget) This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) event is received. [Calculate the suitable rectangle size of this responder.]
`Void`	HandleBoundVirtual( `Void` ) (inherits from SFYWidget) This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event is received. [Perform the processing when the virtual region is changed.]
`Bool`	HandlePageDownKey( `Void` ) (inherits from SFYContainer) This function will be called when the SFEVT_KEY event of the PageDown key is received.
`Bool`	HandlePageUpKey( `Void` ) (inherits from SFYContainer) This function will be called when the SFEVT_KEY event of the PageUp key is received.
`Void`	HandleRenderRequest( `SFXGraphicsPtr` graphics ) (inherits from SFYWidget) This function will be called when the (SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) event is received. [Draw this responder.]
`Bool`	HandleScrollDownKey( `Void` ) (inherits from SFYContainer) This function will be called when the SFEVT_KEY event of the ScrollDown key is received.
`Bool`	HandleScrollUpKey( `Void` ) (inherits from SFYContainer) This function will be called when the SFEVT_KEY event of the ScrollUp key is received.
`Bool`	HandleSnapDownKey( `Void` ) (inherits from SFYContainer) This function will be called when the SFEVT_KEY event of the SnapDown key is received.
`Bool`	HandleSnapUpKey( `Void` ) (inherits from SFYContainer) This function will be called when the SFEVT_KEY event of the SnapUp key is received.
`Void`	Invalidate( `Void` ) (inherits from SFYResponder) Register the specified redraw region of this responder.
`Void`	Invalidate( `SFXRectangleConstRef` param ) (inherits from SFYResponder) Register the specified redraw region of this responder.
`Void`	InvokeBackward( `SFXEventConstRef` event , `Bool` overload , `BoolPtr` result = null ) (inherits from SFYResponder) Call the handlers for the specified event from the end of the handler list registered into this responder.
`Void`	InvokeForward( `SFXEventConstRef` event , `Bool` overload , `BoolPtr` result = null ) (inherits from SFYResponder) Call the handlers for the specified event from the head of the handler list registered into this responder.
`Void`	SetType( `SFCType` param ) (inherits from SFYResponder) Set the Type value of this responder to the specified 4-character value.
`Void`	static_throw( `static_exception< T > const &` param ) (inherits from static_exception) Set an exception.
`Void`	static_throw( `T const &` param ) (inherits from static_exception) Set an exception.
`Bool`	static_try( `Void` ) (inherits from static_exception) Confirm whether or not the exception is retained.

Types
CodeEnum Constant that represents the SFZContainer class.
DefaultEnum (inherits from SFYContainer) Constant that represents the default scroll-step[pixel unit].
HorizontalEnum (inherits from SFYResponder) Constants that represent the horizontal alignment.
VerticalEnum (inherits from SFYResponder) Constants that represent the vertical alignment.

SFZContainer::SFZContainer

Constructor of the SFZContainer class.

[ protected, explicit ]
SFZContainer(Void);

Description

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

Reference

SFYResponder::SetType | SFZContainer::CodeEnum | Type

SFZContainer::~SFZContainer

Destructor of the SFZContainer class.

[ protected, virtual ]
virtual ~SFZContainer(Void);

Description

This destructor does nothing.

SFZContainer::NewInstance

Create a new instance of this responder class.

[ public, static ]
SFZDialogSmp NewInstance(
    SFCErrorPtr exception = null   // error value
);

Argument

exception: Return the error value generated inside the function.

Return value

If succeeds: not null pointer
Otherwise: null pointer

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:

SFZContainerSmp _container;
SFCError error;

if ((_container = SFZContainer::NewInstance(&error)) != null) {

    ...
}

SFZContainer::CodeEnum

Constant that represents the SFZContainer class.

enum CodeEnum {
    CODE_TYPE = four_char_code('n', 't', 'n', 'r')
};
SFMTYPEDEFTYPE(CodeEnum)

Reference

SFYResponder::GetType | SFYResponder::SetType