FCMCustomWindow

Summary of modifications:

  • Create* methods have an additional optional parameter for specifying a control name. Named controls can be retrieved via GetControl.
  • Cache original control objects to preserve mixin data and override control getters to return the original objects.
  • Added Each method for iterating over controls by class name.

Functions

Init

fcmcustomwindow.Init(self)

View source

[Internal]

Input Type Description
self FCMCustomWindow

CreateCancelButton

fcmcustomwindow.CreateCancelButton(self, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
control_name (optional) `FCString string`
Return type Description
FCMCtrlButton

CreateOkButton

fcmcustomwindow.CreateOkButton(self, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
control_name (optional) `FCString string`
Return type Description
FCMCtrlButton

CreateButton

fcmcustomwindow.CreateButton(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlButton

CreateCheckbox

fcmcustomwindow.CreateCheckbox(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlCheckbox

CreateDataList

fcmcustomwindow.CreateDataList(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlDataList

CreateEdit

fcmcustomwindow.CreateEdit(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlEdit

CreateListBox

fcmcustomwindow.CreateListBox(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlListBox

CreatePopup

fcmcustomwindow.CreatePopup(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlPopup

CreateSlider

fcmcustomwindow.CreateSlider(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlSlider

CreateStatic

fcmcustomwindow.CreateStatic(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlStatic

CreateSwitcher

fcmcustomwindow.CreateSwitcher(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlSwitcher

CreateTree

fcmcustomwindow.CreateTree(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlTree

CreateUpDown

fcmcustomwindow.CreateUpDown(self, x, y, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlUpDown

CreateHorizontalLine

fcmcustomwindow.CreateHorizontalLine(self, x, y, length, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
length number
control_name (optional) `FCString string`
Return type Description
FCMCtrlLine

CreateVerticalLine

fcmcustomwindow.CreateVerticalLine(self, x, y, length, control_name)

View source

[Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
length number
control_name (optional) `FCString string`
Return type Description
FCMCtrlLine

FindControl

fcmcustomwindow.FindControl(self, control_id)

View source

[PDK Port] Finds a control based on its ID.

Input Type Description
self FCMCustomWindow
control_id number
Return type Description
FCMControl|nil

GetControl

fcmcustomwindow.GetControl(self, control_name)

View source

Finds a control based on its name.

Input Type Description
self FCMCustomWindow
control_name `FCString string`
Return type Description
FCMControl|nil

Each

fcmcustomwindow.Each(self, class_filter)

View source

An iterator for controls that can filter by class.

Input Type Description
self FCMCustomWindow
class_filter (optional) string A class name, can be a parent class. See documentation mixin.is_instance_of for details on class filtering.
Return type Description
function An iterator function.

GetItemAt

fcmcustomwindow.GetItemAt(self, index)

View source

[Override] Ensures that the original control object is returned.

Input Type Description
self FCMCustomWindow
index number
Return type Description
FCMControl

CreateCloseButton

fcmcustomwindow.CreateCloseButton(self, x, y, control_name)

View source

[>= v0.56] [Override] Add optional control_name parameter.

Input Type Description
self FCMCustomWindow
x number
y number
control_name (optional) `FCString string`
Return type Description
FCMCtrlButton

GetParent

fcmcustomwindow.GetParent(self)

View source

[PDK Port] Returns the parent window. The parent will only be available while the window is showing.

Input Type Description
self FCMCustomWindow
Return type Description
FCMCustomWindow|nil nil if no parent

ExecuteModal

fcmcustomwindow.ExecuteModal(self, parent)

View source

[Override] Stores the parent window to make it available via GetParent.

Input Type Description
self FCMCustomWindow
parent `FCCustomWindow FCMCustomWindow
Return type Description
number