Difference between revisions of "ComboBox"

From VisionaireWiki
Jump to navigation Jump to search
(Removing all content from page)
m (Bot (Edward's framework))
 
Line 1: Line 1:
 +
==comboBox==
 +
Creates a combo-box.
  
 +
Lua Syntax:
 +
<pre>comboBox( [windowName], {flags=1,
 +
    edit = true|false,
 +
    select = int,
 +
    position = {x=int,y=int},
 +
    size = {x=int,y=int},
 +
    border = "[lrtb] width",
 +
    align = "left"|"right"|"center"|"top"|"bottom",
 +
    expand = "shaped",
 +
    proportion = int})</pre>
 +
===Arguments===
 +
====windowName====
 +
:'''"string"''' - Name of the new control. If omitted a unique name is generated automatically.
 +
===Flags===
 +
====e/edit====
 +
 +
:If true then edit an existing combobox.
 +
====s/select====
 +
 +
:Selects an entry of the combobox. Specifies the entry (first entry is 0) which will be selected. Only allowed with edit flag.
 +
====pos/position====
 +
 +
:Specifies the position of the window.
 +
====sz/size====
 +
 +
:Specifies the size of the window.
 +
====b/border====
 +
 +
:This flag specifies to which side(s) of the control a border will be applied to.
 +
:'''"[lrtb] width"''' - First group is a string combining characters standing for 'left', 'right', 'top' and 'bottom' side.After a space the width of the border in pixel is specified.
 +
====al/align====
 +
 +
:Specifies the alignment of the item within the space allotted to it by the layout.
 +
:'''"left"|"right"|"center"|"top"|"bottom"''' - Alignment of control. Top- and bottom-align only makes sense in a row-layout, left- and right-align in a column layout.
 +
====exp/expand====
 +
 +
:Specifies whether the item will be expanded to fill the space assigned to the item.
 +
:'''"shaped"''' - With this argument the item will be expanded as much as possible while also maintaining its aspect ratio
 +
====p/proportion====
 +
 +
:Used in row- and column-layout to indicate if a child of a layout can change its size in the main orientation of the layout - where 0 stands for not changeable and a value of more than zero is interpreted relative to the value of other children of the same layout.
 +
===Return Values===
 +
;String
 +
:Name of the new control.

Latest revision as of 12:57, 16 August 2009

comboBox

Creates a combo-box.

Lua Syntax:

comboBox( [windowName], {flags=1, 
    edit = true|false, 
    select = int, 
    position = {x=int,y=int}, 
    size = {x=int,y=int}, 
    border = "[lrtb] width", 
    align = "left"|"right"|"center"|"top"|"bottom", 
    expand = "shaped", 
    proportion = int})

Arguments

windowName

"string" - Name of the new control. If omitted a unique name is generated automatically.

Flags

e/edit

If true then edit an existing combobox.

s/select

Selects an entry of the combobox. Specifies the entry (first entry is 0) which will be selected. Only allowed with edit flag.

pos/position

Specifies the position of the window.

sz/size

Specifies the size of the window.

b/border

This flag specifies to which side(s) of the control a border will be applied to.
"[lrtb] width" - First group is a string combining characters standing for 'left', 'right', 'top' and 'bottom' side.After a space the width of the border in pixel is specified.

al/align

Specifies the alignment of the item within the space allotted to it by the layout.
"left"|"right"|"center"|"top"|"bottom" - Alignment of control. Top- and bottom-align only makes sense in a row-layout, left- and right-align in a column layout.

exp/expand

Specifies whether the item will be expanded to fill the space assigned to the item.
"shaped" - With this argument the item will be expanded as much as possible while also maintaining its aspect ratio

p/proportion

Used in row- and column-layout to indicate if a child of a layout can change its size in the main orientation of the layout - where 0 stands for not changeable and a value of more than zero is interpreted relative to the value of other children of the same layout.

Return Values

String
Name of the new control.