継承図

協調図

解説

■ 仕様と使い方

SFYScrollBarControl は、 各種スクロールバーコントロールを実装するための起点となるクラスです。

SFZScrollBarControl や SFZContainerScrollBarControl は、 このクラスを継承します。

このクラスは、スクロールバーの描画機能（トラック、増分矢印ラベル、減分矢印ラベル、サムラベル） とスクロール状況（最大値、最小値、現在値、ページサイズ）を設定する機能を提供します。 また、以下の表にあるようにいくつかの仮想関数のデフォルトの動作も実装します。

以下は、スクロールバーコントロールの仕様です。

仮想領域が実領域よりも大きい場合や、 リストボックスやメニューなどで実領域に表示可能な項目よりもたくさんの項目がある場合、 レスポンダはスクロールしてコンテンツ（内容）を表示します。

このようなレスポンダでは、 以下の手順でスクロールバーコントロールを装着することにより、 実領域に現在表示されているコンテンツに関するコンテンツ全体に対する相対的な位置関係（スクロールの状況）をスクロールバーコントロールに表示することができます。

	注意
	スクロールバーを装着する対象となるレスポンダを『ターゲットレスポンダ』と呼んでいます。 また、ターゲットレスポンダの実領域に現在表示されているコンテンツを『表示コンテンツ』、 表示されていないものも含めたすべてのコンテンツを『全体コンテンツ』と呼んでいます。

	ターゲットレスポンダの最小値、最大値、現在値、ページサイズについて
	多くのレスポンダでは、 全体コンテンツの始点と終点の座標で最小値と最大値、表示コンテンツ（＝実領域）の始点と幅で現在値とページサイズを表現します （いずれもローカル領域の座標系。スクロール方向が水平の場合は X 座標、垂直の場合は Y 座標。最小値は常に 0 です）。 ターゲットレスポンダの実領域や仮想領域が変更された場合、 全体コンテンツの始点や終点、表示コンテンツの始点や幅も変更されますので、 スクロールバーコントロールの最小値、最大値、現在値、ページサイズも更新する必要があります。 例外: SFZListBoxControl クラスでは、 全体コンテンツの項目数で最大値、表示コンテンツの先頭項目のインデックスで現在位置、 表示コンテンツの項目数でページサイズを表現します（最小値は常に 0）。

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

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

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

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

■イベントハンドラ

	注釈
	※1. SFYResponder::SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize())) を実行します。

参照

SFYControl | SFZScrollBarControl | SFZContainerScrollBarControl | SFYControl::SetMinimumValue | SFYControl::SetMaximumValue | SFYControl::SetCurrentValue | SFYScrollBarControl::SetPageValue | SFYScrollBarControl::SetBevelColor | SFYScrollBarControl::SetTrackColor | SFYScrollBarControl::SetArrowColor | SFYScrollBarControl::SetOrientation | SFYScrollBarControl::IsScrollable | SFYResponder::SetRealBound | 実領域 | 仮想領域 | スクロールバーイベント [SFEVT_RESPONDER_SCROLLBAR]

メンバ

解説

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

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

内部実装

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

/*public */SFYScrollBarControl::SFYScrollBarControl(Void) static_throws
{
    static SFXEventRange::AtomRecConst          range[] = {
        { SFEVT_RESPONDER_VALUE,  SFEVT_RESPONDER_VALUE,  SFP16_VALUE_MAXIMUM,  SFP16_VALUE_CURRENT}
    };
    SFYHandler::RuleRec                         rule[lengthof(range)];

    if (static_try()) {
        SetType(CODE_TYPE);
        rule[0].spp = XANDLER_FUNCTION(OnValue);
        rule[0].reference = this;
        static_throw(RegisterHandler(atomic_cast(range), rule, lengthof(range)));
        if (static_try()) {
            static SFXRGBColor::AtomRecConst    theme[] = {
                {{{0x00, 0xFF, 0xFF, 0xFF}}},
                {{{0x00, 0xCC, 0xCC, 0xCC}}},
                {{{0x00, 0x88, 0x88, 0x88}}},
                {{{0x00, 0xF0, 0xF0, 0xF0}}},
                {{{0x00, 0x00, 0x00, 0x00}}}
            };
            _color.bevel.Set(theme[0], theme[1], theme[2]);
            _color.track.Set(theme[3]);
            _color.arrow.Set(theme[4]);
            SetMinimumValue(0);
            SetMaximumValue(0);
            SetCurrentValue(0);
            _pagesize = 0;
            _scrollstep = 0;
            _scrollbar.orient = DEFAULT_ORIENTATION;
            _scrollbar.thumbTop = 0;
            _scrollbar.thumbLength = 0;
            _scrollbar.scrollRange = 0;
            _scrollable = false;
        }
    }
}// SFYScrollBarControl::SFYScrollBarControl //

/*private */XANDLER_IMPLEMENT_VOIDVALUE(SFYScrollBarControl, OnValue, invoker, reason, value)
{
    unused(invoker); unused(value);
    switch (reason) {
        case SFP16_VALUE_MAXIMUM:
        case SFP16_VALUE_MINIMUM:
            QueryScrollable();
            RelocateThumb();
            break;
        case SFP16_VALUE_CURRENT:
            RelocateThumbTop();
            break;
        default:
            break;
    }
    Invalidate();
    return;
}// XANDLER_IMPLEMENT_VOIDSTATE(SFYScrollBarControl, OnValue) //

/*private */Void SFYScrollBarControl::QueryScrollable(Void)
{
    SInt32Const                                 min(GetMinimumValue());
    SInt32Const                                 max(GetMaximumValue());

    if (((max > min) && (max - min > _pagesize)) ^ !(!_scrollable)) {
        _scrollable = !_scrollable;
        HandleScrollable();
    }
    return;
}// SFYScrollBarControl::QueryScrollable //

/*protected virtual */Void SFYScrollBarControl::HandleScrollable(Void)
{
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_SCROLLBAR, SFP16_SCROLLBAR_ENABLE, 0), true);
    return;
}// SFYScrollBarControl::HandleScrollable //

/*private */Void SFYScrollBarControl::RelocateThumb(Void)
{
    if (IsScrollable()) {
        RelocateThumbLength();
        RelocateThumbTop();
    }
    else {
        _scrollbar.thumbLength = 0;
    }
    return;
}// SFYScrollBarControl::RelocateThumb //

/*private */Void SFYScrollBarControl::RelocateThumbLength(Void)
{
    SInt32Const                                 min(GetMinimumValue());
    SInt32Const                                 max(GetMaximumValue());
    SFXRectangleConst                           rc(GetLocalBound());
    SInt16                                      track;

    track = (_scrollbar.orient == VERTICAL) ? _track.GetHeight() : _track.GetWidth();
    track = (track > 0) ? track : 0;
    _scrollbar.thumbLength = static_cast<SInt16>(track * _pagesize / (max - min));
    if ((_scrollbar.thumbLength < MINIMUM_THUMB_LENGTH) && (MINIMUM_THUMB_LENGTH < track)) {
        _scrollbar.thumbLength = MINIMUM_THUMB_LENGTH;
    }
    _scrollbar.scrollRange = track - _scrollbar.thumbLength;
    return;
}// SFYScrollBarControl::RelocateThumbLength //

/*private */ Void SFYScrollBarControl::RelocateThumbTop(Void)
{
    SInt32Const                                 cur(GetCurrentValue());
    SInt32Const                                 min(GetMinimumValue());
    SInt32Const                                 max(GetMaximumValue());

    if (max - min > _pagesize) { // This is always true. //
        _scrollbar.thumbTop = static_cast<SInt16>(_scrollbar.scrollRange * (cur - min) / (max - min - _pagesize));
    }
    else {
        _scrollbar.thumbTop = 0;
    }
    return;
}// SFYScrollBarControl::RelocateThumbTop //

参照

SFYResponder::SetType | SFYScrollBarControl::CodeEnum | SFYScrollBarControl::SetBevelColor | SFYScrollBarControl::SetTrackColor | SFYScrollBarControl::SetArrowColor | SFYScrollBarControl::SetPageValue | SFYScrollBarControl::SetScrollStepValue | SFYScrollBarControl::SetOrientation | SFYScrollBarControl::OrientationEnum | SFYScrollBarControl::GetThumbTop | SFYScrollBarControl::GetThumbLength | SFYScrollBarControl::GetScrollRange | SFYScrollBarControl::IsScrollable | SFYScrollBarControl::HandleScrollable | SFYControl::SetMinimumValue | SFYControl::SetMaximumValue | SFYControl::SetCurrentValue | SFXBevelColor | SFXRGBColor | SFXEvent | タイプ | 状態 | イベント | 値イベント[SFEVT_RESPONDER_VALUE]

解説

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

内部実装

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

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

解説

この関数は、SFYScrollBarControl::SetScrollStepValue 関数で設定したスクロールステップだけ現在値を減らします。

このスクロールバーコントロールは、 値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, 新しい現在値)] を受信します。

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

内部実装

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

/*public */Bool SFYScrollBarControl::Decrement(Void)
{
    SInt32                                      cur(GetCurrentValue());
    SInt32                                      min(GetMinimumValue());
    Bool                                        result(true);

    if (cur > min) {
        cur -= _scrollstep;
        cur = (cur > min) ? cur : min;
        SetCurrentValue(cur);
    }
    else {
        SetCurrentValue(min);
        result = false;
    }
    return result;
}// SFYScrollBarControl::Decrement //

参照

SFYScrollBarControl::SetScrollStepValue | SFYScrollBarControl::Increment | 値イベント[SFEVT_RESPONDER_VALUE]

解説

この関数は、減分矢印矩形領域を描画します。

独自の処理を行う場合は、この関数をオーバーライドします。

	Tip
	この関数は、SFZScrollBarControl::HandleRenderRequest 関数内で呼び出されます。

内部実装

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

enum {
        MINIMUM_THUMB_LENGTH             = 2,
        MINIMUM_MINOR_AXIS_SIZE          = 2,
        INACTIVE_ARROW                   = 0x66
};

/*protected */Void SFYScrollBarControl::DrawDecrement(SFXGraphicsPtr graphics) const
{
    SFXRGBColor                                 arrow(GetArrowColor());
    SFXBevelColor                               bevel(GetBevelColor());
    SFXRectangleConstRef                        rc(GetDecrementArrowRectangle());

    if (!rc.IsEmpty()) {
        if (!GetStateActive(true) || !IsScrollable()) {
            bevel.SetDark(bevel.GetBase());
            bevel.SetLight(bevel.GetBase());
            (arrow.GetBrightness() > 0x7F) ? arrow.SubRGB(INACTIVE_ARROW) : arrow.AddRGB(INACTIVE_ARROW);
        }
        if (GetOrientation() == VERTICAL) {
            graphics->FillBevelRectangle(rc, bevel);
            graphics->FillTriangle(CalculateTriangle(rc, SCROLL_UP), arrow);
        }
        else {
            graphics->FillBevelRectangle(rc, bevel);
            graphics->FillTriangle(CalculateTriangle(rc, SCROLL_LEFT), arrow);
        }
    }
    return;
}// SFYScrollBarControl::DrawDecrement

/*private */SFXTriangle SFYScrollBarControl::CalculateTriangle(SFXRectangleConstRef rect, ScrollDirectionEnum direction) const
{
    SInt16                                      w;
    SInt16                                      h;
    SFXRectangle                                temp(rect);

    if (direction == SCROLL_UP || direction == SCROLL_DOWN) {
        h = rect.GetHeight() / 4;
        w = h * 2;
    }
    else {
        w = rect.GetWidth() / 4;
        h = w * 2;
    }
    temp.SetSize(w, h);
    temp.Offset((rect.GetWidth() - w - 1) / 2, (rect.GetHeight() - h - 1) / 2);
    return InscribedTriangle(temp, direction);
}// SFZSoftKeyControl::CalculateTriangle //

/*private */SFXTriangle SFYScrollBarControl::InscribedTriangle(SFXRectangleConstRef rect, ScrollDirectionEnum direction) const
{
    SFXTriangle                                 result;
    SInt16                                      x(rect.GetX());
    SInt16                                      y(rect.GetY());
    SInt16                                      w(rect.GetWidth());
    SInt16                                      h(rect.GetHeight());

    switch (direction) {
        case SCROLL_UP:
            result.Set(x + w / 2, y, x, y + h, x + w, y + h);
            break;
        case SCROLL_DOWN:
            result.Set(x, y, x + w, y, x + w / 2, y + h);
            break;
        case SCROLL_LEFT:
            result.Set(x + w, y, x, y + h / 2, x + w, y + h);
            break;
        case SCROLL_RIGHT:
            result.Set(x, y, x, y + h, x + w, y + h / 2);
            break;
    }
    return result;
}// SFYScrollBarControl::InscribedTriangle //

参照

SFZScrollBarControl::HandleRenderRequest | SFYScrollBarControl::DrawTrack | SFYScrollBarControl::DrawIncrement | SFYScrollBarControl::DrawThumb

解説

この関数は、増分矢印矩形領域を描画します。

独自の処理を行う場合は、この関数をオーバーライドします。

	Tip
	この関数は、SFZScrollBarControl::HandleRenderRequest 関数内で呼び出されます。

内部実装

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

enum {
        MINIMUM_THUMB_LENGTH             = 2,
        MINIMUM_MINOR_AXIS_SIZE          = 2,
        INACTIVE_ARROW                   = 0x66
};

/*protected */Void SFYScrollBarControl::DrawIncrement(SFXGraphicsPtr graphics) const
{
    SFXRGBColor                                 arrow(GetArrowColor());
    SFXBevelColor                               bevel(GetBevelColor());
    SFXRectangleConstRef                        rc(GetIncrementArrowRectangle());

    if (!rc.IsEmpty()) {
        if (!GetStateActive(true) || !IsScrollable()) {
            bevel.SetDark(bevel.GetBase());
            bevel.SetLight(bevel.GetBase());
            (arrow.GetBrightness() > 0x7F) ? arrow.SubRGB(INACTIVE_ARROW) : arrow.AddRGB(INACTIVE_ARROW);
        }
        if (GetOrientation() == VERTICAL) {
            graphics->FillBevelRectangle(rc, bevel);
            graphics->FillTriangle(CalculateTriangle(rc, SCROLL_DOWN), arrow);
        }
        else {
            graphics->FillBevelRectangle(rc, bevel);
            graphics->FillTriangle(CalculateTriangle(rc, SCROLL_RIGHT), arrow);
        }
    }
    return;
}// SFYScrollBarControl::DrawIncrement //

/*private */SFXTriangle SFYScrollBarControl::CalculateTriangle(SFXRectangleConstRef rect, ScrollDirectionEnum direction) const
{
    SInt16                                      w;
    SInt16                                      h;
    SFXRectangle                                temp(rect);

    if (direction == SCROLL_UP || direction == SCROLL_DOWN) {
        h = rect.GetHeight() / 4;
        w = h * 2;
    }
    else {
        w = rect.GetWidth() / 4;
        h = w * 2;
    }
    temp.SetSize(w, h);
    temp.Offset((rect.GetWidth() - w - 1) / 2, (rect.GetHeight() - h - 1) / 2);
    return InscribedTriangle(temp, direction);
}// SFZSoftKeyControl::CalculateTriangle //

/*private */SFXTriangle SFYScrollBarControl::InscribedTriangle(SFXRectangleConstRef rect, ScrollDirectionEnum direction) const
{
    SFXTriangle                                 result;
    SInt16                                      x(rect.GetX());
    SInt16                                      y(rect.GetY());
    SInt16                                      w(rect.GetWidth());
    SInt16                                      h(rect.GetHeight());

    switch (direction) {
        case SCROLL_UP:
            result.Set(x + w / 2, y, x, y + h, x + w, y + h);
            break;
        case SCROLL_DOWN:
            result.Set(x, y, x + w, y, x + w / 2, y + h);
            break;
        case SCROLL_LEFT:
            result.Set(x + w, y, x, y + h / 2, x + w, y + h);
            break;
        case SCROLL_RIGHT:
            result.Set(x, y, x, y + h, x + w, y + h / 2);
            break;
    }
    return result;
}// SFYScrollBarControl::InscribedTriangle //

参照

SFZScrollBarControl::HandleRenderRequest | SFYScrollBarControl::DrawTrack | SFYScrollBarControl::DrawDecrement | SFYScrollBarControl::DrawThumb

解説

この関数は、サム領域を描画します。

独自の処理を行う場合は、この関数をオーバーライドします。

	Tip
	この関数は、SFZScrollBarControl::HandleRenderRequest 関数内で呼び出されます。

	注意
	『ページサイズ ≧ {(最大値) - (最小値)} 』の場合、 スクロール不可能状態になり、サム領域は描画されません。

内部実装

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

/*protected */Void SFYScrollBarControl::DrawThumb(SFXGraphicsPtr graphics) const
{
    SFXBevelColor                               bevel(GetBevelColor());

    if (IsScrollable()) {
        if (!GetStateActive(true)) {
            bevel.SetDark(bevel.GetBase());
            bevel.SetLight(bevel.GetBase());
        }
        graphics->FillBevelRectangle(GetThumbRectangle(), bevel);
    }
    return;
}// SFYScrollBarControl::DrawThumb

参照

SFZScrollBarControl::HandleRenderRequest | SFYScrollBarControl::DrawTrack | SFYScrollBarControl::DrawDecrement | SFYScrollBarControl::DrawIncrement

解説

この関数は、トラック（厳密には全体部分）を描画します。

スクロールバーの下地を塗りつぶすときに利用します。

独自の処理を行う場合は、この関数をオーバーライドします。

	Tip
	この関数は、SFZScrollBarControl::HandleRenderRequest 関数内で呼び出されます。

内部実装

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

/*protected */Void SFYScrollBarControl::DrawTrack(SFXGraphicsPtr graphics) const
{
    graphics->FillRectangle(GetTrackRectangle(), GetTrackColor());
    return;
}// SFYScrollBarControl::DrawTrack //

参照

SFZScrollBarControl::HandleRenderRequest | SFYScrollBarControl::DrawDecrement | SFYScrollBarControl::DrawIncrement | SFYScrollBarControl::DrawThumb

戻り値

増分 / 減分矢印（三角形部分）の色。

解説

この関数は、矢印の色を取得します。

参照

SFYScrollBarControl::SetArrowColor | SFXRGBColor

戻り値

スクロールバーの外枠を描画するためのベベルカラー（SFXBevelColor）。

解説

この関数は、スクロールバーの外枠を描画するためのベベルカラーを取得します。

参照

SFYScrollBarControl::SetBevelColor | SFXBevelColor

戻り値

減分矢印ラベルの領域。

解説

この関数は、減分矢印矩形領域を取得します。

参照

SFYScrollBarControl::SetDecrementArrowRectangle

戻り値

増分矢印ラベルの領域。

解説

この関数は、増分矢印矩形領域を取得します。

参照

SFYScrollBarControl::SetIncrementArrowRectangle

戻り値

スクロールバーの方向（SFYScrollBarControl::HORIZONTAL または SFYScrollBarControl::VERTICAL）。

解説

この関数は、スクロールバーの方向（垂直か水平）を取得します。

参照

SFYScrollBarControl::SetOrientation | SFYScrollBarControl::OrientationEnum

戻り値

ページサイズ。

解説

この関数は、ページサイズを取得します。

ページサイズはサムの長さに対応します。

実際のサムの長さは SFYScrollBarControl::GetThumbLength 関数を呼び出して取得します。

参照

SFYScrollBarControl::SetPageValue | SFYScrollBarControl::GetThumbLength

戻り値

スクロールレンジ。

解説

この関数は、スクロールレンジを取得します。

	注意
	スクロールレンジは、トラックの長さからサムの長さを減算した値です。

戻り値

スクロールステップの値。

解説

この関数は、スクロールステップの値を取得します。

参照

SFYScrollBarControl::SetScrollStepValue

戻り値

サムラベルの長さ。

解説

この関数は、サムの長さを取得します。

注意

サムの長さは、 SFYScrollBarControl::SetPageValue 関数を使用して設定するページサイズに対応します。 『ページサイズ ≧ {(最大値) - (最小値)} 』の場合、 スクロール不能状態にあり、サムは描画されません。このとき、『サムの長さ＝トラックの長さ』となります。 『ページサイズ ＜ {(最大値) - (最小値)} 』の場合、 スクロール可能であり、サムの長さは以下の値になります。 サムの長さ ＝ max(トラックの長さ * ページサイズ / {(最大値) - (最小値)}, 2) // max(a, b) は、a と b の大きい方を表します なお、最大値 / 最小値は、 SFYControl::SetMaximumValue / SFYControl::SetMinimumValue 関数を使用して設定します。 通常、最小値はデフォルト値の 0 を使用します。 最大値は、スクロールバーに表示する対象がコンテナ系レスポンダの場合は、 レスポンダ領域終端のローカル座標系の X または Y 座標の値になります（スクロール方向が水平の場合は X 座標、垂直の場合は Y 座標）。 トラックの長さは、スクロールバーコントロール矩形領域の長さから減分矢印矩形領域と増分矢印矩形領域の長さを減算した値になります （スクロール方向が水平の場合は X 成分の長さ、垂直の場合は Y 成分の長さ）。

参照

SFYScrollBarControl::SetPageValue | SFYControl::SetMaximumValue | SFYControl::SetMinimumValue

戻り値

サム領域。

解説

この関数は、サム領域を取得します。

戻り値

サムトップの位置（垂直スクロールバーの場合は Y 座標の値、水平スクロールバーの場合は X 座標の値）。

解説

この関数は、サムトップの位置を取得します。

	注意
	原点は、減分矢印とトラックの境界となります。

戻り値

トラック矩形を塗り潰す色。

解説

この関数は、トラック矩形を塗り潰す色を取得します。

参照

SFYScrollBarControl::SetTrackColor | SFXRGBColor

戻り値

トラック領域。

解説

この関数は、トラック領域を取得します。

	注意
	トラック領域は、 スクロールバーコントロール矩形領域から減分矢印矩形領域と増分矢印矩形領域を除いた領域になります 詳細は、SFYScrollBarControl::RelocateTrackAndArrow 関数の内部実装コードを参照してください。

参照

SFYScrollBarControl::SetTrackRectangle | SFYScrollBarControl::GetDecrementArrowRectangle | SFYScrollBarControl::GetIncrementArrowRectangle

解説

この関数は、領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] を受信したときに呼び出されます。

仮想領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、スクロールバー部品を再配置させます。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベント]
	SFYResponder::SetRealBound / SFYResponder::SetVirtualBound 関数は、 この関数内の処理により仮想領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundVirtual 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の仮想領域が設定されています。

	仮想領域の変更処理
	SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 仮想領域の変更処理は、最初に SFYWidget::HandleBoundVirtual 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドして処理を記述します。

内部実装

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

enum {
        MINIMUM_THUMB_LENGTH             = 2,
        MINIMUM_MINOR_AXIS_SIZE          = 2,
        INACTIVE_ARROW                   = 0x66
};

/*protected virtual */Void SFYScrollBarControl::HandleBoundVirtual(Void)
{
    Relocate();
    return;
}// SFYScrollBarControl::HandleBoundVirtual //

/*private */Void SFYScrollBarControl::Relocate(Void)
{
    RelocateTrackAndArrow();
    RelocateThumb();
    return;
}// SFYScrollBarControl::Relocate //

/*private */Void SFYScrollBarControl::RelocateThumbLength(Void)
{
    SInt32Const                                 min(GetMinimumValue());
    SInt32Const                                 max(GetMaximumValue());
    SFXRectangleConst                           rc(GetLocalBound());
    SInt16                                      track;

    track = (_scrollbar.orient == VERTICAL) ? _track.GetHeight() : _track.GetWidth();
    track = (track > 0) ? track : 0;
    _scrollbar.thumbLength = static_cast<SInt16>(track * _pagesize / (max - min));
    if ((_scrollbar.thumbLength < MINIMUM_THUMB_LENGTH) && (MINIMUM_THUMB_LENGTH < track)) {
        _scrollbar.thumbLength = MINIMUM_THUMB_LENGTH;
    }
    _scrollbar.scrollRange = track - _scrollbar.thumbLength;
    return;
}// SFYScrollBarControl::RelocateThumbLength //

/*private */ Void SFYScrollBarControl::RelocateThumbTop(Void)
{
    SInt32Const                                 cur(GetCurrentValue());
    SInt32Const                                 min(GetMinimumValue());
    SInt32Const                                 max(GetMaximumValue());

    if (max - min > _pagesize) { // This is always true. //
        _scrollbar.thumbTop = static_cast<SInt16>(_scrollbar.scrollRange * (cur - min) / (max - min - _pagesize));
    }
    else {
        _scrollbar.thumbTop = 0;
    }
    return;
}// SFYScrollBarControl::RelocateThumbTop //

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、スクロール可能状態が変化したときに呼び出されます。

独自の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、 スクロールバーイベント [SFXEvent(SFEVT_RESPONDER_SCROLLBAR, SFP16_SCROLLBAR_ENABLE, 0)] を送信します。

内部実装

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

/*protected virtual */Void SFYScrollBarControl::HandleScrollable(Void)
{
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_SCROLLBAR, SFP16_SCROLLBAR_ENABLE, 0), true);
    return;
}// SFYScrollBarControl::HandleScrollable //

参照

SFXEvent | スクロールバーイベント [SFEVT_RESPONDER_SCROLLBAR]

解説

この関数は、SFYScrollBarControl::SetScrollStepValue 関数で設定したスクロールステップだけ現在値を増やします。

このスクロールバーコントロールは、 値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, 新しい現在値)] を受信します。

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

内部実装

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

/*public */Bool SFYScrollBarControl::Increment(Void)
{
    SInt32                                      cur(GetCurrentValue());
    SInt32                                      max(GetMaximumValue());
    Bool                                        result(true);

    if (cur < max) {
        cur += _scrollstep;
        cur = (cur < max) ? cur : max;
        SetCurrentValue(cur);
    }
    else {
        SetCurrentValue(max);
        result = false;
    }
    return result;
}// SFYScrollBarControl::Increment //

参照

SFYScrollBarControl::SetScrollStepValue | SFYScrollBarControl::Decrement | 値イベント[SFEVT_RESPONDER_VALUE]

戻り値

解説

この関数は、スクロール可能かどうかを判定します。

内部実装

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

/*public */inline Bool SFYScrollBarControl::IsScrollable(Void) const
{
    return _scrollable;
}// SFYScrollBarControl::IsScrollable //

解説

この関数は、トラック矩形領域と減分・増分矢印矩形領域を再配置します。

デフォルトの実装は、 ローカル領域と方向 (orientation) を元に減分矢印矩形領域、トラック矩形領域、増分矢印矩形領域を順番に並べて再配置します。

スクロールバーコントロールでは、 SFYScrollBarControl::HandleBoundVirtual 関数のオーバーライドは非推奨です。 トラック矩形領域や減分・増分矢印矩形領域の大きさや配置を変更するには、この関数をオーバーライドします。

デフォルトの実装

/*protected virtual */Void SFYScrollBarControl::RelocateTrackAndArrow(Void)
{
    SFXRectangleConst                           rc(GetLocalBound());
    SInt16                                      side;
    SInt16                                      length;

    if (_scrollbar.orient == VERTICAL) {
        side = rc.GetWidth();
        length = (side + side < rc.GetHeight()) ? side : rc.GetHeight() / 2;
        _decrementArrow.Set(rc).SetHeight(length);
        _track.Set(rc).AddY(length).SubHeight(length + length);
        _incrementArrow.Set(_decrementArrow).AddY(_track.GetHeight() + length);
    }
    else {
        side = rc.GetHeight();
        length = (side + side < rc.GetWidth()) ? side : rc.GetWidth() / 2;
        _decrementArrow.Set(rc).SetWidth(length);
        _track.Set(rc).AddX(length).SubWidth(length + length);
        _incrementArrow.Set(_decrementArrow).AddX(_track.GetWidth() + length);
    }
    return;
}// SFYScrollBarControl::RelocateTrackAndArrow //

参照

SFYScrollBarControl::SetOrientation | SFYScrollBarControl::HandleBoundVirtual | ローカル領域

解説

この関数は、矢印ラベル（三角形）の色を設定します。

デフォルト値: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]

このスクロールバーコントロールは、 矢印ラベル（三角形）の色が変更されると、 スタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_COLOR, 0)] を受信します。

参照

SFYScrollBarControl::GetArrowColor | SFXRGBColor

解説

この関数は、 スクロールバーの外枠を描画するためのベベルカラー（SFXBevelColor）を設定します。

デフォルト値: SFXBevelColor(SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00), SFXRGBColor(0xCC, 0xCC, 0xCC, 0x00), SFXRGBColor(0x88, 0x88, 0x88, 0x00))

このスクロールバーコントロールは、 スクロールバーの外枠を描画するためのベベルカラーが変更されると、 スタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_COLOR, 0)] を受信します。

参照

SFYScrollBarControl::GetBevelColor | SFXBevelColor | SFXRGBColor

解説

この関数は、減分矢印矩形領域を設定します。

デフォルトの設定は、 SFYScrollBarControl::RelocateTrackAndArrow 関数で行われます。 詳細は、SFYScrollBarControl::RelocateTrackAndArrow 関数の内部実装コードを参照してください。

	注意
	この関数は、 スクロールバーのデフォルトレイアウトをカスタマイズしたい場合に限り利用します。 SFYScrollBarControl::RelocateTrackAndArrow 関数もスクロールバーのレイアウト変更に合わせてオーバーライドする必要があります。

内部実装

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

/*protected */inline Void SFYScrollBarControl::SetDecrementArrowRectangle(SFXRectangleConstRef param)
{
    _decrementArrow.Set(param);
}// SFYScrollBarControl::SetDecrementArrowRectangle //

参照

SFYScrollBarControl::GetDecrementArrowRectangle | SFYScrollBarControl::RelocateTrackAndArrow | SFYResponder::Invalidate

解説

この関数は、増分矢印矩形領域を設定します。

デフォルトの設定は、 SFYScrollBarControl::RelocateTrackAndArrow 関数で行われます。 詳細は、SFYScrollBarControl::RelocateTrackAndArrow 関数の内部実装コードを参照してください。

	注意
	この関数は、 スクロールバーのデフォルトレイアウトをカスタマイズしたい場合に限り利用します。 SFYScrollBarControl::RelocateTrackAndArrow 関数もスクロールバーのレイアウト変更に合わせてオーバーライドする必要があります。

内部実装

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

/*protected */inline Void SFYScrollBarControl::SetIncrementArrowRectangle(SFXRectangleConstRef param)
{
    _incrementArrow.Set(param);
}// SFYScrollBarControl::SetIncrementArrowRectangle //

参照

SFYScrollBarControl::GetIncrementArrowRectangle | SFYScrollBarControl::RelocateTrackAndArrow | SFYResponder::Invalidate

解説

この関数は、スクロールバーの方向を設定します。

水平（SFYScrollBarControl::HORIZONTAL）または垂直（SFYScrollBarControl::VERTICAL）を設定します。

デフォルト値: SFYScrollBarControl::VERTICAL

スクロールバーの方向が変更される場合は、 領域の再配置が行われます。

参照

SFYScrollBarControl::GetOrientation | SFYScrollBarControl::OrientationEnum

解説

この関数は、ページサイズを設定します。

このスクロールバーコントロールは、スクロール可能状態が変化した場合、 スクロールバーイベント [SFXEvent(SFEVT_RESPONDER_SCROLLBAR, SFP16_SCROLLBAR_ENABLE, 0)] を受信します。

注意

param 引数には、1 以上の整数を指定します。 ページサイズはサムの長さに対応します。 『ページサイズ ≧ {(最大値) - (最小値)} 』の場合、 スクロール不可能であり、スクロールバーコントロールのサムは描画されません。 このとき、 サムの長さ（SFYScrollBarControl::GetThumbLength 関数の戻り値）は 0 になります。 『ページサイズ ＜ {(最大値) - (最小値)} 』の場合、 スクロール可能であり、以下の長さのサムが描画されます。 サムの長さ ＝ max(トラックの長さ * ページサイズ / {(最大値) - (最小値)}, 2) // max(a, b) は、a と b の大きい方を表します なお、最大値 / 最小値は、 SFYControl::SetMaximumValue / SFYControl::SetMinimumValue 関数を使用して設定します。 通常、最小値はデフォルト値の 0 を使用します。 最大値は、スクロールバーに表示する対象がコンテナ系レスポンダの場合は、 レスポンダ領域終端のローカル座標系の X または Y 座標の値になります（スクロール方向が水平の場合は X 座標、垂直の場合は Y 座標）。 トラックの長さは、スクロールバーコントロール矩形領域の長さから減分矢印矩形領域と増分矢印矩形領域の長さを減算した値になります （スクロール方向が水平の場合は X 成分の長さ、垂直の場合は Y 成分の長さ）。

内部実装

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

/*public */Void SFYScrollBarControl::SetPageValue(SInt32 param)
{
    if (_pagesize != param) {
        _pagesize = param;
        QueryScrollable();
        RelocateThumb();
        Invalidate();
    }
    return;
}// SFYScrollBarControl::SetPageValue //

/*private */Void SFYScrollBarControl::QueryScrollable(Void)
{
    SInt32Const                                 min(GetMinimumValue());
    SInt32Const                                 max(GetMaximumValue());

    if (((max > min) && (max - min > _pagesize)) ^ !(!_scrollable)) {
        _scrollable = !_scrollable;
        HandleScrollable();
    }
    return;
}// SFYScrollBarControl::QueryScrollable //

/*protected virtual */Void SFYScrollBarControl::HandleScrollable(Void)
{
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_SCROLLBAR, SFP16_SCROLLBAR_ENABLE, 0), true);
    return;
}// SFYScrollBarControl::HandleScrollable //

/*private */Void SFYScrollBarControl::RelocateThumb(Void)
{
    if (IsScrollable()) {
        RelocateThumbLength();
        RelocateThumbTop();
    }
    else {
        _scrollbar.thumbLength = 0;
    }
    return;
}// SFYScrollBarControl::RelocateThumb //

/*private */Void SFYScrollBarControl::RelocateThumbLength(Void)
{
    SInt32Const                                 min(GetMinimumValue());
    SInt32Const                                 max(GetMaximumValue());
    SFXRectangleConst                           rc(GetLocalBound());
    SInt16                                      track;

    track = (_scrollbar.orient == VERTICAL) ? _track.GetHeight() : _track.GetWidth();
    track = (track > 0) ? track : 0;
    _scrollbar.thumbLength = static_cast<SInt16>(track * _pagesize / (max - min));
    if ((_scrollbar.thumbLength < MINIMUM_THUMB_LENGTH) && (MINIMUM_THUMB_LENGTH < track)) {
        _scrollbar.thumbLength = MINIMUM_THUMB_LENGTH;
    }
    _scrollbar.scrollRange = track - _scrollbar.thumbLength;
    return;
}// SFYScrollBarControl::RelocateThumbLength //

/*private */ Void SFYScrollBarControl::RelocateThumbTop(Void)
{
    SInt32Const                                 cur(GetCurrentValue());
    SInt32Const                                 min(GetMinimumValue());
    SInt32Const                                 max(GetMaximumValue());

    if (max - min > _pagesize) { // This is always true. //
        _scrollbar.thumbTop = static_cast<SInt16>(_scrollbar.scrollRange * (cur - min) / (max - min - _pagesize));
    }
    else {
        _scrollbar.thumbTop = 0;
    }
    return;
}// SFYScrollBarControl::RelocateThumbTop //

参照

SFYScrollBarControl::GetPageValue | SFYScrollBarControl::GetThumbLength | SFYScrollBarControl::GetTrackRectangle | スクロールバーイベント [SFEVT_RESPONDER_SCROLLBAR]

解説

この関数は、スクロールステップ （SFYScrollBarControl::Increment / SFYScrollBarControl::Decrement 関数で現在値を増減する単位）を設定します。

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

内部実装

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

/*public */Void SFYScrollBarControl::SetScrollStepValue(SInt32 param)
{
    if (_scrollstep != param) {
        _scrollstep = param;
    }
    return;
}// SFYScrollBarControl::SetScrollStepValue //

参照

SFYScrollBarControl::GetScrollStepValue | SFYScrollBarControl::Decrement | SFYScrollBarControl::Increment

解説

この関数は、トラック矩形を塗り潰す色を設定します。

デフォルト値: SFXRGBColor(0xF0, 0xF0, 0xF0, 0x00)[薄灰色]

このスクロールバーコントロールは、 トラック矩形を塗り潰す色が変更されると、 スタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_COLOR, 0)] を受信します。

参照

SFYScrollBarControl::GetTrackColor | SFXRGBColor

解説

この関数は、トラック領域を設定します。

デフォルトの設定は、 SFYScrollBarControl::RelocateTrackAndArrow 関数で行われます。 詳細は、SFYScrollBarControl::RelocateTrackAndArrow 関数の内部実装コードを参照してください。

	注意
	この関数は、 スクロールバーのデフォルトレイアウトをカスタマイズしたい場合に限り利用します。 SFYScrollBarControl::RelocateTrackAndArrow 関数もスクロールバーのレイアウト変更に合わせてオーバーライドする必要があります。

内部実装

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

/*protected */inline Void SFYScrollBarControl::SetTrackRectangle(SFXRectangleConstRef param)
{
    _track.Set(param);
    return;
}// SFYScrollBarControl::SetTrackRectangle //

参照

SFYScrollBarControl::GetTrackRectangle | SFYScrollBarControl::RelocateTrackAndArrow | SFYResponder::Invalidate

参照

SFYResponder::GetType | SFYResponder::SetType