Struct CodeView 

pub struct CodeView<Msg> { /* private fields */ }

Code with syntax colours, line numbers and wrapping of long lines.

While focused, c copies the code to the clipboard and flashes. The code is a text selection region: a mouse drag selects inside it (turn it off with NodeMut::selectable), and clean copies leave out the line numbers and the signs of marked lines.

For reviews, line_marks shows a diff and highlight_lines tints lines to look at; either adds a sign column at the left edge. reveal scrolls the enclosing ScrollView to a line.

Style keys: code (bg, padding) with focus and pressed; code-line-number; code-token.<kind> where kind is keyword, type, function, macro, string, number, comment, attribute, lifetime, punctuation, table, key, variable or plain; code-line.<look> (bg for the line, fg for its sign) where look is added, removed, accent or warning. Icons: line-added, line-removed, warning and the pillar.

Implementations

impl<Msg: 'static> CodeView<Msg>

pub fn new(code: impl Into<String>, language: Language) -> Self

Shows code in language.

pub fn line_marks(self, marks: impl IntoIterator<Item = LineMark>) -> Self

Marks lines as a diff: the first mark belongs to line 1, the next to line 2, and lines past the last mark are unchanged. Added lines are tinted with the success colour and signed +, removed ones with the danger colour and −, in the sign column at the left edge.

pub fn highlight_lines( self, lines: impl RangeBounds<usize>, tone: LineTone, ) -> Self

Tints lines (counted from 1, like the line numbers) in tone, over any diff mark, and puts the tone’s sign in the sign column. Call it again for more lines; where ranges meet, the later call wins. The tint is separate from a text selection, which draws over it.

pub fn reveal(self, line: usize) -> Self

Scrolls the enclosing ScrollView just enough to show line (counted from 1; past the end, the last line) with two rows of context, gliding there unless motion is reduced. It happens when the revealed line changes, so the user can scroll away afterwards; outside a scroll view it does nothing.

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

Shows or hides line numbers; shown by default.

pub fn on_copy(self, message: Msg) -> Self

Message sent after the code was copied with c.

Trait Implementations

impl<Msg: Clone + 'static> Widget<Msg> for CodeView<Msg>

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.