Difference between revisions of "Lua:Class:CheckBox"

From Cheat Engine
Jump to navigation Jump to search
m (Reverted edits by This content is not available (Talk) to last revision by TheyCallMeTim13)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
'''CheckBox Class''' (Inheritance ButtonControl->WinControl->Control->Component->Object)
+
[[Category:Lua]]
 +
CheckBox '''Class''': ('''Inheritance''': ''[[Lua:Class:ButtonControl|ButtonControl]]''->''[[Lua:Class:WinControl|WinControl]]''->''[[Lua:Class:Control|Control]]''->''[[Lua:Class:Component|Component]]''->''[[Lua:Class:Object|Object]]'')
 +
 
 
The Checkbox is a visual component that lets the user click it and change state between checked, unchecked, and if possible, grayed
 
The Checkbox is a visual component that lets the user click it and change state between checked, unchecked, and if possible, grayed
 
  
 
'''createCheckBox(owner)'''  
 
'''createCheckBox(owner)'''  
 
Creates a CheckBox class object which belongs to the given owner. Owner can be any object inherited from WinControl
 
Creates a CheckBox class object which belongs to the given owner. Owner can be any object inherited from WinControl
  
'''
+
== Properties ==
checkbox_getAllowGrayed(CheckBox)'''
+
;AllowGrayed
Gets the AllowGrayed property
+
:AllowGrayed Determines if there is a 3th state
 
 
 
 
'''checkbox_setAllowGrayed(CheckBox, boolean)'''  -- it is same as '''control_setEnabled(control, ~ boolean)''' 
 
Sets the AllowGrayed property
 
 
 
 
 
'''checkbox_getState(checkbox)'''
 
Gets the current state of the checkbox
 
  0=Unchecked
 
  1=Checked
 
  2=Grayed
 
 
 
'''
 
checkbox_setState(checkbox, state)'''
 
Sets the state of the checkbox
 
  0=Unchecked
 
  1=Checked
 
  2=Grayed
 
  
 +
;State
 +
:The state of the checkbox. 0=Unchecked, 1=Checked, 2=Gray
  
checkbox_onChange(checkbox, function)
+
;OnChange(function(sender))
Sets an OnChange event for the checkbox that gets triggered when the state has been changed (by the user of programatically)
+
:Function to be called when the state changes
  function (sender)
 
  
  
Line 47: Line 31:
  
 
for x = 1, #checkBoxes do
 
for x = 1, #checkBoxes do
     control_setCaption( checkBoxes[x], "This is checkbox " .. tostring( x ) );
+
     checkBoxes[x].Caption="This is checkbox " .. tostring( x )
     control_setPosition( checkBoxes[x], 10, x * 20 )
+
     checkBoxes[x].setPosition(10, x * 20)
 
end  
 
end  
  
checkbox_setState(checkboxes[1], 0)    -- Sets checkboxes[1] to unchecked state.
+
checkBoxes[1].State=0 -- Sets checkboxes[1] to unchecked state.
checkbox_setState(checkboxes[2], 1)    -- Sets checkboxes[2] to checked state.
+
checkBoxes[2].State=1 -- Sets checkboxes[2] to checked state.
checkbox_setState(checkboxes[3], 2)    -- checkboxes[3] is grayed out.
+
checkBoxes[3].State=2 -- Sets checkboxes[3] to the gray state
  
if checkbox_getState(checkboxes[4]) then  -- if checkboxes[4] is checked then the function returns true otherwise false.
+
if checkBoxes[4].Checked then  -- if checkboxes[4] is checked then the function returns true otherwise false.
 
   print "true"
 
   print "true"
 
else
 
else
Line 61: Line 45:
 
end
 
end
 
</pre>
 
</pre>
 +
 +
{{LuaSeeAlso}}

Latest revision as of 14:10, 18 March 2019

CheckBox Class: (Inheritance: ButtonControl->WinControl->Control->Component->Object)

The Checkbox is a visual component that lets the user click it and change state between checked, unchecked, and if possible, grayed

createCheckBox(owner) Creates a CheckBox class object which belongs to the given owner. Owner can be any object inherited from WinControl

Properties[edit]

AllowGrayed
AllowGrayed Determines if there is a 3th state
State
The state of the checkbox. 0=Unchecked, 1=Checked, 2=Gray
OnChange(function(sender))
Function to be called when the state changes


Example:

local form = createForm( true );

local checkBoxes = {};
checkBoxes[1] = createCheckBox( form );
checkBoxes[2] = createCheckBox( form );
checkBoxes[3] = createCheckBox( form );
checkBoxes[4] = createCheckBox( form );
checkBoxes[5] = createCheckBox( form );

for x = 1, #checkBoxes do
    checkBoxes[x].Caption="This is checkbox " .. tostring( x )
    checkBoxes[x].setPosition(10, x * 20)
end 

checkBoxes[1].State=0  -- Sets checkboxes[1] to unchecked state.
checkBoxes[2].State=1  -- Sets checkboxes[2] to checked state.
checkBoxes[3].State=2  -- Sets checkboxes[3] to the gray state

if checkBoxes[4].Checked then  -- if checkboxes[4] is checked then the function returns true otherwise false.
   print "true"
else
   print "false"
end

See also[edit]