Struct druid::text::Editor

pub struct Editor<T> { /* fields omitted */ }

A component for widgets that offer text editing.

Editor manages an EditableText type, applying edits and maintaining selection state.

The type parameter T is the text data being edited.

Implementations

impl<T> Editor<T>

pub fn new() -> Self

Create a new Editor.

pub fn set_multiline(&mut self, multiline: bool)

Set whether the editor supports multi-line text. Default to false.

If this is false, inserted text will only insert up to the first included newline.

pub fn set_wrap_width(&mut self, width: f64)

Set an explicit wrap width for this editor.

By default the editor will not wrap lines; this is suitable for cases such as a a single-line text field, where the containing widget will scroll the editor as required.

pub fn layout(&self) -> &TextLayout<T>

Return a reference to the inner TextLayout object.

pub fn layout_mut(&mut self) -> &mut TextLayout<T>

Return a mutable reference to the inner TextLayout object.

impl<T: TextStorage + EditableText> Editor<T>

pub fn set_text(&mut self, text: T)

Set the text for this editor.

This must be set before the editor is used, such as in WidgetAdded.

pub fn selection(&self) -> &Selection

Return the current selection.

pub fn set_selection(&mut self, selection: Selection)

Set the current selection.

The selection will be constrained to the current text.

pub fn selection_rects(&self) -> Vec<Rect>

Returns the Rects representing the current selection.

pub fn cursor_line(&self) -> Line

Returns the Line to draw for the current cursor position.

pub fn click(&mut self, mouse: &MouseEvent, data: &mut T)

Handle a mouse click

pub fn drag(&mut self, mouse: &MouseEvent, data: &mut T)

Handle a mouse drag

pub fn copy(&self, data: &mut T)

Handle a copy command

pub fn cut(&mut self, data: &mut T)

Handle a cut command

pub fn paste(&mut self, t: String, data: &mut T)

Handle a paste command

pub fn select_all(&mut self, data: &T)

Set the selection to the entire buffer.

pub fn update(&mut self, ctx: &mut UpdateCtx<'_, '_>, new_data: &T, env: &Env)

Update the editor if the data or env has changed.

The widget owning this Editor must call this method during its own update call.

pub fn rebuild_if_needed(&mut self, factory: &mut PietText, env: &Env)

Must be called in WidgetAdded

pub fn do_edit(&mut self, edit: EditAction, data: &mut T)

Perform an EditAction.

pub fn draw(&self, ctx: &mut PaintCtx<'_, '_, '_>, point: impl Into<Point>)

Draw this editor at the provided point.

Trait Implementations

impl<T: Clone> Clone for Editor<T>

pub fn clone(&self) -> Editor<T>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Editor<T>

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

Formats the value using the given formatter.

impl<T> Default for Editor<T>

pub fn default() -> Self

Returns the "default value" for a type.