#include <SFZBandScrollBarControl.h.hpp>

class SFZBandScrollBarControl : public SFYScrollBarControl;

SFMTYPEDEFRESPONDER(SFZBandScrollBarControl)

継承図

協調図

解説

バンドスクロールバーコントロールは、帯コントロールのためのスクロールバーコントロールです。

SFZBandScrollBarControl::Bind 関数で結びつけた帯コントロールの状態に応じて自動スクロールします。

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

デザインは、SFYScrollBarControl::SetBevelColor、 SFYScrollBarControl::SetTrackColor、 SFYScrollBarControl::SetArrowColor 関数によって変更可能です。

位置やサイズを変更するには、SFYResponder::SetRealBound 関数を使います。

SFYScrollBarControl::SetOrientation 関数によって、垂直方向のスクロールバーや水平方向のスクロールバーを生成できます。

参照

SFYScrollBarControl | SFYScrollBarControl::SetBevelColor | SFYScrollBarControl::SetTrackColor | SFYScrollBarControl::SetArrowColor | SFYScrollBarControl::SetOrientation | SFYResponder::SetRealBound

メンバ

コンストラクタ/デストラクタ
SFZBandScrollBarControl( Void ) SFZBandScrollBarControl クラスのコンストラクタです。
~SFZBandScrollBarControl( Void ) SFZBandScrollBarControl クラスのデストラクタです。

パブリック関数
SFCError	Bind( SFYBandControlSmpConstRef bandcontrol ) スクロールする対象となる帯コントロールと結びつけます。
static SFZBandScrollBarControlSmp	NewInstance( SFCErrorPtr exception = null ) 新しいインスタンスを作成します。
Void	UnBind( Void ) 対象の帯コントロールを解除します。
Void	ClearHandler( Void ) (SFYResponder から継承) ハンドラの登録をすべて解除します。
Void	ClearTracer( Void ) (SFYResponder から継承) トレーサの登録をすべて解除します。
Bool	Decrement( Void ) (SFYScrollBarControl から継承) スクロール ステップの値を減らします。
SFCError	Distribute( SFXEventConstRef event , BoolPtr result = null ) (SFYResponder から継承) 配信エンジンを起動してイベントを配信します。
Bool	GetAlwaysVisible( Void ) (SFYScrollBarControl から継承) 常にスクロールバーを表示するかどうかを返します。
SFXRGBColorConstRef	GetArrowColor( Void ) (SFYScrollBarControl から継承) スクロールバーの矢印の色を取得します。
SFXRGBColorConstRef	GetBackgroundColor( Void ) (SFYWidget から継承) 背景の色を取得します。
SFXBevelColorConstRef	GetBevelColor( Void ) (SFYScrollBarControl から継承) 3D のスクロールバーを描画するためのベベルカラーを取得します。
SFYResponderSmp	GetChildBack( Void ) (SFYResponder から継承) GetChildBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) GetChildBack( UInt32 id ) (SFYResponder から継承) GetChildBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 最背面に位置する子レスポンダを取得します。
SFYResponderSmp	GetChildBackward( SInt32 index ) (SFYResponder から継承) GetChildBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) GetChildBackward( SInt32 index , UInt32 id ) (SFYResponder から継承) GetChildBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 背面から数えて指定された順番に位置する子レスポンダを取得します。
SInt32	GetChildCount( Void ) (SFYResponder から継承) GetChildCount( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) GetChildCount( UInt32 id ) (SFYResponder から継承) GetChildCount( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 子レスポンダの数を取得します。
SFYResponderSmp	GetChildForward( SInt32 index ) (SFYResponder から継承) GetChildForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) GetChildForward( SInt32 index , UInt32 id ) (SFYResponder から継承) GetChildForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 前面から数えて指定された順番に位置する子レスポンダを取得します。
SFYResponderSmp	GetChildFront( Void ) (SFYResponder から継承) GetChildFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) GetChildFront( UInt32 id ) (SFYResponder から継承) GetChildFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 最前面に位置する子レスポンダを取得します。
SInt32	GetCurrentValue( Void ) (SFYControl から継承) コントロールの現在値を取得します。
SFYDistributerPtr	GetDistributer( Void ) (SFYResponder から継承) 配信エンジンを取得します。
SFXRectangle	GetGlobalBound( Void ) (SFYResponder から継承) グローバル領域を取得します。
UInt32	GetID( Void ) (SFYResponder から継承) ID を取得します。
SFXRectangle	GetLocalBound( Void ) (SFYResponder から継承) ローカル領域を取得します。
SInt32	GetMaximumValue( Void ) (SFYControl から継承) コントロールの最大値を取得します。
SInt32	GetMinimumValue( Void ) (SFYControl から継承) コントロールの最小値を取得します。
SInt32	GetNthBackward( Void ) (SFYResponder から継承) GetNthBackward( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) GetNthBackward( UInt32 id ) (SFYResponder から継承) GetNthBackward( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 自レスポンダが背面から数えて何番目に位置するかを取得します。
SInt32	GetNthForward( Void ) (SFYResponder から継承) GetNthForward( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) GetNthForward( UInt32 id ) (SFYResponder から継承) GetNthForward( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 自レスポンダが前面から数えて何番目に位置するかを取得します。
OrientationEnum	GetOrientation( Void ) (SFYScrollBarControl から継承) スクロールバーの方向を取得します。
SInt32	GetPageValue( Void ) (SFYScrollBarControl から継承) ページ サイズを取得します。
SFYResponderSmp	GetParent( Void ) (SFYResponder から継承) 親レスポンダを取得します。
Bool	GetPropertyTransparent( Void ) (SFYResponder から継承) 透過属性を取得します。
SFXRectangleConstRef	GetRealBound( Void ) (SFYResponder から継承) 実領域を取得します。
VoidPtr	GetReference( Void ) (SFYResponder から継承) リファレンス値を取得します。
SFYRendererPtr	GetRenderer( Void ) (SFYResponder から継承) 描画エンジンを取得します。
SFYResponderSmp	GetRoot( Void ) (SFYResponder から継承) ルートレスポンダを取得します。
SInt16	GetScrollRange( Void ) (SFYScrollBarControl から継承) Scroll Range を取得します。
SInt32	GetScrollStepValue( Void ) (SFYScrollBarControl から継承) スクロール ステップの値を取得します。
Bool	GetStateActive( Bool inherit = false ) (SFYResponder から継承) 活性状態を取得します。
Bool	GetStateEnable( Bool inherit = false ) (SFYResponder から継承) 操作可能状態を取得します。
Bool	GetStateFocus( Bool inherit = false ) (SFYResponder から継承) フォーカス状態を取得します。
Bool	GetStateVisible( Bool inherit = false ) (SFYResponder から継承) 可視状態を取得します。
SFXRectangle	GetSuitableBound( Void ) (SFYResponder から継承) GetSuitableBound( SFXRectangleConstRef param ) (SFYResponder から継承) 最適な大きさを取得します。
SFXMargin	GetSuitableMargin( Void ) (SFYResponder から継承) 最適な余白を取得します。
SInt16	GetThumbLength( Void ) (SFYScrollBarControl から継承) Thumb の長さを取得します。
SInt16	GetThumbTop( Void ) (SFYScrollBarControl から継承) Thumb Top の位置を取得します。
SFXRGBColorConstRef	GetTrackColor( Void ) (SFYScrollBarControl から継承) Track の色を取得します。
SFCType	GetType( Void ) (SFYResponder から継承) タイプを取得します。
SFXRectangleConstRef	GetVirtualBound( Void ) (SFYResponder から継承) 仮想領域を取得します。
Bool	Increment( Void ) (SFYScrollBarControl から継承) スクロール ステップの値を増やします。
Void	Initialize( Void ) (SFYResponder から継承) レスポンダを初期化します。
Void	Invalidate( Void ) (SFYResponder から継承) Invalidate( SFXRectangleConstRef param ) (SFYResponder から継承) 再描画領域を登録します。
Void	InvokeBackward( SFXEventConstRef event , Bool overload , BoolPtr result = null ) (SFYResponder から継承) レスポンダにイベントを送信します。ハンドラ関数はハンドラリストに登録された順序で呼び出されます。
Void	InvokeForward( SFXEventConstRef event , Bool overload , BoolPtr result = null ) (SFYResponder から継承) レスポンダにイベントを送信します。ハンドラ関数はハンドラリストに登録された逆順で呼び出されます。
Bool	IsBack( Void ) (SFYResponder から継承) IsBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) IsBack( UInt32 id ) (SFYResponder から継承) IsBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 自レスポンダが最背面に位置するかどうかを判定します。
Bool	IsFront( Void ) (SFYResponder から継承) IsFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) IsFront( UInt32 id ) (SFYResponder から継承) IsFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 自レスポンダが最前面に位置するかどうかを判定します。
Bool	IsNthBackward( SInt32 index ) (SFYResponder から継承) IsNthBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) IsNthBackward( SInt32 index , UInt32 id ) (SFYResponder から継承) IsNthBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 自レスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
Bool	IsNthForward( SInt32 index ) (SFYResponder から継承) IsNthForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) IsNthForward( SInt32 index , UInt32 id ) (SFYResponder から継承) IsNthForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 自レスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
Bool	IsRoot( Void ) (SFYResponder から継承) 自レスポンダがルートレスポンダかどうかを判定します。
SFCError	RegisterHandler( SFXEventRangeConstRef range , SFYHandler::RuleRecConstRef rule ) (SFYResponder から継承) RegisterHandler( SFXEventRangeConstPtr range , SFYHandler::HandlerSPPConstPtr spp , VoidPtrConstPtr reference , SInt32 length ) (SFYResponder から継承) RegisterHandler( SFXEventRangeConstPtr range , SFYHandler::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承) RegisterHandler( SFXEventRangeConstRef range , SFYHandler::HandlerSPP spp , VoidPtr reference ) (SFYResponder から継承) ハンドラを登録します。
SFCError	RegisterTracer( SFXEventRangeConstRef range , SFYTracer::RuleRecConstRef rule ) (SFYResponder から継承) RegisterTracer( SFXEventRangeConstPtr range , SFYTracer::OrderEnumConstPtr order , SFYTracer::StateEnumConstPtr state , BoolConstPtr overload , SInt32 length ) (SFYResponder から継承) RegisterTracer( SFXEventRangeConstPtr range , SFYTracer::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承) RegisterTracer( SFXEventRangeConstRef range , SFYTracer::OrderEnum order , SFYTracer::StateEnum state , Bool overload ) (SFYResponder から継承) トレーサを登録します。
SFCError	Render( Bool force = false ) (SFYResponder から継承) 描画エンジンを起動して再描画します。
Void	SetAlwaysVisible( Bool param ) (SFYScrollBarControl から継承) 常にスクロールバーを表示するかどうかを設定します。
Void	SetArrowColor( SFXRGBColorConstRef param ) (SFYScrollBarControl から継承) スクロールバーの矢印の色を設定します。
Void	SetBackgroundColor( SFXRGBColorConstRef param ) (SFYWidget から継承) 背景の色を設定します。
Void	SetBevelColor( SFXBevelColorConstRef param ) (SFYScrollBarControl から継承) 3D のスクロールバーを描画するためのベベルカラーを設定します。
Void	SetCurrentValue( SInt32 param ) (SFYControl から継承) コントロールの現在値を設定します。
Void	SetDistributer( SFYDistributerPtr param ) (SFYResponder から継承) 配信エンジンを設定します。
Void	SetID( UInt32 param ) (SFYResponder から継承) ID を設定します。
Void	SetMaximumValue( SInt32 param ) (SFYControl から継承) コントロールの最大値を設定します。
Void	SetMinimumValue( SInt32 param ) (SFYControl から継承) コントロールの最小値を設定します。
Void	SetOrientation( OrientationEnum param ) (SFYScrollBarControl から継承) スクロールバーの方向を設定します。
Void	SetPageValue( SInt32 param ) (SFYScrollBarControl から継承) ページ サイズを設定します。
SFCError	SetParent( SFYResponderSmpConstRef param ) (SFYResponder から継承) 親レスポンダを設定します。
Void	SetProperty( Bool transparent ) (SFYResponder から継承) 属性をまとめて設定します。
Void	SetPropertyTransparent( Bool param ) (SFYResponder から継承) 透過属性を設定します。
Void	SetRealBound( SFXRectangleConstRef param ) (SFYResponder から継承) 実領域を設定します。
Void	SetReference( VoidPtr param ) (SFYResponder から継承) リファレンス値を設定します。
Void	SetRenderer( SFYRendererPtr param ) (SFYResponder から継承) 描画エンジンを設定します。
Void	SetScrollStepValue( SInt32 param ) (SFYScrollBarControl から継承) スクロール ステップの値を設定します。
Void	SetState( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 状態をまとめて設定します。
Void	SetStateActive( Bool param ) (SFYResponder から継承) 活性状態を設定します。
Void	SetStateEnable( Bool param ) (SFYResponder から継承) 操作可能状態を設定します。
Void	SetStateFocus( Bool param ) (SFYResponder から継承) フォーカス状態を設定します。
Void	SetStateVisible( Bool param ) (SFYResponder から継承) 可視状態を設定します。
Void	SetTrackColor( SFXRGBColorConstRef param ) (SFYScrollBarControl から継承) Track の色を設定します。
Void	SetVirtualBound( SFXRectangleConstRef param ) (SFYResponder から継承) 仮想領域を設定します。
Void	Terminate( Void ) (SFYResponder から継承) レスポンダの終了処理をします。
Void	ToBack( Void ) (SFYResponder から継承) ToBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) ToBack( UInt32 id ) (SFYResponder から継承) ToBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 自レスポンダを姉妹レスポンダのなかで最背面に移動します。
Void	ToFront( Void ) (SFYResponder から継承) ToFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) ToFront( UInt32 id ) (SFYResponder から継承) ToFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 自レスポンダを姉妹レスポンダのなかで最前面に移動します。
Void	ToNthBackward( SInt32 index ) (SFYResponder から継承) ToNthBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) ToNthBackward( SInt32 index , UInt32 id ) (SFYResponder から継承) ToNthBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 自レスポンダを背面から数えて指定された順番に移動します。
Void	ToNthForward( SInt32 index ) (SFYResponder から継承) ToNthForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) ToNthForward( SInt32 index , UInt32 id ) (SFYResponder から継承) ToNthForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承) 自レスポンダを前面から数えて指定された順番に移動します。
Void	UnregisterHandler( SFXEventRangeConstRef range , SFYHandler::RuleRecConstRef rule ) (SFYResponder から継承) UnregisterHandler( SFXEventRangeConstPtr range , SFYHandler::HandlerSPPConstPtr spp , VoidPtrConstPtr reference , SInt32 length ) (SFYResponder から継承) UnregisterHandler( SFXEventRangeConstPtr range , SFYHandler::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承) UnregisterHandler( SFXEventRangeConstRef range , SFYHandler::HandlerSPP spp , VoidPtr reference ) (SFYResponder から継承) ハンドラの登録を解除します。
Void	UnregisterTracer( SFXEventRangeConstRef range ) (SFYResponder から継承) UnregisterTracer( SFXEventRangeConstPtr range , SInt32 length ) (SFYResponder から継承) トレーサの登録を解除します。
T const &	static_catch( Void ) (static_exception から継承) 現在保持している例外を取得します。

プロテクト関数
Void	HandleRenderRequest( SFXGraphicsPtr graphics ) スクロールバーを描画します。
SFXRectangle	DrawDecrement( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle ) (SFYScrollBarControl から継承) 増分領域を描画します。
SFXRectangle	DrawIncrement( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle ) (SFYScrollBarControl から継承) 減分領域を描画します。
Void	DrawThumb( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle ) (SFYScrollBarControl から継承) サム領域を描画します。
SFXRectangle	DrawTrack( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle ) (SFYScrollBarControl から継承) トラック領域を描画します。
static SFYResponderSmp	Factory( SFYResponderPtr responder , SFCErrorPtr exception = null ) (SFYResponder から継承) NewInstance 関数の実装を補助します。
SFYResponderSmp	GetThis( Void ) (SFYResponder から継承) スマートポインタで保持された this を取得します。
Void	HandleBoundGlobal( SFXRectangleConstRef rectangle ) (SFYWidget から継承) グローバル領域の変更処理を行います。
Void	HandleBoundOptimize( SFXRectanglePtr rectangle ) (SFYWidget から継承) 指定した矩形に収まる範囲内で最適なサイズを計算します。
Void	HandleBoundReal( Void ) (SFYScrollBarControl から継承) 実領域が変化した時の処理を行います。
Void	HandleBoundRequest( SFXRectanglePtr rectangle ) (SFYWidget から継承) 最適な矩形を計算します。
Void	HandleBoundVirtual( Void ) (SFYScrollBarControl から継承) 仮想領域の変更処理を行います。
Void	SetType( SFCType param ) (SFYResponder から継承) タイプを設定します。
Void	UpdateScrollBar( Void ) (SFYScrollBarControl から継承) サムの大きさと位置、スクロール範囲を調整します。
Void	static_throw( static_exception< T > const & param ) (static_exception から継承) static_throw( T const & param ) (static_exception から継承) 例外を設定します。
Bool	static_try( Void ) (static_exception から継承) 例外が保持されているかどうかを確かめます。

型
CodeEnum SFZBandScrollBarControl クラスを表す定数です。
OrientationEnum (SFYScrollBarControl から継承) スクロールバーの方向を表す定数です。

[ protected, explicit ]
SFZBandScrollBarControl(Void);

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

解説

SFZBandScrollBarControl::UnBind を呼び出します。

[ public, virtual ]
SFCError Bind(
    SFYBandControlSmpConstRef bandcontrol   // スクロールする対象となる帯コントロール
);

戻り値

解説

対象の帯コントロールに値変更通知ハンドラ(※1)をインストールし、自動スクロール機能を提供します。

自動スクロール機能を解除する場合は、SFZBandScrollBarControl::UnBind を呼び出します。

(※1) 帯コントロールの値(最小値、最大値、トップ値、フィールド値)を読みとり、スクロールバーの値に反映させます。

帯コントロールの値とスクロールバーの値の対応付けを以下に示します。

参照

SFZBandScrollBarControl::UnBind

[ protected, virtual, const ]
Void HandleRenderRequest(
    SFXGraphicsPtr graphics   // グラフィックスオブジェクト
);

解説

この関数は、(SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) イベントを受信してから呼び出されます。

開発者は、スクロールバーを描画するこの関数をオーバーライドできます。

実装は、以下の呼び出しです。

DrawThumb(graphics, DrawIncrement(graphics, DrawDecrement(graphics, DrawTrack(graphics, GetLocalBound()))));

参照

SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | 描画イベント(SFEVT_RESPONDER_RENDER) | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理

[ public, static ]
SFZBandScrollBarControlSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);

引数

戻り値

解説

SFZBandScrollBarControl クラスの新しいインスタンスを作成します。

作成に成功した場合は null 以外のポインタを返し、exception 引数は常に SFERR_NO_ERROR になります。メモリ不足などで作成に失敗した場合は null ポインタを返し、exception 引数にエラー値が返ります。

使用例

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

// スクロールバーのインスタンスを生成する
SFCError error;
SFZBandScrollBarControlSmp _bar;

if ((_bar = SFZBandScrollBarControl::NewInstance(&error)) != null) {
    	...
}

[ public, virtual ]
Void UnBind(Void);

解説

対象となる帯コントロールから値変更通知ハンドラをアンインストールし、自動スクロール機能を解除します。

SFZBandScrollBarControl::Bind 内やデスクトラクタ内でも呼び出されます。

帯コントールからスクロールバーを明示的に取り外すときに呼び出します。

参照

SFZBandScrollBarControl::Bind SFZBandScrollBarControl::~SFZBandScrollBarControl

enum CodeEnum {
    CODE_TYPE = four_char_code('c', 'b', 's', 'b')
};
SFMTYPEDEFTYPE(CodeEnum)

参照

SFYResponder::GetType | SFYResponder::SetType