Struct cosmic::iced_widget::text_editor::TextEditor
source · pub struct TextEditor<'a, Highlighter, Message, Theme = Theme, Renderer = Renderer>{ /* private fields */ }
Expand description
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§
source§impl<'a, Message, Theme, Renderer> TextEditor<'a, PlainText, Message, Theme, Renderer>
impl<'a, Message, Theme, Renderer> TextEditor<'a, PlainText, Message, Theme, Renderer>
sourcepub fn new(
content: &'a Content<Renderer>,
) -> TextEditor<'a, PlainText, Message, Theme, Renderer>
pub fn new( content: &'a Content<Renderer>, ) -> TextEditor<'a, PlainText, Message, Theme, Renderer>
Creates new TextEditor
with the given Content
.
source§impl<'a, Highlighter, Message, Theme, Renderer> TextEditor<'a, Highlighter, Message, Theme, Renderer>
impl<'a, Highlighter, Message, Theme, Renderer> TextEditor<'a, Highlighter, Message, Theme, Renderer>
sourcepub fn placeholder(
self,
placeholder: impl IntoFragment<'a>,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
pub fn placeholder( self, placeholder: impl IntoFragment<'a>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
Sets the placeholder of the TextEditor
.
sourcepub fn height(
self,
height: impl Into<Length>,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
pub fn height( self, height: impl Into<Length>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
Sets the height of the TextEditor
.
sourcepub fn width(
self,
width: impl Into<Pixels>,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
pub fn width( self, width: impl Into<Pixels>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
Sets the width of the TextEditor
.
sourcepub fn on_action(
self,
on_edit: impl Fn(Action) -> Message + 'a,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
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.
sourcepub fn font(
self,
font: impl Into<<Renderer as Renderer>::Font>,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
pub fn font( self, font: impl Into<<Renderer as Renderer>::Font>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
Sets the Font
of the TextEditor
.
sourcepub fn size(
self,
size: impl Into<Pixels>,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
pub fn size( self, size: impl Into<Pixels>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
Sets the text size of the TextEditor
.
sourcepub fn line_height(
self,
line_height: impl Into<LineHeight>,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
pub fn line_height( self, line_height: impl Into<LineHeight>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
Sets the text::LineHeight
of the TextEditor
.
sourcepub fn padding(
self,
padding: impl Into<Padding>,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
pub fn padding( self, padding: impl Into<Padding>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
Sets the Padding
of the TextEditor
.
sourcepub fn wrapping(
self,
wrapping: Wrapping,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
pub fn wrapping( self, wrapping: Wrapping, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
Sets the Wrapping
strategy of the TextEditor
.
sourcepub 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,
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.
sourcepub fn key_binding(
self,
key_binding: impl Fn(KeyPress) -> Option<Binding<Message>> + 'a,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
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.
sourcepub fn style(
self,
style: impl Fn(&Theme, Status) -> Style + 'a,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
Sets the style of the TextEditor
.
sourcepub fn class(
self,
class: impl Into<<Theme as Catalog>::Class<'a>>,
) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> TextEditor<'a, Highlighter, Message, Theme, Renderer>
Sets the style class of the TextEditor
.
Trait Implementations§
source§impl<'a, Highlighter, Message, Theme, Renderer> From<TextEditor<'a, Highlighter, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>
impl<'a, Highlighter, Message, Theme, Renderer> From<TextEditor<'a, Highlighter, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>
source§fn from(
text_editor: TextEditor<'a, Highlighter, Message, Theme, Renderer>,
) -> Element<'a, Message, Theme, Renderer>
fn from( text_editor: TextEditor<'a, Highlighter, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>
source§impl<'a, Highlighter, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for TextEditor<'a, Highlighter, Message, Theme, Renderer>
impl<'a, Highlighter, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for TextEditor<'a, Highlighter, Message, Theme, Renderer>
source§fn on_event(
&mut self,
tree: &mut Tree,
event: Event,
layout: Layout<'_>,
cursor: Cursor,
_renderer: &Renderer,
clipboard: &mut dyn Clipboard,
shell: &mut Shell<'_, Message>,
_viewport: &Rectangle,
) -> Status
fn on_event( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, _renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, ) -> Status
source§fn draw(
&self,
tree: &Tree,
renderer: &mut Renderer,
theme: &Theme,
_defaults: &Style,
layout: Layout<'_>,
cursor: Cursor,
_viewport: &Rectangle,
)
fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, _defaults: &Style, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, )
Widget
using the associated Renderer
.source§fn mouse_interaction(
&self,
_state: &Tree,
layout: Layout<'_>,
cursor: Cursor,
_viewport: &Rectangle,
_renderer: &Renderer,
) -> Interaction
fn mouse_interaction( &self, _state: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction
source§fn operate(
&self,
tree: &mut Tree,
_layout: Layout<'_>,
_renderer: &Renderer,
operation: &mut dyn Operation,
)
fn operate( &self, tree: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, operation: &mut dyn Operation, )
source§fn overlay<'a>(
&'a mut self,
_state: &'a mut Tree,
_layout: Layout<'_>,
_renderer: &Renderer,
_translation: Vector,
) -> Option<Element<'a, Message, Theme, Renderer>>
fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>
Widget
, if there is any.source§fn a11y_nodes(
&self,
_layout: Layout<'_>,
_state: &Tree,
_cursor: Cursor,
) -> A11yTree
fn a11y_nodes( &self, _layout: Layout<'_>, _state: &Tree, _cursor: Cursor, ) -> A11yTree
source§fn set_id(&mut self, _id: Id)
fn set_id(&mut self, _id: Id)
source§fn drag_destinations(
&self,
_state: &Tree,
_layout: Layout<'_>,
_renderer: &Renderer,
_dnd_rectangles: &mut DndDestinationRectangles,
)
fn drag_destinations( &self, _state: &Tree, _layout: Layout<'_>, _renderer: &Renderer, _dnd_rectangles: &mut DndDestinationRectangles, )
Auto Trait Implementations§
impl<'a, Highlighter, Message, Theme, Renderer> Freeze for TextEditor<'a, Highlighter, Message, Theme, Renderer>
impl<'a, Highlighter, Message, Theme = Theme, Renderer = Renderer> !RefUnwindSafe for TextEditor<'a, Highlighter, Message, Theme, Renderer>
impl<'a, Highlighter, Message, Theme = Theme, Renderer = Renderer> !Send for TextEditor<'a, Highlighter, Message, Theme, Renderer>
impl<'a, Highlighter, Message, Theme = Theme, Renderer = Renderer> !Sync for TextEditor<'a, Highlighter, Message, Theme, Renderer>
impl<'a, Highlighter, Message, Theme, Renderer> Unpin for TextEditor<'a, Highlighter, Message, Theme, Renderer>
impl<'a, Highlighter, Message, Theme = Theme, Renderer = Renderer> !UnwindSafe for TextEditor<'a, Highlighter, Message, Theme, Renderer>
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more