Inheritance diagram

Collaboration diagram

Description

SFZContainerScrollBarControl is a scroll bar control to display the scrolling status of the responder(mainly container of the SFZContainer type) bound by the SFZContainerScrollBarControl::Bind function.

In SFZContainerScrollBarControl, there is no need to register a handler for real and virtual region events into a container nor set the position and the size of the scroll bar thumb by reading container's region information by using the SFZContainerScrollBarControl::Bind function instead.

Sample code: ScrollBarControl-en.zip

Execution Result:

Reference

SFZScrollBarControl | SFZContainer | SFZContainerScrollBarControl::Bind

Member

Description

This constructor performs the initializations as follows:

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

Reference

SFYResponder::SetType | SFZContainerScrollBarControl::CodeEnum | SFZContainerScrollBarControl::Bind | SFZContainerScrollBarControl::UnBind | SFXEvent | Type | State | Event | State Event[SFEVT_RESPONDER_STATE]

Description

This destructor does nothing.

Return value

Description

This function binds the specified responder(mainly container of the SFZContainer type) with this scroll bar control.

The function of displaying the scrolling status is provided by registering the handler for the region event into the bound responder(mainly container of the SFZContainer type).

To remove the scroll bar control from the responder(or disable the function of displaying the scrolling status), call the SFZContainerScrollBarControl::UnBind function.

Reference

SFZContainerScrollBarControl::UnBind | SFZContainer | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

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:

SFZContainerScrollBarControlSmp _containerscrollbar;
SFCError error;

if ((_containerscrollbar = SFZContainerScrollBarControl::NewInstance(&error)) != null) {

    ...
}

Description

This function unbind the responder(mainly container of the SFZContainer type) from this scroll bar control.

The function of displaying the scrolling status is disabled by unregistering the handler for the region event from the bound responder(mainly container of the SFZContainer type).

This function will be called in the SFZContainerScrollBarControl::Bind function or the destructor.

To remove the scroll bar control from the responder explicitly(or disable the function of displaying the scrolling status), call this function.

Reference

SFZContainerScrollBarControl::Bind SFZContainerScrollBarControl::~SFZContainerScrollBarControl

Reference

SFYResponder::GetType | SFYResponder::SetType