Skip to main content

TextArea

Struct TextArea 

Source
pub struct TextArea { /* private fields */ }
Expand description

A multi-line text editor. It edits the text in a shared signal as a TextInput does, and takes the focus the same ways. Enter breaks the line, and Ctrl+Enter runs on_accept. Up and Down move by line, keeping the caret’s place across, Home and End go to the ends of the line as it is wrapped, Ctrl+Home and Ctrl+End to the ends of the text, and PageUp and PageDown by the height of the ScrollView around it, or 10 lines. Tab types a tab, drawn four spaces wide, and Shift+Tab and Ctrl+Tab move the focus back and on.

The area is as tall as its lines, at least one. Put it in a ScrollView to cap its height; when the caret leaves the view, the view scrolls the least that shows it.

use crabshell_ui::{Cx, ScrollView, Style, TextArea};

fn note(cx: &Cx) -> ScrollView {
    let text = cx.signal(String::new());
    ScrollView::new(TextArea::new(text).placeholder("Write a note"))
        .style(Style::new().height(120.0))
}

Implementations§

Source§

impl TextArea

Source

pub fn new(text: Signal<String>) -> TextArea

An area editing text.

Source

pub fn placeholder(self, text: impl IntoProp<String>) -> TextArea

Sets the text shown, dimmed, while the area is empty.

Source

pub fn focus(self, focus: impl IntoProp<bool>) -> TextArea

Takes the keyboard focus whenever this turns true.

Source

pub fn wrap(self, wrap: impl IntoProp<bool>) -> TextArea

When on, the default, lines wrap at words to the area’s width, 200 unless its style sets one. Off, each line is as long as it is and the area as wide as its longest, so a sideways ScrollView scrolls it.

Source

pub fn on_accept(self, handler: impl Fn(&Cx, &str) + 'static) -> TextArea

Runs handler with the text when Ctrl+Enter is pressed in the area.

Source

pub fn style(self, style: impl IntoProp<Style>) -> TextArea

Sets the style. An area cuts its text to the inside of its border. Its text takes the font, color, alignment, line height and decorations it inherits or sets, as a Text does.

Source

pub fn visible(self, visible: impl IntoProp<bool>) -> Self

Shows or hides the widget. Hidden, it is taken out of the layout, so its space goes to the others, and it isn’t drawn, hit or reached by Tab; it drops the keyboard focus and the pointer. Its bindings and state stay, so it shows again as it was. Shown by default.

Source

pub fn geometry(self, geometry: Signal<Rect>) -> Self

Shares where the widget is: after each layout that moves or resizes it, its laid-out rectangle in the window’s logical pixels, scrolled with any scroll view around it but not moved by a style’s translate, scale or rotate, is written to geometry. A hidden widget writes nothing. An effect that reads it may change the layout: the window is laid out again at once, until nothing moves.

Source

pub fn mapped_geometry(self, geometry: Signal<Rect>) -> Self

Shares where the widget is drawn: the box around it once its own and its ancestors’ translate, scale and rotate have moved it, in the window’s logical pixels, scrolled with any scroll view around it. It is written after each layout that moves it and after each change of a transform or an offset that does, every frame of an animated one. A hidden widget writes nothing. Where the window itself is on its output is unknown: Wayland doesn’t tell a client.

Trait Implementations§

Source§

impl Widget for TextArea

Source§

fn into_element(self: Box<Self>) -> Element

Turns the description, and everything inside it, into the element the window builds nodes from. It runs when the window is created or a list item first appears, before the window’s tree is touched and without recording what it reads, so it only describes.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more