pub struct ScriptViewHost { /* private fields */ }Implementations§
Source§impl ScriptViewHost
impl ScriptViewHost
Sourcepub fn scrollbars(
&self,
scope: &str,
theme: &PrimitiveTheme,
) -> Result<ScrollbarContext, ScriptViewError>
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.
Sourcepub fn new(
window_id: impl Into<String>,
cx: &mut App,
) -> Result<Self, ScriptViewError>
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.
pub fn window_id(&self) -> String
Sourcepub fn set_overlay_viewport(
&self,
viewport: OverlayBounds,
) -> Result<(), ScriptViewError>
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.
pub fn use_window_overlay_viewport(&self)
Sourcepub fn overlay_placement(
&self,
view_id: &str,
local_id: &str,
) -> Result<Option<PlacementResult>, OverlayLookupError>
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.
Sourcepub fn overlay_placement_in(
&self,
view_id: &str,
component: &str,
local_id: &str,
) -> Option<PlacementResult>
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]).
Sourcepub fn open_overlays(&self) -> Vec<OpenOverlay>
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.
Sourcepub fn dismiss_escape(&self, window: &mut Window, cx: &mut App) -> bool
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.
Visible controlled scopes. Only the focused scope is eligible for Back.
Propose a pop to the deepest focused inner stack. False lets the Host perform its outer Back. Ignored/rejected proposals still own Back.
Sourcepub fn bind_keys(
&self,
bindings: impl IntoIterator<Item = KeyBindingSpec>,
cx: &mut App,
) -> Result<(), ScriptViewError>
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.
pub fn container(&self, child: impl IntoElement) -> AnyElement
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for ScriptViewHost
impl !Send for ScriptViewHost
impl !Sync for ScriptViewHost
impl !UnwindSafe for ScriptViewHost
impl Forget for ScriptViewHost
impl Freeze for ScriptViewHost
impl Move for ScriptViewHost
impl Unpin for ScriptViewHost
impl UnsafeUnpin for ScriptViewHost
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Variant for T
impl<T> Variant for T
Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Variant trait object to &mut dyn Any.Source§fn as_boxed_any(self: Box<T>) -> Box<dyn Any>
fn as_boxed_any(self: Box<T>) -> Box<dyn Any>
Variant trait object to Box<dyn Any>.