ItemList
A vertical list of selectable items with one or multiple columns.
ItemList.swift:35class ItemListThis control provides a vertical list of selectable items that may be in a single or in multiple columns, with each item having options for text and an icon. Tooltips are supported and may be different for every item in the list.
Selectable items in the list may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled to allow use of popup context menus. Items may also be “activated” by double-clicking them or by pressing [kbd]Enter[/kbd].
Item text only supports single-line strings. Newline characters (e.g. \n) in the string won’t produce a newline. Text wrapping is enabled in .top mode, but the column’s width is adjusted to fully fit its content by default. You need to set fixedColumnWidth greater than zero to wrap the text.
All set_* methods allow negative item indices, i.e. -1 to access the last item, -2 to select the second-to-last item, and so on.
Incremental search: Like PopupMenu and Tree, ItemList supports searching within the list while the control is focused. Press a key that matches the first letter of an item’s name to select the first item starting with the given letter. After that point, there are two ways to perform incremental search: 1) Press the same key again before the timeout duration to select the next item starting with the same letter. 2) Press letter keys that match the rest of the word before the timeout duration to match to select the item in question directly. Both of these actions will be reset to the beginning of the list if the timeout duration has passed since the last keystroke was registered. You can adjust the timeout duration by changing ProjectSettings/gui/timers/incrementalSearchMaxIntervalMsec.
This object emits the following signals:
Superclasses
class ControlBase class for all GUI controls. Adapts its position and size based on its parent control.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentableTypes that conform to VariantRepresentable can be stored directly in
Variantwith no conversion. These include all of the Variant types from Godot (for exampleGString,Rect,Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Types
enum IconModeenum SelectModeclass Signal1Signal support.
class Signal2Signal support.
class Signal3Signal support.
class Signal4Signal support.
class Signal5Signal support.
Type members
Instance members
var allowReselect: BoolIf
true, the currently selected item can be selected again.var allowRmbSelect: BoolIf
true, right mouse button click can select items.var allowSearch: BoolIf
true, allows navigating theItemListwith letter keys through incremental search.var autoHeight: BoolIf
true, the control will automatically resize the height to fit its content.var emptyClicked: Signal2Triggered when any mouse click is issued within the rect of the list but on empty space.
var fixedColumnWidth: Int32The width all columns will be adjusted to.
var fixedIconSize: Vector2iThe size all icons will be adjusted to.
var iconMode: ItemList.IconModeThe icon position, whether above or to the left of the text. See the
IconModeconstants.var iconScale: DoubleThe scale of icon applied after
fixedIconSizeand transposing takes effect.var itemActivated: Signal5Triggered when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd].
var itemClicked: Signal3Triggered when specified list item has been clicked with any mouse button.
var itemCount: Int32The number of items currently in the list.
var itemSelected: Signal1Triggered when specified item has been selected.
var maxColumns: Int32Maximum columns the list will have.
var maxTextLines: Int32Maximum lines of text allowed in each item. Space will be reserved even when there is not enough lines of text to display.
var multiSelected: Signal4Triggered when a multiple selection is altered on a list allowing multiple selection.
var sameColumnWidth: BoolWhether all columns will have the same width.
var selectMode: ItemList.SelectModeAllows single or multiple item selection. See the
SelectModeconstants.var textOverrunBehavior: TextServer.OverrunBehaviorSets the clipping behavior when the text exceeds an item’s bounding rectangle. See
TextServer.OverrunBehaviorfor a description of all modes.func addIconItem(icon: Texture2D?, selectable: Bool) -> Int32 Adds an item to the item list with no text, only an icon. Returns the index of an added item.
func addItem(text: String, icon: Texture2D?, selectable: Bool) -> Int32 Adds an item to the item list with specified text. Returns the index of an added item.
func clear() Removes all items from the list.
func deselect(idx: Int32) Ensures the item associated with the specified index is not selected.
func deselectAll() Ensures there are no items selected.
func ensureCurrentIsVisible() Ensure current selection is visible, adjusting the scroll position as necessary.
func forceUpdateListSize() Forces an update to the list size based on its items. This happens automatically whenever size of the items, or other relevant settings like
autoHeight, change. The method can be used to trigger the update ahead of next drawing pass.func getItemAtPosition(Vector2, exact: Bool) -> Int32 Returns the item index at the given
position.func getItemCustomBgColor(idx: Int32) -> Color Returns the custom background color of the item specified by
idxindex.func getItemCustomFgColor(idx: Int32) -> Color Returns the custom foreground color of the item specified by
idxindex.func getItemIcon(idx: Int32) -> Texture2D? Returns the icon associated with the specified index.
func getItemIconModulate(idx: Int32) -> Color Returns a
Colormodulating item’s icon at the specified index.func getItemIconRegion(idx: Int32) -> Rect2 Returns the region of item’s icon used. The whole icon will be used if the region has no area.
func getItemLanguage(idx: Int32) -> String Returns item’s text language code.
func getItemMetadata(idx: Int32) -> Variant Returns the metadata value of the specified index.
func getItemRect(idx: Int32, expand: Bool) -> Rect2 Returns the position and size of the item with the specified index, in the coordinate system of the
ItemListnode. Ifexpandistruethe last column expands to fill the rest of the row.func getItemText(idx: Int32) -> String Returns the text associated with the specified index.
func getItemTextDirection(idx: Int32) -> Control.TextDirection Returns item’s text base writing direction.
func getItemTooltip(idx: Int32) -> String Returns the tooltip hint associated with the specified index.
func getSelectedItems() -> PackedInt32Array Returns an array with the indexes of the selected items.
func getVScrollBar() -> VScrollBar? Returns the vertical scrollbar.
func isAnythingSelected() -> Bool Returns
trueif one or more items are selected.func isItemDisabled(idx: Int32) -> Bool Returns
trueif the item at the specified index is disabled.func isItemIconTransposed(idx: Int32) -> Bool Returns
trueif the item icon will be drawn transposed, i.e. the X and Y axes are swapped.func isItemSelectable(idx: Int32) -> Bool Returns
trueif the item at the specified index is selectable.func isItemTooltipEnabled(idx: Int32) -> Bool Returns
trueif the tooltip is enabled for specified item index.func isSelected(idx: Int32) -> Bool Returns
trueif the item at the specified index is currently selected.func moveItem(fromIdx: Int32, toIdx: Int32) Moves item from index
fromIdxtotoIdx.func removeItem(idx: Int32) Removes the item specified by
idxindex from the list.func select(idx: Int32, single: Bool) Select the item at the specified index.
func setItemCustomBgColor(idx: Int32, customBgColor: Color) Sets the background color of the item specified by
idxindex to the specifiedColor.func setItemCustomFgColor(idx: Int32, customFgColor: Color) Sets the foreground color of the item specified by
idxindex to the specifiedColor.func setItemDisabled(idx: Int32, disabled: Bool) Disables (or enables) the item at the specified index.
func setItemIcon(idx: Int32, icon: Texture2D?) Sets (or replaces) the icon’s
Texture2Dassociated with the specified index.func setItemIconModulate(idx: Int32, modulate: Color) Sets a modulating
Colorof the item associated with the specified index.func setItemIconRegion(idx: Int32, rect: Rect2) Sets the region of item’s icon used. The whole icon will be used if the region has no area.
func setItemIconTransposed(idx: Int32, transposed: Bool) Sets whether the item icon will be drawn transposed.
func setItemLanguage(idx: Int32, language: String) Sets language code of item’s text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
func setItemMetadata(idx: Int32, metadata: Variant) Sets a value (of any type) to be stored with the item associated with the specified index.
func setItemSelectable(idx: Int32, selectable: Bool) Allows or disallows selection of the item associated with the specified index.
func setItemText(idx: Int32, text: String) Sets text of the item associated with the specified index.
func setItemTextDirection(idx: Int32, direction: Control.TextDirection) Sets item’s text base writing direction.
func setItemTooltip(idx: Int32, tooltip: String) Sets the tooltip hint for the item associated with the specified index.
func setItemTooltipEnabled(idx: Int32, enable: Bool) Sets whether the tooltip hint is enabled for specified item index.
func sortItemsByText() Sorts items in the list by their text.