Class ItemList

Namespace
Forma
Assembly
Forma.dll

Godot-style selectable list supporting item state, columns, keyboard navigation and tile layouts.

public sealed class ItemList : TemplatedControl, IAddChild<Control>, IAddChild, INotifyPropertyChanged, IDisposable
Inheritance
ItemList
Implements
Inherited Members

Constructors

ItemList() 

public ItemList()

Properties

AccessibilityRole 

public override AccessibilityRole AccessibilityRole { get; }

Property Value

AccessibilityRole

AllowReselect 

public bool AllowReselect { get; set; }

Property Value

bool

AllowRightMouseSelect 

public bool AllowRightMouseSelect { get; set; }

Property Value

bool

AllowSearch 

public bool AllowSearch { get; set; }

Property Value

bool

AutoHeight 

public bool AutoHeight { get; set; }

Property Value

bool

AutoWidth 

public bool AutoWidth { get; set; }

Property Value

bool

Current 

public int Current { get; set; }

Property Value

int

Entries 

public IReadOnlyList<ItemListEntry> Entries { get; }

Property Value

IReadOnlyList<ItemListEntry>

FixedColumnWidth 

public int FixedColumnWidth { get; set; }

Property Value

int

FixedIconSize 

public Vector2 FixedIconSize { get; set; }

Property Value

Vector2

Font 

public SpriteFont Font { get; set; }

Property Value

SpriteFont

IconMode 

public ItemListIconMode IconMode { get; set; }

Property Value

ItemListIconMode

IconScale 

public float IconScale { get; set; }

Property Value

float

IncrementalSearchTimeout 

public TimeSpan IncrementalSearchTimeout { get; set; }

Property Value

TimeSpan

ItemCount 

public int ItemCount { get; }

Property Value

int

ItemHeight 

public float ItemHeight { get; set; }

Property Value

float

Items

Compatibility projection of the entries' text values.

public IReadOnlyList<string> Items { get; }

Property Value

IReadOnlyList<string>

MaxColumns

Maximum visual columns; zero lets the list use all fitting columns.

public int MaxColumns { get; set; }

Property Value

int

MaxTextLines 

public int MaxTextLines { get; set; }

Property Value

int

SameColumnWidth 

public bool SameColumnWidth { get; set; }

Property Value

bool

ScrollHintMode 

public ItemListScrollHintMode ScrollHintMode { get; }

Property Value

ItemListScrollHintMode

ScrollOffsetY 

public float ScrollOffsetY { get; set; }

Property Value

float

SelectModeMulti 

public bool SelectModeMulti { get; set; }

Property Value

bool

SelectionMode 

public ItemListSelectionMode SelectionMode { get; set; }

Property Value

ItemListSelectionMode

TileScrollHint 

public bool TileScrollHint { get; }

Property Value

bool

UIFont 

public UIFont UIFont { get; set; }

Property Value

UIFont

WraparoundItems 

public bool WraparoundItems { get; set; }

Property Value

bool

Methods

AddIconItem(Texture2D, bool) 

public int AddIconItem(Texture2D icon, bool selectable = true)

Parameters

icon Texture2D
selectable bool

Returns

int

AddItem(string, Texture2D, bool) 

public int AddItem(string text, Texture2D icon = null, bool selectable = true)

Parameters

text string
icon Texture2D
selectable bool

Returns

int

CenterOnCurrent(bool, bool) 

public void CenterOnCurrent(bool centerVertically = true, bool centerHorizontally = false)

Parameters

centerVertically bool
centerHorizontally bool

Clear() 

public void Clear()

ClearIncrementalSearch() 

public void ClearIncrementalSearch()

Deselect(int) 

public void Deselect(int index)

Parameters

index int

DeselectAll() 

public void DeselectAll()

EnsureCurrentIsVisible() 

public void EnsureCurrentIsVisible()

FindMetadata(object) 

public int FindMetadata(object metadata)

Parameters

metadata object

Returns

int

GetAllowReselect() 

public bool GetAllowReselect()

Returns

bool

GetAllowRmbSelect() 

public bool GetAllowRmbSelect()

Returns

bool

GetAllowSearch() 

public bool GetAllowSearch()

Returns

bool

GetIncrementalSearch() 

public string GetIncrementalSearch()

Returns

string

GetItemAtPosition(Point, bool) 

public int GetItemAtPosition(Point position, bool exact = false)

Parameters

position Point
exact bool

Returns

int

GetItemAutoTranslateMode(int) 

public AutoTranslateMode GetItemAutoTranslateMode(int index)

Parameters

index int

Returns

AutoTranslateMode

GetItemCustomBackgroundColor(int) 

public Color? GetItemCustomBackgroundColor(int index)

Parameters

index int

Returns

Color?

GetItemCustomForegroundColor(int) 

public Color? GetItemCustomForegroundColor(int index)

Parameters

index int

Returns

Color?

GetItemIcon(int) 

public Texture2D GetItemIcon(int index)

Parameters

index int

Returns

Texture2D

GetItemIconModulate(int) 

public Color GetItemIconModulate(int index)

Parameters

index int

Returns

Color

GetItemIconRegion(int) 

public Rectangle? GetItemIconRegion(int index)

Parameters

index int

Returns

Rectangle?

GetItemLanguage(int) 

public string GetItemLanguage(int index)

Parameters

index int

Returns

string

GetItemMetadata(int) 

public object GetItemMetadata(int index)

Parameters

index int

Returns

object

GetItemRect(int, bool) 

public Rectangle GetItemRect(int index, bool expand = true)

Parameters

index int
expand bool

Returns

Rectangle

GetItemTagIcon(int) 

public Texture2D GetItemTagIcon(int index)

Parameters

index int

Returns

Texture2D

GetItemText(int) 

public string GetItemText(int index)

Parameters

index int

Returns

string

GetItemTextDirection(int) 

public TextDirection GetItemTextDirection(int index)

Parameters

index int

Returns

TextDirection

GetItemTooltip(int) 

public string GetItemTooltip(int index)

Parameters

index int

Returns

string

GetMaxScrollOffsetY() 

public float GetMaxScrollOffsetY()

Returns

float

GetMinimumSize() 

public override Vector2 GetMinimumSize()

Returns

Vector2

GetScrollHintMode() 

public ItemListScrollHintMode GetScrollHintMode()

Returns

ItemListScrollHintMode

GetSelectedItems() 

public IReadOnlyList<int> GetSelectedItems()

Returns

IReadOnlyList<int>

GetTooltip(Point)

Returns the tooltip at a global pointer position. Override to provide dynamic help text.

public override string GetTooltip(Point position)

Parameters

position Point

Returns

string

GetTooltipAutoTranslateModeAt(Point) 

public AutoTranslateMode GetTooltipAutoTranslateModeAt(Point position)

Parameters

position Point

Returns

AutoTranslateMode

HasAutoHeight() 

public bool HasAutoHeight()

Returns

bool

HasAutoWidth() 

public bool HasAutoWidth()

Returns

bool

HasWraparoundItems() 

public bool HasWraparoundItems()

Returns

bool

IsAnythingSelected() 

public bool IsAnythingSelected()

Returns

bool

IsItemDisabled(int) 

public bool IsItemDisabled(int index)

Parameters

index int

Returns

bool

IsItemIconTransposed(int) 

public bool IsItemIconTransposed(int index)

Parameters

index int

Returns

bool

IsItemSelectable(int) 

public bool IsItemSelectable(int index)

Parameters

index int

Returns

bool

IsItemTooltipEnabled(int) 

public bool IsItemTooltipEnabled(int index)

Parameters

index int

Returns

bool

IsPosAtEndOfItems(Point) 

public bool IsPosAtEndOfItems(Point position)

Parameters

position Point

Returns

bool

IsScrollHintTiled() 

public bool IsScrollHintTiled()

Returns

bool

IsSelected(int) 

public bool IsSelected(int index)

Parameters

index int

Returns

bool

MoveItem(int, int) 

public void MoveItem(int fromIndex, int toIndex)

Parameters

fromIndex int
toIndex int

RemoveItem(int) 

public void RemoveItem(int index)

Parameters

index int

Select(int, bool) 

public void Select(int index, bool single = true)

Parameters

index int
single bool

SetAllowReselect(bool) 

public void SetAllowReselect(bool allow)

Parameters

allow bool

SetAllowRmbSelect(bool) 

public void SetAllowRmbSelect(bool allow)

Parameters

allow bool

SetAllowSearch(bool) 

public void SetAllowSearch(bool allow)

Parameters

allow bool

SetAutoHeight(bool) 

public void SetAutoHeight(bool enable)

Parameters

enable bool

SetAutoWidth(bool) 

public void SetAutoWidth(bool enable)

Parameters

enable bool

SetCurrent(int) 

public void SetCurrent(int index)

Parameters

index int

SetItemAutoTranslateMode(int, AutoTranslateMode) 

public void SetItemAutoTranslateMode(int index, AutoTranslateMode mode)

Parameters

index int
mode AutoTranslateMode

SetItemCount(int) 

public void SetItemCount(int count)

Parameters

count int

SetItemCustomBackgroundColor(int, Color?) 

public void SetItemCustomBackgroundColor(int index, Color? color)

Parameters

index int
color Color?

SetItemCustomForegroundColor(int, Color?) 

public void SetItemCustomForegroundColor(int index, Color? color)

Parameters

index int
color Color?

SetItemDisabled(int, bool) 

public void SetItemDisabled(int index, bool disabled)

Parameters

index int
disabled bool

SetItemIcon(int, Texture2D) 

public void SetItemIcon(int index, Texture2D icon)

Parameters

index int
icon Texture2D

SetItemIconModulate(int, Color) 

public void SetItemIconModulate(int index, Color modulate)

Parameters

index int
modulate Color

SetItemIconRegion(int, Rectangle?) 

public void SetItemIconRegion(int index, Rectangle? region)

Parameters

index int
region Rectangle?

SetItemIconTransposed(int, bool) 

public void SetItemIconTransposed(int index, bool transposed)

Parameters

index int
transposed bool

SetItemLanguage(int, string) 

public void SetItemLanguage(int index, string language)

Parameters

index int
language string

SetItemMetadata(int, object) 

public void SetItemMetadata(int index, object metadata)

Parameters

index int
metadata object

SetItemSelectable(int, bool) 

public void SetItemSelectable(int index, bool selectable)

Parameters

index int
selectable bool

SetItemTagIcon(int, Texture2D) 

public void SetItemTagIcon(int index, Texture2D icon)

Parameters

index int
icon Texture2D

SetItemText(int, string) 

public void SetItemText(int index, string text)

Parameters

index int
text string

SetItemTextDirection(int, TextDirection) 

public void SetItemTextDirection(int index, TextDirection direction)

Parameters

index int
direction TextDirection

SetItemTooltip(int, string) 

public void SetItemTooltip(int index, string tooltip)

Parameters

index int
tooltip string

SetItemTooltipEnabled(int, bool) 

public void SetItemTooltipEnabled(int index, bool enabled)

Parameters

index int
enabled bool

SetScrollHintMode(ItemListScrollHintMode) 

public void SetScrollHintMode(ItemListScrollHintMode mode)

Parameters

mode ItemListScrollHintMode

SetTileScrollHint(bool) 

public void SetTileScrollHint(bool enable)

Parameters

enable bool

SetWraparoundItems(bool) 

public void SetWraparoundItems(bool enable)

Parameters

enable bool

SortItemsByText() 

public void SortItemsByText()

Events

ItemActivated 

public event Action<ItemList, int> ItemActivated

Event Type

Action<ItemList, int>

ItemSelected 

public event Action<ItemList, int> ItemSelected

Event Type

Action<ItemList, int>

MultiSelected 

public event Action<ItemList, int, bool> MultiSelected

Event Type

Action<ItemList, int, bool>
Edit this page