Struct Editor 

pub struct Editor<'a, Message> { /* private fields */ }

The editor widget. Borrows the document to draw; publishes Actions.

Implementations

impl<'a, Message> Editor<'a, Message>

pub fn new( doc: &'a Document, on_action: impl Fn(Action) -> Message + 'a, ) -> Self

An editor rendering doc; on_action(action) is published for each input the widget interprets. Defaults to Font::MONOSPACE at 14 px.

pub fn popup(self, popup: Option<&'a PopupList>) -> Self

Supply the open completion popup to render over the editor. The app holds the completion controller and passes its PopupList here each frame; None when no popup is open.

pub fn snippet_active(self, active: bool) -> Self

Tell the editor a snippet session is active, so it captures Tab / Shift+Tab / Escape to drive it (the app owns the session).

pub fn signature(self, signature: Option<&'a SignatureInfo>) -> Self

Supply the active signature-help box to render above the caret.

pub fn hover(self, hover: Option<&'a HoverInfo>) -> Self

Supply the open hover popup to render at the hovered word.

pub fn id(self, id: impl Into<Id>) -> Self

Give the editor a widget Id so the application can move keyboard focus to it through iced’s focus operations (focus, focus_next, …) — the addressing half of the focus protocol a multi-pane host needs. Without an id the editor can be unfocused by a focus elsewhere but never targeted by one (a None id never matches).

pub fn font(self, font: Font) -> Self

Set the (monospace) font. The cell advance is re-measured for it.

pub fn text_size(self, size: f32) -> Self

Set the font size in logical pixels; the row height follows unless later overridden with Editor::line_height.

pub fn line_height(self, line_height: f32) -> Self

Override the row height in logical pixels.

Trait Implementations

impl<'a, Message: 'a> From<Editor<'a, Message>> for Element<'a, Message, Theme, Renderer>

fn from(editor: Editor<'a, Message>) -> Self

Converts to this type from the input type.

impl<Message> Widget<Message, Theme, Renderer<Renderer, Renderer>> for Editor<'_, Message>

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn operate( &mut self, tree: &mut Tree, layout: Layout<'_>, _renderer: &Renderer, operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout( &mut self, tree: &mut Tree, _renderer: &Renderer, limits: &Limits, ) -> Node

Returns the layout::Node of the Widget.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, _style: &Style, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn update( &mut self, tree: &mut Tree, event: &Event, layout: Layout<'_>, cursor: Cursor, _renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, )

Processes a runtime Event.

fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn diff(&self, tree: &mut Tree)

Reconciles the Widget with the provided Tree.

fn overlay<'a>( &'a mut self, _tree: &'a mut Tree, _layout: Layout<'a>, _renderer: &Renderer, _viewport: &Rectangle, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.