Struct ScrollViewer 

pub struct ScrollViewer { /* private fields */ }

Scrolling container which manages the internal content’s scrolling

Design (optional Border):

┌─────────┐
│Child1  ▲│
│Child2  ┃│
│Child3   │
│Child4   │
│Child5  ▼│
│◀━     ▶ │
└─────────┘

Implementations

impl ScrollViewer

pub const ARROW_UP: Grapheme

pub const ARROW_UP_DISABLED: Grapheme

pub const BAR_MARKER_V: Grapheme

pub const ARROW_DOWN: Grapheme

pub const ARROW_DOWN_DISABLED: Grapheme

pub const ARROW_LEFT: Grapheme

pub const ARROW_LEFT_DISABLED: Grapheme

pub const BAR_MARKER_H: Grapheme

pub const ARROW_RIGHT: Grapheme

pub const ARROW_RIGHT_DISABLED: Grapheme

pub fn set_content( rc: &Rc<RefCell<Self>>, content: Option<&Rc<RefCell<dyn Scrollable>>>, )

Examples found in repository

examples/scrollviewer.rs (lines 74-77)

	fn default() -> Self {
		let values = [
			"Tomatoes",
			"Tofu",
			"Flatbread",
			"Olive oil",
			"Salt",
			"Oregano",
			"Butter",
		];

		let scrollviewer = WindowFactory::create::<ScrollViewer>();
		scrollviewer
			.borrow_mut()
			.set_border(BorderStyle::new(BorderKind::Solid, None, None));
		let stackpanel = WindowFactory::create::<Stackpanel>();
		for v in values {
			let cbx = WindowFactory::create::<TextCheckbox>();
			cbx.borrow_mut().set_text(v);
			stackpanel.borrow_mut().add_item(cbx);
		}
		ScrollViewer::set_content(
			&scrollviewer,
			Some(&(stackpanel as Rc<RefCell<dyn Scrollable>>)),
		);

		Self {
			uid: WindowUID::new(),
			scrollviewer,
			running: true,
		}
	}

pub fn set_scrollbar_visibility(&mut self, show: bool)

pub fn is_scrollable(&self, axis: Orientation) -> bool

Can current Scrollable be scrolled horizontally / vertically

pub fn scroll(&mut self, direction: Direction, kind: ScrollKind)

Scrolls page/line-wise (see ScrollKind) in the given direction

pub fn set_offset(&mut self, direction: Orientation, offset: usize)

Sets the horizontal / vertical offset

pub fn offset(&self, axis: Orientation) -> usize

Horizontal / Vertical offset of the scrolled content

pub fn viewport(&self, axis: Orientation) -> usize

Horizontal / Vertical size of the viewport for current Scrollable

Trait Implementations

impl Default for ScrollViewer

fn default() -> ScrollViewer

Returns the “default value” for a type.

impl HasWindowUID for ScrollViewer

fn uid(&self) -> WindowUID

Must be static and unique for each object implementing Window. Generate once per instance using WindowUID::new.

impl Widget for ScrollViewer

fn set_visibility(&mut self, visibility: bool)

fn set_width(&mut self, width: Size)

fn set_height(&mut self, height: Size)

fn set_margin(&mut self, margin: Thickness)

fn set_border(&mut self, border: BorderStyle)

fn set_alignment( &mut self, horizontal: HorizontalAlignment, vertical: VerticalAlignment, )

fn set_enabled_state(&mut self, is_enabled: bool)

Changing the IsEnabled state usually changes the highlight color

fn set_width_constraint(&mut self, width: SizeConstraint)

fn set_height_constraint(&mut self, height: SizeConstraint)

impl WidgetColors for ScrollViewer

fn set_disabled_color(&mut self, color: Option<Color>)

fn set_base_fg_color(&mut self, color: Option<Color>)

fn set_base_bg_color(&mut self, color: Option<Color>)

impl Window for ScrollViewer

fn render(&self, canvas: &mut Canvas)

Allows self to draw into its own Canvas The canvas size depends on other properties set and the terminal size itself It is guarenteed that the size of the Canvas is atleast 1x1

fn handle_event(&mut self, event: &mut WindowEvent)

The events are forwarded from crossterm with the only exception of Resize which will have the same dimensions as the resulting canvas If a event’s handled attributed is set to true it will stop bubbling otherwise it will keep bubbling until another Window marks it as handled Except for:

fn children(&mut self, builder: SubWindowBuilder) -> SubWindows

Returns all children windows (and layouting Rects) Note: When changing the children make sure to also adjust the focus

fn focus(&self) -> Option<WindowRef>

Which child of the window has focus Is there is None, then ´self´ has focus

fn is_enabled(&self) -> bool

Is self enabled? Indicated whether or not to handle input and if its focusable When false, Window is still eligible to receive events

impl WindowLayout for ScrollViewer

fn desired_size(&self, available_size: TPoint) -> TPoint

Parents call this to get the desired size of the child This must not exceed available_size on any axis When the result’s product is equal to 0, this window wont be drawn

fn alignment(&self) -> (HorizontalAlignment, VerticalAlignment)

Aligns self within its parent Window

fn border(&self) -> BorderStyle

fn is_visible(&self) -> bool

fn margin(&self) -> Thickness

fn desired_size_pre_hook(&mut self, available_size: TPoint)

This is similar to desired_size but will not return anything and can mutably change self This is executed before WindowLayout::desired_size Only implement if actually necessary