[−][src]Struct termimad::TextView
A scrollable text, in a specific area.
The text is assumed to have been computed for the given area.
For example:
use termimad::*; // You typically borrow those 3 vars from elsewhere let markdown = "#title\n* item 1\n* item 2"; let area = Area::new(0, 0, 10, 12); let skin = MadSkin::default(); // displaying let text = skin.area_text(markdown, &area); let view = TextView::from(&area, &text); view.write().unwrap();
If the text and skin are constant, you might prefer to use a MadView instead of a TextView: the MadView owns the mardkown string and ensures the formatted text is computed accordingly to the area.
Fields
scroll: i32
show_scrollbar: bool
Implementations
impl<'a, 't> TextView<'a, 't>
[src]
pub fn from(area: &'a Area, text: &'t FmtText<'_, '_>) -> TextView<'a, 't>
[src]
make a displayed text, that is a text in an area
pub fn content_height(&self) -> i32
[src]
pub fn scrollbar(&self) -> Option<(u16, u16)>
[src]
return an option which when filled contains a tupple with the top and bottom of the vertical scrollbar. Return none when the content fits the available space (or if show_scrollbar is false).
pub fn write(&self) -> Result<()>
[src]
display the text in the area, taking the scroll into account.
pub fn write_on<W>(&self, w: &mut W) -> Result<()> where
W: Write,
[src]
W: Write,
display the text in the area, taking the scroll into account.
pub fn set_scroll(&mut self, scroll: i32) -> i32
[src]
set the scroll position but makes it fit into allowed positions. Return the actual scroll.
pub fn try_scroll_lines(&mut self, lines_count: i32) -> i32
[src]
change the scroll position lines_count can be negative
pub fn try_scroll_pages(&mut self, pages_count: i32) -> i32
[src]
change the scroll position pages_count can be negative
Auto Trait Implementations
impl<'a, 't> RefUnwindSafe for TextView<'a, 't>
impl<'a, 't> Send for TextView<'a, 't>
impl<'a, 't> Sync for TextView<'a, 't>
impl<'a, 't> Unpin for TextView<'a, 't>
impl<'a, 't> UnwindSafe for TextView<'a, 't>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,