FCMCtrlListBox

Summary of modifications:

  • Setters that accept FCString now also accept Lua string and number.
  • In getters with an FCString parameter, the parameter is now optional and a Lua string is returned.
  • Setters that accept FCStrings now also accept multiple arguments of FCString, Lua string, or number.
  • Numerous additional methods for accessing and modifying listbox items.
  • Added SelectionChange custom control event.

Functions

Init

fcmctrllistbox.Init(self)

View source

[Internal]

Input Type Description
self FCMCtrlListBox

Clear

fcmctrllistbox.Clear(self)

View source

[Fluid] [Override]

Input Type Description
self FCMCtrlListBox

SetSelectedItem

fcmctrllistbox.SetSelectedItem(self, index)

View source

[Fluid] [Override] Ensures that SelectionChange is triggered.

Input Type Description
self FCMCtrlListBox
index number

SetSelectedLast

fcmctrllistbox.SetSelectedLast(self)

View source

[Override] Ensures that SelectionChange is triggered.

Input Type Description
self FCMCtrlListBox
Return type Description
boolean true if a selection was possible.

AddString

fcmctrllistbox.AddString(self, str)

View source

[Fluid] [Override]

Accepts Lua string and number in addition to FCString.

Input Type Description
self FCMCtrlListBox
str `FCString string

AddStrings

fcmctrllistbox.AddStrings(self)

View source

[Fluid] Adds multiple strings to the list box.

@ … (FCStrings|FCString|string|number)

Input Type Description
self FCMCtrlListBox

GetStrings

fcmctrllistbox.GetStrings(self, strs)

View source

Returns a copy of all strings in the list box.

Input Type Description
self FCMCtrlListBox
strs (optional) FCStrings An optional FCStrings object to populate with strings.
Return type Description
table A table of strings (1-indexed - beware if accessing keys!).

SetStrings

fcmctrllistbox.SetStrings(self)

View source

[Fluid] [Override] Accepts multiple arguments.

@ … (FCStrings|FCString|string|number) numbers will be automatically cast to string

Input Type Description
self FCMCtrlListBox

GetItemText

fcmctrllistbox.GetItemText(self, index, str)

View source

Returns the text for an item in the list box. This method works in all JW/RGP Lua versions and irrespective of whether InitWindow has been called.

Input Type Description
self FCMCtrlListBox
index number 0-based index of item.
str (optional) FCString Optional FCString object to populate with text.
Return type Description
string

SetItemText

fcmctrllistbox.SetItemText(self, index, str)

View source

[Fluid] [PDK Port] Sets the text for an item.

Input Type Description
self FCMCtrlListBox
index number 0-based index of item.
str `FCString string

GetSelectedString

fcmctrllistbox.GetSelectedString(self, str)

View source

Returns the text for the item that is currently selected.

Input Type Description
self FCMCtrlListBox
str (optional) FCString Optional FCString object to populate with text. If no item is currently selected, it will be populated with an empty string.
Return type Description
string|nil nil if no item is currently selected.

SetSelectedString

fcmctrllistbox.SetSelectedString(self, str)

View source

[Fluid] Sets the currently selected item to the first item with a matching text value.

If no match is found, the current selected item will remain selected.

Input Type Description
self FCMCtrlListBox
str `FCString string

InsertItem

fcmctrllistbox.InsertItem(self, index, str)

View source

[Fluid] [PDKPort] Inserts a string at the specified index. If index is <= 0, will insert at the start. If index is >= Count, will insert at the end.

Input Type Description
self FCMCtrlListBox
index number 0-based index to insert new item.
str `FCString string

DeleteItem

fcmctrllistbox.DeleteItem(self, index)

View source

[Fluid] [PDK Port] Deletes an item from the list box. If the currently selected item is deleted, items will be deselected (ie set to -1)

Input Type Description
self FCMCtrlListBox
index number 0-based index of item to delete.

HandleSelectionChange

fcmctrllistbox.HandleSelectionChange(control, last_item, last_item_text, is_deleted)

View source

[Callback Template]

Input Type Description
control FCMCtrlListBox
last_item number The 0-based index of the previously selected item. If no item was selected, the value will be -1.
last_item_text string The text value of the previously selected item.
is_deleted boolean true if the previously selected item is no longer in the control.

AddHandleSelectionChange

fcmctrllistbox.AddHandleSelectionChange(self, callback)

View source

[Fluid] Adds a handler for SelectionChange events. If the selected item is changed by a handler, that same handler will not be called again for that change.

The event will fire in the following cases:

  • When the window is created (if an item is selected)
  • Change in selected item by user or programatically (inserting an item before or after will not trigger the event)
  • Changing the text value of the currently selected item
  • Deleting the currently selected item
  • Clearing the control (including calling Clear and SetStrings)
Input Type Description
self FCMCtrlListBox
callback function See HandleSelectionChange for callback signature.

RemoveHandleSelectionChange

fcmctrllistbox.RemoveHandleSelectionChange(self, callback)

View source

[Fluid] Removes a handler added with AddHandleSelectionChange.

Input Type Description
self FCMCtrlListBox
callback function Handler to remove.