Struct md_tui::nodes::textcomponent::TextComponent

source ·
pub struct TextComponent { /* private fields */ }

Implementations§

source§

impl TextComponent

source

pub fn new(kind: TextNode, content: Vec<Word>) -> Self

source

pub fn new_formatted(kind: TextNode, content: Vec<Vec<Word>>) -> Self

source

pub fn kind(&self) -> TextNode

source

pub fn content(&self) -> &Vec<Vec<Word>>

source

pub fn content_as_lines(&self) -> Vec<String>

source

pub fn content_as_bytes(&self) -> Vec<u8>

source

pub fn content_owned(self) -> Vec<Vec<Word>>

source

pub fn meta_info(&self) -> &Vec<Word>

source

pub fn height(&self) -> u16

Examples found in repository?
examples/demo.rs (line 98)
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
    fn draw(&mut self, frame: &mut Frame) {
        self.area = frame.area();

        self.markdown = Some(parser::parse_markdown(
            None,
            &CONTENT.to_string(),
            self.area.width,
        ));

        if let Some(markdown) = &mut self.markdown {
            markdown.set_scroll(self.scroll);

            let area = Rect {
                width: self.area.width - 1,
                height: self.area.height - 1,
                x: 1,
                ..self.area
            };

            for child in markdown.children() {
                match child {
                    Component::TextComponent(comp) => {
                        if comp.y_offset().saturating_sub(comp.scroll_offset()) >= area.height
                            || (comp.y_offset() + comp.height())
                                .saturating_sub(comp.scroll_offset())
                                == 0
                        {
                            continue;
                        }

                        frame.render_widget(comp.clone(), area);
                    }
                    _ => {}
                }
            }
        }
    }
source

pub fn y_offset(&self) -> u16

Examples found in repository?
examples/demo.rs (line 97)
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
    fn draw(&mut self, frame: &mut Frame) {
        self.area = frame.area();

        self.markdown = Some(parser::parse_markdown(
            None,
            &CONTENT.to_string(),
            self.area.width,
        ));

        if let Some(markdown) = &mut self.markdown {
            markdown.set_scroll(self.scroll);

            let area = Rect {
                width: self.area.width - 1,
                height: self.area.height - 1,
                x: 1,
                ..self.area
            };

            for child in markdown.children() {
                match child {
                    Component::TextComponent(comp) => {
                        if comp.y_offset().saturating_sub(comp.scroll_offset()) >= area.height
                            || (comp.y_offset() + comp.height())
                                .saturating_sub(comp.scroll_offset())
                                == 0
                        {
                            continue;
                        }

                        frame.render_widget(comp.clone(), area);
                    }
                    _ => {}
                }
            }
        }
    }
source

pub fn scroll_offset(&self) -> u16

Examples found in repository?
examples/demo.rs (line 97)
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
    fn draw(&mut self, frame: &mut Frame) {
        self.area = frame.area();

        self.markdown = Some(parser::parse_markdown(
            None,
            &CONTENT.to_string(),
            self.area.width,
        ));

        if let Some(markdown) = &mut self.markdown {
            markdown.set_scroll(self.scroll);

            let area = Rect {
                width: self.area.width - 1,
                height: self.area.height - 1,
                x: 1,
                ..self.area
            };

            for child in markdown.children() {
                match child {
                    Component::TextComponent(comp) => {
                        if comp.y_offset().saturating_sub(comp.scroll_offset()) >= area.height
                            || (comp.y_offset() + comp.height())
                                .saturating_sub(comp.scroll_offset())
                                == 0
                        {
                            continue;
                        }

                        frame.render_widget(comp.clone(), area);
                    }
                    _ => {}
                }
            }
        }
    }
source

pub fn set_y_offset(&mut self, y_offset: u16)

source

pub fn set_scroll_offset(&mut self, offset: u16)

source

pub fn is_focused(&self) -> bool

source

pub fn deselect(&mut self)

source

pub fn visually_select(&mut self, index: usize) -> Result<(), String>

source

pub fn selected_heights(&self) -> Vec<usize>

source

pub fn words_mut(&mut self) -> Vec<&mut Word>

source

pub fn transform(&mut self, width: u16)

Trait Implementations§

source§

impl Clone for TextComponent

source§

fn clone(&self) -> TextComponent

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for TextComponent

source§

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

Formats the value using the given formatter. Read more
source§

impl From<TextComponent> for Component

source§

fn from(comp: TextComponent) -> Self

Converts to this type from the input type.
source§

impl Widget for TextComponent

source§

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.