Skip to main content

ScrollableText

Struct ScrollableText 

Source
pub struct ScrollableText {
    pub text: Text,
    pub style: Style,
    pub wrap: WrapMode,
    pub scroll: ScrollState,
    pub alignment: Alignment,
    pub selectable: bool,
    pub region_id: Option<WidgetId>,
    /* private fields */
}

Fields§

§text: Text§style: Style§wrap: WrapMode§scroll: ScrollState§alignment: Alignment§selectable: bool§region_id: Option<WidgetId>

Implementations§

Source§

impl ScrollableText

Source

pub fn new(text: Text) -> Self

Source

pub fn raw(content: &str) -> Self

Source

pub fn with_style(self, style: Style) -> Self

Source

pub fn with_theme_tokens(self, tokens: ThemeTokens) -> Self

Source

pub fn wrap(self, mode: WrapMode) -> Self

Source

pub fn with_scroll(self, scroll: ScrollState) -> Self

Source

pub fn alignment(self, alignment: Alignment) -> Self

Source

pub fn with_selectable(self, selectable: bool) -> Self

Source

pub fn with_region_id(self, id: impl Into<WidgetId>) -> Self

Source

pub fn set_text(&mut self, text: Text)

Source

pub fn push_line(&mut self, line: Line)

Source

pub fn invalidate(&self)

Source

pub fn rows_for_width(&self, width: u16) -> Vec<Line>

Source

pub fn with_rows_for_width<R>( &self, width: u16, f: impl FnOnce(&[Line]) -> R, ) -> R

Source

pub fn rendered_height(&self, width: u16) -> usize

Source

pub fn render_with_interaction( &self, buffer: &mut Buffer, area: Rect, layer: &mut InteractionLayer, )

Trait Implementations§

Source§

impl Clone for ScrollableText

Source§

fn clone(&self) -> ScrollableText

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ScrollableText

Source§

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

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

impl From<&str> for ScrollableText

Source§

fn from(value: &str) -> Self

Converts to this type from the input type.
Source§

impl From<Text> for ScrollableText

Source§

fn from(value: Text) -> Self

Converts to this type from the input type.
Source§

impl Widget for ScrollableText

Source§

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

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> ToOwned for T
where T: Clone,

Source§

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>,

Source§

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>,

Source§

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.