pub struct Screen { /* private fields */ }Expand description
Terminal screen state
Implementations§
Source§impl Screen
impl Screen
Sourcepub fn primary_grid(&self) -> &Grid
pub fn primary_grid(&self) -> &Grid
Get the primary grid (for rendering)
Sourcepub fn cursor_pos(&self) -> Pos
pub fn cursor_pos(&self) -> Pos
Get cursor position
Sourcepub fn cursor_visible(&self) -> bool
pub fn cursor_visible(&self) -> bool
Check if cursor is visible
Sourcepub fn scrollback(&self) -> usize
pub fn scrollback(&self) -> usize
Get current scrollback offset
Sourcepub fn set_scrollback(&mut self, offset: usize)
pub fn set_scrollback(&mut self, offset: usize)
Set scrollback offset
Sourcepub fn scroll_screen_up(&mut self, n: usize)
pub fn scroll_screen_up(&mut self, n: usize)
Scroll screen up (for user interaction)
Sourcepub fn scroll_screen_down(&mut self, n: usize)
pub fn scroll_screen_down(&mut self, n: usize)
Scroll screen down (for user interaction)
Sourcepub fn get_selected_text(
&self,
low_x: i32,
low_y: i32,
high_x: i32,
high_y: i32,
) -> String
pub fn get_selected_text( &self, low_x: i32, low_y: i32, high_x: i32, high_y: i32, ) -> String
Get selected text
Sourcepub fn handle_action(&mut self, action: Action)
pub fn handle_action(&mut self, action: Action)
Handle a termwiz action
Sourcepub fn visible_rows(&self) -> impl Iterator<Item = &Row>
pub fn visible_rows(&self) -> impl Iterator<Item = &Row>
Get visible rows iterator (for rendering)
Sourcepub fn is_alternate_screen(&self) -> bool
pub fn is_alternate_screen(&self) -> bool
Check if in alternate screen mode
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Screen
impl RefUnwindSafe for Screen
impl Send for Screen
impl Sync for Screen
impl Unpin for Screen
impl UnwindSafe for Screen
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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