CheckBoxScreenGadget()

Syntax

Result = CheckBoxScreenGadget(#ScreenGadget, x, y, Width, Height, Text$)

Creates a checkbox gadget in the current GadgetList.

Parameters

#ScreenGadget	A number to identify the new gadget. #PB_Any can be used to auto-generate this number.
x, y, Width, Height	The position and dimensions of the new gadget.
Text$	The text to display at the right of the checkbox.

Return value

Nonzero on success, zero otherwise. If #PB_Any was used as the #ScreenGadget parameter then the return-value is the auto-generated gadget number on success.

Remarks

To add a 'mini help' to this gadget, use ScreenGadgetToolTip().

The following functions can be used to control the gadget:
- GetScreenGadgetState() can be used to get the current gadget state (checked or unchecked).
- SetScreenGadgetState() can be used to change the gadget state (checked or unchecked).

See Also

ScreenGadgetToolTip(), GetScreenGadgetState(), SetScreenGadgetState()

Supported OS

All