.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_PopupMenu: PopupMenu ========= **Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- PopupMenu displays a list of options. Member Functions ---------------- +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_icon_item` **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_icon_check_item` **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Object` icon **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_metadata` **(** :ref:`int` idx, var metadata **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_ID` **(** :ref:`int` idx, :ref:`int` id **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_ID` **(** :ref:`int` idx **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_count` **(** **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_separator` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **item_pressed** **(** :ref:`int` ID **)** Description ----------- PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus. Member Function Description --------------------------- .. _class_PopupMenu_add_icon_item: - void **add_icon_item** **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. .. _class_PopupMenu_add_item: - void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. .. _class_PopupMenu_add_icon_check_item: - void **add_icon_check_item** **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new check able item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. .. _class_PopupMenu_add_check_item: - void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. .. _class_PopupMenu_add_submenu_item: - void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** .. _class_PopupMenu_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Set the text of the item at index "idx". .. _class_PopupMenu_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Object` icon **)** Set the icon of the item at index "idx". .. _class_PopupMenu_set_item_accelerator: - void **set_item_accelerator** **(** :ref:`int` idx, :ref:`int` accel **)** Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. .. _class_PopupMenu_set_item_metadata: - void **set_item_metadata** **(** :ref:`int` idx, var metadata **)** .. _class_PopupMenu_set_item_checked: - void **set_item_checked** **(** :ref:`int` idx, :ref:`bool` checked **)** Set the checkstate status of the item at index "idx". .. _class_PopupMenu_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** .. _class_PopupMenu_set_item_submenu: - void **set_item_submenu** **(** :ref:`int` idx, :ref:`String` submenu **)** .. _class_PopupMenu_set_item_as_separator: - void **set_item_as_separator** **(** :ref:`int` idx, :ref:`bool` enable **)** .. _class_PopupMenu_set_item_as_checkable: - void **set_item_as_checkable** **(** :ref:`int` idx, :ref:`bool` enable **)** .. _class_PopupMenu_set_item_ID: - void **set_item_ID** **(** :ref:`int` idx, :ref:`int` id **)** Set the id of the item at index "idx". .. _class_PopupMenu_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text of the item at index "idx". .. _class_PopupMenu_get_item_icon: - :ref:`Object` **get_item_icon** **(** :ref:`int` idx **)** const Return the icon of the item at index "idx". .. _class_PopupMenu_get_item_metadata: - void **get_item_metadata** **(** :ref:`int` idx **)** const .. _class_PopupMenu_get_item_accelerator: - :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** const Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. .. _class_PopupMenu_get_item_submenu: - :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** const .. _class_PopupMenu_is_item_separator: - :ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** const .. _class_PopupMenu_is_item_checkable: - :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const .. _class_PopupMenu_is_item_checked: - :ref:`bool` **is_item_checked** **(** :ref:`int` idx **)** const Return the checkstate status of the item at index "idx". .. _class_PopupMenu_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const .. _class_PopupMenu_get_item_ID: - :ref:`int` **get_item_ID** **(** :ref:`int` idx **)** const Return the id of the item at index "idx". .. _class_PopupMenu_get_item_index: - :ref:`int` **get_item_index** **(** :ref:`int` id **)** const Find and return the index of the item containing a given id. .. _class_PopupMenu_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Return the amount of items. .. _class_PopupMenu_add_separator: - void **add_separator** **(** **)** Add a separator between items. Separators also occupy an index. .. _class_PopupMenu_remove_item: - void **remove_item** **(** :ref:`int` idx **)** .. _class_PopupMenu_clear: - void **clear** **(** **)** Clear the popup menu.