FCMCtrlCheckbox

Summary of Modifications

• Added CheckChange custom control event.

Functions

• Init(self)
• GetCheck(self)
• SetCheck(self, checked)
• HandleCheckChange(control, last_check)
• AddHandleCheckChange(self, callback)
• RemoveHandleCheckChange(self, callback)
• StoreState(self)
• RestoreState(self)

Init

fcmctrlcheckbox.Init(self)

View source

[Internal]

Input	Type	Description
self	FCMCtrlCheckbox

GetCheck

fcmctrlcheckbox.GetCheck(self)

View source

[Override]

Override Changes:

• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlCheckbox

Return type	Description
number

SetCheck

fcmctrlcheckbox.SetCheck(self, checked)

View source

[Fluid] [Override]

Override Changes:

• Ensures that CheckChange event is triggered.

Input	Type	Description
self	FCMCtrlCheckbox
checked	number

HandleCheckChange

fcmctrlcheckbox.HandleCheckChange(control, last_check)

View source

[Callback Template]

Input	Type	Description
control	FCMCtrlCheckbox	The control that was changed.
last_check	string	The previous value of the control’s check state..

AddHandleCheckChange

fcmctrlcheckbox.AddHandleCheckChange(self, callback)

View source

[Fluid]

Adds a handler for when the value of the control’s check state changes. The event will fire when:

• The window is created (if the check state is not 0)
• The control is checked/unchecked by the user
• The control’s check state is changed programmatically (if the check state is changed within a handler, that same handler will not be called again for that change.)

Input	Type	Description
self	FCMCtrlCheckbox
callback	function	See HandleCheckChange for callback signature.

RemoveHandleCheckChange

fcmctrlcheckbox.RemoveHandleCheckChange(self, callback)

View source

[Fluid]

Removes a handler added with AddHandleCheckChange.

Input	Type	Description
self	FCMCtrlCheckbox
callback	function

StoreState

fcmctrlcheckbox.StoreState(self)

View source

[Fluid] [Internal] [Override]

Override Changes:

• Stores FCMCtrlCheckbox-specific properties.

Do not disable this method. Override as needed but call the parent first.

Input	Type	Description
self	FCMCtrlCheckbox

RestoreState

fcmctrlcheckbox.RestoreState(self)

View source

[Fluid] [Internal] [Override]

Override Changes:

• Restores FCMCtrlCheckbox-specific properties.

Do not disable this method. Override as needed but call the parent first.

Input	Type	Description
self	FCMCtrlCheckbox