Struct WindowConfigBuilder

pub struct WindowConfigBuilder(/* private fields */);

Implementations

impl WindowConfigBuilder

pub fn anchor(&mut self, anchor: WindowAnchor) -> &mut Self

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

pub fn border(&mut self, border: WindowBorder) -> &mut Self

Style of the optional window border.

pub fn bufpos(&mut self, line: usize, column: usize) -> &mut Self

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.

pub fn col(&mut self, col: impl Into<Float>) -> &mut Self

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

pub fn external(&mut self, external: bool) -> &mut Self

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

pub fn fixed(&mut self, fixed: bool) -> &mut Self

pub fn focusable(&mut self, focusable: bool) -> &mut Self

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

pub fn footer(&mut self, footer: WindowTitle) -> &mut Self

pub fn footer_pos(&mut self, footer_pos: WindowTitlePosition) -> &mut Self

pub fn hide(&mut self, hide: bool) -> &mut Self

pub fn height(&mut self, height: u32) -> &mut Self

Window height in character cells. Minimum of 1.

pub fn noautocmd(&mut self, noautocmd: bool) -> &mut Self

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

pub fn relative(&mut self, relative: WindowRelativeTo) -> &mut Self

Sets the window layout to floating Decides what the window is positioned relatively to.

pub fn split(&mut self, direction: SplitDirection) -> &mut Self

Configures where a split window is opened.

pub fn vertical(&mut self, vertical: bool) -> &mut Self

Should the split window be opened as vertical.

pub fn row(&mut self, row: impl Into<Float>) -> &mut Self

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

pub fn style(&mut self, style: WindowStyle) -> &mut Self

Configures the appearance of the window.

pub fn width(&mut self, width: u32) -> &mut Self

Window width in character cells. Minimum of 1.

pub fn zindex(&mut self, zindex: u32) -> &mut Self

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

pub fn title(&mut self, title: WindowTitle) -> &mut Self

pub fn title_pos(&mut self, title_pos: WindowTitlePosition) -> &mut Self

pub fn build(&mut self) -> WindowConfig

Trait Implementations

impl Clone for WindowConfigBuilder

fn clone(&self) -> WindowConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for WindowConfigBuilder

fn default() -> WindowConfigBuilder

Returns the “default value” for a type.