Struct unsegen_pager::Pager

pub struct Pager<L, D = NoDecorator<L>> where
    L: PagerLine,
    D: LineDecorator,  { /* fields omitted */ }

Main Widget, may (or may not) store content, but defines static types for content and decoration.

Use load to actually fill the widget with content.

In addition to the PagerContent, it has a concept of an 'active line' that can be updated via user interaction (using the Scrollable implementation) and is always displayed when drawn to a window.

Methods

impl<L, D> Pager<L, D> where
    L: PagerLine,
    D: LineDecorator<Line = L>, 

pub fn new() -> Self

Create an empty pager, with no current content.

pub fn load(&mut self, content: PagerContent<L, D>)

Load (and potentially overwrite previous) content to display in the pager.

If possible, the current line position will be preserved.

pub fn clear_content(&mut self)

Clear the current content.

On subsequent draw calls, nothing will be written to the window.

pub fn content(&self) -> Option<&PagerContent<L, D>>

Get a reference to the current content, if available.

pub fn content_mut(&mut self) -> Option<&mut PagerContent<L, D>>

Get a mutable reference to the current content, if available.

Note that PagerContent does not allow mutable access to the stored lines, so it is required to use load to update the contents. A pager is not a text editor.

pub fn go_to_line<I: Into<LineIndex>>(
    &mut self,
    line: I
) -> Result<(), PagerError>

Go to the specified line, if present.

If there is no such line, an error is returned.

pub fn go_to_line_if<F: Fn(LineIndex, &L) -> bool>(
    &mut self,
    predicate: F
) -> Result<(), PagerError>

Go to first line that matches the given predicate.

If there is no such line, an error is returned.

pub fn current_line_index(&self) -> LineIndex

Get the index of the currently active line.

pub fn current_line(&self) -> Option<&L>

Get a reference to the currently active line.

Trait Implementations

impl<L, D> Default for Pager<L, D> where
    L: PagerLine,
    D: LineDecorator<Line = L>, 

fn default() -> Self

Returns the "default value" for a type.

impl<L, D> Widget for Pager<L, D> where
    L: PagerLine,
    D: LineDecorator<Line = L>, 

fn space_demand(&self) -> Demand2D

Return the current demand for (rectangular) screen estate.

fn draw(&self, window: Window, _: RenderingHints)

Draw the widget to the given window.

impl<L, D> Scrollable for Pager<L, D> where
    L: PagerLine,
    D: LineDecorator<Line = L>, 

fn scroll_backwards(&mut self) -> OperationResult

fn scroll_forwards(&mut self) -> OperationResult

fn scroll_to_beginning(&mut self) -> OperationResult

fn scroll_to_end(&mut self) -> OperationResult