DgsCreateCheckBox - Revision history

XLive: update arguments names

2021-02-16T13:58:44Z

update arguments names

Thisdp at 14:30, 26 June 2018

2018-06-26T14:30:50Z

← Older revision		Revision as of 14:30, 26 June 2018
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsCreateCheckBox ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textcolor, float textScaleX = 1.0, float textScaleY = 1.0, element defimg_f = nil, element hovimg_f = nil, element cliimg_f = nil, int defcolor_f = 0xFFFFFFFF, int hovcolor_f = 0xFFFFFFFF, int clicolor_f = 0xFFB4B4B4, element defimg_t = nil, element hovimg_t = nil, element cliimg_t = nil, int defcolor_t = 0xFFFFFFFF, int hovcolor_t = 0xFFFFFFFF,int clicolor_t = 0xFFB4B4B4, element defimg_i = nil, element hovimg_i = nil, element cliimg_i = nil, int defcolor_i = 0xFFFFFFFF, int hovcolor_i = 0xFFFFFFFF,int clicolor_i = 0xFFB4B4B4 ] )		element dgsCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative [, element parent = nil, int textcolor, float textScaleX = 1.0, float textScaleY = 1.0, element defimg_f = nil, element hovimg_f = nil, element cliimg_f = nil, int defcolor_f = 0xFFFFFFFF, int hovcolor_f = 0xFFFFFFFF, int clicolor_f = 0xFFB4B4B4, element defimg_t = nil, element hovimg_t = nil, element cliimg_t = nil, int defcolor_t = 0xFFFFFFFF, int hovcolor_t = 0xFFFFFFFF,int clicolor_t = 0xFFB4B4B4, element defimg_i = nil, element hovimg_i = nil, element cliimg_i = nil, int defcolor_i = 0xFFFFFFFF, int hovcolor_i = 0xFFFFFFFF,int clicolor_i = 0xFFB4B4B4 ] )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp: Thisdp moved page DgsDxCreateCheckBox to DgsCreateCheckBox

2018-01-20T11:10:17Z

Thisdp moved page DgsDxCreateCheckBox to DgsCreateCheckBox

← Older revision

Revision as of 11:10, 20 January 2018

Thisdp at 11:09, 20 January 2018

2018-01-20T11:09:42Z

Thisdp: /* Example */

2017-10-02T11:13:54Z

Example

← Older revision		Revision as of 11:13, 2 October 2017
Line 62:		Line 62:
	local checkedBox = DGS:dgsDxCreateCheckBox(20,30,150,20,"Checked checkbox",true,false,window) -- note the parameter after header, it will make the checkbox be checked		local checkedBox = DGS:dgsDxCreateCheckBox(20,30,150,20,"Checked checkbox",true,false,window) -- note the parameter after header, it will make the checkbox be checked
	local uncheckedBox = DGS:dgsDxCreateCheckBox(20,60,150,20,"Unchecked checkbox",false,false,window) -- not here though		local uncheckedBox = DGS:dgsDxCreateCheckBox(20,60,150,20,"Unchecked checkbox",false,false,window) -- not here though
	local indeterminateBox= DGS:dgsDxCreateCheckBox(20,90,150,20,"~~Unchecked~~ checkbox",nil,false,window) -- ~~not here though~~		local indeterminateBox= DGS:dgsDxCreateCheckBox(20,90,150,20,"Indeterminate checkbox",nil,false,window) -- Indeterminate
	DGS:dgsDxGUISetVisible(window,false) -- set it invisible just in case		DGS:dgsDxGUISetVisible(window,false) -- set it invisible just in case
	return window -- we return the window		return window -- we return the window

Thisdp: /* Example */

2017-10-02T11:13:17Z

Example

← Older revision		Revision as of 11:13, 2 October 2017
Line 53:		Line 53:
	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
	This example creates a ~~GUI~~ window with a checked and an unchecked checkbox and adds a command to toggle their visibility		This example creates a DGS window with a checked and an unchecked checkbox and adds a command to toggle their visibility
	<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->		<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
			DGS = exports.dgs

	function drawGUI()		function drawGUI()
	local ~~guiWindow~~ = ~~guiCreateWindow~~(100,100,200,~~100~~,"Checkbox test area",false,false) -- create the container window		local window = DGS:dgsDxCreateWindow(100,100,200,120,"Checkbox test area",false,false) -- create the container window
	local checkedBox = ~~guiCreateCheckBox~~(20,30,150,20,"Checked checkbox",true,false,~~guiWindow~~) -- note the parameter after header, it will make the checkbox be checked		local checkedBox = DGS:dgsDxCreateCheckBox(20,30,150,20,"Checked checkbox",true,false,window) -- note the parameter after header, it will make the checkbox be checked
	local uncheckedBox = ~~guiCreateCheckBox~~(20,60,150,20,"Unchecked checkbox",false,false,~~guiWindow~~) -- not here though		local uncheckedBox = DGS:dgsDxCreateCheckBox(20,60,150,20,"Unchecked checkbox",false,false,window) -- not here though
	~~guiSetVisible~~(~~guiWindow~~,false) -- set it invisible just in case		local indeterminateBox= DGS:dgsDxCreateCheckBox(20,90,150,20,"Unchecked checkbox",nil,false,window) -- not here though
	return ~~guiWindow~~ -- we return the ~~guiWindow~~		DGS:dgsDxGUISetVisible(window,false) -- set it invisible just in case
			return window -- we return the window
	end		end
	function cmdGUI(cmd)		function cmdGUI(cmd)
	if not checkBoxWindow then -- if it hasn't been declared yet		if not checkBoxWindow then -- if it hasn't been declared yet
	checkBoxWindow = drawGUI() -- we draw the ~~gui~~ window		checkBoxWindow = drawGUI() -- we draw the dgs window
	~~guiSetVisible~~(checkBoxWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper ~~guiSetVisible~~, but this is needed if you want to cache a window without actually showing it		DGS:dgsDxGUISetVisible(checkBoxWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper dgsDxGUISetVisible, but this is needed if you want to cache a window without actually showing it
	else -- if we actually have run this function before and declared checkBoxWindow		else -- if we actually have run this function before and declared checkBoxWindow
	~~guiSetVisible~~(checkBoxWindow, not ~~guiGetVisible~~(checkBoxWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it		DGS:dgsDxGUISetVisible(checkBoxWindow, not DGS:dgsDxGUIGetVisible(checkBoxWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it
	end		end
	showCursor(not isCursorShowing()) -- similar to above visibility		showCursor(not isCursorShowing()) -- similar to above visibility

Thisdp: /* Required Arguments */

2017-10-02T11:00:26Z

Required Arguments

@@ Line 19: / Line 19: @@
 *'''selected:''' A boolean representing whether the checkbox created should be selected by default.
 *'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing measures relative to the parent.
 ===Optional Arguments===

Thisdp: /* Syntax */

2017-10-02T10:57:14Z

Syntax

← Older revision		Revision as of 10:57, 2 October 2017
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsDxCreateCheckBox ( float x, float y, float width, float height, string text~~, bool selected~~, bool relative, [element parent = nil] )		element dgsDxCreateCheckBox ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textcolor, float textScaleX = 1.0, float textScaleY = 1.0, element defimg_f = nil, element hovimg_f = nil, element cliimg_f = nil, int defcolor_f = 0xFFFFFFFF, int hovcolor_f = 0xFFFFFFFF, int clicolor_f = 0xFFB4B4B4, element defimg_t = nil, element hovimg_t = nil, element cliimg_t = nil, int defcolor_t = 0xFFFFFFFF, int hovcolor_t = 0xFFFFFFFF,int clicolor_t = 0xFFB4B4B4, element defimg_i = nil, element hovimg_i = nil, element cliimg_i = nil, int defcolor_i = 0xFFFFFFFF, int hovcolor_i = 0xFFFFFFFF,int clicolor_i = 0xFFB4B4B4 ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 25:		Line 25:

	===Returns===		===Returns===
	Returns [[element]] of the checkbox if it was created succesfully, ''false'' otherwise.		Returns [[element]] of the checkbox if it was created succesfully, ''false'' otherwise.

	==Example==		==Example==

Thisdp at 10:55, 2 October 2017

2017-10-02T10:55:37Z

← Older revision		Revision as of 10:55, 2 October 2017
Line 3:		Line 3:
	This function creates a DGS Dx Check Box.		This function creates a DGS Dx Check Box.

	'''Note: DGS Dx Check Box have 3 states.(checked:true; unchecked:false; indeterminate: nil)'''		'''Note: DGS Dx Check Box have 3 states.(checked: true; unchecked: false; indeterminate: nil)'''

	==Syntax==		==Syntax==

Thisdp at 10:55, 2 October 2017

2017-10-02T10:55:20Z

← Older revision		Revision as of 10:55, 2 October 2017
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function creates a DGS Dx Check Box.		This function creates a DGS Dx Check Box.

	'''Note: DGS Dx Check Box have 3 states.(checked:true; unchecked:false; indeterminate: nil)'''		'''Note: DGS Dx Check Box have 3 states.(checked:true; unchecked:false; indeterminate: nil)'''

← Older revision		Revision as of 13:58, 16 February 2021
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative [, element parent = nil, int ~~textcolor~~, float ~~textScaleX~~ = 1.0, float ~~textScaleY~~ = 1.0, element ~~defimg_f~~ = nil, element ~~hovimg_f~~ = nil, element ~~cliimg_f~~ = nil, int ~~defcolor_f~~ = 0xFFFFFFFF, int ~~hovcolor_f~~ = 0xFFFFFFFF, int ~~clicolor_f~~ = 0xFFB4B4B4, element ~~defimg_t~~ = nil, element ~~hovimg_t~~ = nil, element ~~cliimg_t~~ = nil, int ~~defcolor_t~~ = 0xFFFFFFFF, int ~~hovcolor_t~~ = 0xFFFFFFFF,int ~~clicolor_t~~ = 0xFFB4B4B4, element ~~defimg_i~~ = nil, element ~~hovimg_i~~ = nil, element ~~cliimg_i~~ = nil, int ~~defcolor_i~~ = 0xFFFFFFFF, int ~~hovcolor_i~~ = 0xFFFFFFFF,int ~~clicolor_i~~ = 0xFFB4B4B4 ] )		element dgsCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative [, element parent = nil, int textColor, float scaleX = 1.0, float scaleY = 1.0, element normalUncheckedImage = nil, element hoveringUncheckedImage = nil, element clickedUnCheckedImage = nil, int normalUnCheckedColor = 0xFFFFFFFF, int hoveringUnCheckedColor = 0xFFFFFFFF, int clickedUnCheckedColor = 0xFFB4B4B4, element normalCheckedImage = nil, element hoveringCheckedImage = nil, element clickedCheckedImage = nil, int normalCheckedColor = 0xFFFFFFFF, int hoveringCheckedColor = 0xFFFFFFFF,int clickedCheckedColor = 0xFFB4B4B4, element normalIndeterminateImage = nil, element hoveringIndeterminateImage = nil, element clickedIndeterminateImage = nil, int normalIndeterminateColor = 0xFFFFFFFF, int hoveringIndeterminateColor = 0xFFFFFFFF,int clickedIndeterminateColor = 0xFFB4B4B4 ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 22:		Line 22:
	{{OptionalArg}}		{{OptionalArg}}
	*'''parent:''' This is the parent that the DGS check box is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.		*'''parent:''' This is the parent that the DGS check box is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
	*'''~~textcolor~~:''' An int of the color of the check box.		*'''textColor:''' An int of the color of the check box.
	*'''~~textScaleX~~ :''' A float of the width of the text scale.		*'''scaleX :''' A float of the width of the text scale.
	*'''~~textScaleY~~:''' A float of the height of the text scale.		*'''scaleY:''' A float of the height of the text scale.
	*'''~~defimg_f~~:''' An image element of the default state of the check box. (unchecked)		*'''normalUncheckedImage:''' An image element of the default state of the check box. (unchecked)
	*'''~~hovimg_f~~:''' An image element of the hovered state of the check box. (unchecked)		*'''hoveringUncheckedImage:''' An image element of the hovered state of the check box. (unchecked)
	*'''~~cliimg_f~~:''' An image element of the clicked state of the check box. (unchecked)		*'''clickedUnCheckedImage:''' An image element of the clicked state of the check box. (unchecked)
	*'''~~defcolor_f~~:''' An integer of the color of the default state of the check box. (unchecked)		*'''normalUnCheckedColor:''' An integer of the color of the default state of the check box. (unchecked)
	*'''~~hovcolor_f~~:''' An integer of the color of the hovered state of the check box. (unchecked)		*'''hoveringUnCheckedColor:''' An integer of the color of the hovered state of the check box. (unchecked)
	*'''~~clicolor_f~~:''' An integer of the color of the clicked state of the check box. (unchecked)		*'''clickedUnCheckedColor:''' An integer of the color of the clicked state of the check box. (unchecked)
	*'''~~defimg_t~~:''' An image element of the default state of the check box. (checked)		*'''normalCheckedImage:''' An image element of the default state of the check box. (checked)
	*'''~~hovimg_t~~:''' An image element of the hovered state of the check box. (checked)		*'''hoveringCheckedImage:''' An image element of the hovered state of the check box. (checked)
	*'''~~cliimg_t~~:''' An image element of the clicked state of the check box. (checked)		*'''clickedCheckedImage:''' An image element of the clicked state of the check box. (checked)
	*'''~~defcolor_t~~:''' An integer of the color of the default state of the check box. (checked)		*'''normalCheckedColor:''' An integer of the color of the default state of the check box. (checked)
	*'''~~hovcolor_t~~:''' An integer of the color of the hovered state of the check box. (checked)		*'''hoveringCheckedColor:''' An integer of the color of the hovered state of the check box. (checked)
	*'''~~clicolor_t~~:''' An integer of the color of the clicked state of the check box. (checked)		*'''clickedCheckedColor:''' An integer of the color of the clicked state of the check box. (checked)
	*'''~~defimg_i~~:''' An image element of the default state of the check box. (indeterminate)		*'''normalIndeterminateImage:''' An image element of the default state of the check box. (indeterminate)
	*'''~~hovimg_i~~:''' An image element of the hovered state of the check box. (indeterminate)		*'''hoveringIndeterminateImage:''' An image element of the hovered state of the check box. (indeterminate)
	*'''~~cliimg_i~~:''' An image element of the clicked state of the check box. (indeterminate)		*'''clickedIndeterminateImage:''' An image element of the clicked state of the check box. (indeterminate)
	*'''~~defcolor_i~~:''' An integer of the color of the default state of the check box. (indeterminate)		*'''normalIndeterminateColor:''' An integer of the color of the default state of the check box. (indeterminate)
	*'''~~hovcolor_i~~:''' An integer of the color of the hovered state of the check box. (indeterminate)		*'''hoveringIndeterminateColor:''' An integer of the color of the hovered state of the check box. (indeterminate)
	*'''~~clicolor_i~~:''' An integer of the color of the clicked state of the check box. (indeterminate)		*'''clickedIndeterminateColor:''' An integer of the color of the clicked state of the check box. (indeterminate)

	===Optional Arguments===		===Optional Arguments===

← Older revision		Revision as of 11:09, 20 January 2018
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element ~~dgsDxCreateCheckBox~~ ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textcolor, float textScaleX = 1.0, float textScaleY = 1.0, element defimg_f = nil, element hovimg_f = nil, element cliimg_f = nil, int defcolor_f = 0xFFFFFFFF, int hovcolor_f = 0xFFFFFFFF, int clicolor_f = 0xFFB4B4B4, element defimg_t = nil, element hovimg_t = nil, element cliimg_t = nil, int defcolor_t = 0xFFFFFFFF, int hovcolor_t = 0xFFFFFFFF,int clicolor_t = 0xFFB4B4B4, element defimg_i = nil, element hovimg_i = nil, element cliimg_i = nil, int defcolor_i = 0xFFFFFFFF, int hovcolor_i = 0xFFFFFFFF,int clicolor_i = 0xFFB4B4B4 ] )		element dgsCreateCheckBox ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textcolor, float textScaleX = 1.0, float textScaleY = 1.0, element defimg_f = nil, element hovimg_f = nil, element cliimg_f = nil, int defcolor_f = 0xFFFFFFFF, int hovcolor_f = 0xFFFFFFFF, int clicolor_f = 0xFFB4B4B4, element defimg_t = nil, element hovimg_t = nil, element cliimg_t = nil, int defcolor_t = 0xFFFFFFFF, int hovcolor_t = 0xFFFFFFFF,int clicolor_t = 0xFFB4B4B4, element defimg_i = nil, element hovimg_i = nil, element cliimg_i = nil, int defcolor_i = 0xFFFFFFFF, int hovcolor_i = 0xFFFFFFFF,int clicolor_i = 0xFFB4B4B4 ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 59:		Line 59:

	function drawGUI()		function drawGUI()
	local window = DGS:~~dgsDxCreateWindow~~(100,100,200,120,"Checkbox test area",false,false) -- create the container window		local window = DGS:dgsCreateWindow(100,100,200,120,"Checkbox test area",false,false) -- create the container window
	local checkedBox = DGS:~~dgsDxCreateCheckBox~~(20,30,150,20,"Checked checkbox",true,false,window) -- note the parameter after header, it will make the checkbox be checked		local checkedBox = DGS:dgsCreateCheckBox(20,30,150,20,"Checked checkbox",true,false,window) -- note the parameter after header, it will make the checkbox be checked
	local uncheckedBox = DGS:~~dgsDxCreateCheckBox~~(20,60,150,20,"Unchecked checkbox",false,false,window) -- not here though		local uncheckedBox = DGS:dgsCreateCheckBox(20,60,150,20,"Unchecked checkbox",false,false,window) -- not here though
	local indeterminateBox= DGS:~~dgsDxCreateCheckBox~~(20,90,150,20,"Indeterminate checkbox",nil,false,window) -- Indeterminate		local indeterminateBox= DGS:dgsCreateCheckBox(20,90,150,20,"Indeterminate checkbox",nil,false,window) -- Indeterminate
	DGS:~~dgsDxGUISetVisible~~(window,false) -- set it invisible just in case		DGS:dgsSetVisible(window,false) -- set it invisible just in case
	return window -- we return the window		return window -- we return the window
	end		end
Line 69:		Line 69:
	if not checkBoxWindow then -- if it hasn't been declared yet		if not checkBoxWindow then -- if it hasn't been declared yet
	checkBoxWindow = drawGUI() -- we draw the dgs window		checkBoxWindow = drawGUI() -- we draw the dgs window
	DGS:~~dgsDxGUISetVisible~~(checkBoxWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper ~~dgsDxGUISetVisible~~, but this is needed if you want to cache a window without actually showing it		DGS:dgsSetVisible(checkBoxWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper dgsSetVisible, but this is needed if you want to cache a window without actually showing it
	else -- if we actually have run this function before and declared checkBoxWindow		else -- if we actually have run this function before and declared checkBoxWindow
	DGS:~~dgsDxGUISetVisible~~(checkBoxWindow, not DGS:~~dgsDxGUIGetVisible~~(checkBoxWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it		DGS:dgsSetVisible(checkBoxWindow, not DGS:dgsGetVisible(checkBoxWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it
	end		end
	showCursor(not isCursorShowing()) -- similar to above visibility		showCursor(not isCursorShowing()) -- similar to above visibility