ScrollView

Struct ScrollView 

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

A scrollable view widget

Implementations§

Source§

impl ScrollView

Source

pub fn new() -> Self

Create a new scroll view

Source

pub fn content_height(self, height: u16) -> Self

Set the total content height

Source

pub fn scroll_offset(self, offset: u16) -> Self

Set the scroll offset

Source

pub fn show_scrollbar(self, show: bool) -> Self

Enable/disable scrollbar

Source

pub fn scrollbar_style(self, fg: Color, bg: Color) -> Self

Set scrollbar colors

Source

pub fn offset(&self) -> u16

Get current scroll offset

Source

pub fn set_offset(&mut self, offset: u16, viewport_height: u16)

Set scroll offset with bounds checking

Source

pub fn scroll_down(&mut self, lines: u16, viewport_height: u16)

Scroll down by lines

Source

pub fn scroll_up(&mut self, lines: u16)

Scroll up by lines

Source

pub fn scroll_to_top(&mut self)

Scroll to top

Source

pub fn scroll_to_bottom(&mut self, viewport_height: u16)

Scroll to bottom

Source

pub fn page_down(&mut self, viewport_height: u16)

Page down

Source

pub fn page_up(&mut self, viewport_height: u16)

Page up

Source

pub fn handle_key(&mut self, key: &Key, viewport_height: u16) -> bool

Handle key input, returns true if scroll changed

Source

pub fn is_scrollable(&self, viewport_height: u16) -> bool

Check if content is scrollable

Source

pub fn scroll_percentage(&self, viewport_height: u16) -> f32

Get scroll percentage (0.0 - 1.0)

Source

pub fn render_scrollbar(&self, ctx: &mut RenderContext<'_>)

Render scrollbar

Source

pub fn content_area(&self, area: Rect) -> Rect

Get the visible area for content (excludes scrollbar)

Source

pub fn create_content_buffer(&self, width: u16) -> Buffer

Create a clipped buffer for scrolled content

Source

pub fn render_content( &self, ctx: &mut RenderContext<'_>, content_buffer: &Buffer, )

Render scrolled content from a pre-rendered buffer

Source§

impl ScrollView

Source

pub fn element_id(self, id: impl Into<String>) -> Self

Set element ID for CSS selector (#id)

Source

pub fn class(self, class: impl Into<String>) -> Self

Add a CSS class

Source

pub fn classes<I, S>(self, classes: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Add multiple CSS classes

Trait Implementations§

Source§

impl Default for ScrollView

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl StyledView for ScrollView

Source§

fn set_id(&mut self, id: impl Into<String>)

Set element ID
Source§

fn add_class(&mut self, class: impl Into<String>)

Add a CSS class
Source§

fn remove_class(&mut self, class: &str)

Remove a CSS class
Source§

fn toggle_class(&mut self, class: &str)

Toggle a CSS class
Source§

fn has_class(&self, class: &str) -> bool

Check if has class
Source§

impl View for ScrollView

Source§

fn id(&self) -> Option<&str>

Get element ID (for CSS #id selectors)
Source§

fn classes(&self) -> &[String]

Get CSS classes (for CSS .class selectors)
Source§

fn meta(&self) -> WidgetMeta

Get widget metadata for DOM
Source§

fn render(&self, ctx: &mut RenderContext<'_>)

Render the view
Source§

fn widget_type(&self) -> &'static str

Get widget type name (for CSS type selectors)
Source§

fn children(&self) -> &[Box<dyn View>]

Get child views (for container widgets) 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> 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> 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.
Source§

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<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
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