DgsTooltipApplyTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
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]]
===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==  
Line 22: 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}}

Latest revision as of 11:17, 24 December 2022

This function applies a DGS tooltip to a DGS element.

Syntax

bool dgsTooltipApplyTo( element tooltip, element targetElement, string text [, string/dx-font font = tooltipFont, number maxWidth = tooltipMaxWidth ] )

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

  • tooltipFont: A string/dx-font of the text font. Font of tooltip template will be used if not specified.
  • maxWidth: A number of the max width of the tooltip that can show. MaxWidth of tooltip template will be used if not specified.

Returns

Returns true if successful, false otherwise.

Example

DGS = exports.dgs --get exported functions from dgs

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

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsTooltipApplyTo?oldid=75805"