Skip to main content

ScriptViewHost

Struct ScriptViewHost 

Source
pub struct ScriptViewHost { /* private fields */ }

Implementations§

Source§

impl ScriptViewHost

Source

pub fn scrollbars( &self, scope: &str, theme: &PrimitiveTheme, ) -> Result<ScrollbarContext, ScriptViewError>

Create a themed scrollbar factory for a Host-native surface. scope identifies that surface within this Host and must be stable and unique. Render it under Self::container so disappearance and window input cancel gestures through the Host’s shared interaction lifecycle.

§Errors

Returns ScriptViewError::InvalidId for an unsafe scope identifier.

Source

pub fn new( window_id: impl Into<String>, cx: &mut App, ) -> Result<Self, ScriptViewError>

Create one interaction/overlay domain, normally one per GPUI window.

§Errors

Returns ScriptViewError::InvalidId for an unsafe window identifier.

Source

pub fn window_id(&self) -> String

Source

pub fn set_overlay_viewport( &self, viewport: OverlayBounds, ) -> Result<(), ScriptViewError>

Restrict this Host’s overlays to an explicit absolute rectangle.

§Errors

Returns ScriptViewError::Overlay for invalid geometry.

Source

pub fn use_window_overlay_viewport(&self)

Source

pub fn overlay_placement( &self, view_id: &str, local_id: &str, ) -> Result<Option<PlacementResult>, OverlayLookupError>

The placement of the overlay a view rendered with this script key, as of the last frame; None while it is closed or not rendered.

§Errors

Returns crate::OverlayLookupError::Ambiguous when several component instances in the view declare an overlay with this key; name one with Self::overlay_placement_in.

Source

pub fn overlay_placement_in( &self, view_id: &str, component: &str, local_id: &str, ) -> Option<PlacementResult>

The placement of the overlay that one component instance declared with this key, as of the last frame. component is the instance path as diagnostics print it (/View[main]/Filter[eu]/Select[region]).

Source

pub fn open_overlays(&self) -> Vec<OpenOverlay>

The script overlays open in this Host’s views as of the last frame, bottom to top: the last entry is the topmost. Escape closes the last one with dismiss_on_escape; a modal holds focus while it is the topmost modal. Overlays declared inside components are listed too (a Select’s <key>-combobox, a Dialog in a third-party widget), with the declaring instance in owner. Read it from an action handler or from the Host’s render, before the container lays out: while the container lays out and prepaints, the list is being rebuilt.

Source

pub fn dismiss_escape(&self, window: &mut Window, cx: &mut App) -> bool

Close the topmost script overlay that Escape closes, as the Self::container’s Escape handler does, and report whether one took the key. An App-level Escape binding, which GPUI dispatches before any key-down listener, calls this first and handles Escape itself only when it returns false.

Source

pub fn navigation_stacks( &self, window: &Window, cx: &App, ) -> Vec<NavigationStackInfo>

Visible controlled scopes. Only the focused scope is eligible for Back.

Source

pub fn navigate_back(&self, window: &mut Window, cx: &mut App) -> bool

Propose a pop to the deepest focused inner stack. False lets the Host perform its outer Back. Ignored/rejected proposals still own Back.

Source

pub fn bind_keys( &self, bindings: impl IntoIterator<Item = KeyBindingSpec>, cx: &mut App, ) -> Result<(), ScriptViewError>

Bind host-approved script actions once at App scope.

§Errors

Returns a conflict when another binding already owns the same keys and context, or an invalid-key error from GPUI conversion.

Source

pub fn container(&self, child: impl IntoElement) -> AnyElement

Trait Implementations§

Source§

impl Clone for ScriptViewHost

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> Variant for T
where T: Any + Clone + SendSync,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert this Variant trait object to &dyn Any.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert this Variant trait object to &mut dyn Any.
Source§

fn as_boxed_any(self: Box<T>) -> Box<dyn Any>

Convert this Variant trait object to Box<dyn Any>.
Source§

fn type_name(&self) -> &'static str

Get the name of this type.
Source§

fn clone_object(&self) -> Box<dyn Variant>

Clone this Variant trait object.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more