The HorizontalScrollWindow is a container window that provides a horizontal scrolling panel for all of it’s child windows.
| HorizontalScrollWindow | The HorizontalScrollWindow is a container window that provides a horizontal scrolling panel for all of it’s child windows. |
| Implementation Details | To use a HorizontalScrollWindow, you add children as normal to it’s childscrollwindow. |
| XML Definition | This is the HorizontalScrollWindow XML definition. |
| XML Tag | |
| Required Attributes | Required for the window element to create itself properly. |
| childscrollwindow | Name of the child Window that contains all items you wish to scroll through. |
| scrollbar | Name of the child <HorizontalScrollBar> that is anchored at the appropriate location on the window. |
| lineheight | The line height to be used with the scrollbar. |
| autoHideScrollBar | Auto-hides the scroll bar when the window the contents scroll child is less than one page. |
| HorizontalScrollWindowSetOffset() | Sets the current scroll position offset. |
| HorizontalScrollWindowGetOffset() | Returns the current scroll position offset. |
| HorizontalScrollWindowUpdateScrollRect() | Updates the childscrollwindow and scrollbar to reflect it’s current contents. |
To use a HorizontalScrollWindow, you add children as normal to it’s childscrollwindow. This child window will resize as necissary to fit the lenght of your child windows when you call ScrollWindowUpdateScrollRect(). If the contents of the window extend beyond the size of the scroll window, the scrollbar will be shown and automatically update to reflect the lenght of your child windows.
(see ..\docs\images\HorizontalScrollWindow_Example1.jpg)
This is the HorizontalScrollWindow XML definition.
| XML Tag | |
| Required Attributes | Required for the window element to create itself properly. |
| childscrollwindow | Name of the child Window that contains all items you wish to scroll through. |
| scrollbar | Name of the child <HorizontalScrollBar> that is anchored at the appropriate location on the window. |
| lineheight | The line height to be used with the scrollbar. |
| autoHideScrollBar | Auto-hides the scroll bar when the window the contents scroll child is less than one page. |
| HorizontalScrollWindowSetOffset() | Sets the current scroll position offset. |
| HorizontalScrollWindowGetOffset() | Returns the current scroll position offset. |
| HorizontalScrollWindowUpdateScrollRect() | Updates the childscrollwindow and scrollbar to reflect it’s current contents. |
Name of the child Window that contains all items you wish to scroll through. The scroll child should anchored at the appropriate spot on the window. It will be adjusted left and right automatically to facilitate scrolling.
A string value, which is the name of a valid child Window.
Name of the child <HorizontalScrollBar> that is anchored at the appropriate location on the window.
A string value, which is the name of a valid child <HorizontalScrollBar>.
Auto-hides the scroll bar when the window the contents scroll child is less than one page.
A boolean value.
Sets the current scroll position offset.
| horizScrollWindowName | (string) The name of the HorizontalScrollWindow |
| scrollPos | (number) The current scroll position offset. |
| nil | no return value |
HorizontalScrollWindowSetOffset( "InteractionWindowMain", 0 )
Returns the current scroll position offset.
| horizScrollWindowName | (string) The name of the HorizontalScrollWindow |
| scrollPos | (number) The current scroll position offset. |
local scrollPos = HorizontalScrollWindowGetOffset( "InteractionWindowMain" )
Updates the childscrollwindow and scrollbar to reflect it’s current contents.
| horizScrollWindowName | (string) The name of the HorizontalScrollWindow |
| nil | no return value |
HorizontalScrollWindowUpdateScrollRect( "InteractionWindowMain" )