The DockableWindow provides basic window functionality and allows multiple DockableWindows to be joined together in one or more groups.
| DockableWindow | The DockableWindow provides basic window functionality and allows multiple DockableWindows to be joined together in one or more groups. |
| Implementation Details | |
| XML Definition | |
| XML Tag | |
| Required Attributes | You need to specify valid values for all of these elements to get the DockableWindow to create properly. |
| szTabDef | The name of a Button definition to use as the tab for the dockable window. |
| OnDock | Called when a window has been docked |
| OnUnDock | Called when a window has been undocked |
| OnPositionTabs | Called when a window’s tabs have been positioned |
| DockableWindowGetTabString() | Returns the string that is shown on the tab button for the dockable window. |
| Functions | |
| Functions | |
| DockableWindowSetTabString() | Sets the text displayed on the button |
| DockableWindowSetTabOffset() | Set’s the Offset of the first tab from the left side of the window. |
| DockableWindowGetTabOffset() | Returns the tab offset for the specified window. |
| DockableWindowDock() | |
| DockableWindowUnDock() | |
| DockableWindowGetRootName() | Returns the string name of the root window of the dockable window group |
| DockableWindowSetTopWindow() | |
| DockableWindowGetTopWindowName(dockableWindowName) | Returns the string name of the top window of the dockable window group |
| DockableWindowGetChildName(dockableWindowName, index) | Returns the string name of the child window of the dockable window group |
| DockableWindowSetOffsetOnRootDelete(windowName, x, y) | Set’s the parent offset to use when the root window is deleted. |
| DockableWindowIsChildOf(rootWindowName, windowName) | Returns true if the window is a child of the root window |
| DockableWindowSetMovable(dockableWindowName, bMovable) | Returns the string name of the child window of the dockable window group |
| DockableWindowSetTabShowing() | Sets if a dockable window’s tab should be shown (and drawn) on the screen. |
| DockableWindowSetAllTabsAlpha() | Sets if a dockable window’s tab should be shown (and drawn) on the screen. |
| WindowGetTabShowing() | Returns the current show state of the dockable window’s tab |
| XML Tag | |
| Required Attributes | You need to specify valid values for all of these elements to get the DockableWindow to create properly. |
| szTabDef | The name of a Button definition to use as the tab for the dockable window. |
| OnDock | Called when a window has been docked |
| OnUnDock | Called when a window has been undocked |
| OnPositionTabs | Called when a window’s tabs have been positioned |
| DockableWindowGetTabString() | Returns the string that is shown on the tab button for the dockable window. |
You need to specify valid values for all of these elements to get the DockableWindow to create properly.
Called when a window has been docked
SomeWindowName.OnDock(RootWindowName, ChildWindowName)
| RootWindowName | (string) This is the name of the root window that the child is being docked to |
| ChildWindowName | (string) This is the name of the child window that is being docked. |
Called when a window has been undocked
SomeWindowName.OnUnDock(RootWindowName, ChildWindowName)
| RootWindowName | (string) This is the name of the root window that the child is being undocked from |
| ChildWindowName | (string) This is the name of the child window that is being undocked. |
Called when a window’s tabs have been positioned
SomeWindowName.OnPositionTabs(TabHeight)
| TabHeight | (number) This is the height offset taken up by the tabs |
Returns the string that is shown on the tab button for the dockable window.
| dockableWindowName | (string) The name of the DockableWindow. |
| szTabString | (string) The string associated with the tab button of the dockable window. |
local szTabString = DockableWindowGetTabString( dockableWindowName )
| Functions | |
| DockableWindowSetTabString() | Sets the text displayed on the button |
| DockableWindowSetTabOffset() | Set’s the Offset of the first tab from the left side of the window. |
| DockableWindowGetTabOffset() | Returns the tab offset for the specified window. |
| DockableWindowDock() | |
| DockableWindowUnDock() | |
| DockableWindowGetRootName() | Returns the string name of the root window of the dockable window group |
| DockableWindowSetTopWindow() | |
| DockableWindowGetTopWindowName(dockableWindowName) | Returns the string name of the top window of the dockable window group |
| DockableWindowGetChildName(dockableWindowName, index) | Returns the string name of the child window of the dockable window group |
| DockableWindowSetOffsetOnRootDelete(windowName, x, y) | Set’s the parent offset to use when the root window is deleted. |
| DockableWindowIsChildOf(rootWindowName, windowName) | Returns true if the window is a child of the root window |
| DockableWindowSetMovable(dockableWindowName, bMovable) | Returns the string name of the child window of the dockable window group |
| DockableWindowSetTabShowing() | Sets if a dockable window’s tab should be shown (and drawn) on the screen. |
| DockableWindowSetAllTabsAlpha() | Sets if a dockable window’s tab should be shown (and drawn) on the screen. |
| WindowGetTabShowing() | Returns the current show state of the dockable window’s tab |
Sets the text displayed on the button
| dockableWindowName | (string) The name of the dockable window. |
| text | (wstring) The text string. |
| nil | no return value |
DockableWindowSetTabString("ChatWindow", GetString( StringTables.Default.LABEL_ACCEPT ))Set’s the Offset of the first tab from the left side of the window.
| windowName | (string) The name of the window. |
| offset | (number) The offset to use on the tab. May be any integer value. |
| nil | no return value |
DockableWindowSetTabOffset( "ChatWindow", 10 )
Returns the tab offset for the specified window.
| windowName | (string) The name of the window. |
| offset | (number) The tab offset value for the window. |
local offset = DockableWindowGetTabOffset( <SystemData.ActiveWindow.name> )
| dockableRootWindowName | (string) The name of the DockableWindow that will be the root. |
| dockableChildWindowName | (string) The name of the DockableWindow that will be docked to the root. |
| nil | no return value |
DockableWindowDock( dockableRootWindowName, dockableChildWindowName )
| dockableRootWindowName | (string) The name of the DockableWindow that is the root of the window group. |
| dockableChildWindowName | (string) The name of the DockableWindow that will be unddocked from the root. |
| nil | no return value |
DockableWindowUnDock( dockableRootWindowName, dockableChildWindowName )
Returns the string name of the root window of the dockable window group
| dockableWindowName | (string) The name of the DockableWindow who’s root we want the name of. |
| szRootName | (string) the name of the root window. If the window is the root the window name is returned. |
DockableWindowGetRootName( dockableWindowName )
| rootWindowName | (string) The name of the DockableWindow that is the root. |
| topWindowName | (string) The name of the DockableWindow that will be set to the top. |
| nil | no return value |
DockableWindowSetTopWindow( rootWindowName, topWindowName )
Returns the string name of the top window of the dockable window group
| dockableWindowName | (string) The name of the DockableWindow whose top window we want the name of. |
| szTopName | (string) the name of the top window. |
DockableWindowGetTopWindowName( dockableWindowName )
Returns the string name of the child window of the dockable window group
| dockableWindowName | (string) The name of the DockableWindow who’s child we want the name of. |
| index | (number) The index of the child we want to access. If this is greater than the number of children then we will return an empty string. |
| szChildName | (string) the name of the child window. |
DockableWindowGetChildName( dockableWindowName, index )
Set’s the parent offset to use when the root window is deleted.
| windowName | (string) The name of the window. |
| x | (number) The x offset to set the parent offset to when the root window is deleted. |
| y | (number) The y offset to set the parent offset to when the root window is deleted. |
| nil | no return value |
DockableWindowSetOffsetOnRootDelete( "ChatWindow", 10, 143 )
Returns true if the window is a child of the root window
| RootWindowName | (string) The name of the root window. |
| windowName | (string) The name of the window to check for child status. |
| bool | returns true if the window is a child of the root window |
DockableWindowIsChildOf("ChatWindow", "CombatWindow")Returns the string name of the child window of the dockable window group
| dockableWindowName | (string) The name of the DockableWindow who’s child we want the name of. |
| bMovable | (bool) True if it will now be movable and false if it will not |
No return value
DockableWindowSetMovable( dockableWindowName, bMovable )
Sets if a dockable window’s tab should be shown (and drawn) on the screen. When a window’s tab is not showing, it will not receive updates or mouse events. Generic event handlers will still be processed.
| windowName | (string) The name of the dockable window. |
| showing | (boolean) Should the tab be drawn? |
| nil | no return value |
DockableWindowSetTabShowing(dockableWindowName, bShow )
Sets if a dockable window’s tab should be shown (and drawn) on the screen. When a window’s tab is not showing, it will not receive updates or mouse events. Generic event handlers will still be processed.
| alphaValue | (number) The value to set all of the Tabs to. |
| nil | no return value |
DockableWindowSetAllTabsAlpha( alphaValue )