Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiGetScrollBarInfo

hiGetScrollBarInfo(
g_formOrScrollRegion
)
=> l_scrollbarInfo

Description

Provides information about the horizontal and vertical scroll bars on a form or scroll region field. You can use this information to set the position of scroll bars with the hiSetScrollBarValue function.

Argument

g_formOrScrollRegion

  

Handle to the form or scroll region field.

Values Returned

l_scrollbarInfo

A list of the following form:

list ( [ nil | list ( x_horzMin x_horzMax x_horzValue x_horzSliderSize ) ] [ nil | list( x_vertMin x_vertMax x_vertValue x_vertSliderSize ) ] )

The first element of the list provides information about the horizontal scroll bar; the second element of the list provides information about the vertical scroll bar. If the first element is nil, the form or scroll region field does not have a horizontal scroll bar; if the second item in the list is nil, the form or scroll region field does not have a vertical scroll bar.

x_horzMin and x_vertMin are the minimum pixel position (usually 0); x_horzMax and x_vertMax are the horizontal or vertical pixel size of the form or scroll region field; x_horzValue and x_vertValue are the current values of the scroll bars; and  x_horzSliderSize and x_vertSliderSize are the visible areas of the form or scroll region field.

The maximum values for the l_newValues argument of the  hiSetScrollBarValue function are:

x_horzMax - x_horzSliderSize and x_vertMax - x_vertSliderSize.

Related Topics

Form and Field Functions

hiSetScrollBarValue


Return to top
 ⠀
X