Skip to main content

TileContext

Struct TileContext 

Source
pub struct TileContext { /* private fields */ }
Expand description

Everything gpui_base::dock exports, so a consumer never has to depend on the foundation crate directly to write a skin or read a container’s state. Kept in step with base’s own list by every_base_dock_export_is_reachable_from_here.

Two names are handled elsewhere and one is deliberately absent: base’s Panel and PanelView arrive as BasePanel and BasePanelView because this module’s Panel/PanelView are the presentation halves that extend them, and base’s Dock — a plain state struct holding one dock’s open, collapsible, size and resizing flags — is not re-exported at all, because the name meant a panel container in every released version of this crate and handing it back with a different meaning is worse than dropping it. A skin reads a dock through DockContext. What a skin needs to draw one tile, and the callbacks it invokes rather than reimplementing the snapping and resize arithmetic.

Implementations§

Source§

impl TileContext

Source

pub fn node(&self) -> NodeId

The Tiles node this tile belongs to, for a skin that needs to name the canvas in a drag payload or a drop target.

Source

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

Source

pub fn panel_id(&self) -> PanelId

Source

pub fn bounds(&self) -> Bounds<Pixels>

Source

pub fn z_index(&self) -> usize

Source

pub fn is_moving(&self) -> bool

Source

pub fn is_resizing(&self) -> bool

Source

pub fn is_closable(&self) -> bool

Source

pub fn is_zoomed(&self) -> bool

Whether this tile is the one filling the whole dock.

A zoomed tile is drawn without its stored bounds and takes no move or resize gesture, so a skin should offer the way back out here rather than the affordances of a tile that can still be dragged.

Source

pub fn is_zoomable(&self) -> bool

Whether this tile’s panel allows zooming at all. Where the zoom control appears is the skin’s decision; whether there is one to offer is not.

Source

pub fn begin_move( &self, pointer: Point<Pixels>, window: &mut Window, cx: &mut App, )

Pointer positions are in window coordinates: every gesture is resolved against the position the gesture started at, so the skin never has to convert into canvas space.

Source

pub fn move_to(&self, pointer: Point<Pixels>, window: &mut Window, cx: &mut App)

Source

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

Source

pub fn begin_resize( &self, side: ResizeSide, pointer: Point<Pixels>, window: &mut Window, cx: &mut App, )

Source

pub fn resize_to( &self, pointer: Point<Pixels>, window: &mut Window, cx: &mut App, )

Source

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

Source

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

Source

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

Flip this tile between filling the whole dock and sitting at its stored bounds.

Zooming in is refused when Self::is_zoomable is false, so a skin that offers a Zoom control should gate it on that. Zooming out is never refused.

Source

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

Dismiss this tile. Refused when Self::is_closable is false, so a skin that offers a Close control should gate it on that.

Trait Implementations§

Source§

impl Clone for TileContext

Source§

fn clone(&self) -> TileContext

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