継承図

協調図

解説

SFZContainerScrollBarControl は、 SFYContainer を継承するレスポンダのスクロール状況を表示するためのコンテナ専用スクロールバーコントロールです。

スクロールバーコントロール（SFZContainerScrollBarControl）をレスポンダ （SFYContainer を継承するコンテナ）装着と着脱の手順は以下の通りです。

	注意
	スクロールバーを装着する対象となるレスポンダを『ターゲットレスポンダ』と呼んでいます。

ターゲットレスポンダの最小値、最大値、現在値、ページサイズについて

全体コンテンツの始点と終点の座標で最小値と最大値、表示コンテンツ（＝実領域）の始点と幅で現在値とページサイズを表現します （いずれもローカル領域の座標系。スクロール方向が水平の場合は X 座標、垂直の場合は Y 座標。最小値は常に 0 です）。 ターゲットレスポンダの実領域や仮想領域が変更された場合、 全体コンテンツの始点や終点、表示コンテンツの始点や幅も変更されます。 SFZContainerScrollBarControl クラスでは、 SFZScrollBarControl クラスと異なり、 開発者はスクロールバーコントロールの最小値、最大値、現在値、ページサイズを管理する必要がありません。 この処理は、SFZContainerScrollBarControl クラス内で自動的に行われます。 具体的には、領域変更通知ハンドラである SFZContainerScrollBarControl::OnBindBound 関数内から呼び出される SFZContainerScrollBarControl::Listen 関数によって行われます。 詳細は、 SFZContainerScrollBarControl::Bind / SFZContainerScrollBarControl::UnBind 関数の内部実装コードを参照してください。

	スクロールバーイベントについて
	スクロールバーコントロールは、 ターゲットレスポンダがスクロール可能な状態からスクロール不可能な状態、あるいはその逆になったとき、 スクロールバーイベント [SFEVT_RESPONDER_SCROLLBAR] [SFXEvent(SFEVT_RESPONDER_SCROLLBAR, SFP16_SCROLLBAR_ENABLE, 0)] を受信します。

	スクロール可能性の判定について
	ターゲットレスポンダが現在スクロール可能であるかどうかは、 SFYScrollBarControl::IsScrollable 関数を使用して判定します。

	スクロールバーコントロールの幅について
	スクロールバーコントロールの幅として、4 ピクセル以上の値を指定できます。 減分・増分矢印を矩形領域内にバランス良く描画するには、5 以上の奇数を指定することを推奨します。

	Increment / Decrement / SetScrollStepValue 関数について
	スクロールバーコントロールを装着するレスポンダ（ターゲットレスポンダ） 側でスクロールバーコントロールの現在値を増減する場合、 SFYScrollBarControl::Increment / SFYScrollBarControl::Decrement / SFYScrollBarControl::SetScrollStepValue 関数は使用しません。 これらの関数は、 スクロールバーコントロール側からターゲットレスポンダをスクロールしたい場合に使用します。 通常、ターゲットレスポンダ側でスクロールさせますので、 これらの関数を使用する機会は少ないと考えられます。

	SFZContainerScrollBarControl のターゲットレスポンダの種類について
	SFZContainerScrollBarControl は、 SFYContainer を継承するレスポンダに装着します。 具象レスポンダクラスとしては、 SFZContainer、SFZWindow、SFZTabPage、 SFZDialog、SFZMessageDialog、SFZQuestionDialog を挙げることができます。

サンプルコード: ScrollBarControl.zip

実行結果:

参照

SFYScrollBarControl | SFZScrollBarControl | SFYContainer | SFZContainer | SFZWindow | SFZTabPage | SFZDialog | SFZMessageDialog | SFZQuestionDialog | SFYControl::SetMinimumValue | SFYControl::SetMaximumValue | SFYControl::SetCurrentValue | SFYScrollBarControl::SetPageValue | SFYScrollBarControl::SetBevelColor | SFYScrollBarControl::SetTrackColor | SFYScrollBarControl::SetArrowColor | SFYScrollBarControl::SetOrientation | SFYScrollBarControl::IsScrollable | SFZContainerScrollBarControl::Bind | SFZContainerScrollBarControl::UnBind | SFYResponder::SetRealBound | 実領域 | 仮想領域 | 状態 | スクロールバーイベント [SFEVT_RESPONDER_SCROLLBAR]

メンバ

解説

このコンストラクタは、以下の初期化処理を行います。

	注意
	SFZContainerScrollBarControl クラスを継承するレスポンダでは、 上記イベントが発生すると、それに対応するハンドラが呼び出されます。

内部実装

このコンストラクタの内部実装は以下の通りです。

#include <SFZResponder/SFZControl/SFZScrollBarControl/SFZContainerScrollBarControl.h.hpp>
#include <SFXGeneral/SFXEvent/SFXEvent.h.hpp>

/*public */SFZContainerScrollBarControl::SFZContainerScrollBarControl(Void) static_throws
{
    static SFXEventRange::AtomRecConst  range[] = {
        {SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,  SFP16_STATE_VALID,   SFP16_STATE_VALID}
    };
    SFYHandler::RuleRec                 rule[lengthof(range)];

    if (static_try()) {
        SetType(CODE_TYPE);
        _responder = null;
        rule[0].spp = XANDLER_FUNCTION(OnStateValid);
        rule[0].reference = this;
        static_throw(RegisterHandler(atomic_cast(range), rule, lengthof(range)));
    }
}// SFZContainerScrollBarControl::SFZContainerScrollBarControl //

XANDLER_IMPLEMENT_VOIDSTATE(SFZContainerScrollBarControl, OnStateValid, invoker, reason, state)
{
    unused(invoker); unused(reason);
    if (!state) {
        UnBind();
    }
    return;
}// XANDLER_IMPLEMENT_VOIDBOUND(SFZContainerScrollBarControl, OnStateValid)

参照

SFYResponder::SetType | SFZContainerScrollBarControl::CodeEnum | SFZContainerScrollBarControl::Bind | SFZContainerScrollBarControl::UnBind | SFXEvent | タイプ | 状態 | イベント | 状態イベント[SFEVT_RESPONDER_STATE]

解説

このデストラクタは、何も行いません。

内部実装

このデストラクタの内部実装は以下の通りです。

/*public virtual */SFZContainerScrollBarControl::~SFZContainerScrollBarControl(Void)
{
}// SFZContainerScrollBarControl::~SFZContainerScrollBarControl //

戻り値

解説

この関数は、 指定されたレスポンダ（SFYContainer を継承するコンテナ。以下、ターゲットレスポンダ）にこのスクロールバーコントロールを装着します。

ターゲットレスポンダの実領域と仮想領域から、 スクロールバーコントロールの最大値、最小値、現在値、ページサイズを設定する、 領域変更通知ハンドラをターゲットレスポンダに登録します。 この処理により、 スクロールバーコントロール装着後は、 ターゲットレスポンダの実領域や仮想領域が変更されると、 このハンドラが呼び出されて随時スクロール状況が自動更新されます。

スクロールバーコントロールを着脱するには、 SFZContainerScrollBarControl::UnBind 関数を呼び出します。

	注意
	特定のスクロールバーコントロールが、同時に装着できるレスポンダの個数は 1 つだけです。 他のレスポンダに装着中のスクロールバーコントロールに対してこの関数を呼び出した場合、 スクロールバーコントロールは着脱され、新たに指定したレスポンダに装着されます。 詳細は、内部実装コードを参照してください。

	SFZContainerScrollBarControl の装着対象となるレスポンダ
	SFZContainerScrollBarControl は、 SFYContainer を継承するレスポンダに装着します。 具象レスポンダクラスとしては、 SFZContainer、SFZWindow、SFZTabPage、 SFZDialog、SFZMessageDialog、SFZQuestionDialog を挙げることができます。

内部実装

この関数の内部実装は以下の通りです。

#include <SFZResponder/SFZControl/SFZScrollBarControl/SFZContainerScrollBarControl.h.hpp>
#include <SFXGeneral/SFXEvent/SFXEvent.h.hpp>

/*public */SFCError SFZContainerScrollBarControl::Bind(SFYResponderSmpConstRef responder)
{
    return BindImpl(responder.Get());
}// SFZContainerScrollBarControl::Bind //

/*private */SFCError SFZContainerScrollBarControl::BindImpl(SFYResponderPtr responder)
{
    static SFXEventRange::AtomRecConst  range[] = {
        {SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,  SFP16_STATE_VALID,   SFP16_STATE_VALID},
        {SFEVT_RESPONDER_BOUND,  SFEVT_RESPONDER_BOUND,   SFP16_BOUND_REAL, SFP16_BOUND_VIRTUAL}
    };
    SFYHandler::RuleRec                 rule[lengthof(range)];
    SFCError                            error(SFERR_NO_ERROR);

    UnBind();
    if ((_responder = responder) != null && _responder != this) {
        rule[0].spp = XANDLER_FUNCTION(OnBindValid);
        rule[0].reference = this;
        rule[1].spp = XANDLER_FUNCTION(OnBindBound);
        rule[1].reference = this;
        error = _responder->RegisterHandler(atomic_cast(range), rule, lengthof(range));
        if (error == SFERR_NO_ERROR) {
            Listen();
        }
    }
    else {
        error = SFERR_INVALID_PARAM;
    }
    return error;
}// SFZContainerScrollBarControl::BindImpl //

XANDLER_IMPLEMENT_VOIDBOUND(SFZContainerScrollBarControl, OnBindBound, invoker, reason, bound)
{
    unused(invoker); unused(reason); unused(bound);
    Listen();
    return;
}// XANDLER_IMPLEMENT_VOIDBOUND(SFZContainerScrollBarControl, OnBindBound)

/*private */Void SFZContainerScrollBarControl::Listen(Void)
{
    SFXRectangle                        rRect;
    SFXRectangle                        vRect;
    SInt16                              max;
    SInt16                              cur;
    SInt16                              page;

    if (_responder != null) {
        rRect = _responder->GetRealBound();
        vRect = _responder->GetVirtualBound();
        if (GetOrientation() == VERTICAL) {
            max = vRect.GetHeight();
            cur = -vRect.GetTop();
            page = rRect.GetHeight();
        }
        else {
            max = vRect.GetWidth();
            cur = -vRect.GetLeft();
            page = rRect.GetWidth();
        }
        SetMinimumValue(0);
        SetMaximumValue(max);
        SetCurrentValue(cur);
        SetPageValue(page);
    }
    return;
}// SFZContainerScrollBarControl::Listen //

参照

SFZContainerScrollBarControl::UnBind | SFYContainer | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]

引数

戻り値

解説

この関数は、SFZContainerScrollBarControl クラスの新しいインスタンスを作成します。

インスタンスの作成に成功した場合は null 以外のポインタを返します。 失敗した場合は、null ポインタを返します。

exception 引数を指定した場合、 この引数にはエラー値が返ります。

使用例

以下は、コンテナ専用スクロールバーのインスタンスを生成するためのコードです。

// コンテナ専用スクロールバーのインスタンスを生成する
SFCError error;
SFZContainerScrollBarControlSmp _containerscrollbar;

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

解説

この関数は、 このスクロールバーコントロールを装着しているレスポンダ（SFYContainer を継承するコンテナ。以下、ターゲットレスポンダ）からスクロールバーコントロールを着脱します。

この関数は、 ターゲットレスポンダへの領域変更通知ハンドラの登録を解除し、 ターゲットレスポンダの実領域と仮想領域の変更に伴う、 スクロールバーコントロールの最大値、最小値、現在値、ページサイズの自動更新を終了します。

この関数を実行後、ページサイズは 0 に設定されます。

スクロールバーコントロールを装着するには、 SFZContainerScrollBarControl::Bind 関数を呼び出します。

	注意
	このスクロールバーコントロールを装着しているレスポンダが存在しない場合は何も起こりません。

	注意
	この関数は、 スクロールバーコントロールまたはターゲットレスポンダの状態が無効状態 （SFYResponder::Terminate 関数が呼び出された状態）になると、 状態変更通知ハンドラから自動的に呼び出されます。 詳細は、内部実装コードを参照してください。

内部実装

この関数の内部実装は以下の通りです。

#include <SFZResponder/SFZControl/SFZScrollBarControl/SFZContainerScrollBarControl.h.hpp>
#include <SFXGeneral/SFXEvent/SFXEvent.h.hpp>

/*public */Void SFZContainerScrollBarControl::UnBind(Void)
{
    static SFXEventRange::AtomRecConst  range[] = {
        {SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,  SFP16_STATE_VALID,   SFP16_STATE_VALID},
        {SFEVT_RESPONDER_BOUND,  SFEVT_RESPONDER_BOUND,   SFP16_BOUND_REAL, SFP16_BOUND_VIRTUAL}
    };
    SFYHandler::RuleRec                 rule[lengthof(range)];

    if (_responder != null) {
        rule[0].spp = XANDLER_FUNCTION(OnBindValid);
        rule[0].reference = this;
        rule[1].spp = XANDLER_FUNCTION(OnBindBound);
        rule[1].reference = this;
        _responder->UnregisterHandler(atomic_cast(range), rule, lengthof(range));
        _responder = null;
        SetPageValue(0);
    }
    return;
}// SFZContainerScrollBarControl::UnBind //

XANDLER_IMPLEMENT_VOIDSTATE(SFZContainerScrollBarControl, OnBindValid, invoker, reason, state)
{
    unused(invoker); unused(reason);
    if (!state) {
        UnBind();
    }
    return;
}// XANDLER_IMPLEMENT_VOIDBOUND(SFZContainerScrollBarControl, OnBindValid)

XANDLER_IMPLEMENT_VOIDBOUND(SFZContainerScrollBarControl, OnBindBound, invoker, reason, bound)
{
    unused(invoker); unused(reason); unused(bound);
    Listen();
    return;
}// XANDLER_IMPLEMENT_VOIDBOUND(SFZContainerScrollBarControl, OnBindBound)

参照

SFZContainerScrollBarControl::Bind SFYScrollBarControl::SetPageValue | SFYContainer | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND] | 状態イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND] | 状態

参照

SFYResponder::GetType | SFYResponder::SetType