FCMCtrlSwitcher

Summary of Modifications

• Setters that accept FCString will also accept Lua string and number.
• Methods that returned a boolean to indicate success/failure now throw an error instead.
• Added methods for accessing and adding pages.
• Added PageChange custom control event.

Functions

• Init(self)
• AddPage(self, title)
• AddPages(self)
• AttachControl(self, control, pageindex)
• AttachControlByTitle(self, control, title)
• SetSelectedPage(self, index)
• SetSelectedPageByTitle(self, title)
• GetSelectedPageTitle(self, title)
• GetPageTitle(self, index, str)
• HandlePageChange(control, last_page, last_page_title)
• AddHandlePageChange(self, callback)
• RemoveHandlePageChange(self, callback)

Init

fcmctrlswitcher.Init(self)

View source

[Internal]

Input	Type	Description
self	FCMCtrlSwitcher

AddPage

fcmctrlswitcher.AddPage(self, title)

View source

[Fluid] [Override]

Override Changes:

• Accepts Lua string or number in addition to FCString.

Input	Type	Description
self	FCMCtrlSwitcher
title	`FCString	string

AddPages

fcmctrlswitcher.AddPages(self)

View source

[Fluid]

Adds multiple pages, one page for each argument.

@ … (FCString | string | number)

Input	Type	Description
self	FCMCtrlSwitcher

AttachControl

fcmctrlswitcher.AttachControl(self, control, pageindex)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

• Throws an error instead of returning a boolean for success/failure.

Input	Type	Description
self	FCMCtrlSwitcher
control	`FCControl	FCMControl`
pageindex	number

AttachControlByTitle

fcmctrlswitcher.AttachControlByTitle(self, control, title)

View source

[Fluid]

Attaches a control to a page by its title.

Input	Type	Description
self	FCMCtrlSwitcher
control	`FCControl	FCMControl`
title	`FCString	string

SetSelectedPage

fcmctrlswitcher.SetSelectedPage(self, index)

View source

[Fluid] [Override]

Override Changes:

• Ensures that PageChange event is triggered.

Input	Type	Description
self	FCMCtrlSwitcher
index	number

SetSelectedPageByTitle

fcmctrlswitcher.SetSelectedPageByTitle(self, title)

View source

[Fluid]

Set the selected page by its title. If the page is not found, an error will be thrown.

Input	Type	Description
self	FCMCtrlSwitcher
title	`FCString	string

GetSelectedPageTitle

fcmctrlswitcher.GetSelectedPageTitle(self, title)

View source

[?Fluid]

Retrieves the title of the currently selected page.

Input	Type	Description
self	FCMCtrlSwitcher
title (optional)	FCString	Optional FCString object to populate.

Return type	Description
string | nil	Returned if title is omitted. nil if no page is selected

GetPageTitle

fcmctrlswitcher.GetPageTitle(self, index, str)

View source

[?Fluid]

Retrieves the title of a page.

Input	Type	Description
self	FCMCtrlSwitcher
index	number	The 0-based index of the page.
str (optional)	FCString	An optional FCString object to populate.

Return type	Description
string	Returned if str is omitted.

HandlePageChange

fcmctrlswitcher.HandlePageChange(control, last_page, last_page_title)

View source

[Callback Template]

Input	Type	Description
control	FCMCtrlSwitcher	The control on which the event occurred.
last_page	number	The 0-based index of the previously selected page. If no page was previously selected, this will be -1 (eg when the window is created).
last_page_title	string	The title of the previously selected page.

AddHandlePageChange

fcmctrlswitcher.AddHandlePageChange(self, callback)

View source

[Fluid]

Adds an event listener for PageChange events. The event fires when:

• The window is created (if pages have been added)
• The user switches page
• The selected page is changed programmatically (if the selected page is changed within a handler, that same handler will not be called for that change)

Input	Type	Description
self	FCMCtrlSwitcher
callback	function	See HandlePageChange for callback signature.

RemoveHandlePageChange

fcmctrlswitcher.RemoveHandlePageChange(self, callback)

View source

[Fluid]

Removes a handler added with AddHandlePageChange.

Input	Type	Description
self	FCMCtrlSwitcher
callback	function