OpalCreateToggle

function OpalCreateToggle(window_ref:integer, x:integer, y:integer, width:integer, height:integer, label:string, icon_image:element = NULL, value:boolean = FALSE, group:integer = -1, enabled:boolean = TRUE, visible:boolean = TRUE) : integer

Create a toggle button. If you click on a toggle button it will stay down, and the value will be set TRUE. Clicking again will unset it. If the group is >-1 then only one widget can be set, clicking on the toggle will unset all other widgets in the same group (you can have radio and toggle buttons in the same group). Clicking again will not unset it, but clicking on another widget in the same group will. Returns the index/reference of the widget.


window_ref:integer = ref of the window that will contain the widget
x:integer = top left postion in the window
y:integer = top left postion in the window
width:integer = width of the widget
height:integer = height of the widget
label:string = button caption
icon_image:element = image to use as an icon
value:boolean = starting state; TRUE=set, FALSE=unset
[group]:integer = grouping, -1 is no group. (default -1)
[enabled]:boolean = Enable the widget (default TRUE)
[visible]:boolean = Show the widget (default TRUE)
This function returns a integer