Class OptionButton

Namespace
Forma
Assembly
Forma.dll

Opens a popup menu of choices and reflects the selected item's text and icon.

public sealed class OptionButton : BaseButton, IAddChild<Control>, IAddChild, INotifyPropertyChanged, IDisposable
Inheritance
OptionButton
Implements
Inherited Members

Constructors

OptionButton() 

public OptionButton()

Properties

AccessibilityRole 

public override AccessibilityRole AccessibilityRole { get; }

Property Value

AccessibilityRole

AllowReselect 

public bool AllowReselect { get; set; }

Property Value

bool

DisableShortcuts

Gates OptionButton's own accelerator/shortcut item activation, matching Godot's disable_shortcuts property.

public bool DisableShortcuts { get; set; }

Property Value

bool

FitToLongestItem 

public bool FitToLongestItem { get; set; }

Property Value

bool

ItemItems 

public IReadOnlyList<OptionButtonItem> ItemItems { get; }

Property Value

IReadOnlyList<OptionButtonItem>

Items 

public IReadOnlyList<string> Items { get; }

Property Value

IReadOnlyList<string>

Popup 

public PopupMenu Popup { get; }

Property Value

PopupMenu

Selected 

public int Selected { get; }

Property Value

int

SelectedId 

public int SelectedId { get; }

Property Value

int

SelectedMetadata 

public object SelectedMetadata { get; }

Property Value

object

Methods

AddIconItem(Texture2D, string, int) 

public int AddIconItem(Texture2D icon, string text, int id = -1)

Parameters

icon Texture2D
text string
id int

Returns

int

AddItem(string, int) 

public int AddItem(string text, int id = -1)

Parameters

text string
id int

Returns

int

AddSeparator(string) 

public int AddSeparator(string text = "")

Parameters

text string

Returns

int

Clear() 

public void Clear()

GetAllowReselect() 

public bool GetAllowReselect()

Returns

bool

GetItemAutoTranslateMode(int) 

public AutoTranslateMode GetItemAutoTranslateMode(int index)

Parameters

index int

Returns

AutoTranslateMode

GetItemCount() 

public int GetItemCount()

Returns

int

GetItemIcon(int) 

public Texture2D GetItemIcon(int index)

Parameters

index int

Returns

Texture2D

GetItemId(int) 

public int GetItemId(int index)

Parameters

index int

Returns

int

GetItemIndex(int) 

public int GetItemIndex(int id)

Parameters

id int

Returns

int

GetItemMetadata(int) 

public object GetItemMetadata(int index)

Parameters

index int

Returns

object

GetItemText(int) 

public string GetItemText(int index)

Parameters

index int

Returns

string

GetItemTooltip(int) 

public string GetItemTooltip(int index)

Parameters

index int

Returns

string

GetMinimumSize() 

public override Vector2 GetMinimumSize()

Returns

Vector2

GetSearchBarFuzzySearchMaxMisses() 

public int GetSearchBarFuzzySearchMaxMisses()

Returns

int

GetSearchBarMinItemCount() 

public int GetSearchBarMinItemCount()

Returns

int

GetSelectableItem(bool) 

public int GetSelectableItem(bool fromLast = false)

Parameters

fromLast bool

Returns

int

HasSelectableItems() 

public bool HasSelectableItems()

Returns

bool

IsFitToLongestItem() 

public bool IsFitToLongestItem()

Returns

bool

IsItemDisabled(int) 

public bool IsItemDisabled(int index)

Parameters

index int

Returns

bool

IsItemSeparator(int) 

public bool IsItemSeparator(int index)

Parameters

index int

Returns

bool

IsSearchBarEnabled() 

public bool IsSearchBarEnabled()

Returns

bool

IsSearchBarFuzzySearchEnabled() 

public bool IsSearchBarFuzzySearchEnabled()

Returns

bool

RemoveItem(int) 

public void RemoveItem(int index)

Parameters

index int

Select(int) 

public void Select(int index)

Parameters

index int

Select(int, bool) 

public void Select(int index, bool emitSignal)

Parameters

index int
emitSignal bool

SetAllowReselect(bool) 

public void SetAllowReselect(bool allow)

Parameters

allow bool

SetFitToLongestItem(bool) 

public void SetFitToLongestItem(bool fit)

Parameters

fit bool

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

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

SetItemId(int, int) 

public void SetItemId(int index, int id)

Parameters

index int
id int

SetItemMetadata(int, object) 

public void SetItemMetadata(int index, object metadata)

Parameters

index int
metadata object

SetItemText(int, string) 

public void SetItemText(int index, string text)

Parameters

index int
text string

SetItemTooltip(int, string) 

public void SetItemTooltip(int index, string tooltip)

Parameters

index int
tooltip string

SetSearchBarEnabled(bool) 

public void SetSearchBarEnabled(bool enabled)

Parameters

enabled bool

SetSearchBarFuzzySearchEnabled(bool) 

public void SetSearchBarFuzzySearchEnabled(bool enabled)

Parameters

enabled bool

SetSearchBarFuzzySearchMaxMisses(int) 

public void SetSearchBarFuzzySearchMaxMisses(int maxMisses)

Parameters

maxMisses int

SetSearchBarMinItemCount(int) 

public void SetSearchBarMinItemCount(int count)

Parameters

count int

ShowPopup() 

public void ShowPopup()

Events

ItemFocused

Raised whenever the popup's focused item changes (keyboard navigation, incremental search, hover), matching Godot's item_focused signal wired from the popup's id_focused.

public event Action<OptionButton, int> ItemFocused

Event Type

Action<OptionButton, int>

ItemSelected 

public event Action<OptionButton, int> ItemSelected

Event Type

Action<OptionButton, int>
Edit this page