HorizontalScrollbar

水平スクロールバー (HorizontalScrollbar) は、自動的なスクロールバー機能を持つ複合ウィンドウ要素です。

Summary

HorizontalScrollbar	水平スクロールバー (HorizontalScrollbar) は、自動的なスクロールバー機能を持つ複合ウィンドウ要素です。
実装の詳細	水平スクロールバーはスクロールバー機能を自動化する複合ウィンドウ要素です。スクロールバーは独立して使用することもできますが、水平スクロールバーのような他のスクロールウィンドウのコンポーネントとして使われることが大半です。
XML定義
XMLタグ
必須属性
up	UPボタンに使用するボタン定義の名前。
down	DOWNボタンに使用するボタン定義の名前。
thumb	可変スクロールバーサムに使用する水平リサイズイメージの名前。
gutter	スクロールエリアの背景に使用する水平リサイズイメージの名前。
任意要素
UpOffset	スクロールバー左上角からのUPボタンのオフセット。
DownOffset	スクロールバー左下角からのDOWNボタンのオフセット。
ThumbOffset	スクロールバーウの左上角からのサムのオフセット。
ActiveZoneOffset	アクティブゾーンはスクロールバーの範囲外ですが、（範囲内でドラッグを始めた）スクロールバーをクリックしたままドラッグし続けられるエリアです。
ウィンドウコールバック
コールバック
OnScrollPosChanged	スクロール位置が変化した時に呼び出されます。
関数
関数
HorizontalScrollbarSetScrollPosition()	現在のスクロール位置を設定します。
HorizontalScrollbarGetScrollPosition()	現在のスクロール位置を返します。
HorizontalScrollbarSetMaxScrollPosition()	最大スクロール位置を設定します。
HorizontalScrollbarGetMaxScrollPosition()	最大スクロール位置を返します。
HorizontalScrollbarSetPageSize()	ページサイズを設定します。
HorizontalScrollbarGetPageSize()	ページサイズを返します。
HorizontalScrollbarSetLineSize()	ラインサイズを設定します。
HorizontalScrollbarGetLineSize()	ラインサイズを返します。

実装の詳細

水平スクロールバーはスクロールバー機能を自動化する複合ウィンドウ要素です。スクロールバーは独立して使用することもできますが、水平スクロールバーのような他のスクロールウィンドウのコンポーネントとして使われることが大半です。

コンポーネント

UP矢印用の Button 定義。
DOWN矢印用の Button 定義。
スクロールバー背景用の HorizontalResizeImage 。
スクロールサム用の HorizontalResizeImage 。

スクロールバーのサイズが決まると、それに合うように背景画像のサイズも変更されます。他のウィンドウ要素の一部として使用された場合、スクロールバーサムは自動的にサイズと位置を変更して親ウィンドウのデータを反映します。

Luaを通じて自作のスクロールバーを使用する場合、用いるデータに従って以下の値を設定する必要があります

lineSize	単体ラインの縦幅。 ( HorizontalScrollbarSetLineSize() と HorizontalScrollbarGetLineSize() を使用します)
pageSize	ページ全体の縦幅。 ( HorizontalScrollbarSetPageSize() と HorizontalScrollbarGetPageSize() を使用します)
maxScroll	スクロール範囲の最大値。 ( HorizontalScrollbarSetMaxScrollPosition() と HorizontalScrollbarGetMaxScrollPosition() を使用します)

XML定義

Summary

XMLタグ
必須属性
up	UPボタンに使用するボタン定義の名前。
down	DOWNボタンに使用するボタン定義の名前。
thumb	可変スクロールバーサムに使用する水平リサイズイメージの名前。
gutter	スクロールエリアの背景に使用する水平リサイズイメージの名前。
任意要素
UpOffset	スクロールバー左上角からのUPボタンのオフセット。
DownOffset	スクロールバー左下角からのDOWNボタンのオフセット。
ThumbOffset	スクロールバーウの左上角からのサムのオフセット。
ActiveZoneOffset	アクティブゾーンはスクロールバーの範囲外ですが、（範囲内でドラッグを始めた）スクロールバーをクリックしたままドラッグし続けられるエリアです。

XMLタグ

<HorizontalScrollbar>
....
</HorizontalScrollbar>

代替グループ

Window

必須属性

up

UPボタンに使用するボタン定義の名前。

データ型

string

有効な Button の名前。

デフォルト値

””

down

DOWNボタンに使用するボタン定義の名前。

データ型

string

有効な Button の名前。

デフォルト値

””

thumb

可変スクロールバーサムに使用する水平リサイズイメージの名前。

データ型

string

有効な HorizontalResizeImage の名前。

デフォルト値

””

gutter

スクロールエリアの背景に使用する水平リサイズイメージの名前。

データ型

string

有効な HorizontalResizeImage の名前。

デフォルト値

””

任意要素

UpOffset

スクロールバー左上角からのUPボタンのオフセット。

構文

<UpOffset x="2" y="0" />

x	ウインドウ左上角からのXピクセルオフセット。
y	ウインドウ左上角からのYピクセルオフセット。

デフォルト値

x	0
y	0

DownOffset

スクロールバー左下角からのDOWNボタンのオフセット。

構文

<DownOffset x="2" y="0" />

x	ウインドウ左下角からのXピクセルオフセット。
y	ウインドウ左上角からのYピクセルオフセット。

デフォルト値

x	0
y	0

ThumbOffset

スクロールバーウの左上角からのサムのオフセット。

構文

<ThumbOffset x="2" y="0" />

x	ウインドウ左上角からのXピクセルオフセット。
y	ウインドウ左上角からのYピクセルオフセット。

デフォルト値

x	0
y	0

ActiveZoneOffset

アクティブゾーンはスクロールバーの範囲外ですが、（範囲内でドラッグを始めた）スクロールバーをクリックしたままドラッグし続けられるエリアです。

Windowsはスクロールバーの両脇におよそ100ピクセルのアクティブゾーンを持っているようです。

構文

<ActiveZoneOffset x="100" y="0" />

x	スクロールバーの両側からのXピクセル距離。
y	スクロールバーの両側からのYピクセル距離。

デフォルト値

x	0
y	0

ウィンドウコールバック

Summary

コールバック
OnScrollPosChanged	スクロール位置が変化した時に呼び出されます。

コールバック

OnScrollPosChanged

スクロール位置が変化した時に呼び出されます。

構文

SomeHorizontalScrollBar.OnScrollPosChanged( scrollPos )

scrollPos

(integer) 現在のスクロール位置 (1からスクロールサイズ／ページサイズまで)。

関数

Summary

関数
HorizontalScrollbarSetScrollPosition()	現在のスクロール位置を設定します。
HorizontalScrollbarGetScrollPosition()	現在のスクロール位置を返します。
HorizontalScrollbarSetMaxScrollPosition()	最大スクロール位置を設定します。
HorizontalScrollbarGetMaxScrollPosition()	最大スクロール位置を返します。
HorizontalScrollbarSetPageSize()	ページサイズを設定します。
HorizontalScrollbarGetPageSize()	ページサイズを返します。
HorizontalScrollbarSetLineSize()	ラインサイズを設定します。
HorizontalScrollbarGetLineSize()	ラインサイズを返します。

関数