Dgs-dxswitchbutton - Revision history

XLive: Moved to mouseButtons property

2023-06-11T14:11:01Z

Moved to mouseButtons property

← Older revision		Revision as of 14:11, 11 June 2023
Line 8:		Line 8:

	==Properties==		==Properties==
	~~===clickType===~~
	~~This property determines which button on mouse can change the state of switch button.~~
	~~<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"clickType",clickType)</syntaxhighlight>~~
	*'''clickType:''' An integer, available values are as follows:
	**'''1:''' Left Mouse Button
	**'''2:''' Wheel
	**'''3:''' Right Mouse Button

	===clip===		===clip===
	Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''		Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''

Thisdp: /* style */

2023-01-16T14:51:03Z

style

← Older revision		Revision as of 14:51, 16 January 2023
Line 115:		Line 115:
	**'''1:''' Split background color for turned on and off ( also split images ).		**'''1:''' Split background color for turned on and off ( also split images ).
	**'''2:''' Split background color for turned on and off ( not split images ).		**'''2:''' Split background color for turned on and off ( not split images ).
			**'''3:''' Do not split background color. Just switch gradually.
			**'''4:''' No cursor. Just switch gradually.

	===textOn===		===textOn===

Thisdp at 09:09, 24 April 2022

2022-04-24T09:09:13Z

Zhvachka: /* wordbreak */

2022-03-17T10:43:02Z

wordbreak

← Older revision		Revision as of 10:43, 17 March 2022
Line 147:		Line 147:
	*'''troughWidth:''' A float of the trough length of switch button.		*'''troughWidth:''' A float of the trough length of switch button.

	===~~wordbreak~~===		===wordBreak===
	Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''		Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"wordBreak",wordBreak)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"wordBreak",wordBreak)</syntaxhighlight>

Zhvachka: /* wordbreak */

2022-03-16T17:27:11Z

wordbreak

← Older revision		Revision as of 17:27, 16 March 2022
Line 149:		Line 149:
	===wordbreak===		===wordbreak===
	Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''		Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"~~wordbreak~~",~~wordbreak~~)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"wordBreak",wordBreak)</syntaxhighlight>
	*'''~~wordbreak~~:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.		*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

	==See Also==		==See Also==
	{{DGSPROPERTIES}}		{{DGSPROPERTIES}}

Thisdp: /* style */

2021-03-25T05:39:49Z

style

← Older revision		Revision as of 05:39, 25 March 2021
Line 113:		Line 113:
	*'''style:''' Mixed, available values are as follows:		*'''style:''' Mixed, available values are as follows:
	**'''false:''' Default, a switch button with fading color when changing state.		**'''false:''' Default, a switch button with fading color when changing state.
	**'''1:''' Split background color for turned on and off.		**'''1:''' Split background color for turned on and off ( also split images ).
			**'''2:''' Split background color for turned on and off ( not split images ).

	===textOn===		===textOn===

Thisdp at 11:06, 5 March 2021

2021-03-05T11:06:07Z

← Older revision		Revision as of 11:06, 5 March 2021
Line 30:		Line 30:
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorWidth",cursorWidth)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorWidth",cursorWidth)</syntaxhighlight>
	*'''cursorWidth:''' A float of the cursor width of switch button.		*'''cursorWidth:''' A float of the cursor width of switch button.

			===cursorLength===
			This property determines the cursor length of switch button.
			<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorLength",cursorLength)</syntaxhighlight>
			*'''cursorLength:''' A float of the cursor length of switch button.

	===colorcoded===		===colorcoded===
Line 135:		Line 140:
	*'''scaleX:''' A float of the 2D X scale of the text of the switch button.		*'''scaleX:''' A float of the 2D X scale of the text of the switch button.
	*'''scaleY:''' A float of the 2D Y scale of the text of the switch button.		*'''scaleY:''' A float of the 2D Y scale of the text of the switch button.

			===troughWidth===
			This property determines trough length of switch button.
			<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"troughWidth",troughWidth)</syntaxhighlight>
			*'''troughWidth:''' A float of the trough length of switch button.

	===wordbreak===		===wordbreak===

Thisdp at 15:16, 15 August 2020

2020-08-15T15:16:55Z

@@ Line 49: / Line 49: @@
 *'''hoverColor:''' A integer of background color of turned off switch button when the mouse is hovering on it.
 *'''clickColor:''' A integer of background color of turned off switch button when the mouse is clicked on it.
 ===font===

Thisdp at 14:25, 2 April 2020

2020-04-02T14:25:50Z

← Older revision		Revision as of 14:25, 2 April 2020
Line 35:		Line 35:
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorcoded",colorcoded)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorcoded",colorcoded)</syntaxhighlight>
	*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.		*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

			===colorOn===
			The color which can be translated by [[tocolor]] of the background color when the switch button turns on.
			<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorOn",{normalColor,hoverColor,clickColor})</syntaxhighlight>
			*'''normalColor:''' A integer of background color of turned on switch button.
			*'''hoverColor:''' A integer of background color of turned on switch button when the mouse is hovering on it.
			*'''clickColor:''' A integer of background color of turned on switch button when the mouse is clicked on it.

			===colorOff===
			The color which can be translated by [[tocolor]] of the background color when the switch button turns off.
			<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorOff",{normalColor,hoverColor,clickColor})</syntaxhighlight>
			*'''normalColor:''' A integer of background color of turned off switch button.
			*'''hoverColor:''' A integer of background color of turned off switch button when the mouse is hovering on it.
			*'''clickColor:''' A integer of background color of turned off switch button when the mouse is clicked on it.

	===font===		===font===
Line 41:		Line 55:
	*'''font:''' A string or a [[Element/DX_font\|dx font element]] of the text font of the switch button.		*'''font:''' A string or a [[Element/DX_font\|dx font element]] of the text font of the switch button.

	===~~image_t~~===		===imageOn===
	The background image of switch button when the state is on.~~(State=true)~~		The background image of switch button when the state is on.
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"~~image_t~~",{normalImage,hoverImage,clickImage})</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOn",{normalImage,hoverImage,clickImage})</syntaxhighlight>
	*'''normalImage:''' An material of background image of turned on switch button.		*'''normalImage:''' An material of background image of turned on switch button.
	*'''hoverImage:''' An material of background image of turned on switch button when the mouse is hovering on it.		*'''hoverImage:''' An material of background image of turned on switch button when the mouse is hovering on it.
	*'''clickImage:''' An material of background image of turned on switch button when the mouse is clicked on it.		*'''clickImage:''' An material of background image of turned on switch button when the mouse is clicked on it.

	===~~image_f~~===		===imageOff===
	The background image of switch button when the state is off.(~~State=false)~~		The background image of switch button when the state is off.(
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"~~image_f~~",{normalImage,hoverImage,clickImage})</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOff",{normalImage,hoverImage,clickImage})</syntaxhighlight>
	*'''normalImage:''' An material of background image of turned off switch button.		*'''normalImage:''' An material of background image of turned off switch button.
	*'''hoverImage:''' An material of background image of turned off switch button when the mouse is hovering on it.		*'''hoverImage:''' An material of background image of turned off switch button when the mouse is hovering on it.
Line 74:		Line 88:
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"stateAnim",stateAnim)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"stateAnim",stateAnim)</syntaxhighlight>
	*'''stateAnim:''' A float of the cursor animation progress.		*'''stateAnim:''' A float of the cursor animation progress.

			===style===
			This property determines the state of switch button.
			<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"style",style)</syntaxhighlight>
			*'''style:''' Mixed, available values are as follows:
			**'''false:''' Default, a switch button with fading color when changing state.
			**'''1:''' Split background color for turned on and off.

	===textOn===		===textOn===
	This property stores the text to be shown when the switch button turns on.~~(State=true)~~		This property stores the text to be shown when the switch button turns on.
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textOn",textOn)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textOn",textOn)</syntaxhighlight>
	*'''textOn:''' A string of the text of the switch button.		*'''textOn:''' A string of the text of the switch button.

	===textOff===		===textOff===
	This property stores the text to be shown when the switch button turns off.~~(State=false)~~		This property stores the text to be shown when the switch button turns off.
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textOff",textOff)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textOff",textOff)</syntaxhighlight>
	*'''textOff:''' A string of the text of the switch button.		*'''textOff:''' A string of the text of the switch button.

	===~~textColor_t~~===		===textColorOn===
	The color which can be translated by [[tocolor]] of the text when the switch button turns on.~~(State=true)~~		The color which can be translated by [[tocolor]] of the text when the switch button turns on.
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textColor_t",textColor_t)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textColor_t",textColor_t)</syntaxhighlight>
	*'''textColor_t:''' An integer of the color of the text when the switch button turns on.~~(State=true)~~		*'''textColor_t:''' An integer of the color of the text when the switch button turns on.

	===~~textColor_f~~===		===textColorOff===
	The color which can be translated by [[tocolor]] of the text when the switch button turns off.(State=false)		The color which can be translated by [[tocolor]] of the text when the switch button turns off.(State=false)
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textColor_f",textColor_f)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textColor_f",textColor_f)</syntaxhighlight>
	*'''textColor_f:''' An integer of the color of the text when the switch button turns off.~~(State=false)~~		*'''textColor_f:''' An integer of the color of the text when the switch button turns off.

	===textSize===		===textSize===

Thisdp at 11:20, 2 April 2020

2020-04-02T11:20:29Z

@@ Line 40: / Line 40: @@
 <syntaxhighlight lang="lua">dgsSetProperty(switchButton,"font",font)</syntaxhighlight>
 *'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the switch button.
 ===shadow===

← Older revision		Revision as of 09:09, 24 April 2022
Line 65:		Line 65:
	The cursor image of switch button.		The cursor image of switch button.
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorImage",{normalColor,hoverColor,clickColor})</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorImage",{normalColor,hoverColor,clickColor})</syntaxhighlight>
	*'''normalImage:''' An material of cursor image of the switch button.		*'''normalImage:''' A material of cursor image of the switch button.
	*'''hoverImage:''' An material of cursor image of the switch button when the mouse is hovering on it.		*'''hoverImage:''' A material of cursor image of the switch button when the mouse is hovering on it.
	*'''clickImage:''' An material of cursor image of the switch button when the mouse is clicked on it.		*'''clickImage:''' A material of cursor image of the switch button when the mouse is clicked on it.

	===font===		===font===
Line 77:		Line 77:
	The background image of switch button when the state is on.		The background image of switch button when the state is on.
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOn",{normalImage,hoverImage,clickImage})</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOn",{normalImage,hoverImage,clickImage})</syntaxhighlight>
	*'''normalImage:''' An material of background image of turned on switch button.		*'''normalImage:''' A material of background image of turned on switch button.
	*'''hoverImage:''' An material of background image of turned on switch button when the mouse is hovering on it.		*'''hoverImage:''' A material of background image of turned on switch button when the mouse is hovering on it.
	*'''clickImage:''' An material of background image of turned on switch button when the mouse is clicked on it.		*'''clickImage:''' A material of background image of turned on switch button when the mouse is clicked on it.

	===imageOff===		===imageOff===
	The background image of switch button when the state is off.(		The background image of switch button when the state is off.(
	<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOff",{normalImage,hoverImage,clickImage})</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOff",{normalImage,hoverImage,clickImage})</syntaxhighlight>
	*'''normalImage:''' An material of background image of turned off switch button.		*'''normalImage:''' A material of background image of turned off switch button.
	*'''hoverImage:''' An material of background image of turned off switch button when the mouse is hovering on it.		*'''hoverImage:''' A material of background image of turned off switch button when the mouse is hovering on it.
	*'''clickImage:''' An material of background image of turned off switch button when the mouse is clicked on it.		*'''clickImage:''' A material of background image of turned off switch button when the mouse is clicked on it.

	===shadow===		===shadow===