Skip to main content

PanelHandle

Struct PanelHandle 

Source
pub struct PanelHandle(/* private fields */);
Expand description

The panel handle gpui-base holds on this crate’s behalf.

Concrete on purpose. Base stores it as Arc<dyn gpui_base::dock::PanelView>, and every renderer hook — the tab bar, the tile drag bar — gets it back with Self::of, which is an Any downcast to this one type. That is the only recovery Rust offers: the sub-trait object Arc<dyn PanelView> cannot be reconstructed from base’s handle, but a concrete wrapper around it can be.

Implementations§

Source§

impl PanelHandle

Source

pub fn new<P: Panel>(panel: Entity<P>) -> Self

Source

pub fn from_view(panel: Arc<dyn PanelView>) -> Self

Wrap a presentation handle that is already erased.

Source

pub fn of(panel: &Arc<dyn PanelView>) -> Option<&Self>

Recover the handle behind one of base’s, or None when base is holding a panel this crate did not wrap — a bare Entity<P> handed straight to gpui_base::dock::DockLayout::panel, say. A skin must draw something for that case; base’s own gpui_base::dock::PanelView::panel_name is the fallback with no obligations on the panel author.

Source

pub fn panel(&self) -> Arc<dyn PanelView>

The presentation handle, cloned out.

Owned rather than borrowed because the title bar’s ellipsis menu is built inside a 'static callback: the menu closure outlives the render_tab_bar call that created it, so it cannot borrow from the render context it was made in.

Trait Implementations§

Source§

impl Clone for PanelHandle

Source§

fn clone(&self) -> PanelHandle

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
Source§

impl Deref for PanelHandle

So a recovered handle answers the presentation trait directly: PanelHandle::of(panel)?.title(window, cx). Only Self::panel hands out an owned clone, which is what a 'static callback needs.

Source§

type Target = dyn PanelView

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl PanelView for PanelHandle

Source§

fn panel_name(&self, cx: &App) -> &'static str

Source§

fn panel_id(&self, cx: &App) -> PanelId

Source§

fn closable(&self, cx: &App) -> bool

Source§

fn zoomable(&self, cx: &App) -> bool

Source§

fn visible(&self, cx: &App) -> bool

Source§

fn set_active(&self, active: bool, window: &mut Window, cx: &mut App)

Source§

fn set_zoomed(&self, zoomed: bool, window: &mut Window, cx: &mut App)

Source§

fn on_added_to( &self, group: WeakEntity<TabGroup>, window: &mut Window, cx: &mut App, )

Source§

fn on_removed(&self, window: &mut Window, cx: &mut App)

Source§

fn view(&self) -> AnyView

Source§

fn focus_handle(&self, cx: &App) -> FocusHandle

Source§

fn dump(&self, cx: &App) -> PanelState

Source§

fn as_any(&self) -> &dyn Any

The concrete value behind this handle. 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<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> DynClone for T
where T: Clone,

Source§

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

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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