Struct MarkupView

pub struct MarkupView<R: Renderer + 'static> { /* private fields */ }

A view for hypertext that has been rendered by a Renderer.

This view displays hypertext (a combination of formatted text and links) that typically has been parsed from a markup language. You can use the arrow keys to navigate between the links, and the Enter key to select a link. If the focused link is changed, the on_link_focus callback is triggered. If the focused link is selected using the Enter key, the on_link_select callback is triggered.

The displayed hypertext is created by a Renderer implementation. The MarkupView calls the render method with the size constraint provided by cursive and receives a RenderedDocument that contains the text and the links. This document is cached until the available width changes.

You can also limit the available width by setting a maximum line width with the set_maximum_width method.

Implementations

impl MarkupView<RichRenderer>

pub fn html(html: &str) -> MarkupView<RichRenderer>

Creates a new MarkupView that uses a rich text HTML renderer.

Requires the html feature (enabled per default).

impl<R: Renderer + 'static> MarkupView<R>

pub fn with_renderer(renderer: R) -> MarkupView<R>

Creates a new MarkupView with the given renderer.

pub fn on_link_focus<F: Fn(&mut Cursive, &str) + 'static>(&mut self, f: F)

Sets the callback that is triggered if the link focus is changed.

Note that this callback is only triggered if the link focus is changed with the arrow keys. It is not triggered if the view takes focus. The callback will receive the target of the link as an argument.

pub fn on_link_select<F: Fn(&mut Cursive, &str) + 'static>(&mut self, f: F)

Sets the callback that is triggered if a link is selected.

This callback is triggered if a link is focused and the users presses the Enter key. The callback will receive the target of the link as an argument.

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

Sets the maximum width of the view.

This means that the width that is available for the renderer is limited to the given value.

Trait Implementations

impl<R: Renderer + 'static> View for MarkupView<R>

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

fn layout(&mut self, constraint: XY<usize>)

Called once the size for this view has been decided.

fn required_size(&mut self, constraint: XY<usize>) -> XY<usize>

Returns the minimum size the view requires with the given restrictions.

fn take_focus( &mut self, direction: Direction, ) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

fn on_event(&mut self, event: Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn important_area(&self, _: XY<usize>) -> Rect

What part of the view is important and should be visible?

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn call_on_any( &mut self, _: &Selector<'_>, _: &mut dyn FnMut(&mut (dyn View + 'static)), )

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, _: &Selector<'_>) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector.

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

Returns the type of this view.