VerticalScrollbar

垂直スクロールバー (VerticalScrollbar) は、Windowsスタイルのスクロールバーを提供します。このウィンドウ要素は、自動的に他のいくつかのウィンドウコンポーネントを組み合わせたものです。

Summary
VerticalScrollbar垂直スクロールバー (VerticalScrollbar) は、Windowsスタイルのスクロールバーを提供します。このウィンドウ要素は、自動的に他のいくつかのウィンドウコンポーネントを組み合わせたものです。
実装の詳細垂直スクロールバーはスクロールバー機能を自動化する複合ウィンドウ要素です。スクロールバーは独立して使用することもできますが、 ListBoxScrollWindow 、または LogDisplay などの他のスクロールウィンドウのコンポーネントとして使われることが大半です。
XML定義
XMLタグ
必須属性
upUPボタンに使用されるボタン定義の名前。
downDOWNボタンに使用するボタン定義の名前。
thumb可変スクロールバーサムに使用する垂直リサイズイメージの名前。
gutterスクロールエリアの背景に使用する垂直リサイズイメージの名前。
任意属性
UpOffsetスクロールバーウインドウ上部からのUPボタンのオフセット。
DownOffsetDOWNボタン用のスクロールバー左下角からのオフセット。
ThumbOffsetスクロールバーウィンドウの左上からのサム(つまみ)のオフセット。
ActiveZoneOffsetアクティブゾーンはスクロールバーの範囲外のエリアですが、(範囲内エリアでドラッグを始めた)スクロールバーをクリックしたままドラッグし続けられる部分です。
ウィンドウ コールバック
コールバック
OnScrollPosChangedスクロール位置が変化した時に呼び出されます。
関数
関数
VerticalScrollbarSetScrollPosition()現在のスクロール位置を設定します。
VerticalScrollbarGetScrollPosition()現在のスクロール位置を返します。
VerticalScrollbarSetMaxScrollPosition()最大スクロール位置を設定します。
VerticalScrollbarGetMaxScrollPosition()最大スクロール位置を返します。
VerticalScrollbarSetPageSize()ページサイズを設定します。
VerticalScrollbarGetPageSize()ページサイズを返します。
VerticalScrollbarSetLineSize()ラインサイズを設定します。
VerticalScrollbarGetLineSize()ラインサイズを返します。

実装の詳細

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

コンポーネント

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

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

lineSize単体ラインの縦幅。 ( VerticalScrollbarSetLineSize()VerticalScrollbarGetLineSize() を使用します)
pageSizeページ全体の縦幅。 ( VerticalScrollbarSetPageSize()VerticalScrollbarGetPageSize() を使用します)
maxScrollスクロール範囲の最大値。 ( VerticalScrollbarSetMaxScrollPosition()VerticalScrollbarGetMaxScrollPosition() を使用します)

XML定義

Summary
XMLタグ
必須属性
upUPボタンに使用されるボタン定義の名前。
downDOWNボタンに使用するボタン定義の名前。
thumb可変スクロールバーサムに使用する垂直リサイズイメージの名前。
gutterスクロールエリアの背景に使用する垂直リサイズイメージの名前。
任意属性
UpOffsetスクロールバーウインドウ上部からのUPボタンのオフセット。
DownOffsetDOWNボタン用のスクロールバー左下角からのオフセット。
ThumbOffsetスクロールバーウィンドウの左上からのサム(つまみ)のオフセット。
ActiveZoneOffsetアクティブゾーンはスクロールバーの範囲外のエリアですが、(範囲内エリアでドラッグを始めた)スクロールバーをクリックしたままドラッグし続けられる部分です。

XMLタグ

<VerticalScrollbar>
....
</VerticalScrollbar>

代替グループ

必須属性

up

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

データ型

string有効な Button の名前。

デフォルト値

  • ””

down

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

データ型

string有効な Button の名前。

デフォルト値

  • ””

thumb

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

データ型

string有効な VerticalResizeImage の名前。

デフォルト値

  • ””

gutter

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

データ型

string有効な VerticalResizeImage の名前。

デフォルト値

  • ””

任意属性

UpOffset

スクロールバーウインドウ上部からのUPボタンのオフセット。

構文

<UpOffset x="2" y="0" />
xウインドウ左上角からのXピクセルオフセット。
yウインドウ左上角からのYピクセルオフセット。

デフォルト値

x0
y0

DownOffset

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

構文

<DownOffset x="2" y="0" />
xウインドウ左下角からのXピクセルオフセット。
yウインドウ左上角からのYピクセルオフセット。

デフォルト値

x0
y0

ThumbOffset

スクロールバーウィンドウの左上からのサム(つまみ)のオフセット。

構文

<ThumbOffset x="2" y="0" />
xウインドウ左上角からのXピクセルオフセット。
yウインドウ左上角からのYピクセルオフセット。

デフォルト値

x0
y0

ActiveZoneOffset

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

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

構文

<ActiveZoneOffset x="100" y="0" />
xスクロールバーの両側からのXピクセル距離。
yスクロールバーの両側からのYピクセル距離。

デフォルト値

x0
y0

ウィンドウ コールバック

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

コールバック

OnScrollPosChanged

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

構文

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

関数

Summary
関数
VerticalScrollbarSetScrollPosition()現在のスクロール位置を設定します。
VerticalScrollbarGetScrollPosition()現在のスクロール位置を返します。
VerticalScrollbarSetMaxScrollPosition()最大スクロール位置を設定します。
VerticalScrollbarGetMaxScrollPosition()最大スクロール位置を返します。
VerticalScrollbarSetPageSize()ページサイズを設定します。
VerticalScrollbarGetPageSize()ページサイズを返します。
VerticalScrollbarSetLineSize()ラインサイズを設定します。
VerticalScrollbarGetLineSize()ラインサイズを返します。

関数

VerticalScrollbarSetScrollPosition()

現在のスクロール位置を設定します。

パラメータ

verticalScrollbarName(string) 垂直スクロールバーの名前。
scrollPos(integer) 現在のスクロール位置。

戻り値

nil戻り値無し。

VerticalScrollbarSetScrollPosition("SomeScrollBar", 0 )

VerticalScrollbarGetScrollPosition()

現在のスクロール位置を返します。

パラメータ

verticalScrollbarName(string) 垂直スクロールバーの名前。

戻り値

scrollPos(integer) 現在のスクロール位置。

local scrollPos = VerticalScrollbarGetScrollPosition( "SomeScrollBar" )

VerticalScrollbarSetMaxScrollPosition()

最大スクロール位置を設定します。

パラメータ

verticalScrollbarName(string) 垂直スクロールバーの名前。
maxScrollPos(integer) 最大スクロール位置。

戻り値

nil戻り値無し。

VerticalScrollbarSetMaxScrollPosition("SomeScrollBar", 100 )

VerticalScrollbarGetMaxScrollPosition()

最大スクロール位置を返します。

パラメータ

verticalScrollbarName(string) 垂直スクロールバーの名前。

戻り値

maxScrollPos(integer) 最大スクロール位置。

関連するXML

local maxScrollPos = VerticalScrollbarGetMaxScrollPosition("SomeScrollBar" )

VerticalScrollbarSetPageSize()

ページサイズを設定します。

パラメータ

verticalScrollbarName(string) 垂直スクロールバーの名前。
pageSize(integer) ページサイズ。

戻り値

nil戻り値無し。

VerticalScrollbarSetPageSize("SomeScrollBar", 10 )

VerticalScrollbarGetPageSize()

ページサイズを返します。

パラメータ

verticalScrollbarName(string) 垂直スクロールバーの名前。

戻り値

pageSize(integer) 現在のページサイズ。

関連するXML

local pageSize = VerticalScrollbarGetPageSize("SomeScrollBar" )

VerticalScrollbarSetLineSize()

ラインサイズを設定します。

パラメータ

verticalScrollbarName(string) 垂直スクロールバーの名前。
lineSize(integer) ラインサイズ。

戻り値

nil戻り値無し。

VerticalScrollbarSetLineSize("SomeScrollBar", 10 )

VerticalScrollbarGetLineSize()

ラインサイズを返します。

パラメータ

verticalScrollbarName(string) 垂直スクロールバーの名前。

戻り値

lineSize(integer) 現在のラインサイズ。

関連するXML

local lineSize = VerticalScrollbarGetLineSize("SomeScrollBar" )
ウィンドウの一要素であるリストボックス (ListBox) は、大量のウィンドウ要素を手作業で割り当てることなく、大きなデータテーブルとして自動表示する手段を提供します。
スクロールウィンドウ (ScrollWindow) は、全ての子ウィンドウに垂直方向のスクロールパネルを提供するコンテナウィンドウです。
ログディスプレイ (LogDisplay) は、任意の数の TextLog を表示するためのスクロール表示機能を提供します。
ボタン (Button) 要素は、マウスカーソルの状態に応じて自動的にテクスチャやフォントカラーを変更するなどといった、一般的なボタン要素を自動化します。
垂直リサイズイメージ (VerticalResizeImage) 要素を使えば、あらゆる高さのウィンドウに適合する画像を自動的に作成することができます。
ラインサイズを設定します。
ラインサイズを返します。
ページサイズを設定します。
ページサイズを返します。
最大スクロール位置を設定します。
最大スクロール位置を返します。
ウィンドウ (Window) 要素はウィンドウを作成する際に使用する基本的な要素です。他のウィンドウ要素もこの要素の内容を継承しており、全ての属性、要素、データメンバー、関数をサポートしています。
表示するテクスチャの名前。
Close