DgsWindowGetTextExtent: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function returns the extent, or width, of the current title text of a DGS window. ==Syntax== <syntaxhighlight lang="lua"> float dgsWindowGetTextExtent ( element theWIndow ) </syntaxhighlight> ===Required Arguments=== *'''theWIndow:''' The window to get the title text extent from. ===Returns=== Returns the absolute width of the the current title text of a DGS window if the function is successful, ''false'' otherwise. ==Example== T...")
 
 
(One intermediate revision by the same user not shown)
Line 17: Line 17:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
-- create the window (the container for our label)
-- create the window
local myWindow = DGS:dgsCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )
local myWindow = DGS:dgsCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )


Line 23: Line 23:
local textExtent = DGS:dgsWindowGetTextExtent( myWindow )
local textExtent = DGS:dgsWindowGetTextExtent( myWindow )
local fontHeight = DGS:dgsWindowGetFontHeight( myWindow )
local fontHeight = DGS:dgsWindowGetFontHeight( myWindow )
DGS:dgsSetSize ( myWindow, textExtent, _, false)
DGS:dgsSetSize ( myWindow, textExtent, _, false )
DGS:dgsSetProperty ( myWindow, "titleHeight", fontHeight )
DGS:dgsSetProperty ( myWindow, "titleHeight", fontHeight )
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 13:54, 3 November 2022

This function returns the extent, or width, of the current title text of a DGS window.

Syntax

float dgsWindowGetTextExtent ( element theWIndow )

Required Arguments

  • theWIndow: The window to get the title text extent from.

Returns

Returns the absolute width of the the current title text of a DGS window if the function is successful, false otherwise.

Example

This example creates a window, gets the title text extent and font height, and sets the window width and height size according to these values.

DGS = exports.dgs
-- create the window
local myWindow = DGS:dgsCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )

-- get the (absolute) text extent and font height, and use these to resize the window width and title height
local textExtent = DGS:dgsWindowGetTextExtent( myWindow )
local fontHeight = DGS:dgsWindowGetFontHeight( myWindow )
DGS:dgsSetSize ( myWindow, textExtent, _, false )
DGS:dgsSetProperty ( myWindow, "titleHeight", fontHeight )

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