Struct Window 

pub struct Window { /* private fields */ }

The main window behind the application. Represents the terminal window, allowing it to be used similar to a buffer, but has extra event handling.

let mut window = Window::init()?;
render!(window, (10, 10) => [ "Element Here!" ]);

Implementations

impl Window

pub fn new(io: Stdout) -> Result<Self>

Creates a new window from the given stdout. Please prefer to use init as it will do all of the terminal init stuff.

pub fn new_inline(io: Stdout, height: u16) -> Result<Self>

Creates a new window built for inline using the given Stdout and height.

pub fn init_inline(height: u16) -> Result<Self>

Initializes a window that is prepared for inline rendering. Height is the number of columns that your terminal will need.

pub fn init() -> Result<Self>

Initializes the window, and returns a new Window for your use.

pub fn keyboard(&mut self) -> Result<()>

Enables the kitty keyboard protocol

pub fn buffer(&self) -> &Buffer

Returns the active Buffer, as a reference.

pub fn buffer_mut(&mut self) -> &mut Buffer

Returns the active Buffer, as a mutable reference.

pub fn swap_buffers(&mut self)

Swaps the buffers, clearing the old buffer. Used automatically by the window’s update method.

pub fn size(&self) -> Vec2

Returns the current known size of the buffer’s window.

pub fn restore(&mut self) -> Result<()>

Restores the window to it’s previous state from before the window’s init method. If the window is inline, restore the inline render

pub fn render(&mut self) -> Result<()>

Renders the window to the screen. should really only be used by the update method, but if you need a custom system, you can use this.

pub fn update(&mut self, poll: Duration) -> Result<()>

Handles events, and renders the screen.

pub fn render_cursor(&mut self) -> Result<()>

pub fn handle_event(&mut self, poll: Duration) -> Result<()>

Handles events. Used automatically by the update method, so no need to use it unless update is being used.

pub fn cursor_visible(&self) -> bool

Returns whether the cursor is visible

pub fn cursor(&self) -> Vec2

Returns the current cursor position

pub fn cursor_style(&self) -> SetCursorStyle

Returns the current cursor style

pub fn set_cursor_visible(&mut self, visible: bool)

Sets the cursor visibility

pub fn set_cursor(&mut self, pos: Vec2)

Sets the cursor position, clamping to window bounds

pub fn set_cursor_style(&mut self, style: SetCursorStyle)

Sets the cursor style

pub fn move_cursor(&mut self, x: i16, y: i16)

Move the cursor by a given distance

pub fn mouse_pos(&self) -> Vec2

pub fn insert_event(&mut self, event: Event)

Pushes an event into the state Could be usefull with a custom event loop or for keyboard control from elsewhere

pub fn events(&self) -> &Vec<Event>

Returns the current event for the frame, as a reference.

pub fn hover<V: Into<Vec2>>(&self, loc: V, size: V) -> Result<bool>

Returns true if the mouse cursor is hovering the given rect.

pub fn io(&mut self) -> &mut Stdout

Trait Implementations

impl AsMut<Buffer> for Window

fn as_mut(&mut self) -> &mut Buffer

Converts this type into a mutable reference of the (usually inferred) input type.

impl Default for Window

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Window

fn drop(&mut self)

Executes the destructor for this type.