Skip to main content

Scroll

Struct Scroll 

Source
pub struct Scroll {
    pub rows: u32,
    pub fixed_top: u32,
    pub fixed_bottom: u32,
}
Expand description

A cells surface taller than where it shows (set_scroll): the viewer scrolls the rows between the fixed ones with its own motion.

Fields§

§rows: u32

The rows the plugin paints (at most Scroll::MAX_ROWS): the surface’s height while it is at least as tall as where it shows.

§fixed_top: u32

Rows at the top that stay in place: a title or a toolbar.

§fixed_bottom: u32

Rows at the bottom that stay in place, at the bottom of where the surface shows: a status line or key hints.

Implementations§

Source§

impl Scroll

Source

pub const MAX_ROWS: u32 = 4096

The most rows a scrolling surface paints.

Source

pub const fn rows(rows: u32) -> Self

rows rows that all scroll.

Examples found in repository?
examples/graphics_chart.rs (line 121)
118    fn activate(_cx: &mut Context) -> Self {
119        let pane = Surface::new("usage");
120        let _ = pane.set_scroll(Some(
121            Scroll::rows(TITLE_ROWS + SERVICES * SERVICE_ROWS).fixed(TITLE_ROWS, 0),
122        ));
123        let mut usage = Self { pane };
124        usage.paint();
125        usage
126    }
More examples
Hide additional examples
examples/scroll_list.rs (line 91)
87    fn activate(_cx: &mut Context) -> Self {
88        let list = Surface::new("list");
89        // Call it again when the content's height changes. It stays in force.
90        let _ = list.set_scroll(Some(
91            Scroll::rows(TITLE_ROWS + ITEMS + HINT_ROWS).fixed(TITLE_ROWS, HINT_ROWS),
92        ));
93        Self {
94            list,
95            selected: 0,
96            dirty: true,
97        }
98    }
Source

pub const fn fixed(self, top: u32, bottom: u32) -> Self

The same rows with top rows fixed above and bottom rows fixed below the scrolling ones.

Examples found in repository?
examples/graphics_chart.rs (line 121)
118    fn activate(_cx: &mut Context) -> Self {
119        let pane = Surface::new("usage");
120        let _ = pane.set_scroll(Some(
121            Scroll::rows(TITLE_ROWS + SERVICES * SERVICE_ROWS).fixed(TITLE_ROWS, 0),
122        ));
123        let mut usage = Self { pane };
124        usage.paint();
125        usage
126    }
More examples
Hide additional examples
examples/scroll_list.rs (line 91)
87    fn activate(_cx: &mut Context) -> Self {
88        let list = Surface::new("list");
89        // Call it again when the content's height changes. It stays in force.
90        let _ = list.set_scroll(Some(
91            Scroll::rows(TITLE_ROWS + ITEMS + HINT_ROWS).fixed(TITLE_ROWS, HINT_ROWS),
92        ));
93        Self {
94            list,
95            selected: 0,
96            dirty: true,
97        }
98    }

Trait Implementations§

Source§

impl Clone for Scroll

Source§

fn clone(&self) -> Self

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 Copy for Scroll

Source§

impl Debug for Scroll

Source§

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

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

impl Default for Scroll

Source§

fn default() -> Self

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

impl Eq for Scroll

Source§

impl PartialEq for Scroll

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Scroll

Auto Trait Implementations§

§

impl Forget for Scroll

§

impl Freeze for Scroll

§

impl Move for Scroll

§

impl RefUnwindSafe for Scroll

§

impl Send for Scroll

§

impl Sync for Scroll

§

impl Unpin for Scroll

§

impl UnsafeUnpin for Scroll

§

impl UnwindSafe for Scroll

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> Resource for T
where T: 'static,

Source§

type Rep = Option<T>

The type which is actually stored in-memory for this resource. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.