DgsTooltipApplyTo - Revision history

Thisdp at 11:17, 24 December 2022

2022-12-24T11:17:29Z

← Older revision		Revision as of 11:17, 24 December 2022
Line 9:		Line 9:
	</syntaxhighlight>		</syntaxhighlight>

	~~[[File:DGSTooltipExample.png\|thumb\|example]]~~
	===Required Arguments===		===Required Arguments===
	*'''tooltip:''' A DGS tooltip template that you want to use.		*'''tooltip:''' A DGS tooltip template that you want to use.
Line 26:		Line 25:
	DGS = exports.dgs --get exported functions from dgs		DGS = exports.dgs --get exported functions from dgs

	local label = dgsCreateLabel(200,200,200,50,"test tooltip",false)		local label = DGS:dgsCreateLabel(200,200,200,50,"test tooltip",false)
	local tooltip = dgsCreateToolTip()		local tooltip = DGS:dgsCreateToolTip()
	dgsTooltipApplyTo(tooltip,label,"this a demo tooltip")		DGS:dgsTooltipApplyTo(tooltip,label,"this a demo tooltip")
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{DGSFUNCTIONS}}		{{DGSFUNCTIONS}}

Thisdp at 11:16, 24 December 2022

2022-12-24T11:16:22Z

← Older revision		Revision as of 11:16, 24 December 2022
Line 2:		Line 2:
	{{Client function}}		{{Client function}}

	This function ~~creates~~ a tooltip ~~as template that can be applied~~ to ~~any~~ DGS ~~elements~~.		This function applies a DGS tooltip to a DGS element.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~element~~ dgsTooltipApplyTo( [ ~~int textColor = 0xFFFFFFFF~~, ~~int bgColor~~ = ~~0x80000000~~, ~~texture bgImage~~ = ~~nil~~ ] )		bool dgsTooltipApplyTo( element tooltip, element targetElement, string text [, string/dx-font font = tooltipFont, number maxWidth = tooltipMaxWidth ] )
	</syntaxhighlight>		</syntaxhighlight>

	[[File:DGSTooltipExample.png\|thumb\|example]]		[[File:DGSTooltipExample.png\|thumb\|example]]
			===Required Arguments===
			*'''tooltip:''' A DGS tooltip template that you want to use.
			*'''targetElement:''' A DGS element that you want to apply the tooltip to.
			*'''text:''' A string of the text that will be show.

	===Optional Arguments===		===Optional Arguments===
	*'''~~textColor~~ :''' ~~An integer of the color~~ of the text of ~~the~~ tooltip.		*'''tooltipFont:''' A string/dx-font of the text font. Font of tooltip template will be used if not specified.
	*'''~~bgColor~~:''' ~~An integer~~ of the ~~background color~~ of the tooltip.		*'''maxWidth:''' A number of the max width of the tooltip that can show. MaxWidth of tooltip template will be used if not specified.
	*'''bgImage:''' A material element of the background image of ~~the~~ tooltip.

	===Returns===		===Returns===
	Returns ~~an dgs-dxtooltip(DGS Plugin Type)[dgs-dxtooltip(element type)]~~ if successful, ''false'' otherwise.		Returns ''true'' if successful, ''false'' otherwise.

	==Example==		==Example==

Thisdp at 11:08, 24 December 2022

2022-12-24T11:08:43Z

← Older revision		Revision as of 11:08, 24 December 2022
Line 9:		Line 9:
	</syntaxhighlight>		</syntaxhighlight>

	[[File:~~RemImage~~.png\|thumb\|example]]		[[File:DGSTooltipExample.png\|thumb\|example]]
	===Optional Arguments===		===Optional Arguments===
	*'''textColor :''' An integer of the color of the text of the tooltip.		*'''textColor :''' An integer of the color of the text of the tooltip.

Thisdp: Created page with "NOTOC {{Client function}} This function creates a tooltip as template that can be applied to any DGS elements. ==Syntax== element dgsTooltipApplyTo( [ int textColor = 0xFFFFFFFF, int bgColor = 0x80000000, texture bgImage = nil ] ) example ===Optional Arguments=== '''textColor :''' An integer of the color of the text of the tooltip. '''bgColor:''' An integer of the background color of..."

2022-12-24T11:08:11Z

Created page with "__NOTOC__ {{Client function}} This function creates a tooltip as template that can be applied to any DGS elements. ==Syntax== <syntaxhighlight lang="lua"> element dgsTooltipApplyTo( [ int textColor = 0xFFFFFFFF, int bgColor = 0x80000000, texture bgImage = nil ] ) </syntaxhighlight> thumb|example ===Optional Arguments=== *'''textColor :''' An integer of the color of the text of the tooltip. *'''bgColor:''' An integer of the background color of..."

New page

__NOTOC__
{{Client function}}

This function creates a tooltip as template that can be applied to any DGS elements.

==Syntax==
<syntaxhighlight lang="lua">
element dgsTooltipApplyTo( [ int textColor = 0xFFFFFFFF, int bgColor = 0x80000000, texture bgImage = nil ] )
</syntaxhighlight>

[[File:RemImage.png|thumb|example]]
===Optional Arguments===
*'''textColor :''' An integer of the color of the text of the tooltip.
*'''bgColor:''' An integer of the background color of the tooltip.
*'''bgImage:''' A material element of the background image of the tooltip.

===Returns===
Returns an dgs-dxtooltip(DGS Plugin Type)[dgs-dxtooltip(element type)] if successful, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs

local label = dgsCreateLabel(200,200,200,50,"test tooltip",false)
local tooltip = dgsCreateToolTip()
dgsTooltipApplyTo(tooltip,label,"this a demo tooltip")
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}