DgsComboBoxSetSelectedItem: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function sets the selected item from a dgs combobox. ==Syntax== <syntaxhighlight lang="lua"> bool dgsDxComboBoxSetSelectedItem ( element c...")
 
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsDxComboBoxSetSelectedItem ( element comboBox, int itemIndex )
bool dgsComboBoxSetSelectedItem ( element comboBox, int itemIndex )
</syntaxhighlight>  
</syntaxhighlight>  


Line 20: Line 20:
DGS = exports.dgs
DGS = exports.dgs
function drawGUI()
function drawGUI()
    dgsWindow = DGS:dgsDxCreateWindow(100,100,200,100,"ComboBox test area",false,false) -- create the container window
dgsWindow = DGS:dgsCreateWindow(100,100,200,100,"ComboBox test area",false,false) -- create the container window
    combobox = DGS:dgsDxCreateComboBox(20,30,150,20,"Checked ComboBox",false,dgsWindow) -- note the parameter after header, it will create a ComboBox
combobox = DGS:dgsCreateComboBox(20,30,150,20,"Checked ComboBox",false,dgsWindow) -- note the parameter after header, it will create a ComboBox
    DGS:dgsDxComboBoxAddItem(combobox,"Selected") --Add items to combobox
DGS:dgsComboBoxAddItem(combobox,"Selected") --Add items to combobox
    DGS:dgsDxComboBoxAddItem(combobox,"UnSelected")
DGS:dgsComboBoxAddItem(combobox,"UnSelected")
    DGS:dgsDxComboBoxSetSelected(combobox,1)--set the first row which is the selected row Selected.
DGS:dgsComboBoxSetSelectedItem(combobox,1)--set the first row which is the selected row Selected.
    DGS:dgsDxGUISetVisible(dgsWindow,false) -- set it invisible just in case
DGS:dgsSetVisible(dgsWindow,false) -- set it invisible just in case
end
end


addCommandHandler("combobox",function()
addCommandHandler("combobox",function()
    if not dgsWindow then -- if it hasn't been declared yet
if not dgsWindow then -- if it hasn't been declared yet
        drawGUI() -- we draw the gui window
drawGUI() -- we draw the gui window
        DGS:dgsDxGUISetVisible(dgsWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper dgsDxGUISetVisible, but this is needed if you want to cache a window without actually showing it
DGS:dgsSetVisible(dgsWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper dgsSetVisible, but this is needed if you want to cache a window without actually showing it
    else -- if we actually have run this function before and declared dgsWindow
else -- if we actually have run this function before and declared dgsWindow
        DGS:dgsDxGUISetVisible(dgsWindow, not guiGetVisible(dgsWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it
DGS:dgsSetVisible(dgsWindow, not guiGetVisible(dgsWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it
    end
end
    showCursor(not isCursorShowing()) -- similar to above visibility
showCursor(not isCursorShowing()) -- similar to above visibility
end)
end)
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 11:13, 20 January 2018

This function sets the selected item from a dgs combobox.

Syntax

bool dgsComboBoxSetSelectedItem ( element comboBox, int itemIndex )

Required Arguments

  • comboBox: the dgs combobox you want to select an item from
  • itemIndex: the item you want to select (item 1 is the first item). If -1 is specified, then the combo box text is set to it's caption.

Returns

Returns true if the selected item has been changed successfully, false otherwise.

Example

This example creates a DGS window with a checked and an unchecked combo box and adds a command to toggle their visibility 

DGS = exports.dgs
function drawGUI()
	dgsWindow = DGS:dgsCreateWindow(100,100,200,100,"ComboBox test area",false,false) -- create the container window
	combobox = DGS:dgsCreateComboBox(20,30,150,20,"Checked ComboBox",false,dgsWindow) -- note the parameter after header, it will create a ComboBox
	DGS:dgsComboBoxAddItem(combobox,"Selected") --Add items to combobox
	DGS:dgsComboBoxAddItem(combobox,"UnSelected")
	DGS:dgsComboBoxSetSelectedItem(combobox,1)--set the first row which is the selected row Selected.
	DGS:dgsSetVisible(dgsWindow,false) -- set it invisible just in case
end

addCommandHandler("combobox",function()
	if not dgsWindow then -- if it hasn't been declared yet
		drawGUI() -- we draw the gui window
		DGS:dgsSetVisible(dgsWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper dgsSetVisible, but this is needed if you want to cache a window without actually showing it
	else -- if we actually have run this function before and declared dgsWindow
		DGS:dgsSetVisible(dgsWindow, not guiGetVisible(dgsWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it	
	end
	showCursor(not isCursorShowing()) -- similar to above visibility
end)

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/DgsComboBoxSetSelectedItem?oldid=53666"