DgsCheckBoxGetSelected: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool DgsDxCheckBoxGetSelected ( element theCheckbox )
bool dgsCheckBoxGetSelected ( element theCheckbox )
</syntaxhighlight>  
</syntaxhighlight>  


Line 17: Line 17:


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
DGS = exports.dgs
stateTable = {}
stateTable[nil] = "indeterminate"
stateTable[true] = "selected"
stateTable[false] = "unselected"
 
indeterminateBox = DGS:dgsCreateCheckBox(20,30,150,20,"Indeterminate checkbox",nil,false)
uncheckedBox = DGS:dgsCreateCheckBox(20,30,150,20,"UnChecked checkbox",false,false)
state1 = DGS:dgsCheckBoxGetSelected(indeterminateBox)
state2 = DGS:dgsCheckBoxGetSelected(uncheckedBox)
outputChatBox("Indeterminate Box state:"..stateTable[state1])
outputChatBox("unchecked Box state:"..stateTable[state2])
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 11:10, 20 January 2018

This function gets a checkbox's selection state.

Syntax

bool dgsCheckBoxGetSelected ( element theCheckbox )

Required Arguments

  • theCheckbox : The checkbox you wish to retrieve the selection state of.

Returns

Returns true if the checkbox is selected, false if it is not.

Example

DGS = exports.dgs
stateTable = {}
stateTable[nil] = "indeterminate"
stateTable[true] = "selected"
stateTable[false] = "unselected"

indeterminateBox = DGS:dgsCreateCheckBox(20,30,150,20,"Indeterminate checkbox",nil,false)
uncheckedBox = DGS:dgsCreateCheckBox(20,30,150,20,"UnChecked checkbox",false,false)
state1 = DGS:dgsCheckBoxGetSelected(indeterminateBox)
state2 = DGS:dgsCheckBoxGetSelected(uncheckedBox)
outputChatBox("Indeterminate Box state:"..stateTable[state1])
outputChatBox("unchecked Box state:"..stateTable[state2])

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