Dgs-dxbutton - Revision history

Thisdp at 12:01, 8 November 2023

2023-11-08T12:01:29Z

← Older revision		Revision as of 12:01, 8 November 2023
Line 119:		Line 119:
	*'''offsetY''' : A float of the 2D Y offset relative to the position of the button, depends on '''relative'''.		*'''offsetY''' : A float of the 2D Y offset relative to the position of the button, depends on '''relative'''.
	*'''relative''' : A bool of whether the offset is relative or absolute.		*'''relative''' : A bool of whether the offset is relative or absolute.


			===textPadding===
			The text padding of the text on button.
			<syntaxhighlight lang="lua">dgsSetProperty(button,"textPadding",{offsetX,offsetY,relative})</syntaxhighlight>
			*'''textPaddingX''' : A float of the 2D horizontal padding relative to the size of the button, depends on '''relative'''.
			*'''textPaddingY''' : A float of the 2D vertical padding offset relative to the size of the button, depends on '''relative'''.
			*'''relative''' : A bool of whether the padding is relative or absolute.

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

Thisdp: /* iconSize */

2023-08-16T12:18:17Z

iconSize

← Older revision		Revision as of 12:18, 16 August 2023
Line 89:		Line 89:
	This property enables you to change the icon size (Work with '''iconImage''').		This property enables you to change the icon size (Work with '''iconImage''').
	<syntaxhighlight lang="lua">dgsSetProperty(button,"iconSize",{iconSizeX,iconSizeY,relative})</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(button,"iconSize",{iconSizeX,iconSizeY,relative})</syntaxhighlight>
	*'''iconSizeX''' : A number of the 2D X scale to the ~~position~~ of the icon image.		*'''iconSizeX''' : A number of the 2D X scale to the size of the icon image.
	*'''iconSizeY''' : A number of the 2D Y scale to the ~~position~~ of the icon image.		*'''iconSizeY''' : A number of the 2D Y scale to the size of the icon image.
	*'''relative''' : A bool of whether the iconSize is relative to the height of text or absolute pixels.		*'''relative''' : A bool of whether the iconSize is relative to the height of text or absolute pixels.

Thisdp: /* iconSize */

2023-08-16T12:17:30Z

iconSize

← Older revision		Revision as of 12:17, 16 August 2023
Line 89:		Line 89:
	This property enables you to change the icon size (Work with '''iconImage''').		This property enables you to change the icon size (Work with '''iconImage''').
	<syntaxhighlight lang="lua">dgsSetProperty(button,"iconSize",{iconSizeX,iconSizeY,relative})</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(button,"iconSize",{iconSizeX,iconSizeY,relative})</syntaxhighlight>
	*'''iconSizeX''' : ~~An integer~~ of the 2D X scale to the position of the icon image.		*'''iconSizeX''' : A number of the 2D X scale to the position of the icon image.
	*'''iconSizeY''' : ~~An integer~~ of the 2D Y scale to the position of the icon image.		*'''iconSizeY''' : A number of the 2D Y scale to the position of the icon image.
	*'''relative''' : A bool of whether the iconSize is relative to the height of text or absolute pixels.		*'''relative''' : A bool of whether the iconSize is relative to the height of text or absolute pixels.

SFX: Added disabledColor property

2023-06-18T10:45:58Z

Added disabledColor property

← Older revision		Revision as of 10:45, 18 June 2023
Line 26:		Line 26:
	*'''hoveringColor:''' An integer of the color of the background of the button which is selected.		*'''hoveringColor:''' An integer of the color of the background of the button which is selected.
	*'''clickedColor:''' An integer of the color of the background of the button which is clicked.		*'''clickedColor:''' An integer of the color of the background of the button which is clicked.

			===disabledColor===
			The color which can be translated by [[tocolor]] of the background of the button when disabled.
			<syntaxhighlight lang="lua">dgsSetProperty(button,"disabledColor",disabledColor)</syntaxhighlight>
			*'''disabledColor:''' An integer of the color of the background of the button when disabled.

	===colorCoded===		===colorCoded===

XLive: Moved to mouseButtons property

2023-06-11T14:10:11Z

Moved to mouseButtons property

← Older revision		Revision as of 14:10, 11 June 2023
Line 19:		Line 19:
	*'''offsetX''' : A float of the 2D X offset relative to the position of the button.		*'''offsetX''' : A float of the 2D X offset relative to the position of the button.
	*'''offsetY''' : A float of the 2D Y offset relative to the position of the button.		*'''offsetY''' : A float of the 2D Y offset relative to the position of the button.

	~~===clickType===~~
	~~This indicates that which button of the mouse can have effect on the button.~~
	~~<syntaxhighlight lang="lua">dgsSetProperty(button,"clickType",clickType)</syntaxhighlight>~~
	*'''clickType''' : If set to 1, only "Left Mouse Button" can do. If set to 2, only "Right Mouse Button" can do. Otherwise it will be both.

	===color===		===color===
Line 137:		Line 132:
	<syntaxhighlight lang="lua">dgsSetProperty(button,"wordBreak",wordBreak)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(button,"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}}

XLive: update image property

2022-04-30T20:35:28Z

update image property

← Older revision		Revision as of 20:35, 30 April 2022
Line 95:		Line 95:
	===image===		===image===
	Require [texture/shader] that can be used as the background of button.		Require [texture/shader] that can be used as the background of button.
			<syntaxhighlight lang="lua">dgsSetProperty(button,"image",image)</syntaxhighlight>
			*'''image:''' A texture/shader element of the background of the button
			Or
	<syntaxhighlight lang="lua">dgsSetProperty(button,"image",{normalImage,hoveringImage,ClickedImage})</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(button,"image",{normalImage,hoveringImage,ClickedImage})</syntaxhighlight>
	*'''normalImage:''' A texture/shader element of the background of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this image option )		*'''normalImage:''' A texture/shader element of the background of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this image option )

Thisdp at 17:29, 23 April 2022

2022-04-23T17:29:13Z

@@ Line 46: / Line 46: @@
 <syntaxhighlight lang="lua">dgsSetProperty(button,"font",font)</syntaxhighlight>
 *'''font''' : A [[Element/DX_font|dx font element]] of the text font of the button.
 ===iconColor===
@@ Line 53: / Line 59: @@
 *'''hoveringColor:''' An integer of the color of the icon image of the button which is selected.
 *'''clickedColor:''' An integer of the color of the icon image of the button which is clicked.
 ===iconImage===
@@ Line 78: / Line 73: @@
 *'''iconOffsetY''' : An integer of the 2D Y offset in pixels to the position of the icon.
 *'''relative''' : A bool of whether the iconOffset is relative to the height of text or absolute pixels.
 ===iconShadow===

Thisdp: /* iconImage */

2022-04-23T17:28:43Z

iconImage

← Older revision		Revision as of 17:28, 23 April 2022
Line 67:		Line 67:
	===iconImage===		===iconImage===
	Require [texture/shader] that can be used as the icon image of button.		Require [texture/shader] that can be used as the icon image of button.
	<syntaxhighlight lang="lua">dgsSetProperty(button,"iconImage",{normalImage,hoveringImage,~~ClickedImage~~})</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(button,"iconImage",{normalImage,hoveringImage,clickedImage})</syntaxhighlight>
	*'''normalImage:''' A texture/shader element of the icon image of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this option )		*'''normalImage:''' A texture/shader element of the icon image of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this option )
	*'''hoveringImage:''' A texture/shader element of the icon image of the button which is selected. ( You can pass a nil value to disable this option )		*'''hoveringImage:''' A texture/shader element of the icon image of the button which is selected. ( You can pass a nil value to disable this option )

Thisdp at 17:28, 23 April 2022

2022-04-23T17:28:22Z

← Older revision		Revision as of 17:28, 23 April 2022
Line 54:		Line 54:
	*'''clickedColor:''' An integer of the color of the icon image of the button which is clicked.		*'''clickedColor:''' An integer of the color of the icon image of the button which is clicked.

	===~~iconDirection~~===		===iconAlignment===
	~~This property enables you to change~~ the ~~direction~~ of the icon ~~(Work with~~ '''~~iconImage~~''').		Alignment of the icon within the button.
	<syntaxhighlight lang="lua">dgsSetProperty(button,"~~iconDirection~~",~~iconDirection~~)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(button,"iconAlignment",{alignX,alignY})</syntaxhighlight>
	*'''~~iconDirection~~''' : A ~~string~~ determines ~~where will~~ the icon ~~image be. Available values are "left" and "right"~~.		*'''alignX:''' Horizontal alignment of the icon within the button. Can be "left", "center" or "right".
			*'''alignY:''' Vertical alignment of the icon within the button. Can be "top", "center" or "bottom".

			===iconRelative===
			This property determines whether the icon is relative to the text or button.
			<syntaxhighlight lang="lua">dgsSetProperty(button,"iconRelative",iconRelative)</syntaxhighlight>
			*'''iconRelative:''' A bool determines whether the icon is relative to the text or button.

	===iconImage===		===iconImage===
Line 68:		Line 74:
	===iconOffset===		===iconOffset===
	This property enables you to change the offset of the icon from the text (Work with '''iconImage''').		This property enables you to change the offset of the icon from the text (Work with '''iconImage''').
	~~<syntaxhighlight lang="lua">dgsSetProperty(button,"iconOffset",iconOffset)</syntaxhighlight>~~		<syntaxhighlight lang="lua">dgsSetProperty(button,"iconOffset",{iconOffsetX,iconOffsetY,relative})</syntaxhighlight>
	*'''iconOffset''' : An integer of the 2D offset in pixels to the distance of the icon to the text.

	<syntaxhighlight lang="lua">dgsSetProperty(button,"iconOffset",{iconOffsetX,iconOffsetY})</syntaxhighlight>
	*'''iconOffsetX''' : An integer of the 2D X offset in pixels to the position of the icon.		*'''iconOffsetX''' : An integer of the 2D X offset in pixels to the position of the icon.
	*'''iconOffsetY''' : An integer of the 2D Y offset in pixels to the position of the icon.		*'''iconOffsetY''' : An integer of the 2D Y offset in pixels to the position of the icon.
			*'''relative''' : A bool of whether the iconOffset is relative to the height of text or absolute pixels.

	===iconShadow===		===iconShadow===

Thisdp at 07:56, 25 February 2022

2022-02-25T07:56:18Z

← Older revision		Revision as of 07:56, 25 February 2022
Line 32:		Line 32:
	*'''clickedColor:''' An integer of the color of the background of the button which is clicked.		*'''clickedColor:''' An integer of the color of the background of the button which is clicked.

	===~~colorcoded~~===		===colorCoded===
	Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''		Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
	<syntaxhighlight lang="lua">dgsSetProperty(button,"~~colorcoded~~",~~colorcoded~~)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(button,"colorCoded",colorCoded)</syntaxhighlight>
	*'''~~colorcoded~~''' : Set to true to enable embedded #FFFFFF color codes.		*'''colorCoded''' : Set to true to enable embedded #FFFFFF color codes.

	===colorTransitionPeriod===		===colorTransitionPeriod===
Line 126:		Line 126:
	*'''color''' : An integer of the color of the shadow text of the button.		*'''color''' : An integer of the color of the shadow text of the 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(button,"~~wordbreak~~",~~wordbreak~~)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(button,"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}}