| superclass(es) | control |
| subclass(es) | - |
| description | The scrollBar control is a scrollbar which can be positioned anywhere on a
window and it can be a horizontal or vertical scrollbar. |
| see also | panel - system |
The range of a scrollbar determines how many steps there are for a scrollbar to scroll up or down, the position of the thumb control inside a scrollbar must be within that range. Initializing a scrollbar after it has been created consists of setting the minimum and maximum values of the range and then the position of the thumb control. It is possible with the system class to retrieve the default dimensions of a scrollbar. |
create(Parent, X, Y, Width, Height, Output)
| func | Create a horizontal scrollbar control at a specified position with the specified dimensions. Because a control is a child window a parent window must always be specified. The coordinates X, Y, Width and Height determine the dimensions, in window coordinates, of the control. The text is left aligned. |
| pre | The variable Parent must refer to a parent window. The X, Y, Width and Height coordinates must specify a position and dimension for the control. |
| post | If the control was successfully created then true is assigned to Output, else it will contain false. |
createVertical(Parent, X, Y, Width, Height, Output)
| func | Create a vertical scrollbar control that centers it's text at a specified position with the specified dimensions. Because a control is a child window a parent window must always be specified. The coordinates X, Y, Width and Height determine the dimensions, in window coordinates, of the control. |
| pre | The variable Parent must refer to a parent window. The X, Y, Width and Height coordinates must specify a position and dimension for the control. |
| post | If the control was successfully created then true is assigned to Output, else it will contain false. |
| func | Determine if the scrollbar is a horizontal scrollbar. |
| pre | TRUE. |
| post | If the control is a horizontal scrollbar then true is assigned to Output, else it will contain false. |
| func | Determine if the scrollbar is a vertical scrollbar. |
| pre | TRUE. |
| post | If the control is a vertical scrollbar then true is assigned to Output, else it will contain false. |
| func | Put the range of the scrollbar, if Redraw is true the scrollbar is redrawn after the range was changed, else the scrollbar is not redraw. |
| pre | The Min and Max variables must contain integer values and Redraw must contain true or false. |
| post | The range of scrollbar was changed. |
| func | Get the range of the scrollbar. |
| pre | TRUE. |
| post | The minimum value of the range of the scrollbar was assigned to Min and the maximum value of the range was assigned to Max. |
| func | Set the position of the thumb control inside the scrollbar. |
| pre | The variable Pos must contain an integer value, the value must be within the range of the scrollbar. |
| post | The position of the thumb control was adjusted. |
| func | Set the position of the thumb control inside the scrollbar. |
| pre | The variable Pos must contain an integer value, the value must be within the range of the scrollbar. |
| post | The position of the thumb control was adjusted. |
| func | Put the size of the thumb control inside the scrollbar. |
| pre | The variable Size must contain an integer value and Redraw must contain true or false. |
| post | The size of the thumb control was adjusted. |
| func | Get the size of the thumb control inside the scrollbar. |
| pre | TRUE |
| post | The size of the thumb control was unified with the parameter Output. |