Struct gdnative::api::EditorInspector

pub struct EditorInspector { /* fields omitted */ }

tools class EditorInspector inherits ScrollContainer (unsafe).

Official documentation

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

Class hierarchy

EditorInspector inherits methods from:

• ScrollContainer
• Container
• Control
• CanvasItem
• Node
• Object

Tool

This class is used to interact with Godot's editor.

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

impl EditorInspector

pub fn refresh(&self)

Refreshes the inspector.
				[b]Note:[/b] To save on CPU resources, calling this method will do nothing if the time specified in [code]docks/property_editor/auto_refresh_interval[/code] editor setting hasn't passed yet since this method was last called. (By default, this interval is set to 0.3 seconds.)

Methods from Deref<Target = ScrollContainer>

pub fn deadzone(&self) -> i64

pub fn h_scroll(&self) -> i64

The current horizontal scroll value.

pub fn get_h_scrollbar(&self) -> Option<Ref<HScrollBar, Shared>>

Returns the horizontal scrollbar [HScrollBar] of this [ScrollContainer].

pub fn v_scroll(&self) -> i64

The current vertical scroll value.

pub fn get_v_scrollbar(&self) -> Option<Ref<VScrollBar, Shared>>

Returns the vertical scrollbar [VScrollBar] of this [ScrollContainer].

pub fn is_following_focus(&self) -> bool

If [code]true[/code], the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.

pub fn is_h_scroll_enabled(&self) -> bool

If [code]true[/code], enables horizontal scrolling.

pub fn is_v_scroll_enabled(&self) -> bool

If [code]true[/code], enables vertical scrolling.

pub fn set_deadzone(&self, deadzone: i64)

pub fn set_enable_h_scroll(&self, enable: bool)

If [code]true[/code], enables horizontal scrolling.

pub fn set_enable_v_scroll(&self, enable: bool)

If [code]true[/code], enables vertical scrolling.

pub fn set_follow_focus(&self, enabled: bool)

If [code]true[/code], the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.

pub fn set_h_scroll(&self, value: i64)

The current horizontal scroll value.

pub fn set_v_scroll(&self, value: i64)

The current vertical scroll value.

Trait Implementations

impl Debug for EditorInspector

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

Formats the value using the given formatter.

impl Deref for EditorInspector

type Target = ScrollContainer

The resulting type after dereferencing.

fn deref(&self) -> &ScrollContainer

Dereferences the value.

impl DerefMut for EditorInspector

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

Mutably dereferences the value.

impl GodotObject for EditorInspector

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

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.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl QueueFree for EditorInspector

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for EditorInspector

impl SubClass<Container> for EditorInspector

impl SubClass<Control> for EditorInspector

impl SubClass<Node> for EditorInspector

impl SubClass<Object> for EditorInspector

impl SubClass<ScrollContainer> for EditorInspector