pub struct TextArea { /* private fields */ }Expand description
A multi-line text area. Create it once and keep the entity in your view:
let draft = cx.new(|cx| TextArea::new(cx).placeholder("Ask anything").min_rows(2));Implementations§
Source§impl TextArea
impl TextArea
pub fn new(cx: &mut Context<'_, Self>) -> Self
Sourcepub fn set_suggesting(&mut self, suggesting: bool, cx: &mut Context<'_, Self>)
pub fn set_suggesting(&mut self, suggesting: bool, cx: &mut Context<'_, Self>)
Marks that a suggestion list is open for this input: while on, ↑ ↓ Enter Tab Esc dispatch
the super::SuggestionList actions instead of their usual editing behavior.
pub fn is_suggesting(&self) -> bool
pub fn placeholder(self, placeholder: impl Into<SharedString>) -> Self
Sourcepub fn max_height(self, max_height: Pixels) -> Self
pub fn max_height(self, max_height: Pixels) -> Self
Height at which it stops growing and scrolls (240 px by default).
Sourcepub fn error(self, error: Option<SharedString>) -> Self
pub fn error(self, error: Option<SharedString>) -> Self
Error state: the caret and the supporting row turn error and the message replaces the
supporting text. The host paints the box, so it can follow with Self::is_invalid.
pub fn set_error( &mut self, error: Option<SharedString>, cx: &mut Context<'_, Self>, )
Sourcepub fn supporting_text(self, text: impl Into<SharedString>) -> Self
pub fn supporting_text(self, text: impl Into<SharedString>) -> Self
12 px line under the text. Setting it reserves the line’s height, so an error message taking its place does not move what is below.
Sourcepub fn max_length(self, max: usize) -> Self
pub fn max_length(self, max: usize) -> Self
Shows a “12 / 50” counter at the end of the supporting line. It only flags: past the
limit it turns error and typing still works (see Self::hard_limit).
Sourcepub fn hard_limit(self, hard: bool) -> Self
pub fn hard_limit(self, hard: bool) -> Self
With Self::max_length, typing, pasting and IME input are cut at the limit.
Self::set_text and Self::replace_range are not.
Sourcepub fn is_invalid(&self) -> bool
pub fn is_invalid(&self) -> bool
An error was set or the text is past max_length.
pub fn text(&self) -> &SharedString
Sourcepub fn set_text(
&mut self,
text: impl Into<SharedString>,
cx: &mut Context<'_, Self>,
)
pub fn set_text( &mut self, text: impl Into<SharedString>, cx: &mut Context<'_, Self>, )
Replaces the whole text and puts the caret at the end.
pub fn clear(&mut self, cx: &mut Context<'_, Self>)
Sourcepub fn cursor_offset(&self) -> usize
pub fn cursor_offset(&self) -> usize
Caret position, in UTF-8 bytes.
Sourcepub fn replace_range(
&mut self,
range: Range<usize>,
text: &str,
cx: &mut Context<'_, Self>,
)
pub fn replace_range( &mut self, range: Range<usize>, text: &str, cx: &mut Context<'_, Self>, )
Replaces a byte range (e.g. an @query with the chosen mention) and puts the caret after
the inserted text.
pub fn focus(&self, window: &mut Window)
pub fn is_focused(&self, window: &Window) -> bool
Trait Implementations§
Source§impl EntityInputHandler for TextArea
impl EntityInputHandler for TextArea
Source§fn text_for_range(
&mut self,
range_utf16: Range<usize>,
actual_range: &mut Option<Range<usize>>,
_: &mut Window,
_: &mut Context<'_, Self>,
) -> Option<String>
fn text_for_range( &mut self, range_utf16: Range<usize>, actual_range: &mut Option<Range<usize>>, _: &mut Window, _: &mut Context<'_, Self>, ) -> Option<String>
InputHandler::text_for_range for detailsSource§fn selected_text_range(
&mut self,
_: bool,
_: &mut Window,
_: &mut Context<'_, Self>,
) -> Option<UTF16Selection>
fn selected_text_range( &mut self, _: bool, _: &mut Window, _: &mut Context<'_, Self>, ) -> Option<UTF16Selection>
InputHandler::selected_text_range for detailsSource§fn marked_text_range(
&self,
_: &mut Window,
_: &mut Context<'_, Self>,
) -> Option<Range<usize>>
fn marked_text_range( &self, _: &mut Window, _: &mut Context<'_, Self>, ) -> Option<Range<usize>>
InputHandler::marked_text_range for detailsSource§fn unmark_text(&mut self, _: &mut Window, _: &mut Context<'_, Self>)
fn unmark_text(&mut self, _: &mut Window, _: &mut Context<'_, Self>)
InputHandler::unmark_text for detailsSource§fn replace_text_in_range(
&mut self,
range_utf16: Option<Range<usize>>,
new_text: &str,
_: &mut Window,
cx: &mut Context<'_, Self>,
)
fn replace_text_in_range( &mut self, range_utf16: Option<Range<usize>>, new_text: &str, _: &mut Window, cx: &mut Context<'_, Self>, )
InputHandler::replace_text_in_range for detailsSource§fn replace_and_mark_text_in_range(
&mut self,
range_utf16: Option<Range<usize>>,
new_text: &str,
new_selected_range_utf16: Option<Range<usize>>,
_: &mut Window,
cx: &mut Context<'_, Self>,
)
fn replace_and_mark_text_in_range( &mut self, range_utf16: Option<Range<usize>>, new_text: &str, new_selected_range_utf16: Option<Range<usize>>, _: &mut Window, cx: &mut Context<'_, Self>, )
InputHandler::replace_and_mark_text_in_range for detailsSource§fn bounds_for_range(
&mut self,
range_utf16: Range<usize>,
bounds: Bounds<Pixels>,
_: &mut Window,
_: &mut Context<'_, Self>,
) -> Option<Bounds<Pixels>>
fn bounds_for_range( &mut self, range_utf16: Range<usize>, bounds: Bounds<Pixels>, _: &mut Window, _: &mut Context<'_, Self>, ) -> Option<Bounds<Pixels>>
InputHandler::bounds_for_range for detailsSource§fn character_index_for_point(
&mut self,
point: Point<Pixels>,
_: &mut Window,
_: &mut Context<'_, Self>,
) -> Option<usize>
fn character_index_for_point( &mut self, point: Point<Pixels>, _: &mut Window, _: &mut Context<'_, Self>, ) -> Option<usize>
InputHandler::character_index_for_point for detailsimpl EventEmitter<TextAreaEvent> for TextArea
Source§impl Focusable for TextArea
impl Focusable for TextArea
Source§fn focus_handle(&self, _: &App) -> FocusHandle
fn focus_handle(&self, _: &App) -> FocusHandle
Auto Trait Implementations§
impl !RefUnwindSafe for TextArea
impl !UnwindSafe for TextArea
impl Forget for TextArea
impl Freeze for TextArea
impl Move for TextArea
impl Send for TextArea
impl Sync for TextArea
impl Unpin for TextArea
impl UnsafeUnpin for TextArea
Blanket Implementations§
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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> DowncastSync for T
impl<T> DowncastSync for T
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> 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 more