Creation/Dev/Script/Client/GuiScrollCtrl

Inherits GuiControl.

Description

The scroll control is basicly a container where you can add other controls, and the scroll control is automatically displaying vertical and horizontal scroll bars so that you can reach those child controls. Use the hScrollBar and vScrollBar variables to say which scroll bars should be displayed.

Use globalToLocalCoord() and localToGlobalCoord() described in GuiControl to translate between child position to mouse position and vice versa.

Variables

childmargin - {xmargin,ymargin} - gap between the borders and the child controls

constantthumbheight - boolean

hscrollbar - string - "alwaysOn", "alwaysOff", "dynamic" - controls the horizontal scroll bar

scrollpos - {x, y} - read only

tile - boolean - says if the scroll field background should be drawn tiled (otherwise stretched)

vscrollbar - string - "alwaysOn", "alwaysOff", "dynamic" - controls the vertical scroll bar

wheelscrolllines - integer - number of lines to scroll when the mouse wheel is turned

willfirstrespond - boolean

Functions

scrolldelta(int deltax, int deltay)

scrollto(int newx, int newy)

Events

onScrolled(newposx,newposy,deltax,deltay) - either the horizontal or vertical scrollbar has been moved

Example

new GuiScrollCtrl("Test_ScrollField") {
  profile = GuiBlueScrollProfile;
  x = 10;
  y = 10;
  width = 160;
  height = 80;
  hScrollBar = "dynamic";
  vScrollBar = "alwaysOn";
}