Notebook

From VisionaireWiki
Jump to: navigation, search

notebook

Creates a notebook control.

Lua Syntax:

notebook( [windowName], {flags=1, 
    edit = true|false, 
    freeze = true|false, 
    select = int, 
    action = {"string1","string2",...}, 
    deactivateAction = {"string1","string2",...}, 
    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 notebook-control.

Flags

e/edit

If true then edit an existing notebook.

fz/freeze

If true then the notebook will be frozen (layout is not updated and notebook not shown).If false then the notebook is thawn (layout is updated again and notebook is shown).If flag is not specified then the notebook is neither frozen nor thawn.

s/select

Selects a page of the notebook. The first page has index 0.

a/action

List of actions (for each notebook page) which will be called if the corresponding page is activated.

da/deactivateAction

List of actions (for each notebook page) which will be called if the corresponding page is deactivated.

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 notebook control.