PopupMenu

Hérite de : Popup < Window < Viewport < Node < Object

Une fenêtre modale utilisée pour afficher une liste d'options.

Description

PopupMenu est une fenêtre modale utilisée pour afficher une liste d'options. Utile pour les barres d'outils et les menus contextuels.

La taille d'un PopupMenu peut être limitée en utilisant Window.max_size. Si la hauteur de la liste des éléments est supérieure à la hauteur maximale du PopupMenu, un ScrollContainer dans le popup permettra à l'utilisateur de faire défiler le contenu. Si aucune taille maximale n'est définie, ou si elle est définie à 0, la hauteur de PopupMenu sera limitée par son rect parent.

Toutes les méthodes set_* permettent des indices d'éléments négatifs, c'est-à-dire -1 pour accéder au dernier élément, -2 pour sélectionner le deuxième élément, et ainsi de suite.

Recherche incrémentale : Comme ItemList et Tree, PopupMenu prend en charge la recherche dans la liste pendant que le contrôle est en focus. Appuyez sur une touche qui correspond à la première lettre du nom d'un article pour sélectionner le premier élément à partir de la lettre donnée. Après ce point, il y a deux façons d'effectuer la recherche incrémentale : 1) Appuyez à nouveau sur la même touche avant la fin de la durée d'attente pour sélectionner l'élément suivant en commençant par la même lettre. 2) Appuyez sur les touches de lettre qui correspondent au reste du mot avant la fin de la durée d'attente pour sélectionner l'élément en question directement. Ces deux actions seront réinitialisées jusqu'au début de la liste si la durée d'attente est passée depuis que la dernière frappe a été enregistrée. Vous pouvez ajuster la durée d'expiration en changeant ProjectSettings.gui/timers/incremental_search_max_interval_msec.

Note : Les valeurs d'identification utilisées pour les articles sont limitées en 32 bits, pas les 64 bits de int. Il s'agit d'une plage de -2^32 à 2^32 - 1, c'est-à-dire -2147483648 à 2147483647.

Propriétés

bool

allow_search

true

bool

hide_on_checkable_item_selection

true

bool

hide_on_item_selection

true

bool

hide_on_state_item_selection

false

int

item_count

0

bool

prefer_native_menu

false

float

submenu_popup_delay

0.3

SystemMenus

system_menu_id

0

bool

transparent

true (overrides Window)

bool

transparent_bg

true (overrides Viewport)

Méthodes

bool

activate_item_by_event(event: InputEvent, for_global_only: bool = false)

void

add_check_item(label: String, id: int = -1, accel: Key = 0)

void

add_check_shortcut(shortcut: Shortcut, id: int = -1, global: bool = false)

void

add_icon_check_item(texture: Texture2D, label: String, id: int = -1, accel: Key = 0)

void

add_icon_check_shortcut(texture: Texture2D, shortcut: Shortcut, id: int = -1, global: bool = false)

void

add_icon_item(texture: Texture2D, label: String, id: int = -1, accel: Key = 0)

void

add_icon_radio_check_item(texture: Texture2D, label: String, id: int = -1, accel: Key = 0)

void

add_icon_radio_check_shortcut(texture: Texture2D, shortcut: Shortcut, id: int = -1, global: bool = false)

void

add_icon_shortcut(texture: Texture2D, shortcut: Shortcut, id: int = -1, global: bool = false, allow_echo: bool = false)

void

add_item(label: String, id: int = -1, accel: Key = 0)

void

add_multistate_item(label: String, max_states: int, default_state: int = 0, id: int = -1, accel: Key = 0)

void

add_radio_check_item(label: String, id: int = -1, accel: Key = 0)

void

add_radio_check_shortcut(shortcut: Shortcut, id: int = -1, global: bool = false)

void

add_separator(label: String = "", id: int = -1)

void

add_shortcut(shortcut: Shortcut, id: int = -1, global: bool = false, allow_echo: bool = false)

void

add_submenu_item(label: String, submenu: String, id: int = -1)

void

add_submenu_node_item(label: String, submenu: PopupMenu, id: int = -1)

void

clear(free_submenus: bool = false)

int

get_focused_item() const

Key

get_item_accelerator(index: int) const

AutoTranslateMode

get_item_auto_translate_mode(index: int) const

Texture2D

get_item_icon(index: int) const

int

get_item_icon_max_width(index: int) const

Color

get_item_icon_modulate(index: int) const

int

get_item_id(index: int) const

int

get_item_indent(index: int) const

int

get_item_index(id: int) const

String

get_item_language(index: int) const

Variant

get_item_metadata(index: int) const

int

get_item_multistate(index: int) const

int

get_item_multistate_max(index: int) const

Shortcut

get_item_shortcut(index: int) const

String

get_item_submenu(index: int) const

PopupMenu

get_item_submenu_node(index: int) const

String

get_item_text(index: int) const

TextDirection

get_item_text_direction(index: int) const

String

get_item_tooltip(index: int) const

bool

is_item_checkable(index: int) const

bool

is_item_checked(index: int) const

bool

is_item_disabled(index: int) const

bool

is_item_radio_checkable(index: int) const

bool

is_item_separator(index: int) const

bool

is_item_shortcut_disabled(index: int) const

bool

is_native_menu() const

bool

is_system_menu() const

void

remove_item(index: int)

void

scroll_to_item(index: int)

void

set_focused_item(index: int)

void

set_item_accelerator(index: int, accel: Key)

void

set_item_as_checkable(index: int, enable: bool)

void

set_item_as_radio_checkable(index: int, enable: bool)

void

set_item_as_separator(index: int, enable: bool)

void

set_item_auto_translate_mode(index: int, mode: AutoTranslateMode)

void

set_item_checked(index: int, checked: bool)

void

set_item_disabled(index: int, disabled: bool)

void

set_item_icon(index: int, icon: Texture2D)

void

set_item_icon_max_width(index: int, width: int)

void

set_item_icon_modulate(index: int, modulate: Color)

void

set_item_id(index: int, id: int)

void

set_item_indent(index: int, indent: int)

void

set_item_language(index: int, language: String)

void

set_item_metadata(index: int, metadata: Variant)

void

set_item_multistate(index: int, state: int)

void

set_item_multistate_max(index: int, max_states: int)

void

set_item_shortcut(index: int, shortcut: Shortcut, global: bool = false)

void

set_item_shortcut_disabled(index: int, disabled: bool)

void

set_item_submenu(index: int, submenu: String)

void

set_item_submenu_node(index: int, submenu: PopupMenu)

void

set_item_text(index: int, text: String)

void

set_item_text_direction(index: int, direction: TextDirection)

void

set_item_tooltip(index: int, tooltip: String)

void

toggle_item_checked(index: int)

void

toggle_item_multistate(index: int)

Propriétés du thème

Color

font_accelerator_color

Color(0.7, 0.7, 0.7, 0.8)

Color

font_color

Color(0.875, 0.875, 0.875, 1)

Color

font_disabled_color

Color(0.4, 0.4, 0.4, 0.8)

Color

font_hover_color

Color(0.875, 0.875, 0.875, 1)

Color

font_outline_color

Color(0, 0, 0, 1)

Color

font_separator_color

Color(0.875, 0.875, 0.875, 1)

Color

font_separator_outline_color

Color(0, 0, 0, 1)

int

h_separation

4

int

icon_max_width

0

int

indent

10

int

item_end_padding

2

int

item_start_padding

2

int

outline_size

0

int

separator_outline_size

0

int

v_separation

4

Font

font

Font

font_separator

int

font_separator_size

int

font_size

Texture2D

checked

Texture2D

checked_disabled

Texture2D

radio_checked

Texture2D

radio_checked_disabled

Texture2D

radio_unchecked

Texture2D

radio_unchecked_disabled

Texture2D

submenu

Texture2D

submenu_mirrored

Texture2D

unchecked

Texture2D

unchecked_disabled

StyleBox

hover

StyleBox

labeled_separator_left

StyleBox

labeled_separator_right

StyleBox

panel

StyleBox

separator


Signaux

id_focused(id: int) 🔗

Emitted when the user navigated to an item of some id using the ProjectSettings.input/ui_up or ProjectSettings.input/ui_down input action.


id_pressed(id: int) 🔗

Emitted when an item of some id is pressed or its accelerator is activated.

Note: If id is negative (either explicitly or due to overflow), this will return the corresponding index instead.


index_pressed(index: int) 🔗

Emitted when an item of some index is pressed or its accelerator is activated.


menu_changed() 🔗

Emitted when any item is added, modified or removed.


Descriptions des propriétés

  • void set_allow_search(value: bool)

  • bool get_allow_search()

Si true, permet de naviguer dans le PopupMenu avec des touches alphabétiques.


bool hide_on_checkable_item_selection = true 🔗

  • void set_hide_on_checkable_item_selection(value: bool)

  • bool is_hide_on_checkable_item_selection()

Si true, masque le PopupMenu quand une coche ou un bouton radio est sélectionné.


bool hide_on_item_selection = true 🔗

  • void set_hide_on_item_selection(value: bool)

  • bool is_hide_on_item_selection()

Si true, cache le PopupMenu lorsqu'un élément est sélectionné.


bool hide_on_state_item_selection = false 🔗

  • void set_hide_on_state_item_selection(value: bool)

  • bool is_hide_on_state_item_selection()

Si true, cache le PopupMenu lorsqu'un élément d'état est sélectionné.


int item_count = 0 🔗

  • void set_item_count(value: int)

  • int get_item_count()

Le nombre d'éléments actuellement dans la liste.


bool prefer_native_menu = false 🔗

  • void set_prefer_native_menu(value: bool)

  • bool is_prefer_native_menu()

If true, MenuBar will use native menu when supported.

Note: If PopupMenu is linked to StatusIndicator, MenuBar, or another PopupMenu item it can use native menu regardless of this property, use is_native_menu() to check it.


float submenu_popup_delay = 0.3 🔗

  • void set_submenu_popup_delay(value: float)

  • float get_submenu_popup_delay()

Sets the delay time in seconds for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item.


SystemMenus system_menu_id = 0 🔗

If set to one of the values of SystemMenus, this PopupMenu is bound to the special system menu. Only one PopupMenu can be bound to each special menu at a time.


Descriptions des méthodes

bool activate_item_by_event(event: InputEvent, for_global_only: bool = false) 🔗

Vérifie l'événement event fourni contre les raccourcis et accélérateurs du PopupMenu et active le premier élément avec des événements correspondants. Si for_global_only vaut true, seuls les raccourcis et les accélérateurs avec global défini à true seront appelés.

Renvoie true si un élément a été activé avec succès.

Note : Certains Controls, comme MenuButton, appelleront cette méthode automatiquement.


void add_check_item(label: String, id: int = -1, accel: Key = 0) 🔗

Ajoute un nouvel élément cochable avec le texte label.

Un id peut être fourni en option, ainsi qu'un accélérateur (accel). Si aucun id n'est fourni, un id sera créé à partir de l'index. Si aucun accel n'est fourni, la valeur par défaut de 0 (correspondant à @GlobalScope.KEY_NONE) sera assignée à l'élément (ce qui signifie qu'il n'aura pas d'accélérateur). Voir get_item_accelerator() pour plus d'informations sur les accélérateurs.

Note : Les éléments cochables affichent simplement une case à cocher, mais n'ont aucun comportement de vérification intégré et doivent être cochés/décochés manuellement. Voir set_item_checked() pour plus d'informations sur la façon de le contrôler.


void add_check_shortcut(shortcut: Shortcut, id: int = -1, global: bool = false) 🔗

Ajoute un nouvel élément vérifiable et lui attribue le Shortcut spécifié. Définit le texte de la case à cocher au nom du Shortcut.

Un id peut être fourni en option. Si aucun id n'est fourni, un id sera créé à partir de l'index.

Note : Les éléments cochables affichent simplement une case à cocher, mais n'ont aucun comportement de vérification intégré et doivent être cochés/décochés manuellement. Voir set_item_checked() pour plus d'informations sur la façon de le contrôler.


void add_icon_check_item(texture: Texture2D, label: String, id: int = -1, accel: Key = 0) 🔗

Adds a new checkable item with text label and icon texture.

An id can optionally be provided, as well as an accelerator (accel). If no id is provided, one will be created from the index. If no accel is provided, then the default value of 0 (corresponding to @GlobalScope.KEY_NONE) will be assigned to the item (which means it won't have any accelerator). See get_item_accelerator() for more info on accelerators.

Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See set_item_checked() for more info on how to control it.


void add_icon_check_shortcut(texture: Texture2D, shortcut: Shortcut, id: int = -1, global: bool = false) 🔗

Adds a new checkable item and assigns the specified Shortcut and icon texture to it. Sets the label of the checkbox to the Shortcut's name.

An id can optionally be provided. If no id is provided, one will be created from the index.

Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See set_item_checked() for more info on how to control it.


void add_icon_item(texture: Texture2D, label: String, id: int = -1, accel: Key = 0) 🔗

Adds a new item with text label and icon texture.

An id can optionally be provided, as well as an accelerator (accel). If no id is provided, one will be created from the index. If no accel is provided, then the default value of 0 (corresponding to @GlobalScope.KEY_NONE) will be assigned to the item (which means it won't have any accelerator). See get_item_accelerator() for more info on accelerators.


void add_icon_radio_check_item(texture: Texture2D, label: String, id: int = -1, accel: Key = 0) 🔗

Pareil que add_icon_check_item(), mais utilise un bouton radio.


void add_icon_radio_check_shortcut(texture: Texture2D, shortcut: Shortcut, id: int = -1, global: bool = false) 🔗

Pareil que add_icon_check_shortcut(), mais utilise un bouton radio.


void add_icon_shortcut(texture: Texture2D, shortcut: Shortcut, id: int = -1, global: bool = false, allow_echo: bool = false) 🔗

Adds a new item and assigns the specified Shortcut and icon texture to it. Sets the label of the checkbox to the Shortcut's name.

An id can optionally be provided. If no id is provided, one will be created from the index.

If allow_echo is true, the shortcut can be activated with echo events.


void add_item(label: String, id: int = -1, accel: Key = 0) 🔗

Adds a new item with text label.

An id can optionally be provided, as well as an accelerator (accel). If no id is provided, one will be created from the index. If no accel is provided, then the default value of 0 (corresponding to @GlobalScope.KEY_NONE) will be assigned to the item (which means it won't have any accelerator). See get_item_accelerator() for more info on accelerators.

Note: The provided id is used only in id_pressed and id_focused signals. It's not related to the index arguments in e.g. set_item_checked().


void add_multistate_item(label: String, max_states: int, default_state: int = 0, id: int = -1, accel: Key = 0) 🔗

Adds a new multistate item with text label.

Contrarily to normal binary items, multistate items can have more than two states, as defined by max_states. The default value is defined by default_state.

An id can optionally be provided, as well as an accelerator (accel). If no id is provided, one will be created from the index. If no accel is provided, then the default value of 0 (corresponding to @GlobalScope.KEY_NONE) will be assigned to the item (which means it won't have any accelerator). See get_item_accelerator() for more info on accelerators.

func _ready():
    add_multistate_item("Item", 3, 0)

    index_pressed.connect(func(index: int):
            toggle_item_multistate(index)
            match get_item_multistate(index):
                0:
                    print("First state")
                1:
                    print("Second state")
                2:
                    print("Third state")
        )

Note: Multistate items don't update their state automatically and must be done manually. See toggle_item_multistate(), set_item_multistate() and get_item_multistate() for more info on how to control it.


void add_radio_check_item(label: String, id: int = -1, accel: Key = 0) 🔗

Adds a new radio check button with text label.

An id can optionally be provided, as well as an accelerator (accel). If no id is provided, one will be created from the index. If no accel is provided, then the default value of 0 (corresponding to @GlobalScope.KEY_NONE) will be assigned to the item (which means it won't have any accelerator). See get_item_accelerator() for more info on accelerators.

Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See set_item_checked() for more info on how to control it.


void add_radio_check_shortcut(shortcut: Shortcut, id: int = -1, global: bool = false) 🔗

Adds a new radio check button and assigns a Shortcut to it. Sets the label of the checkbox to the Shortcut's name.

An id can optionally be provided. If no id is provided, one will be created from the index.

Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See set_item_checked() for more info on how to control it.


void add_separator(label: String = "", id: int = -1) 🔗

Adds a separator between items. Separators also occupy an index, which you can set by using the id parameter.

A label can optionally be provided, which will appear at the center of the separator.


void add_shortcut(shortcut: Shortcut, id: int = -1, global: bool = false, allow_echo: bool = false) 🔗

Adds a Shortcut.

An id can optionally be provided. If no id is provided, one will be created from the index.

If allow_echo is true, the shortcut can be activated with echo events.


void add_submenu_item(label: String, submenu: String, id: int = -1) 🔗

Obsolète : Prefer using add_submenu_node_item() instead.

Adds an item that will act as a submenu of the parent PopupMenu node when clicked. The submenu argument must be the name of an existing PopupMenu that has been added as a child to this node. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ui_select or ui_right input actions.

An id can optionally be provided. If no id is provided, one will be created from the index.


void add_submenu_node_item(label: String, submenu: PopupMenu, id: int = -1) 🔗

Adds an item that will act as a submenu of the parent PopupMenu node when clicked. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ui_select or ui_right input actions.

submenu must be either child of this PopupMenu or has no parent node (in which case it will be automatically added as a child). If the submenu popup has another parent, this method will fail.

An id can optionally be provided. If no id is provided, one will be created from the index.


void clear(free_submenus: bool = false) 🔗

Removes all items from the PopupMenu. If free_submenus is true, the submenu nodes are automatically freed.


int get_focused_item() const 🔗

Renvoie la position de l’élément qui a actuellement le focus. Ou renvoie -1 si aucun n'a le focus.


Key get_item_accelerator(index: int) const 🔗

Returns the accelerator of the item at the given index. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The return value is an integer which is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A). If no accelerator is defined for the specified index, get_item_accelerator() returns 0 (corresponding to @GlobalScope.KEY_NONE).


AutoTranslateMode get_item_auto_translate_mode(index: int) const 🔗

Returns the auto translate mode of the item at the given index.


Texture2D get_item_icon(index: int) const 🔗

Returns the icon of the item at the given index.


int get_item_icon_max_width(index: int) const 🔗

Returns the maximum allowed width of the icon for the item at the given index.


Color get_item_icon_modulate(index: int) const 🔗

Returns a Color modulating the item's icon at the given index.


int get_item_id(index: int) const 🔗

Returns the ID of the item at the given index. id can be manually assigned, while index can not.


int get_item_indent(index: int) const 🔗

Returns the horizontal offset of the item at the given index.


int get_item_index(id: int) const 🔗

Returns the index of the item containing the specified id. Index is automatically assigned to each item by the engine and can not be set manually.


String get_item_language(index: int) const 🔗

Renvoie le code de langue du texte de l'élément.


Variant get_item_metadata(index: int) const 🔗

Renvoie les métadonnées de l'élément spécifié, qui peuvent être de n'importe quel type. Vous pouvez les définir avec set_item_metadata(), qui fournit un moyen simple d'affecter des données de contexte aux éléments.


int get_item_multistate(index: int) const 🔗

Renvoie l'état de l'élément à l'index donné.


int get_item_multistate_max(index: int) const 🔗

Returns the max states of the item at the given index.


Shortcut get_item_shortcut(index: int) const 🔗

Returns the Shortcut associated with the item at the given index.


String get_item_submenu(index: int) const 🔗

Obsolète : Prefer using get_item_submenu_node() instead.

Returns the submenu name of the item at the given index. See add_submenu_item() for more info on how to add a submenu.


PopupMenu get_item_submenu_node(index: int) const 🔗

Returns the submenu of the item at the given index, or null if no submenu was added. See add_submenu_node_item() for more info on how to add a submenu.


String get_item_text(index: int) const 🔗

Returns the text of the item at the given index.


TextDirection get_item_text_direction(index: int) const 🔗

Renvoie la direction d'écriture de base du texte de l'élément.


String get_item_tooltip(index: int) const 🔗

Returns the tooltip associated with the item at the given index.


bool is_item_checkable(index: int) const 🔗

Returns true if the item at the given index is checkable in some way, i.e. if it has a checkbox or radio button.

Note: Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually.


bool is_item_checked(index: int) const 🔗

Returns true if the item at the given index is checked.


bool is_item_disabled(index: int) const 🔗

Returns true if the item at the given index is disabled. When it is disabled it can't be selected, or its action invoked.

See set_item_disabled() for more info on how to disable an item.


bool is_item_radio_checkable(index: int) const 🔗

Returns true if the item at the given index has radio button-style checkability.

Note: This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.


bool is_item_separator(index: int) const 🔗

Returns true if the item is a separator. If it is, it will be displayed as a line. See add_separator() for more info on how to add a separator.


bool is_item_shortcut_disabled(index: int) const 🔗

Returns true if the specified item's shortcut is disabled.


bool is_native_menu() const 🔗

Returns true if the system native menu is supported and currently used by this PopupMenu.


bool is_system_menu() const 🔗

Returns true if the menu is bound to the special system menu.


void remove_item(index: int) 🔗

Removes the item at the given index from the menu.

Note: The indices of items after the removed item will be shifted by one.


void scroll_to_item(index: int) 🔗

Moves the scroll view to make the item at the given index visible.


void set_focused_item(index: int) 🔗

Sets the currently focused item as the given index.

Passing -1 as the index makes so that no item is focused.


void set_item_accelerator(index: int, accel: Key) 🔗

Sets the accelerator of the item at the given index. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. accel is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A).


void set_item_as_checkable(index: int, enable: bool) 🔗

Sets whether the item at the given index has a checkbox. If false, sets the type of the item to plain text.

Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.


void set_item_as_radio_checkable(index: int, enable: bool) 🔗

Sets the type of the item at the given index to radio button. If false, sets the type of the item to plain text.


void set_item_as_separator(index: int, enable: bool) 🔗

Mark the item at the given index as a separator, which means that it would be displayed as a line. If false, sets the type of the item to plain text.


void set_item_auto_translate_mode(index: int, mode: AutoTranslateMode) 🔗

Sets the auto translate mode of the item at the given index.

Items use Node.AUTO_TRANSLATE_MODE_INHERIT by default, which uses the same auto translate mode as the PopupMenu itself.


void set_item_checked(index: int, checked: bool) 🔗

Sets the checkstate status of the item at the given index.


void set_item_disabled(index: int, disabled: bool) 🔗

Enables/disables the item at the given index. When it is disabled, it can't be selected and its action can't be invoked.


void set_item_icon(index: int, icon: Texture2D) 🔗

Replaces the Texture2D icon of the item at the given index.


void set_item_icon_max_width(index: int, width: int) 🔗

Sets the maximum allowed width of the icon for the item at the given index. This limit is applied on top of the default size of the icon and on top of icon_max_width. The height is adjusted according to the icon's ratio.


void set_item_icon_modulate(index: int, modulate: Color) 🔗

Sets a modulating Color of the item's icon at the given index.


void set_item_id(index: int, id: int) 🔗

Sets the id of the item at the given index.

The id is used in id_pressed and id_focused signals.


void set_item_indent(index: int, indent: int) 🔗

Sets the horizontal offset of the item at the given index.


void set_item_language(index: int, language: String) 🔗

Définit le code de langue du texte de l'élément, utilisé pour les algorithmes de retour à la ligne et de façonnage de texte. Si laissé vide, la langue actuelle est utilisée à la place.


void set_item_metadata(index: int, metadata: Variant) 🔗

Sets the metadata of an item, which may be of any type. You can later get it with get_item_metadata(), which provides a simple way of assigning context data to items.


void set_item_multistate(index: int, state: int) 🔗

Définit l'état d'un objet multi-états. Voir add_multistate_item() pour plus de détails.


void set_item_multistate_max(index: int, max_states: int) 🔗

Sets the max states of a multistate item. See add_multistate_item() for details.


void set_item_shortcut(index: int, shortcut: Shortcut, global: bool = false) 🔗

Sets a Shortcut for the item at the given index.


void set_item_shortcut_disabled(index: int, disabled: bool) 🔗

Disables the Shortcut of the item at the given index.


void set_item_submenu(index: int, submenu: String) 🔗

Obsolète : Prefer using set_item_submenu_node() instead.

Sets the submenu of the item at the given index. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked.


void set_item_submenu_node(index: int, submenu: PopupMenu) 🔗

Sets the submenu of the item at the given index. The submenu is a PopupMenu node that would be shown when the item is clicked. It must either be a child of this PopupMenu or has no parent (in which case it will be automatically added as a child). If the submenu popup has another parent, this method will fail.


void set_item_text(index: int, text: String) 🔗

Sets the text of the item at the given index.


void set_item_text_direction(index: int, direction: TextDirection) 🔗

Définit la direction d'écriture de base du texte.


void set_item_tooltip(index: int, tooltip: String) 🔗

Sets the String tooltip of the item at the given index.


void toggle_item_checked(index: int) 🔗

Toggles the check state of the item at the given index.


void toggle_item_multistate(index: int) 🔗

Cycle vers l'état suivant d'un objet multi-états. Voir add_multistate_item() pour plus de détails.


Descriptions des propriétés du thème

Color font_accelerator_color = Color(0.7, 0.7, 0.7, 0.8) 🔗

The text Color used for shortcuts and accelerators that show next to the menu item name when defined. See get_item_accelerator() for more info on accelerators.


Color font_color = Color(0.875, 0.875, 0.875, 1) 🔗

La Color par défaut du texte pour les noms des éléments du menu.


Color font_disabled_color = Color(0.4, 0.4, 0.4, 0.8) 🔗

La Color utilisée pour le texte des éléments désactivés du menu.


Color font_hover_color = Color(0.875, 0.875, 0.875, 1) 🔗

La Color utilisée pour le texte survolé.


Color font_outline_color = Color(0, 0, 0, 1) 🔗

La teinte du contour du texte de l'élément de menu.


Color font_separator_color = Color(0.875, 0.875, 0.875, 1) 🔗

Color used for labeled separators' text. See add_separator().


Color font_separator_outline_color = Color(0, 0, 0, 1) 🔗

The tint of text outline of the labeled separator.


int h_separation = 4 🔗

L'espace horizontal entre les objets de l'élément.


int icon_max_width = 0 🔗

The maximum allowed width of the item's icon. This limit is applied on top of the default size of the icon, but before the value set with set_item_icon_max_width(). The height is adjusted according to the icon's ratio.


int indent = 10 🔗

Width of the single indentation level.


int item_end_padding = 2 🔗

Horizontal padding to the right of the items (or left, in RTL layout).


int item_start_padding = 2 🔗

Horizontal padding to the left of the items (or right, in RTL layout).


int outline_size = 0 🔗

La taille du contour du texte de l'élément.

Note : Si vous utilisez une police avec FontFile.multichannel_signed_distance_field activé, sa FontFile.msdf_pixel_range doit être définie à au moins deux fois la valeur de outline_size pour que le rendu du contour puisse être correct. Sinon, le contour peut sembler être coupé plus tôt que prévu.


int separator_outline_size = 0 🔗

The size of the labeled separator text outline.


int v_separation = 4 🔗

L’espace vertical entre chaque élément de menu.


Font font 🔗

La Font utilisée pour les éléments du menu.


Font font_separator 🔗

La Font utilisée pour le séparateur avec texte.


int font_separator_size 🔗

Font size of the labeled separator.


int font_size 🔗

Font size of the menu items.


Texture2D checked 🔗

Texture2D icon for the checked checkbox items.


Texture2D checked_disabled 🔗

Texture2D icon for the checked checkbox items when they are disabled.


Texture2D radio_checked 🔗

Texture2D icon for the checked radio button items.


Texture2D radio_checked_disabled 🔗

Texture2D icon for the checked radio button items when they are disabled.


Texture2D radio_unchecked 🔗

Texture2D icon for the unchecked radio button items.


Texture2D radio_unchecked_disabled 🔗

Texture2D icon for the unchecked radio button items when they are disabled.


Texture2D submenu 🔗

Texture2D icon for the submenu arrow (for left-to-right layouts).


Texture2D submenu_mirrored 🔗

Texture2D icon for the submenu arrow (for right-to-left layouts).


Texture2D unchecked 🔗

Texture2D icon for the unchecked checkbox items.


Texture2D unchecked_disabled 🔗

Texture2D icon for the unchecked checkbox items when they are disabled.


StyleBox hover 🔗

Le StyleBox affiché quand un élément d'un PopupMenu est survolé.


StyleBox labeled_separator_left 🔗

La StyleBox pour le côté gauche du séparateur avec label. Voir add_separator().


StyleBox labeled_separator_right 🔗

La StyleBox pour le côté droit du séparateur avec label. Voir add_separator().


StyleBox panel 🔗

StyleBox pour le panneau de l'arrière-plan.


StyleBox separator 🔗

Le StyleBox utilisé pour les séparateurs. Voir add_separator().