DockableWindow

ドッキングウィンドウ (DockableWindow) 要素は基本のウィンドウ機能を提供し、複数のドッキングウィンドウが1つあるいは複数のグループに結合することを実現させます。

Summary
DockableWindowドッキングウィンドウ (DockableWindow) 要素は基本のウィンドウ機能を提供し、複数のドッキングウィンドウが1つあるいは複数のグループに結合することを実現させます。
XML定義
XMLタグ
必須属性
szTabDefドッキングウィンドウでタブとして使用するボタン定義の名前。
ウィンドウ コールバック
コールバック
OnDockウインドウがドッキングした時に呼び出されます。
OnUnDockウィンドウのドッキングが解除された時に呼び出されます。
OnPositionTabsウィンドウにタブが配置された時に呼び出されます。
関数
関数
DockableWindowGetTabString()ドッキングウィンドウのタブボタンに表示されているテキストを返します。
DockableWindowSetTabString()タブボタン上に表示するテキストを設定します。
DockableWindowSetTabOffset()最初のタブのウインドウの左上角からのオフセット値を設定します。
DockableWindowGetTabOffset()指定したウィンドウの最初のタブのオフセット値を返します。
DockableWindowDock()子ウィンドウを指定ウィンドウにドッキングさせます。
DockableWindowUnDock()子ウィンドウと指定ウィンドウのドッキングを解除します。
DockableWindowGetRootName()ドッキングウィンドウグループのルートウィンドウの名前の文字列を返します。
DockableWindowSetTopWindow()指定したウィンドウをドッキングウィンドウグループのトップウィンドウに設定します。
DockableWindowGetTopWindowName()ドッキングウインドウグループのトップウインドウの名前の文字列を返します。
DockableWindowGetChildName()ドッキングウィンドウグループの子ウィンドウの名前の文字列を返します。
DockableWindowSetOffsetOnRootDelete()ルートウィンドウが削除された時に使用する親オフセットを設定します。
DockableWindowIsChildOf()ウィンドウがルートウィンドウの子であるかどうかを調べます。
DockableWindowSetMovable()ドッキングウィンドウグループの子ウィンドウを移動できるようにします。
DockableWindowSetTabShowing()ドッキングウィンドウのタブを画面上に表示（そして描画）するかどうかを設定します。
DockableWindowGetTabShowing()ドッキングウインドウのタブの現在の表示状態を返します。
DockableWindowSetAllTabsAlpha()ドッキングウィンドウの全てのタブにアルファ値を設定します。

XML定義

Summary
XMLタグ
必須属性
szTabDefドッキングウィンドウでタブとして使用するボタン定義の名前。

XMLタグ

<DockableWindow>
....
</DockableWindow>

代替グループ

必須属性

szTabDef

ドッキングウィンドウでタブとして使用するボタン定義の名前。

このボタン定義にはテキストコンポーネントが必要です。

データ型

string有効な Button の名前。

デフォルト値

  • ””

ウィンドウ コールバック

Summary
コールバック
OnDockウインドウがドッキングした時に呼び出されます。
OnUnDockウィンドウのドッキングが解除された時に呼び出されます。
OnPositionTabsウィンドウにタブが配置された時に呼び出されます。

コールバック

OnDock

ウインドウがドッキングした時に呼び出されます。

構文

SomeWindowName.OnDock(RootWindowName, ChildWindowName)

データ型

RootWindowName(string) 子がドッキングされたルートウィンドウの名前。
ChildWindowName(string) ドッキングされた子ウィンドウの名前。

OnUnDock

ウィンドウのドッキングが解除された時に呼び出されます。

構文

SomeWindowName.OnUnDock(RootWindowName, ChildWindowName)

データ型

RootWindowName(string) 子のドッキングが解除されたルートウィンドウの名前。
ChildWindowName(string) ドッキングを解除した子ウィンドウの名前。

OnPositionTabs

ウィンドウにタブが配置された時に呼び出されます。

構文

SomeWindowName.OnPositionTabs(TabHeight)

データ型

TabHeight(integer) タブによって使われる縦幅のオフセット。

関数

Summary
関数
DockableWindowGetTabString()ドッキングウィンドウのタブボタンに表示されているテキストを返します。
DockableWindowSetTabString()タブボタン上に表示するテキストを設定します。
DockableWindowSetTabOffset()最初のタブのウインドウの左上角からのオフセット値を設定します。
DockableWindowGetTabOffset()指定したウィンドウの最初のタブのオフセット値を返します。
DockableWindowDock()子ウィンドウを指定ウィンドウにドッキングさせます。
DockableWindowUnDock()子ウィンドウと指定ウィンドウのドッキングを解除します。
DockableWindowGetRootName()ドッキングウィンドウグループのルートウィンドウの名前の文字列を返します。
DockableWindowSetTopWindow()指定したウィンドウをドッキングウィンドウグループのトップウィンドウに設定します。
DockableWindowGetTopWindowName()ドッキングウインドウグループのトップウインドウの名前の文字列を返します。
DockableWindowGetChildName()ドッキングウィンドウグループの子ウィンドウの名前の文字列を返します。
DockableWindowSetOffsetOnRootDelete()ルートウィンドウが削除された時に使用する親オフセットを設定します。
DockableWindowIsChildOf()ウィンドウがルートウィンドウの子であるかどうかを調べます。
DockableWindowSetMovable()ドッキングウィンドウグループの子ウィンドウを移動できるようにします。
DockableWindowSetTabShowing()ドッキングウィンドウのタブを画面上に表示（そして描画）するかどうかを設定します。
DockableWindowGetTabShowing()ドッキングウインドウのタブの現在の表示状態を返します。
DockableWindowSetAllTabsAlpha()ドッキングウィンドウの全てのタブにアルファ値を設定します。

関数

DockableWindowGetTabString()

ドッキングウィンドウのタブボタンに表示されているテキストを返します。

パラメータ

dockableWindowName(string) ドッキングウインドウの名前。

戻り値

szTabString(string) 表示されているテキスト。

例

local szTabString = DockableWindowGetTabString( dockableWindowName )

DockableWindowSetTabString()

タブボタン上に表示するテキストを設定します。

パラメータ

dockableWindowName(string) ドッキングウインドウの名前。
text(wstring) 表示するテキスト。

戻り値

nil戻り値無し。

例

DockableWindowSetTabString("ChatWindow", GetString( StringTables.Default.LABEL_ACCEPT ))

DockableWindowSetTabOffset()

最初のタブのウインドウの左上角からのオフセット値を設定します。

パラメータ

windowName(string) ウィンドウの名前。
offset(integer) タブのオフセット値。

戻り値

nil戻り値無し。

例

DockableWindowSetTabOffset( "ChatWindow", 10 )

DockableWindowGetTabOffset()

指定したウィンドウの最初のタブのオフセット値を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

offset(integer) タブのオフセット値。

例

local offset = DockableWindowGetTabOffset( <SystemData.ActiveWindow.name> )

DockableWindowDock()

子ウィンドウを指定ウィンドウにドッキングさせます。

パラメータ

dockableRootWindowName(string) ルートになるドッキングウインドウの名前。
dockableChildWindowName(string) ルートにドッキングされる子ウィンドウの名前。

戻り値

nil戻り値無し。

例

DockableWindowDock( dockableRootWindowName, dockableChildWindowName )

DockableWindowUnDock()

子ウィンドウと指定ウィンドウのドッキングを解除します。

パラメータ

dockableRootWindowName(string) ウィンドウグループのルートであるドッキングウィンドウの名前。
dockableChildWindowName(string) ルートウィンドウとのドッキングを解除する子ウィンドウの名前。

戻り値

nil戻り値無し。

例

DockableWindowUnDock( dockableRootWindowName, dockableChildWindowName )

DockableWindowGetRootName()

ドッキングウィンドウグループのルートウィンドウの名前の文字列を返します。

パラメータ

dockableWindowName(string) 名前を調べたいルートウィンドウを持つドッキングウインドウの名前。

戻り値

szRootName(string) ルートウィンドウの名前。そのウィンドウがルートならば、そのウィンドウ名が戻ります。

例

DockableWindowGetRootName( dockableWindowName )

DockableWindowSetTopWindow()

指定したウィンドウをドッキングウィンドウグループのトップウィンドウに設定します。

パラメータ

rootWindowName(string) ルートのドッキングウィンドウの名前。
topWindowName(string) トップにセットされるドッキングウィンドウの名前。

戻り値

nil戻り値無し。

例

DockableWindowSetTopWindow( rootWindowName, topWindowName )

DockableWindowGetTopWindowName()

ドッキングウインドウグループのトップウインドウの名前の文字列を返します。

パラメータ

dockableWindowName(string) 名前を調べたいトップウィンドウを持つドッキングウィンドウの名前。

戻り値

szTopName(string) トップウインドウの名前。

例

DockableWindowGetTopWindowName( dockableWindowName )

DockableWindowGetChildName()

ドッキングウィンドウグループの子ウィンドウの名前の文字列を返します。

パラメータ

dockableWindowName(string) 名前を調べたい子ウィンドウを持つドッキングウィンドウの名前。
index(integer) アクセスしたい子のインデックス。もし子の数よりも大きい場合は、空の文字列が戻ります。

戻り値

szChildName(string) 子ウィンドウの名前。

例

DockableWindowGetChildName( dockableWindowName, index )

DockableWindowSetOffsetOnRootDelete()

ルートウィンドウが削除された時に使用する親オフセットを設定します。

パラメータ

windowName(string) ウィンドウの名前。
x(integer) ルートウィンドウ削除時に親オフセットとして設定するXオフセット。
y(integer) ルートウィンドウ削除時に親オフセットとして設定するYオフセット。

戻り値

nil戻り値無し。

例

DockableWindowSetOffsetOnRootDelete( "ChatWindow", 10, 143 )

DockableWindowIsChildOf()

ウィンドウがルートウィンドウの子であるかどうかを調べます。

パラメータ

RootWindowName(string) ルートウィンドウの名前。
windowName(string) 子状態を調べたいウィンドウの名前。

戻り値

booleanウィンドウがルートウィンドウの子である場合はtrueを返します。

例

DockableWindowIsChildOf("ChatWindow", "CombatWindow")

DockableWindowSetMovable()

ドッキングウィンドウグループの子ウィンドウを移動できるようにします。

パラメータ

dockableWindowName(string) 名前を調べたいウィンドウを子に持つドッキングウィンドウの名前。
bMovable(boolean) true = 移動できるようにする, false = 移動できるようにしない

戻り値

nil戻り値無し。

例

DockableWindowSetMovable( dockableWindowName, bMovable )

DockableWindowSetTabShowing()

ドッキングウィンドウのタブを画面上に表示（そして描画）するかどうかを設定します。

ウィンドウのタブが表示されていない場合、更新やマウスイベントを受け付けません。ジェネリックイベントハンドラは処理されます。

パラメータ

windowName(string) ドッキングウィンドウの名前。
showing(boolean) そのタブは描画されるべきか否か？

戻り値

nil戻り値無し。

例

DockableWindowSetTabShowing(dockableWindowName, bShow )

DockableWindowGetTabShowing()

ドッキングウインドウのタブの現在の表示状態を返します。

パラメータ

windowName(string) ドッキングウィンドウウィンドウの名前。

戻り値

shown(boolean) true = ウィンドウが表示されている, false = 表示されていない

例

local bShown = DockableWindowGetTabShowing( "ChatWindow" )

DockableWindowSetAllTabsAlpha()

ドッキングウィンドウの全てのタブにアルファ値を設定します。

パラメータ

alphaValue(integer) 全てのタブに設定するアルファ値。

戻り値

nil戻り値無し。

例

DockableWindowSetAllTabsAlpha( alphaValue )
ウィンドウ (Window) 要素はウィンドウを作成する際に使用する基本的な要素です。他のウィンドウ要素もこの要素の内容を継承しており、全ての属性、要素、データメンバー、関数をサポートしています。
ボタン (Button) 要素は、マウスカーソルの状態に応じて自動的にテクスチャやフォントカラーを変更するなどといった、一般的なボタン要素を自動化します。
Close