Struct gdnative_bindings_lily::PopupMenu [−][src]
pub struct PopupMenu { /* fields omitted */ }
Expand description
core class PopupMenu
inherits Popup
(unsafe).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
Non reference counted objects such as the ones of this type are usually owned by the engine.
PopupMenu
is a reference-only type. Persistent references can
only exist in the unsafe Ref<PopupMenu>
form.
In the cases where Rust code owns an object of this type, for example if the object was just
created on the Rust side and not passed to the engine yet, ownership should be either given
to the engine or the object must be manually destroyed using Ref::free
, or Ref::queue_free
if it is a Node
.
Class hierarchy
PopupMenu inherits methods from:
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Creates a new instance of this object.
Because this type is not reference counted, the lifetime of the returned object is not automatically managed.
Immediately after creation, the object is owned by the caller, and can be
passed to the engine (in which case the engine will be responsible for
destroying the object) or destroyed manually using Ref::free
, or preferably
Ref::queue_free
if it is a Node
.
Adds a new checkable 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 0
will be assigned to it. See [method 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 [method set_item_checked] for more info on how to control it.
Default Arguments
id
--1
accel
-0
Adds a new checkable item and assigns the specified 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 [method set_item_checked] for more info on how to control it.
Default Arguments
id
--1
global
-false
pub fn add_icon_check_item(
&self,
texture: impl AsArg<Texture>,
label: impl Into<GodotString>,
id: i64,
accel: i64
)
pub fn add_icon_check_item(
&self,
texture: impl AsArg<Texture>,
label: impl Into<GodotString>,
id: i64,
accel: i64
)
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 0
will be assigned to it. See [method 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 [method set_item_checked] for more info on how to control it.
Default Arguments
id
--1
accel
-0
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 [method set_item_checked] for more info on how to control it.
Default Arguments
id
--1
global
-false
pub fn add_icon_item(
&self,
texture: impl AsArg<Texture>,
label: impl Into<GodotString>,
id: i64,
accel: i64
)
pub fn add_icon_item(
&self,
texture: impl AsArg<Texture>,
label: impl Into<GodotString>,
id: i64,
accel: i64
)
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 0
will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
Default Arguments
id
--1
accel
-0
pub fn add_icon_radio_check_item(
&self,
texture: impl AsArg<Texture>,
label: impl Into<GodotString>,
id: i64,
accel: i64
)
pub fn add_icon_radio_check_item(
&self,
texture: impl AsArg<Texture>,
label: impl Into<GodotString>,
id: i64,
accel: i64
)
Same as [method add_icon_check_item], but uses a radio check button.
Default Arguments
id
--1
accel
-0
Same as [method add_icon_check_shortcut], but uses a radio check button.
Default Arguments
id
--1
global
-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.
Default Arguments
id
--1
global
-false
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 0
will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
Default Arguments
id
--1
accel
-0
pub fn add_multistate_item(
&self,
label: impl Into<GodotString>,
max_states: i64,
default_state: i64,
id: i64,
accel: i64
)
pub fn add_multistate_item(
&self,
label: impl Into<GodotString>,
max_states: i64,
default_state: i64,
id: i64,
accel: i64
)
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
. Each press or activate of the item will increase the state by one. 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 0
will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
Default Arguments
default_state
-0
id
--1
accel
-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 0
will be assigned to it. See [method 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 [method set_item_checked] for more info on how to control it.
Default Arguments
id
--1
accel
-0
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 [method set_item_checked] for more info on how to control it.
Default Arguments
id
--1
global
-false
Adds a ShortCut.
An id
can optionally be provided. If no id
is provided, one will be created from the index.
Default Arguments
id
--1
global
-false
Adds an item that will act as a submenu of the parent PopupMenu node when clicked. The submenu
argument is the name of the child PopupMenu node that will be shown when the item is clicked.
An id
can optionally be provided. If no id
is provided, one will be created from the index.
Default Arguments
id
--1
If true
, allows to navigate PopupMenu with letter keys.
Returns the accelerator of the item at index idx
. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
Returns the number of items in the PopupMenu.
Returns the icon of the item at index idx
.
Returns the id of the item at index idx
. id
can be manually assigned, while index can not.
Returns the index of the item containing the specified id
. Index is automatically assigned to each item by the engine. Index can not be set manually.
Returns the metadata of the specified item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items.
Returns the ShortCut associated with the specified idx
item.
Returns the submenu name of the item at index idx
. See [method add_submenu_item] for more info on how to add a submenu.
Returns the text of the item at index idx
.
Returns the tooltip associated with the specified index index idx
.
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.
If true
, hides the PopupMenu when a checkbox or radio button is selected.
If true
, hides the PopupMenu when an item is selected.
If true
, hides the PopupMenu when a state item is selected.
Returns true
if the popup will be hidden when the window loses focus or not.
Returns true
if the item at index idx
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.
Returns true
if the item at index idx
is checked.
Returns true
if the item at index idx
is disabled. When it is disabled it can’t be selected, or its action invoked.
See [method set_item_disabled] for more info on how to disable an item.
Returns true
if the item at index idx
has radio button-style checkability.
Note: This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
Returns true
if the item is a separator. If it is, it will be displayed as a line. See [method add_separator] for more info on how to add a separator.
Returns true
if the specified item’s shortcut is disabled.
Removes the item at index idx
from the menu.
Note: The indices of items after the removed item will be shifted by one.
If true
, allows to navigate PopupMenu with letter keys.
If true
, hides the PopupMenu when a checkbox or radio button is selected.
If true
, hides the PopupMenu when an item is selected.
If true
, hides the PopupMenu when a state item is selected.
Hides the PopupMenu when the window loses focus.
Sets the accelerator of the item at index idx
. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
Sets whether the item at index idx
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.
Sets the type of the item at the specified index idx
to radio button. If false
, sets the type of the item to plain text.
Mark the item at index idx
as a separator, which means that it would be displayed as a line. If false
, sets the type of the item to plain text.
Sets the checkstate status of the item at index idx
.
Enables/disables the item at index idx
. When it is disabled, it can’t be selected and its action can’t be invoked.
Replaces the Texture icon of the specified idx
.
Sets the id
of the item at index idx
.
Sets the metadata of an item, which may be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items.
Sets the state of an multistate item. See [method add_multistate_item] for details.
Disables the ShortCut of the specified index idx
.
Sets the submenu of the item at index idx
. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked.
Sets the text of the item at index idx
.
Sets the String tooltip of the item at the specified index idx
.
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.
Toggles the check state of the item of the specified index idx
.
Cycle to the next state of an multistate item. See [method add_multistate_item] for details.
Methods from Deref<Target = Popup>
If true
, the popup will not be hidden when a click event occurs outside of it, or when it receives the ui_cancel
action event.
Note: Enabling this property doesn’t affect the Close or Cancel buttons’ behavior in dialogs that inherit from this class. As a workaround, you can use [method WindowDialog.get_close_button] or [method ConfirmationDialog.get_cancel] and hide the buttons in question by setting their [member CanvasItem.visible] property to false
.
Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by size
.
Default Arguments
size
-Vector2( 0, 0 )
Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, clamping the size to size
, then ensuring the popup is no larger than the viewport size multiplied by fallback_ratio
.
Default Arguments
size
-Vector2( 0, 0 )
fallback_ratio
-0.75
Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, ensuring the size is never smaller than minsize
.
Default Arguments
minsize
-Vector2( 0, 0 )
Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, scaled at a ratio of size of the screen.
Default Arguments
ratio
-0.75
Shrink popup to keep to the minimum size of content.
If true
, the popup will not be hidden when a click event occurs outside of it, or when it receives the ui_cancel
action event.
Note: Enabling this property doesn’t affect the Close or Cancel buttons’ behavior in dialogs that inherit from this class. As a workaround, you can use [method WindowDialog.get_close_button] or [method ConfirmationDialog.get_cancel] and hide the buttons in question by setting their [member CanvasItem.visible] property to false
.
Trait Implementations
type RefKind = ManuallyManaged
type RefKind = ManuallyManaged
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for PopupMenu
impl UnwindSafe for PopupMenu