Class PopupMenu

Namespace
Forma
Assembly
Forma.dll

A keyboard-focusable command popup with normal, check, radio and separator entries.

[TemplatePart("PART_Items", typeof(PopupMenuItems), true)]
public sealed class PopupMenu : Popup, IAddChild<Control>, IAddChild, INotifyPropertyChanged, IDisposable
Inheritance
PopupMenu
Implements
Inherited Members

Constructors

PopupMenu() 

public PopupMenu()

Fields

ItemsPartName 

public const string ItemsPartName = "PART_Items"

Field Value

string

Properties

AccessibilityRole 

public override AccessibilityRole AccessibilityRole { get; }

Property Value

AccessibilityRole

ActiveSubmenuIndex 

public int ActiveSubmenuIndex { get; }

Property Value

int

AllowSearch 

public bool AllowSearch { get; set; }

Property Value

bool

Font 

public SpriteFont Font { get; set; }

Property Value

SpriteFont

HideOnCheckableItemSelection 

public bool HideOnCheckableItemSelection { get; set; }

Property Value

bool

HideOnItemSelection 

public bool HideOnItemSelection { get; set; }

Property Value

bool

HideOnMultistateItemSelection 

public bool HideOnMultistateItemSelection { get; set; }

Property Value

bool

HighlightedIndex 

public int HighlightedIndex { get; }

Property Value

int

IncrementalSearchTimeout 

public TimeSpan IncrementalSearchTimeout { get; set; }

Property Value

TimeSpan

IsSearchBarFocused 

public bool IsSearchBarFocused { get; }

Property Value

bool

IsSearchBarVisible 

public bool IsSearchBarVisible { get; }

Property Value

bool

ItemHeight 

public float ItemHeight { get; set; }

Property Value

float

Items 

public IReadOnlyList<PopupMenuItem> Items { get; }

Property Value

IReadOnlyList<PopupMenuItem>

ItemsControl 

public PopupMenuItems ItemsControl { get; }

Property Value

PopupMenuItems

PreferNativeMenu 

public bool PreferNativeMenu { get; }

Property Value

bool

SearchBarEnabled 

public bool SearchBarEnabled { get; set; }

Property Value

bool

SearchBarFuzzySearchEnabled 

public bool SearchBarFuzzySearchEnabled { get; set; }

Property Value

bool

SearchBarFuzzySearchMaxMisses 

public int SearchBarFuzzySearchMaxMisses { get; }

Property Value

int

SearchBarHeight 

public float SearchBarHeight { get; set; }

Property Value

float

SearchBarMinItemCount 

public int SearchBarMinItemCount { get; }

Property Value

int

SearchBarSeparation 

public float SearchBarSeparation { get; set; }

Property Value

float

ShrinkHeight 

public bool ShrinkHeight { get; set; }

Property Value

bool

ShrinkWidth 

public bool ShrinkWidth { get; set; }

Property Value

bool

SubmenuPopupDelay 

public TimeSpan SubmenuPopupDelay { get; set; }

Property Value

TimeSpan

SystemMenu 

public PopupSystemMenu SystemMenu { get; }

Property Value

PopupSystemMenu

UIFont 

public UIFont UIFont { get; set; }

Property Value

UIFont

Methods

ActivateItemByShortcut(Keys, KeyboardState, bool) 

public bool ActivateItemByShortcut(Keys key, KeyboardState keyboard, bool globalOnly = false)

Parameters

key Keys
keyboard KeyboardState
globalOnly bool

Returns

bool

AddCheckItem(string, int, PopupMenuShortcut) 

public PopupMenuItem AddCheckItem(string text, int id = -1, PopupMenuShortcut accelerator = null)

Parameters

text string
id int
accelerator PopupMenuShortcut

Returns

PopupMenuItem

AddCheckShortcut(PopupMenuShortcut, int, bool) 

public PopupMenuItem AddCheckShortcut(PopupMenuShortcut shortcut, int id = -1, bool global = false)

Parameters

shortcut PopupMenuShortcut
id int
global bool

Returns

PopupMenuItem

AddIconCheckItem(Texture2D, string, int, PopupMenuShortcut) 

public PopupMenuItem AddIconCheckItem(Texture2D icon, string text, int id = -1, PopupMenuShortcut accelerator = null)

Parameters

icon Texture2D
text string
id int
accelerator PopupMenuShortcut

Returns

PopupMenuItem

AddIconCheckShortcut(Texture2D, PopupMenuShortcut, int, bool) 

public PopupMenuItem AddIconCheckShortcut(Texture2D icon, PopupMenuShortcut shortcut, int id = -1, bool global = false)

Parameters

icon Texture2D
shortcut PopupMenuShortcut
id int
global bool

Returns

PopupMenuItem

AddIconItem(Texture2D, string, int, PopupMenuShortcut) 

public PopupMenuItem AddIconItem(Texture2D icon, string text, int id = -1, PopupMenuShortcut accelerator = null)

Parameters

icon Texture2D
text string
id int
accelerator PopupMenuShortcut

Returns

PopupMenuItem

AddIconRadioCheckItem(Texture2D, string, int, PopupMenuShortcut) 

public PopupMenuItem AddIconRadioCheckItem(Texture2D icon, string text, int id = -1, PopupMenuShortcut accelerator = null)

Parameters

icon Texture2D
text string
id int
accelerator PopupMenuShortcut

Returns

PopupMenuItem

AddIconRadioCheckShortcut(Texture2D, PopupMenuShortcut, int, bool) 

public PopupMenuItem AddIconRadioCheckShortcut(Texture2D icon, PopupMenuShortcut shortcut, int id = -1, bool global = false)

Parameters

icon Texture2D
shortcut PopupMenuShortcut
id int
global bool

Returns

PopupMenuItem

AddIconShortcut(Texture2D, PopupMenuShortcut, int, bool, bool) 

public PopupMenuItem AddIconShortcut(Texture2D icon, PopupMenuShortcut shortcut, int id = -1, bool global = false, bool allowEcho = false)

Parameters

icon Texture2D
shortcut PopupMenuShortcut
id int
global bool
allowEcho bool

Returns

PopupMenuItem

AddItem(string, int, PopupMenuShortcut) 

public PopupMenuItem AddItem(string text, int id = -1, PopupMenuShortcut accelerator = null)

Parameters

text string
id int
accelerator PopupMenuShortcut

Returns

PopupMenuItem

AddMultistateItem(string, int, int, int, PopupMenuShortcut) 

public PopupMenuItem AddMultistateItem(string text, int maxStates, int defaultState = 0, int id = -1, PopupMenuShortcut accelerator = null)

Parameters

text string
maxStates int
defaultState int
id int
accelerator PopupMenuShortcut

Returns

PopupMenuItem

AddRadioCheckItem(string, int, PopupMenuShortcut) 

public PopupMenuItem AddRadioCheckItem(string text, int id = -1, PopupMenuShortcut accelerator = null)

Parameters

text string
id int
accelerator PopupMenuShortcut

Returns

PopupMenuItem

AddRadioCheckShortcut(PopupMenuShortcut, int, bool) 

public PopupMenuItem AddRadioCheckShortcut(PopupMenuShortcut shortcut, int id = -1, bool global = false)

Parameters

shortcut PopupMenuShortcut
id int
global bool

Returns

PopupMenuItem

AddSeparator(string, int) 

public PopupMenuItem AddSeparator(string text = "", int id = -1)

Parameters

text string
id int

Returns

PopupMenuItem

AddShortcut(PopupMenuShortcut, int, bool, bool) 

public PopupMenuItem AddShortcut(PopupMenuShortcut shortcut, int id = -1, bool global = false, bool allowEcho = false)

Parameters

shortcut PopupMenuShortcut
id int
global bool
allowEcho bool

Returns

PopupMenuItem

AddSubmenuItem(string, PopupMenu, int) 

public PopupMenuItem AddSubmenuItem(string text, PopupMenu submenu, int id = -1)

Parameters

text string
submenu PopupMenu
id int

Returns

PopupMenuItem

AddSubmenuItem(string, string, int) 

public PopupMenuItem AddSubmenuItem(string text, string submenu, int id = -1)

Parameters

text string
submenu string
id int

Returns

PopupMenuItem

AddSubmenuNodeItem(string, PopupMenu, int) 

public PopupMenuItem AddSubmenuNodeItem(string text, PopupMenu submenu, int id = -1)

Parameters

text string
submenu PopupMenu
id int

Returns

PopupMenuItem

ArrangeChildren() 

protected override void ArrangeChildren()

Clear() 

public void Clear()

GetAllowSearch() 

public bool GetAllowSearch()

Returns

bool

GetFocusedItem() 

public int GetFocusedItem()

Returns

int

GetItem(int) 

public PopupMenuItem GetItem(int index)

Parameters

index int

Returns

PopupMenuItem

GetItemAccelerator(int) 

public PopupMenuShortcut GetItemAccelerator(int index)

Parameters

index int

Returns

PopupMenuShortcut

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

GetItemIconMaxWidth(int) 

public int GetItemIconMaxWidth(int index)

Parameters

index int

Returns

int

GetItemIconModulate(int) 

public Color GetItemIconModulate(int index)

Parameters

index int

Returns

Color

GetItemId(int) 

public int GetItemId(int index)

Parameters

index int

Returns

int

GetItemIdxFromText(string) 

public int GetItemIdxFromText(string text)

Parameters

text string

Returns

int

GetItemIndent(int) 

public int GetItemIndent(int index)

Parameters

index int

Returns

int

GetItemIndex(int) 

public int GetItemIndex(int id)

Parameters

id int

Returns

int

GetItemLanguage(int) 

public string GetItemLanguage(int index)

Parameters

index int

Returns

string

GetItemMaxStates(int) 

public int GetItemMaxStates(int index)

Parameters

index int

Returns

int

GetItemMetadata(int) 

public object GetItemMetadata(int index)

Parameters

index int

Returns

object

GetItemMultistate(int) 

public int GetItemMultistate(int index)

Parameters

index int

Returns

int

GetItemMultistateMax(int) 

public int GetItemMultistateMax(int index)

Parameters

index int

Returns

int

GetItemShortcut(int) 

public PopupMenuShortcut GetItemShortcut(int index)

Parameters

index int

Returns

PopupMenuShortcut

GetItemState(int) 

public int GetItemState(int index)

Parameters

index int

Returns

int

GetItemSubmenu(int) 

public PopupMenu GetItemSubmenu(int index)

Parameters

index int

Returns

PopupMenu

GetItemSubmenuNode(int) 

public PopupMenu GetItemSubmenuNode(int index)

Parameters

index int

Returns

PopupMenu

GetItemSubmenuPath(int) 

public string GetItemSubmenuPath(int index)

Parameters

index int

Returns

string

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

GetMinimumSize() 

public override Vector2 GetMinimumSize()

Returns

Vector2

GetSearchBarBounds() 

public Rectangle GetSearchBarBounds()

Returns

Rectangle

GetSearchBarCaretColumn() 

public int GetSearchBarCaretColumn()

Returns

int

GetSearchBarClearButtonBounds() 

public Rectangle GetSearchBarClearButtonBounds()

Returns

Rectangle

GetSearchBarFuzzySearchMaxMisses() 

public int GetSearchBarFuzzySearchMaxMisses()

Returns

int

GetSearchBarMinItemCount() 

public int GetSearchBarMinItemCount()

Returns

int

GetSearchBarText() 

public string GetSearchBarText()

Returns

string

GetShrinkHeight() 

public bool GetShrinkHeight()

Returns

bool

GetShrinkWidth() 

public bool GetShrinkWidth()

Returns

bool

GetSubmenuPopupDelay() 

public float GetSubmenuPopupDelay()

Returns

float

GetSystemMenu() 

public PopupSystemMenu GetSystemMenu()

Returns

PopupSystemMenu

IsHideOnCheckableItemSelection() 

public bool IsHideOnCheckableItemSelection()

Returns

bool

IsHideOnItemSelection() 

public bool IsHideOnItemSelection()

Returns

bool

IsHideOnMultistateItemSelection() 

public bool IsHideOnMultistateItemSelection()

Returns

bool

IsHideOnStateItemSelection() 

public bool IsHideOnStateItemSelection()

Returns

bool

IsItemCheckable(int) 

public bool IsItemCheckable(int index)

Parameters

index int

Returns

bool

IsItemChecked(int) 

public bool IsItemChecked(int index)

Parameters

index int

Returns

bool

IsItemDisabled(int) 

public bool IsItemDisabled(int index)

Parameters

index int

Returns

bool

IsItemIndeterminate(int) 

public bool IsItemIndeterminate(int index)

Parameters

index int

Returns

bool

IsItemRadioCheckable(int) 

public bool IsItemRadioCheckable(int index)

Parameters

index int

Returns

bool

IsItemSeparator(int) 

public bool IsItemSeparator(int index)

Parameters

index int

Returns

bool

IsItemShortcutDisabled(int) 

public bool IsItemShortcutDisabled(int index)

Parameters

index int

Returns

bool

IsItemShortcutGlobal(int) 

public bool IsItemShortcutGlobal(int index)

Parameters

index int

Returns

bool

IsNativeMenu() 

public bool IsNativeMenu()

Returns

bool

IsPreferNativeMenu() 

public bool IsPreferNativeMenu()

Returns

bool

IsSearchBarEnabled() 

public bool IsSearchBarEnabled()

Returns

bool

IsSearchBarFuzzySearchEnabled() 

public bool IsSearchBarFuzzySearchEnabled()

Returns

bool

IsSystemMenu() 

public bool IsSystemMenu()

Returns

bool

PopupAt(Vector2, Vector2?) 

public void PopupAt(Vector2 position, Vector2? minimumSize)

Parameters

position Vector2
minimumSize Vector2?

RemoveItem(int) 

public void RemoveItem(int index)

Parameters

index int

ScrollToItem(int) 

public void ScrollToItem(int index)

Parameters

index int

SetAllowSearch(bool) 

public void SetAllowSearch(bool allow)

Parameters

allow bool

SetFocusedItem(int) 

public void SetFocusedItem(int index)

Parameters

index int

SetHideOnCheckableItemSelection(bool) 

public void SetHideOnCheckableItemSelection(bool enabled)

Parameters

enabled bool

SetHideOnItemSelection(bool) 

public void SetHideOnItemSelection(bool enabled)

Parameters

enabled bool

SetHideOnStateItemSelection(bool) 

public void SetHideOnStateItemSelection(bool enabled)

Parameters

enabled bool

SetItemAccelerator(int, PopupMenuShortcut) 

public void SetItemAccelerator(int index, PopupMenuShortcut accelerator)

Parameters

index int
accelerator PopupMenuShortcut

SetItemAsCheckable(int, bool) 

public void SetItemAsCheckable(int index, bool checkable)

Parameters

index int
checkable bool

SetItemAsRadioCheckable(int, bool) 

public void SetItemAsRadioCheckable(int index, bool radioCheckable)

Parameters

index int
radioCheckable bool

SetItemAsSeparator(int, bool) 

public void SetItemAsSeparator(int index, bool separator)

Parameters

index int
separator bool

SetItemAutoTranslateMode(int, AutoTranslateMode) 

public void SetItemAutoTranslateMode(int index, AutoTranslateMode mode)

Parameters

index int
mode AutoTranslateMode

SetItemChecked(int, bool) 

public void SetItemChecked(int index, bool checkedValue)

Parameters

index int
checkedValue bool

SetItemCount(int)

Resizes the item collection, matching Godot's PopupMenu item_count property.

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

SetItemIconMaxWidth(int, int) 

public void SetItemIconMaxWidth(int index, int width)

Parameters

index int
width int

SetItemIconModulate(int, Color) 

public void SetItemIconModulate(int index, Color modulate)

Parameters

index int
modulate Color

SetItemId(int, int) 

public void SetItemId(int index, int id)

Parameters

index int
id int

SetItemIndent(int, int) 

public void SetItemIndent(int index, int indent)

Parameters

index int
indent int

SetItemIndeterminate(int, bool) 

public void SetItemIndeterminate(int index, bool indeterminate)

Parameters

index int
indeterminate bool

SetItemIndex(int, int) 

public void SetItemIndex(int index, int targetIndex)

Parameters

index int
targetIndex int

SetItemLanguage(int, string) 

public void SetItemLanguage(int index, string language)

Parameters

index int
language string

SetItemMaxStates(int, int) 

public void SetItemMaxStates(int index, int maxStates)

Parameters

index int
maxStates int

SetItemMetadata(int, object) 

public void SetItemMetadata(int index, object metadata)

Parameters

index int
metadata object

SetItemMultistate(int, int) 

public void SetItemMultistate(int index, int state)

Parameters

index int
state int

SetItemMultistateMax(int, int) 

public void SetItemMultistateMax(int index, int maxStates)

Parameters

index int
maxStates int

SetItemShortcut(int, PopupMenuShortcut, bool) 

public void SetItemShortcut(int index, PopupMenuShortcut shortcut, bool global = false)

Parameters

index int
shortcut PopupMenuShortcut
global bool

SetItemShortcutDisabled(int, bool) 

public void SetItemShortcutDisabled(int index, bool disabled)

Parameters

index int
disabled bool

SetItemSubmenu(int, PopupMenu) 

public void SetItemSubmenu(int index, PopupMenu submenu)

Parameters

index int
submenu PopupMenu

SetItemSubmenu(int, string) 

public void SetItemSubmenu(int index, string submenu)

Parameters

index int
submenu string

SetItemSubmenuNode(int, PopupMenu) 

public void SetItemSubmenuNode(int index, PopupMenu submenu)

Parameters

index int
submenu PopupMenu

SetItemSubmenuPath(int, string) 

public void SetItemSubmenuPath(int index, string submenu)

Parameters

index int
submenu string

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

SetPreferNativeMenu(bool) 

public void SetPreferNativeMenu(bool enabled)

Parameters

enabled bool

SetSearchBarCaretColumn(int) 

public void SetSearchBarCaretColumn(int column)

Parameters

column int

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

SetSearchBarText(string) 

public void SetSearchBarText(string text)

Parameters

text string

SetShrinkHeight(bool) 

public void SetShrinkHeight(bool shrink)

Parameters

shrink bool

SetShrinkWidth(bool) 

public void SetShrinkWidth(bool shrink)

Parameters

shrink bool

SetSubmenuPopupDelay(float) 

public void SetSubmenuPopupDelay(float seconds)

Parameters

seconds float

SetSystemMenu(PopupSystemMenu) 

public void SetSystemMenu(PopupSystemMenu systemMenu)

Parameters

systemMenu PopupSystemMenu

ToggleItemChecked(int) 

public void ToggleItemChecked(int index)

Parameters

index int

ToggleItemMultistate(int) 

public void ToggleItemMultistate(int index)

Parameters

index int

Events

IdPressed 

public event Action<PopupMenu, int> IdPressed

Event Type

Action<PopupMenu, int>

IndexFocused 

public event Action<PopupMenu, int> IndexFocused

Event Type

Action<PopupMenu, int>

IndexPressed 

public event Action<PopupMenu, int> IndexPressed

Event Type

Action<PopupMenu, int>
Edit this page