Struct WindowConfig

#[non_exhaustive]
pub struct WindowConfig {

    pub anchor: Option<WindowAnchor>,
    pub border: Option<WindowBorder>,
    pub bufpos: Option<(usize, usize)>,
    pub col: Option<Float>,
    pub external: Option<bool>,
    pub fixed: Option<bool>,
    pub focusable: Option<bool>,
    pub footer: Option<WindowTitle>,
    pub footer_pos: Option<WindowTitlePosition>,
    pub height: Option<u32>,
    pub hide: Option<bool>,
    pub noautocmd: Option<bool>,
    pub relative: Option<WindowRelativeTo>,
    pub row: Option<Float>,
    pub split: Option<SplitDirection>,
    pub style: Option<WindowStyle>,
    pub title: Option<WindowTitle>,
    pub title_pos: Option<WindowTitlePosition>,
    pub vertical: Option<bool>,
    pub width: Option<u32>,
    pub win: Option<Window>,
    pub zindex: Option<u32>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

anchor: Option<WindowAnchor>

Decides which corner of the window to place at (row, col).

border: Option<WindowBorder>

Style of the optional window border.

bufpos: Option<(usize, usize)>

Places window relative to buffer text (only when relative is set to WindowRelativeTo::Window(win)). Takes a zero indexed (line, column) tuple, with row and col being placed relative to this position if specified.

col: Option<Float>

Column position in units of screen cell width. May be fractional

external: Option<bool>

Whether an attached GUI should display the window as an external top-level window.

fixed: Option<bool>

focusable: Option<bool>

Enable focus by user actions like mouse events. Non-focusable windows can be entered by set_current_win.

footer: Option<WindowTitle>

footer_pos: Option<WindowTitlePosition>

height: Option<u32>

Window height in character cells. Minimum of 1.

hide: Option<bool>

noautocmd: Option<bool>

If true then no buffer-related autocommand events such as BufEnter or BufLeave are fired when calling open_win.

relative: Option<WindowRelativeTo>

What the window is positioned relative to.

row: Option<Float>

Row position in units of screen cell height. May be fractional.

split: Option<SplitDirection>

style: Option<WindowStyle>

Configures the appearance of the window.

title: Option<WindowTitle>

title_pos: Option<WindowTitlePosition>

vertical: Option<bool>

width: Option<u32>

Window width in character cells. Minimum of 1.

win: Option<Window>

For relative positioned windows, the Window that the window is positioned relative to.

zindex: Option<u32>

Stacking order. Windows with higher zindex go in front of windows with lower indices.

Implementations

impl WindowConfig

pub fn builder() -> WindowConfigBuilder

Creates a new WinConfigBuilder.

Trait Implementations

impl Clone for WindowConfig

fn clone(&self) -> WindowConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowConfig

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

Formats the value using the given formatter.

impl Default for WindowConfig

fn default() -> WindowConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WindowConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromObject for WindowConfig

fn from_object(obj: Object) -> Result<Self, Error>

impl PartialEq for WindowConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WindowConfig