Checkbox
Anthony Ma edited this page May 26, 2015
·
3 revisions
Clone this wiki locally
A Checkbox component lets users make a boolean choice. #Fields
-
xdefault: 1 - x value of the component -
ydefault: 1 - y value of the component -
hdefault: 1 - height of the component -
wdefault: 16 - width of the component -
zdefault: 0 - z value of the component -
parent- parent window object of the component -
removed- whether the component has been queued for removal - should only be modified by the library itself -
visibledefault: true - whether the component is visible -
bgColordefault: colors.lightGray - color of the background of the text -
boxColordefault: colors.white - color of the background of the checkbox -
textColordefault: colors.black - color of the text -
checkedChardefault: "X" - character displayed in the box when it is checked -
checkeddefault: "false" - whether the checkbox has been checked -
textdefault: "txUI Checkbox" - text displayed next to the checkbox -
textPositiondefault: "right" - which side the text is relative to the checkbox
#Functions
-
function draw(self)- draws the checkbox and text -
function click(self, x, y)called by the library to see if the checkbox has been clicked -
function update(self)called every update cycle -
function termX(self)- returns the x position on the terminal -
function termY(self)- returns the y position on the terminal -
function setPos(self, x, y)- sets the position of the component -
function setSize(self, w, h)- sets the size of the component