Difference between revisions of "Lua:Class:PageControl"
Jump to navigation
Jump to search
AntumDeluge (talk | contribs) (List some properties & events) |
AntumDeluge (talk | contribs) (Update inheritence, description, & properties) |
||
| Line 1: | Line 1: | ||
[[Category:Lua]] | [[Category:Lua]] | ||
| − | '''PageControl Class''': (Inheritence: ''[[WinControl]]'') | + | '''PageControl Class''': (Inheritence: ''[[WinControl]]'' > ''[[Control]]'' > ''[[Component]]'' > ''[[Object]]'') |
<span style="color:red; font-weight:bold; font-style:italic;">WARNING: This page is unfinished.</span> | <span style="color:red; font-weight:bold; font-style:italic;">WARNING: This page is unfinished.</span> | ||
| Line 6: | Line 6: | ||
== Description == | == Description == | ||
| − | + | This is an tabbed interface that can hold multiple pages. | |
== Creation == | == Creation == | ||
| Line 35: | Line 35: | ||
; ActivePage : ''TabSheet'' | ; ActivePage : ''TabSheet'' | ||
| − | : | + | : Contains the currently selected tab. |
| + | |||
| + | ; PageCount : ''integer'' | ||
| + | : The total number of pages. | ||
| + | |||
| + | ; Page : ''table'' | ||
| + | : Table of current TabSheets. | ||
== Methods == | == Methods == | ||
Revision as of 14:26, 14 February 2019
PageControl Class: (Inheritence: WinControl > Control > Component > Object)
WARNING: This page is unfinished.
Contents
Description
This is an tabbed interface that can hold multiple pages.
Creation
- createPageControl(owner) : PageControl
- Returns a newly created PageControl.
Properties
- ShowTabs : boolean
- Tabs are shown if true, hidden if false.
- Default: true
- TabPosition : string
- Defines along which edge tabs are located.
- Options: tpTop, tpBottom, tpLeft, tpRight.
- Default: "tpTop"
- TabIndex : integer
- Index of the currently selected tab (beginning at 0).
- Default: 0
- TabOrder : integer
- Default: 0
- TabStop : boolean
- Default: true
- ActivePage : TabSheet
- Contains the currently selected tab.
- PageCount : integer
- The total number of pages.
- Page : table
- Table of current TabSheets.
Methods
- addTab()
- TabSheet
- Creates & returns new TabSheet.
- getPageCount() : integer
- Not available?
- getPage()
- Not currently available?
- addMetaData()
- Not currently available?
Events
- OnChange()
- Action executed when selected tab changes.
- OnCloseTabClicked()
- Not currently available?
Examples
-- main window
local form = createForm()
-- create tabbed interface
local tabs = createPageControl(form)
tabs.Align = alClient
-- add tabs
local tabMain = tabs.addTab()
tabMain.setCaption("Main")
local tabSec = tabs.addTab()
tabSec.setCaption("Secondary")
-- put tabs at bottom of interface
tabs.TabPosition = "tpBottom"
