Struct TreeItem

#[repr(C)]
pub struct TreeItem { /* private fields */ }

Godot class TreeItem.

Inherits Object.

Related symbols:

• tree_item: sidecar module with related enum/flag types
• ITreeItem: virtual methods

See also Godot docs for TreeItem.

Not instantiable

This class cannot be constructed. Obtain Gd<TreeItem> instances via Godot APIs.

Implementations

impl TreeItem

pub fn set_cell_mode(&mut self, column: i32, mode: TreeCellMode)

pub fn get_cell_mode(&self, column: i32) -> TreeCellMode

pub fn set_edit_multiline(&mut self, column: i32, multiline: bool)

pub fn is_edit_multiline(&self, column: i32) -> bool

pub fn set_checked(&mut self, column: i32, checked: bool)

pub fn set_indeterminate(&mut self, column: i32, indeterminate: bool)

pub fn is_checked(&self, column: i32) -> bool

pub fn is_indeterminate(&self, column: i32) -> bool

pub fn propagate_check(&mut self, column: i32)

To set the default parameters, use Self::propagate_check_ex and its builder methods. See the book for detailed usage instructions.

pub fn propagate_check_ex<'a>(&'a mut self, column: i32) -> ExPropagateCheck<'a>

pub fn set_text(&mut self, column: i32, text: impl AsArg<GString>)

pub fn get_text(&self, column: i32) -> GString

pub fn set_text_direction(&mut self, column: i32, direction: TextDirection)

pub fn get_text_direction(&self, column: i32) -> TextDirection

pub fn set_autowrap_mode(&mut self, column: i32, autowrap_mode: AutowrapMode)

pub fn get_autowrap_mode(&self, column: i32) -> AutowrapMode

pub fn set_text_overrun_behavior( &mut self, column: i32, overrun_behavior: OverrunBehavior, )

pub fn get_text_overrun_behavior(&self, column: i32) -> OverrunBehavior

pub fn set_structured_text_bidi_override( &mut self, column: i32, parser: StructuredTextParser, )

pub fn get_structured_text_bidi_override( &self, column: i32, ) -> StructuredTextParser

pub fn set_structured_text_bidi_override_options( &mut self, column: i32, args: &Array<Variant>, )

pub fn get_structured_text_bidi_override_options( &self, column: i32, ) -> Array<Variant>

pub fn set_language(&mut self, column: i32, language: impl AsArg<GString>)

pub fn get_language(&self, column: i32) -> GString

pub fn set_suffix(&mut self, column: i32, text: impl AsArg<GString>)

pub fn get_suffix(&self, column: i32) -> GString

pub fn set_icon(&mut self, column: i32, texture: impl AsObjectArg<Texture2D>)

pub fn get_icon(&self, column: i32) -> Option<Gd<Texture2D>>

pub fn set_icon_region(&mut self, column: i32, region: Rect2)

pub fn get_icon_region(&self, column: i32) -> Rect2

pub fn set_icon_max_width(&mut self, column: i32, width: i32)

pub fn get_icon_max_width(&self, column: i32) -> i32

pub fn set_icon_modulate(&mut self, column: i32, modulate: Color)

pub fn get_icon_modulate(&self, column: i32) -> Color

pub fn set_range(&mut self, column: i32, value: f64)

pub fn get_range(&self, column: i32) -> f64

pub fn set_range_config(&mut self, column: i32, min: f64, max: f64, step: f64)

To set the default parameters, use Self::set_range_config_ex and its builder methods. See the book for detailed usage instructions.

pub fn set_range_config_ex<'a>( &'a mut self, column: i32, min: f64, max: f64, step: f64, ) -> ExSetRangeConfig<'a>

pub fn get_range_config(&mut self, column: i32) -> Dictionary

pub fn set_metadata(&mut self, column: i32, meta: &Variant)

pub fn get_metadata(&self, column: i32) -> Variant

pub fn set_custom_draw( &mut self, column: i32, object: impl AsObjectArg<Object>, callback: impl AsArg<StringName>, )

pub fn set_custom_draw_callback(&mut self, column: i32, callback: &Callable)

pub fn get_custom_draw_callback(&self, column: i32) -> Callable

pub fn set_collapsed(&mut self, enable: bool)

pub fn is_collapsed(&mut self) -> bool

pub fn set_collapsed_recursive(&mut self, enable: bool)

pub fn is_any_collapsed(&mut self) -> bool

To set the default parameters, use Self::is_any_collapsed_ex and its builder methods. See the book for detailed usage instructions.

pub fn is_any_collapsed_ex<'a>(&'a mut self) -> ExIsAnyCollapsed<'a>

pub fn set_visible(&mut self, enable: bool)

pub fn is_visible(&mut self) -> bool

pub fn is_visible_in_tree(&self) -> bool

pub fn uncollapse_tree(&mut self)

pub fn set_custom_minimum_height(&mut self, height: i32)

pub fn get_custom_minimum_height(&self) -> i32

pub fn set_selectable(&mut self, column: i32, selectable: bool)

pub fn is_selectable(&self, column: i32) -> bool

pub fn is_selected(&mut self, column: i32) -> bool

pub fn select(&mut self, column: i32)

pub fn deselect(&mut self, column: i32)

pub fn set_editable(&mut self, column: i32, enabled: bool)

pub fn is_editable(&mut self, column: i32) -> bool

pub fn set_custom_color(&mut self, column: i32, color: Color)

pub fn get_custom_color(&self, column: i32) -> Color

pub fn clear_custom_color(&mut self, column: i32)

pub fn set_custom_font(&mut self, column: i32, font: impl AsObjectArg<Font>)

pub fn get_custom_font(&self, column: i32) -> Option<Gd<Font>>

pub fn set_custom_font_size(&mut self, column: i32, font_size: i32)

pub fn get_custom_font_size(&self, column: i32) -> i32

pub fn set_custom_bg_color(&mut self, column: i32, color: Color)

To set the default parameters, use Self::set_custom_bg_color_ex and its builder methods. See the book for detailed usage instructions.

pub fn set_custom_bg_color_ex<'a>( &'a mut self, column: i32, color: Color, ) -> ExSetCustomBgColor<'a>

pub fn clear_custom_bg_color(&mut self, column: i32)

pub fn get_custom_bg_color(&self, column: i32) -> Color

pub fn set_custom_as_button(&mut self, column: i32, enable: bool)

pub fn is_custom_set_as_button(&self, column: i32) -> bool

pub fn add_button(&mut self, column: i32, button: impl AsObjectArg<Texture2D>)

To set the default parameters, use Self::add_button_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_button_ex<'a>( &'a mut self, column: i32, button: impl AsObjectArg<Texture2D>, ) -> ExAddButton<'a>

pub fn get_button_count(&self, column: i32) -> i32

pub fn get_button_tooltip_text(&self, column: i32, button_index: i32) -> GString

pub fn get_button_id(&self, column: i32, button_index: i32) -> i32

pub fn get_button_by_id(&self, column: i32, id: i32) -> i32

pub fn get_button_color(&self, column: i32, id: i32) -> Color

pub fn get_button( &self, column: i32, button_index: i32, ) -> Option<Gd<Texture2D>>

pub fn set_button_tooltip_text( &mut self, column: i32, button_index: i32, tooltip: impl AsArg<GString>, )

pub fn set_button( &mut self, column: i32, button_index: i32, button: impl AsObjectArg<Texture2D>, )

pub fn erase_button(&mut self, column: i32, button_index: i32)

pub fn set_button_disabled( &mut self, column: i32, button_index: i32, disabled: bool, )

pub fn set_button_color(&mut self, column: i32, button_index: i32, color: Color)

pub fn is_button_disabled(&self, column: i32, button_index: i32) -> bool

pub fn set_tooltip_text(&mut self, column: i32, tooltip: impl AsArg<GString>)

pub fn get_tooltip_text(&self, column: i32) -> GString

pub fn set_text_alignment( &mut self, column: i32, text_alignment: HorizontalAlignment, )

pub fn get_text_alignment(&self, column: i32) -> HorizontalAlignment

pub fn set_expand_right(&mut self, column: i32, enable: bool)

pub fn get_expand_right(&self, column: i32) -> bool

pub fn set_disable_folding(&mut self, disable: bool)

pub fn is_folding_disabled(&self) -> bool

pub fn create_child(&mut self) -> Option<Gd<TreeItem>>

To set the default parameters, use Self::create_child_ex and its builder methods. See the book for detailed usage instructions.

pub fn create_child_ex<'a>(&'a mut self) -> ExCreateChild<'a>

pub fn add_child(&mut self, child: impl AsObjectArg<TreeItem>)

pub fn remove_child(&mut self, child: impl AsObjectArg<TreeItem>)

pub fn get_tree(&self) -> Option<Gd<Tree>>

pub fn get_next(&self) -> Option<Gd<TreeItem>>

pub fn get_prev(&mut self) -> Option<Gd<TreeItem>>

pub fn get_parent(&self) -> Option<Gd<TreeItem>>

pub fn get_first_child(&self) -> Option<Gd<TreeItem>>

pub fn get_next_in_tree(&mut self) -> Option<Gd<TreeItem>>

To set the default parameters, use Self::get_next_in_tree_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_next_in_tree_ex<'a>(&'a mut self) -> ExGetNextInTree<'a>

pub fn get_prev_in_tree(&mut self) -> Option<Gd<TreeItem>>

To set the default parameters, use Self::get_prev_in_tree_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_prev_in_tree_ex<'a>(&'a mut self) -> ExGetPrevInTree<'a>

pub fn get_next_visible(&mut self) -> Option<Gd<TreeItem>>

To set the default parameters, use Self::get_next_visible_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_next_visible_ex<'a>(&'a mut self) -> ExGetNextVisible<'a>

pub fn get_prev_visible(&mut self) -> Option<Gd<TreeItem>>

To set the default parameters, use Self::get_prev_visible_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_prev_visible_ex<'a>(&'a mut self) -> ExGetPrevVisible<'a>

pub fn get_child(&mut self, index: i32) -> Option<Gd<TreeItem>>

pub fn get_child_count(&mut self) -> i32

pub fn get_children(&mut self) -> Array<Gd<TreeItem>>

pub fn get_index(&mut self) -> i32

pub fn move_before(&mut self, item: impl AsObjectArg<TreeItem>)

pub fn move_after(&mut self, item: impl AsObjectArg<TreeItem>)

pub fn call_recursive( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], )

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_recursive( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<(), CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for TreeItem

type Memory = MemManual

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for TreeItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for TreeItem

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &<TreeItem as Deref>::Target

Dereferences the value.

impl DerefMut for TreeItem

fn deref_mut(&mut self) -> &mut <TreeItem as Deref>::Target

Mutably dereferences the value.

impl GodotClass for TreeItem

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = Object

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl Inherits<Object> for TreeItem