DgsComboBoxGetState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function gets the state of combo box (1:Drop Down; -1:Take Back). ==Syntax== <syntaxhighlight lang="lua"> bool dgsDxComboBoxGetState( elem...")
 
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function gets the state of combo box (1:Drop Down; -1:Take Back).
This function gets the state of combo box ( true:Drop Down; false:Take Back ).


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsDxComboBoxGetState( element comboBox )
bool dgsComboBoxGetState( element comboBox )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''comboBox:''' the combo box you want to select an item from
*'''comboBox:''' the combo box you want to get the state from.


===Returns===
===Returns===
Returns an integer if the state of combo box has been got successfully, ''false'' otherwise.
Returns a bool if the state of combo box has been got successfully.


==Example==
==Example==
Line 18: Line 18:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
dgsWindow = DGS:dgsDxCreateWindow(100,100,200,100,"ComboBox test area",false) -- create the container window
dgsWindow = DGS:dgsCreateWindow(100,100,200,100,"ComboBox test area",false) -- create the container window
local combobox = DGS:dgsDxCreateComboBox(20,30,150,20,"Checked ComboBox",false,dgsWindow) -- note the parameter after header, it will create a ComboBox
local combobox = DGS:dgsCreateComboBox(20,30,150,20,"Checked ComboBox",false,dgsWindow) -- note the parameter after header, it will create a ComboBox
DGS:dgsDxComboBoxAddItem(combobox,"Test1") --Add items to combobox
DGS:dgsComboBoxAddItem(combobox,"Test1") --Add items to combobox
DGS:dgsDxComboBoxAddItem(combobox,"Test2")
DGS:dgsComboBoxAddItem(combobox,"Test2")
dropState = DGS:dgsDxComboBoxGetState(combobox)
dropState = DGS:dgsComboBoxGetState(combobox)
outputChatBox("Combo Box State: "..(dropState == 1 and "Dropped Down" or "Taken Back"))
outputChatBox("Combo Box State: "..(dropState and "Dropped Down" or "Taken Back"))
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 11:15, 20 January 2018

This function gets the state of combo box ( true:Drop Down; false:Take Back ).

Syntax

bool dgsComboBoxGetState( element comboBox )

Required Arguments

  • comboBox: the combo box you want to get the state from.

Returns

Returns a bool if the state of combo box has been got successfully.

Example

DGS = exports.dgs
dgsWindow = DGS:dgsCreateWindow(100,100,200,100,"ComboBox test area",false) -- create the container window
local combobox = DGS:dgsCreateComboBox(20,30,150,20,"Checked ComboBox",false,dgsWindow) -- note the parameter after header, it will create a ComboBox
DGS:dgsComboBoxAddItem(combobox,"Test1") --Add items to combobox
DGS:dgsComboBoxAddItem(combobox,"Test2")
dropState = DGS:dgsComboBoxGetState(combobox)
outputChatBox("Combo Box State: "..(dropState and "Dropped Down" or "Taken Back"))

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/DgsComboBoxGetState?oldid=53678"