Struct Editor

pub struct Editor(/* private fields */);

A multi-line text editor.

Implementations

impl Editor

pub fn new() -> Editor

Creates a new empty Editor.

pub fn buffer(&self) -> &Buffer

Returns the buffer of the Editor.

pub fn downgrade(&self) -> Weak

Creates a Weak reference to the Editor.

This is useful to avoid cloning the Editor when referential guarantees are unnecessary. For instance, when creating a rendering tree.

Trait Implementations

impl Debug for Editor

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

Formats the value using the given formatter.

impl Default for Editor

fn default() -> Editor

Returns the “default value” for a type.

impl Editor for Editor

type Font = Font

The font of the Editor.

fn with_text(text: &str) -> Editor

Creates a new Editor laid out with the given text.

fn is_empty(&self) -> bool

Returns true if the Editor has no contents.

fn line(&self, index: usize) -> Option<&str>

Returns the text of the given line in the Editor, if it exists.

fn line_count(&self) -> usize

Returns the amount of lines in the Editor.

fn selection(&self) -> Option<String>

Returns the current selected text of the Editor.

fn cursor(&self) -> Cursor

Returns the current Cursor of the Editor.

fn cursor_position(&self) -> (usize, usize)

Returns the current cursor position of the Editor.

fn perform(&mut self, action: Action)

Performs an Action on the Editor.

fn bounds(&self) -> Size

Returns the current boundaries of the Editor.

fn min_bounds(&self) -> Size

Returns the minimum boundaries to fit the current contents of the Editor.

fn update( &mut self, new_bounds: Size, new_font: Font, new_size: Pixels, new_line_height: LineHeight, new_wrapping: Wrapping, new_highlighter: &mut impl Highlighter, )

Updates the Editor with some new attributes.

fn highlight<H>( &mut self, font: <Editor as Editor>::Font, highlighter: &mut H, format_highlight: impl Fn(&<H as Highlighter>::Highlight) -> Format<<Editor as Editor>::Font>, )

where H: Highlighter,

Runs a text Highlighter in the Editor.

impl PartialEq for Editor

fn eq(&self, other: &Editor) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Editor