pyui.create_check_box

Create a check box for the user to select an option (yes or no). Use the set_control_checked function to initialize the control state.

pyui.create_check_box(dialog, col_spec [,text])
dialog:create_check_box(col_spec, text)

Parameters

	Type	Description
dialog	dialog_handle	Dialog where the control is created
col_spec	integer or {first, last}	Index of the column or specification of the column-span, where the control is placed.
text	string	Initial text-content of the control

Return value

Type	Description
control_handle	A handle to the newly created control

Events

When the user changes the check box state, the on_click handler is called on_click_handler(new_state) with one boolean parameter new_state for the new state of the checkbox.

See also

Control Gallery, set_control_text, set_control_checked, set_on_click_handler, create_radio_button