Skip to main content

Layout

Struct Layout 

Source
pub struct Layout {
    pub statusline: bool,
    pub tabbar: bool,
    /* private fields */
}

Fields§

§statusline: bool§tabbar: bool

Implementations§

Source§

impl Layout

Source

pub fn single(window: Window) -> Self

Source

pub const fn active(&self) -> WindowId

Source

pub fn focus(&mut self, id: WindowId) -> bool

Focus id if it is in the tree. Returns whether it moved.

Source

pub fn set_frame(&mut self, frame: Rect)

Tell the layout how big its frame is. A face calls this; nothing else stores a size.

Source

pub const fn frame(&self) -> Rect

Source

pub const fn tree(&self) -> &Shikiri

The container tree, for a face that wants to solve against its own area rather than the last reported frame.

Source

pub fn solved(&self) -> Solved

Pane geometry, DERIVED. Never stored, so it cannot go stale.

Source

pub fn windows(&self) -> impl Iterator<Item = &Window>

Every window, in layout order.

Source

pub fn windows_mut(&mut self) -> Vec<&mut Window>

Every window, mutably. Used to push per-pane viewport sizes down.

Source

pub fn active_window(&self) -> Option<&Window>

Source

pub fn active_window_mut(&mut self) -> Option<&mut Window>

Source

pub fn count(&self) -> usize

Source

pub fn split_active(&mut self, axis: Axis) -> WindowId

Split the ACTIVE window along axis, showing the same buffer.

The new window is focused and returned. vim’s default is splitbelow/splitright OFF, so the NEW window goes above (:sp) or left (:vsp) — it becomes the FIRST child. Scroll position is copied, so both panes start showing the same thing, which is what makes :sp feel like “look at this file in two places” rather than a jump.

Source

pub fn close(&mut self, id: WindowId) -> bool

Close id, collapsing its parent. The LAST window never closes — vim refuses too (“E444: Cannot close last window”).

Source

pub fn neighbour(&self, dir: Dir) -> Option<WindowId>

The window nearest the active one in dir<C-w>hjkl.

Geometric, not tree-structural: it compares SOLVED rects, so the answer is what the operator sees rather than an artefact of which split happened first.

Trait Implementations§

Source§

impl Clone for Layout

Source§

fn clone(&self) -> Layout

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 Debug for Layout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Layout

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Layout

Source§

impl JsonSchema for Layout

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for Layout

Source§

fn eq(&self, other: &Layout) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for Layout

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Layout

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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