Skip to main content

TextView

Struct TextView 

Source
pub struct TextView { /* private fields */ }
Expand description

A scrollable, wrapped view over a text buffer.

Implementations§

Source§

impl TextView

Source

pub fn new(text: impl Into<Rope>, width: usize, wrap: WrapMode) -> Self

Build a view from raw text, wrap mode, and viewport width.

Source

pub fn set_text(&mut self, text: impl Into<Rope>)

Replace the text and recompute layout.

Source

pub fn set_wrap(&mut self, wrap: WrapMode)

Update wrap mode and recompute layout.

Source

pub fn set_width(&mut self, width: usize)

Update viewport width and recompute layout.

Source

pub const fn wrap_mode(&self) -> WrapMode

Current wrap mode.

Source

pub const fn width(&self) -> usize

Current viewport width used for wrapping.

Source

pub const fn source_line_count(&self) -> usize

Number of logical (source) lines in the text.

Source

pub fn virtual_line_count(&self) -> usize

Number of virtual (wrapped) lines.

Source

pub const fn max_width(&self) -> usize

Maximum display width across all virtual lines.

Source

pub fn lines(&self) -> &[ViewLine]

Access all virtual lines.

Source

pub fn source_to_virtual(&self, source_line: usize) -> Option<usize>

Map a source line index to its first virtual line index.

Source

pub fn virtual_to_source(&self, virtual_line: usize) -> Option<usize>

Map a virtual line index to its source line index.

Source

pub fn clamp_scroll(&self, scroll_y: usize, viewport_height: usize) -> usize

Clamp scroll position to a valid range for the given viewport height.

Source

pub fn max_scroll(&self, viewport_height: usize) -> usize

Maximum scroll offset for the given viewport height.

Source

pub fn visible_range( &self, scroll_y: usize, viewport_height: usize, ) -> Range<usize>

Compute the visible virtual line range for a scroll offset + viewport height.

Source

pub fn visible_lines( &self, scroll_y: usize, viewport_height: usize, ) -> &[ViewLine]

Get the visible virtual lines for a scroll offset + viewport height.

Source

pub fn scroll_to_line( &self, source_line: usize, viewport_height: usize, ) -> Option<usize>

Scroll so the given source line is at the top of the viewport. Returns None if the source line doesn’t exist.

Source

pub fn scroll_to_top(&self) -> usize

Scroll to the top of the view.

Source

pub fn scroll_to_bottom(&self, viewport_height: usize) -> usize

Scroll to the bottom of the view.

Source

pub fn scroll_by_lines( &self, scroll_y: usize, delta: isize, viewport_height: usize, ) -> usize

Scroll by a line delta (positive or negative).

Source

pub fn scroll_by_pages( &self, scroll_y: usize, pages: isize, viewport_height: usize, ) -> usize

Scroll by a page delta (positive or negative).

Trait Implementations§

Source§

impl Clone for TextView

Source§

fn clone(&self) -> TextView

Returns a duplicate 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 TextView

Source§

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

Formats the value using the given formatter. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more