Struct TextEditor

pub struct TextEditor<'a, Highlighter, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>>
where
    Highlighter: Highlighter,
    Theme: Catalog,
    Renderer: Renderer,
{ /* private fields */ }

A multi-line text input.

Example

use iced::widget::text_editor;

struct State {
   content: text_editor::Content,
}

#[derive(Debug, Clone)]
enum Message {
    Edit(text_editor::Action)
}

fn view(state: &State) -> Element<'_, Message> {
    text_editor(&state.content)
        .placeholder("Type something here...")
        .on_action(Message::Edit)
        .into()
}

fn update(state: &mut State, message: Message) {
    match message {
        Message::Edit(action) => {
            state.content.perform(action);
        }
    }
}

Implementations

impl<'a, Message, Theme, Renderer> TextEditor<'a, PlainText, Message, Theme, Renderer>

where Theme: Catalog, Renderer: Renderer,

pub fn new( content: &'a Content<Renderer>, ) -> TextEditor<'a, PlainText, Message, Theme, Renderer>

Creates new TextEditor with the given Content.

impl<'a, Highlighter, Message, Theme, Renderer> TextEditor<'a, Highlighter, Message, Theme, Renderer>

where Highlighter: Highlighter, Theme: Catalog, Renderer: Renderer,

pub fn placeholder( self, placeholder: impl IntoFragment<'a>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Sets the placeholder of the TextEditor.

pub fn height( self, height: impl Into<Length>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Sets the height of the TextEditor.

pub fn width( self, width: impl Into<Pixels>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Sets the width of the TextEditor.

pub fn on_action( self, on_edit: impl Fn(Action) -> Message + 'a, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Sets the message that should be produced when some action is performed in the TextEditor.

If this method is not called, the TextEditor will be disabled.

pub fn font( self, font: impl Into<<Renderer as Renderer>::Font>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Sets the Font of the TextEditor.

pub fn size( self, size: impl Into<Pixels>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Sets the text size of the TextEditor.

pub fn line_height( self, line_height: impl Into<LineHeight>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Sets the text::LineHeight of the TextEditor.

pub fn padding( self, padding: impl Into<Padding>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Sets the Padding of the TextEditor.

pub fn wrapping( self, wrapping: Wrapping, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Sets the Wrapping strategy of the TextEditor.

pub fn highlight( self, syntax: &str, theme: Theme, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

where Renderer: Renderer<Font = Font>,

Available on crate feature highlighter only.

Highlights the TextEditor using the given syntax and theme.

pub fn highlight_with<H>( self, settings: <H as Highlighter>::Settings, to_format: fn(_: &<H as Highlighter>::Highlight, _: &Theme) -> Format<<Renderer as Renderer>::Font>, ) -> TextEditor<'a, H, Message, Theme, Renderer>

where H: Highlighter,

Highlights the TextEditor with the given Highlighter and a strategy to turn its highlights into some text format.

pub fn key_binding( self, key_binding: impl Fn(KeyPress) -> Option<Binding<Message>> + 'a, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Sets the closure to produce key bindings on key presses.

See Binding for the list of available bindings.

pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme, Status) -> Style + 'a>>,

Sets the style of the TextEditor.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>

Available on crate feature advanced only.

Sets the style class of the TextEditor.

Trait Implementations

impl<'a, Highlighter, Message, Theme, Renderer> From<TextEditor<'a, Highlighter, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Highlighter: Highlighter, Message: 'a, Theme: Catalog + 'a, Renderer: Renderer,

fn from( text_editor: TextEditor<'a, Highlighter, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<Highlighter, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for TextEditor<'_, Highlighter, Message, Theme, Renderer>

where Highlighter: Highlighter, Theme: Catalog, Renderer: Renderer,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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

Returns the Size of the Widget in lengths.

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

Returns the layout::Node of the Widget.

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 draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, _defaults: &Style, layout: Layout<'_>, _cursor: Cursor, _viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

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

Returns the current mouse::Interaction of the Widget.

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

Applies an Operation to 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, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

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