Struct gdnative_bindings::ItemList

pub struct ItemList { /* fields omitted */ }

core class ItemList inherits Control (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

ItemList is an unsafe pointer, and all of its methods are unsafe.

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 ItemList::free.

Class hierarchy

ItemList inherits methods from:

• Control
• CanvasItem
• Node
• Object

Methods

impl ItemList

Constants

pub const SELECT_SINGLE: i64

pub const ICON_MODE_TOP: i64

pub const ICON_MODE_LEFT: i64

pub const SELECT_MULTI: i64

impl ItemList

pub fn new() -> Self

Constructor.

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 ItemList::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _get_items(&self) -> VariantArray

pub unsafe fn _gui_input(&mut self, arg0: Option<InputEvent>)

pub unsafe fn _scroll_changed(&mut self, arg0: f64)

pub unsafe fn _set_items(&mut self, arg0: VariantArray)

pub unsafe fn add_icon_item(&mut self, icon: Option<Texture>, selectable: bool)

pub unsafe fn add_item(
    &mut self,
    text: GodotString,
    icon: Option<Texture>,
    selectable: bool
)

pub unsafe fn clear(&mut self)

pub unsafe fn ensure_current_is_visible(&mut self)

pub unsafe fn get_allow_reselect(&self) -> bool

pub unsafe fn get_allow_rmb_select(&self) -> bool

pub unsafe fn get_fixed_column_width(&self) -> i64

pub unsafe fn get_fixed_icon_size(&self) -> Vector2

pub unsafe fn get_icon_mode(&self) -> ItemListIconMode

pub unsafe fn get_icon_scale(&self) -> f64

pub unsafe fn get_item_at_position(&self, position: Vector2, exact: bool) -> i64

pub unsafe fn get_item_count(&self) -> i64

pub unsafe fn get_item_custom_bg_color(&self, idx: i64) -> Color

pub unsafe fn get_item_custom_fg_color(&self, idx: i64) -> Color

pub unsafe fn get_item_icon(&self, idx: i64) -> Option<Texture>

pub unsafe fn get_item_icon_modulate(&self, idx: i64) -> Color

pub unsafe fn get_item_icon_region(&self, idx: i64) -> Rect2

pub unsafe fn get_item_metadata(&self, idx: i64) -> Variant

pub unsafe fn get_item_text(&self, idx: i64) -> GodotString

pub unsafe fn get_item_tooltip(&self, idx: i64) -> GodotString

pub unsafe fn get_max_columns(&self) -> i64

pub unsafe fn get_max_text_lines(&self) -> i64

pub unsafe fn get_select_mode(&self) -> ItemListSelectMode

pub unsafe fn get_selected_items(&mut self) -> Int32Array

pub unsafe fn get_v_scroll(&mut self) -> Option<VScrollBar>

pub unsafe fn has_auto_height(&self) -> bool

pub unsafe fn is_anything_selected(&mut self) -> bool

pub unsafe fn is_item_disabled(&self, idx: i64) -> bool

pub unsafe fn is_item_icon_transposed(&self, idx: i64) -> bool

pub unsafe fn is_item_selectable(&self, idx: i64) -> bool

pub unsafe fn is_item_tooltip_enabled(&self, idx: i64) -> bool

pub unsafe fn is_same_column_width(&self) -> bool

pub unsafe fn is_selected(&self, idx: i64) -> bool

pub unsafe fn move_item(&mut self, from_idx: i64, to_idx: i64)

pub unsafe fn remove_item(&mut self, idx: i64)

pub unsafe fn select(&mut self, idx: i64, single: bool)

pub unsafe fn set_allow_reselect(&mut self, allow: bool)

pub unsafe fn set_allow_rmb_select(&mut self, allow: bool)

pub unsafe fn set_auto_height(&mut self, enable: bool)

pub unsafe fn set_fixed_column_width(&mut self, width: i64)

pub unsafe fn set_fixed_icon_size(&mut self, size: Vector2)

pub unsafe fn set_icon_mode(&mut self, mode: i64)

pub unsafe fn set_icon_scale(&mut self, scale: f64)

pub unsafe fn set_item_custom_bg_color(
    &mut self,
    idx: i64,
    custom_bg_color: Color
)

pub unsafe fn set_item_custom_fg_color(
    &mut self,
    idx: i64,
    custom_fg_color: Color
)

pub unsafe fn set_item_disabled(&mut self, idx: i64, disabled: bool)

pub unsafe fn set_item_icon(&mut self, idx: i64, icon: Option<Texture>)

pub unsafe fn set_item_icon_modulate(&mut self, idx: i64, modulate: Color)

pub unsafe fn set_item_icon_region(&mut self, idx: i64, rect: Rect2)

pub unsafe fn set_item_icon_transposed(&mut self, idx: i64, rect: bool)

pub unsafe fn set_item_metadata(&mut self, idx: i64, metadata: Variant)

pub unsafe fn set_item_selectable(&mut self, idx: i64, selectable: bool)

pub unsafe fn set_item_text(&mut self, idx: i64, text: GodotString)

pub unsafe fn set_item_tooltip(&mut self, idx: i64, tooltip: GodotString)

pub unsafe fn set_item_tooltip_enabled(&mut self, idx: i64, enable: bool)

pub unsafe fn set_max_columns(&mut self, amount: i64)

pub unsafe fn set_max_text_lines(&mut self, lines: i64)

pub unsafe fn set_same_column_width(&mut self, enable: bool)

pub unsafe fn set_select_mode(&mut self, mode: i64)

pub unsafe fn sort_items_by_text(&mut self)

pub unsafe fn unselect(&mut self, idx: i64)

pub unsafe fn unselect_all(&mut self)

pub unsafe fn to_control(&self) -> Control

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Methods from Deref<Target = Control>

pub const CURSOR_CAN_DROP: i64

pub const GROW_DIRECTION_END: i64

pub const SIZE_FILL: i64

pub const CURSOR_HSIZE: i64

pub const CURSOR_VSPLIT: i64

pub const PRESET_CENTER_TOP: i64

pub const CURSOR_BUSY: i64

pub const CURSOR_MOVE: i64

pub const FOCUS_ALL: i64

pub const PRESET_CENTER: i64

pub const CURSOR_BDIAGSIZE: i64

pub const PRESET_BOTTOM_LEFT: i64

pub const SIZE_SHRINK_END: i64

pub const NOTIFICATION_MOUSE_ENTER: i64

pub const CURSOR_VSIZE: i64

pub const GROW_DIRECTION_BEGIN: i64

pub const PRESET_TOP_WIDE: i64

pub const CURSOR_ARROW: i64

pub const NOTIFICATION_FOCUS_ENTER: i64

pub const CURSOR_WAIT: i64

pub const PRESET_VCENTER_WIDE: i64

pub const PRESET_HCENTER_WIDE: i64

pub const ANCHOR_END: i64

pub const PRESET_RIGHT_WIDE: i64

pub const NOTIFICATION_SCROLL_END: i64

pub const MOUSE_FILTER_PASS: i64

pub const NOTIFICATION_MODAL_CLOSE: i64

pub const PRESET_MODE_MINSIZE: i64

pub const NOTIFICATION_SCROLL_BEGIN: i64

pub const PRESET_WIDE: i64

pub const CURSOR_HSPLIT: i64

pub const CURSOR_POINTING_HAND: i64

pub const FOCUS_CLICK: i64

pub const CURSOR_FDIAGSIZE: i64

pub const SIZE_SHRINK_CENTER: i64

pub const NOTIFICATION_FOCUS_EXIT: i64

pub const ANCHOR_BEGIN: i64

pub const MOUSE_FILTER_IGNORE: i64

pub const CURSOR_HELP: i64

pub const FOCUS_NONE: i64

pub const CURSOR_DRAG: i64

pub const PRESET_TOP_LEFT: i64

pub const PRESET_TOP_RIGHT: i64

pub const PRESET_CENTER_RIGHT: i64

pub const MOUSE_FILTER_STOP: i64

pub const PRESET_MODE_KEEP_HEIGHT: i64

pub const NOTIFICATION_THEME_CHANGED: i64

pub const SIZE_EXPAND: i64

pub const PRESET_CENTER_BOTTOM: i64

pub const NOTIFICATION_MOUSE_EXIT: i64

pub const PRESET_LEFT_WIDE: i64

pub const PRESET_MODE_KEEP_WIDTH: i64

pub const CURSOR_CROSS: i64

pub const PRESET_CENTER_LEFT: i64

pub const GROW_DIRECTION_BOTH: i64

pub const PRESET_BOTTOM_WIDE: i64

pub const PRESET_BOTTOM_RIGHT: i64

pub const PRESET_MODE_KEEP_SIZE: i64

pub const CURSOR_FORBIDDEN: i64

pub const CURSOR_IBEAM: i64

pub const NOTIFICATION_RESIZED: i64

pub const SIZE_EXPAND_FILL: i64

pub unsafe fn _clips_input(&mut self) -> bool

pub unsafe fn _get_minimum_size(&mut self) -> Vector2

pub unsafe fn _get_tooltip(&self) -> GodotString

pub unsafe fn _gui_input(&mut self, event: Option<InputEvent>)

pub unsafe fn _make_custom_tooltip(
    &mut self,
    for_text: GodotString
) -> Option<Object>

pub unsafe fn _override_changed(&mut self)

pub unsafe fn _set_anchor(&mut self, margin: i64, anchor: f64)

pub unsafe fn _size_changed(&mut self)

pub unsafe fn _theme_changed(&mut self)

pub unsafe fn _update_minimum_size(&mut self)

pub unsafe fn accept_event(&mut self)

pub unsafe fn add_color_override(&mut self, name: GodotString, color: Color)

pub unsafe fn add_constant_override(&mut self, name: GodotString, constant: i64)

pub unsafe fn add_font_override(
    &mut self,
    name: GodotString,
    font: Option<Font>
)

pub unsafe fn add_icon_override(
    &mut self,
    name: GodotString,
    texture: Option<Texture>
)

pub unsafe fn add_shader_override(
    &mut self,
    name: GodotString,
    shader: Option<Shader>
)

pub unsafe fn add_stylebox_override(
    &mut self,
    name: GodotString,
    stylebox: Option<StyleBox>
)

pub unsafe fn can_drop_data(&mut self, position: Vector2, data: Variant) -> bool

pub unsafe fn drop_data(&mut self, position: Vector2, data: Variant)

pub unsafe fn force_drag(&mut self, data: Variant, preview: Option<Control>)

pub unsafe fn get_anchor(&self, margin: i64) -> f64

pub unsafe fn get_begin(&self) -> Vector2

pub unsafe fn get_color(&self, name: GodotString, _type: GodotString) -> Color

pub unsafe fn get_combined_minimum_size(&self) -> Vector2

pub unsafe fn get_constant(&self, name: GodotString, _type: GodotString) -> i64

pub unsafe fn get_cursor_shape(&self, position: Vector2) -> ControlCursorShape

pub unsafe fn get_custom_minimum_size(&self) -> Vector2

pub unsafe fn get_default_cursor_shape(&self) -> ControlCursorShape

pub unsafe fn get_drag_data(&mut self, position: Vector2) -> Option<Object>

pub unsafe fn get_end(&self) -> Vector2

pub unsafe fn get_focus_mode(&self) -> ControlFocusMode

pub unsafe fn get_focus_neighbour(&self, margin: i64) -> NodePath

pub unsafe fn get_focus_next(&self) -> NodePath

pub unsafe fn get_focus_owner(&self) -> Option<Control>

pub unsafe fn get_focus_previous(&self) -> NodePath

pub unsafe fn get_font(
    &self,
    name: GodotString,
    _type: GodotString
) -> Option<Font>

pub unsafe fn get_global_position(&self) -> Vector2

pub unsafe fn get_global_rect(&self) -> Rect2

pub unsafe fn get_h_grow_direction(&self) -> ControlGrowDirection

pub unsafe fn get_h_size_flags(&self) -> i64

pub unsafe fn get_icon(
    &self,
    name: GodotString,
    _type: GodotString
) -> Option<Texture>

pub unsafe fn get_margin(&self, margin: i64) -> f64

pub unsafe fn get_minimum_size(&self) -> Vector2

pub unsafe fn get_mouse_filter(&self) -> ControlMouseFilter

pub unsafe fn get_parent_area_size(&self) -> Vector2

pub unsafe fn get_parent_control(&self) -> Option<Control>

pub unsafe fn get_pivot_offset(&self) -> Vector2

pub unsafe fn get_position(&self) -> Vector2

pub unsafe fn get_rect(&self) -> Rect2

pub unsafe fn get_rotation(&self) -> f64

pub unsafe fn get_rotation_degrees(&self) -> f64

pub unsafe fn get_scale(&self) -> Vector2

pub unsafe fn get_size(&self) -> Vector2

pub unsafe fn get_stretch_ratio(&self) -> f64

pub unsafe fn get_stylebox(
    &self,
    name: GodotString,
    _type: GodotString
) -> Option<StyleBox>

pub unsafe fn get_theme(&self) -> Option<Theme>

pub unsafe fn get_tooltip(&self, at_position: Vector2) -> GodotString

pub unsafe fn get_v_grow_direction(&self) -> ControlGrowDirection

pub unsafe fn get_v_size_flags(&self) -> i64

pub unsafe fn grab_click_focus(&mut self)

pub unsafe fn grab_focus(&mut self)

pub unsafe fn has_color(&self, name: GodotString, _type: GodotString) -> bool

pub unsafe fn has_color_override(&self, name: GodotString) -> bool

pub unsafe fn has_constant(&self, name: GodotString, _type: GodotString) -> bool

pub unsafe fn has_constant_override(&self, name: GodotString) -> bool

pub unsafe fn has_focus(&self) -> bool

pub unsafe fn has_font(&self, name: GodotString, _type: GodotString) -> bool

pub unsafe fn has_font_override(&self, name: GodotString) -> bool

pub unsafe fn has_icon(&self, name: GodotString, _type: GodotString) -> bool

pub unsafe fn has_icon_override(&self, name: GodotString) -> bool

pub unsafe fn has_point(&mut self, point: Vector2) -> bool

pub unsafe fn has_shader_override(&self, name: GodotString) -> bool

pub unsafe fn has_stylebox(&self, name: GodotString, _type: GodotString) -> bool

pub unsafe fn has_stylebox_override(&self, name: GodotString) -> bool

pub unsafe fn is_clipping_contents(&mut self) -> bool

pub unsafe fn minimum_size_changed(&mut self)

pub unsafe fn release_focus(&mut self)

pub unsafe fn set_anchor(
    &mut self,
    margin: i64,
    anchor: f64,
    keep_margin: bool,
    push_opposite_anchor: bool
)

pub unsafe fn set_anchor_and_margin(
    &mut self,
    margin: i64,
    anchor: f64,
    offset: f64,
    push_opposite_anchor: bool
)

pub unsafe fn set_anchors_and_margins_preset(
    &mut self,
    preset: i64,
    resize_mode: i64,
    margin: i64
)

pub unsafe fn set_anchors_preset(&mut self, preset: i64, keep_margin: bool)

pub unsafe fn set_begin(&mut self, position: Vector2)

pub unsafe fn set_clip_contents(&mut self, enable: bool)

pub unsafe fn set_custom_minimum_size(&mut self, size: Vector2)

pub unsafe fn set_default_cursor_shape(&mut self, shape: i64)

pub unsafe fn set_drag_forwarding(&mut self, target: Option<Control>)

pub unsafe fn set_drag_preview(&mut self, control: Option<Control>)

pub unsafe fn set_end(&mut self, position: Vector2)

pub unsafe fn set_focus_mode(&mut self, mode: i64)

pub unsafe fn set_focus_neighbour(&mut self, margin: i64, neighbour: NodePath)

pub unsafe fn set_focus_next(&mut self, next: NodePath)

pub unsafe fn set_focus_previous(&mut self, previous: NodePath)

pub unsafe fn set_global_position(&mut self, position: Vector2)

pub unsafe fn set_h_grow_direction(&mut self, direction: i64)

pub unsafe fn set_h_size_flags(&mut self, flags: i64)

pub unsafe fn set_margin(&mut self, margin: i64, offset: f64)

pub unsafe fn set_margins_preset(
    &mut self,
    preset: i64,
    resize_mode: i64,
    margin: i64
)

pub unsafe fn set_mouse_filter(&mut self, filter: i64)

pub unsafe fn set_pivot_offset(&mut self, pivot_offset: Vector2)

pub unsafe fn set_position(&mut self, position: Vector2)

pub unsafe fn set_rotation(&mut self, radians: f64)

pub unsafe fn set_rotation_degrees(&mut self, degrees: f64)

pub unsafe fn set_scale(&mut self, scale: Vector2)

pub unsafe fn set_size(&mut self, size: Vector2)

pub unsafe fn set_stretch_ratio(&mut self, ratio: f64)

pub unsafe fn set_theme(&mut self, theme: Option<Theme>)

pub unsafe fn set_tooltip(&mut self, tooltip: GodotString)

pub unsafe fn set_v_grow_direction(&mut self, direction: i64)

pub unsafe fn set_v_size_flags(&mut self, flags: i64)

pub unsafe fn show_modal(&mut self, exclusive: bool)

pub unsafe fn warp_mouse(&mut self, to_position: Vector2)

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for ItemList

fn clone(&self) -> ItemList

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ItemList

impl Debug for ItemList

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Deref for ItemList

type Target = Control

The resulting type after dereferencing.

fn deref(&self) -> &Control

Dereferences the value.

impl DerefMut for ItemList

fn deref_mut(&mut self) -> &mut Control

Mutably dereferences the value.

impl Free for ItemList

unsafe fn godot_free(self)

impl FromVariant for ItemList

fn from_variant(variant: &Variant) -> Option<Self>

impl GodotObject for ItemList

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Instanciable for ItemList

fn construct() -> Self

impl QueueFree for ItemList

unsafe fn godot_queue_free(&mut self)

impl ToVariant for ItemList

fn to_variant(&self) -> Variant