EditSession

Struct EditSession

pub struct EditSession<T> {
    pub layout: TextLayout<T>,
    pub send_notification_on_return: bool,
    pub send_notification_on_cancel: bool,
    pub origin: Point,
    /* private fields */
}

Expand description

Editable text state.

This is the inner state of a TextComponent. It should only be accessed through its containing TextComponent, or by the platform through an ImeHandlerRef created by TextComponent::input_handler.

Fields§

§layout: TextLayout<T>

The inner TextLayout object.

This is exposed so that users can do things like set text properties; you should avoid doing things like rebuilding this layout manually, or setting the text directly.

§send_notification_on_return: bool

If true, the component will send the TextComponent::RETURN notification when the user enters a newline.

§send_notification_on_cancel: bool

If true, the component will send the TextComponent::CANCEL notification when the user cancels editing.

§origin: Point

The origin of the textbox, relative to the origin of the window.

Implementations§

impl<T> EditSession<T>

pub fn selection(&self) -> Selection

The current Selection.

pub fn set_selection(&mut self, selection: Selection) -> Option<ImeInvalidation>

Manually set the selection.

If the new selection is different from the current selection, this will return an ime event that the controlling widget should use to invalidte the platform’s IME state, by passing it to EventCtx::invalidate_text_input.

pub fn composition_range(&self) -> Option<Range<usize>>

The range of text currently being modified by an IME.

pub fn set_accepts_newlines(&mut self, accepts_newlines: bool)

Sets whether or not this session will allow the insertion of newlines.

pub fn set_text_alignment(&mut self, alignment: TextAlignment)

Set the text alignment.

This is only meaningful for single-line text that does not fill the minimum layout size.

pub fn text_alignment(&self) -> TextAlignment

The text alignment.

pub fn pending_ime_invalidation(&mut self) -> Option<ImeInvalidation>

Returns any invalidation action that should be passed to the platform.

The user of this component must check this after calling update.

impl<T: TextStorage + EditableText> EditSession<T>

pub fn insert_text(&mut self, data: &mut T, new_text: &str) -> ImeInvalidation

Insert text not from the IME, replacing the current selection.

The caller is responsible for notifying the platform of the change in text state, by calling EventCtx::invalidate_text_input.

pub fn set_clipboard(&self) -> bool

Sets the clipboard to the contents of the current selection.

Returns true if the clipboard was set, and false if not (indicating) that the selection was empty.)

pub fn cursor_line_for_text_position(&self, pos: usize) -> Line

Returns a line suitable for drawing a standard cursor.

Trait Implementations§

impl<T: Clone> Clone for EditSession<T>

fn clone(&self) -> EditSession<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for EditSession<T>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T> !Freeze for EditSession<T>

impl<T> !RefUnwindSafe for EditSession<T>

impl<T> !Send for EditSession<T>

impl<T> !Sync for EditSession<T>

impl<T> Unpin for EditSession<T>
where T: Unpin,

impl<T> !UnwindSafe for EditSession<T>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> RoundFrom<T> for T

fn round_from(x: T) -> T

Performs the conversion.

impl<T, U> RoundInto<U> for T
where U: RoundFrom<T>,

fn round_into(self) -> U

Performs the conversion.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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