DgsEditGetMasked: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client_function}} __NOTOC__ This function get the state of edit box masking (covering up the text being typed). ==Syntax== <syntaxhighlight lang="lua"> bool dgsDxEditGetM...")
 
No edit summary
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsDxEditGetMasked ( element theElement )
bool dgsEditGetMasked ( element theElement )
</syntaxhighlight>  
</syntaxhighlight>  


Line 18: Line 18:
DGS = exports.dgs
DGS = exports.dgs
-- create a dgs edit box and define it as "editBox"
-- create a dgs edit box and define it as "editBox"
editBox = DGS:dgsDxCreateEdit( 0.3, 0.1, 0.4, 0.1, "", true )
editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "", true )
-- ensure that it is masked
-- ensure that it is masked
DGS:dgsDxEditSetMasked ( editBox, true )
DGS:dgsEditSetMasked ( editBox, true )


-- whether it is masked
-- whether it is masked
maskedState = DGS:dgsDxEditGetMasked ( editBox )
maskedState = DGS:dgsEditGetMasked ( editBox )
outputChatBox("editBox is "..(maskedState and "" or "not ").."masked")
outputChatBox("editBox is "..(maskedState and "" or "not ").."masked")



Revision as of 14:55, 18 January 2018

This function get the state of edit box masking (covering up the text being typed).

Syntax

bool dgsEditGetMasked ( element theElement )

Required Arguments

  • theElement: The dgs edit box to get.

Returns

Returns true if the edit box is masked, false if the edit box is not masked.

Example

DGS = exports.dgs
-- create a dgs edit box and define it as "editBox"
editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "", true )
-- ensure that it is masked
DGS:dgsEditSetMasked ( editBox, true )

-- whether it is masked
maskedState = DGS:dgsEditGetMasked ( editBox )
outputChatBox("editBox is "..(maskedState and "" or "not ").."masked")

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