Panel

From VisionaireWiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

panel

Creates a panel-window.

After successful execution the new panel is the default parent-window. The default-layout is set empty.

Lua Syntax:

panel(windowName, {flags=1, 
    title = "string", 
    style = ["SIMPLE_BORDER"|"DOUBLE_BORDER"|"SUNKEN_BORDER"|"RAISED_BORDER"|"STATIC_BORDER"|"SP_NOBORDER"], 
    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 panel-window, note that for a panel-window the name is mandatory!

Flags

t/title

Specifies a title-text for the panel used as a notebook page.

st/style

Specifies the window style of the panel.
["SIMPLE_BORDER"|"DOUBLE_BORDER"|"SUNKEN_BORDER"|"RAISED_BORDER"|"STATIC_BORDER"|"SP_NOBORDER"] - SIMPLE_BORDER Displays a thin border around the window. wxBORDER is the old name for this style.
DOUBLE_BORDER Displays a double border. Windows and Mac only.
SUNKEN_BORDER Displays a sunken border.
RAISED_BORDER Displays a raised border.
STATIC_BORDER Displays a border suitable for a static control. Windows only.NO_BORDER Displays no border, overriding the default border style for the window.

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 panel-window