Struct egui::widgets::text_edit::state::TextEditState

source ·
pub struct TextEditState {
    pub cursor: TextCursorState,
    pub(crate) undoer: Arc<Mutex<Undoer<(CCursorRange, String)>>>,
    pub(crate) ime_enabled: bool,
    pub(crate) ime_cursor_range: CursorRange,
    pub(crate) singleline_offset: f32,
    pub(crate) last_interaction_time: f64,
}
Expand description

The text edit state stored between frames.

Attention: You also need to store the updated state.

use egui::text::{CCursor, CCursorRange};

let mut output = egui::TextEdit::singleline(&mut text).show(ui);

// Create a new selection range
let min = CCursor::new(0);
let max = CCursor::new(0);
let new_range = CCursorRange::two(min, max);

// Update the state
output.state.cursor.set_char_range(Some(new_range));
// Store the updated state
output.state.store(ui.ctx(), output.response.id);

Fields§

§cursor: TextCursorState

Controls the text selection.

§undoer: Arc<Mutex<Undoer<(CCursorRange, String)>>>

Wrapped in Arc for cheaper clones.

§ime_enabled: bool§ime_cursor_range: CursorRange§singleline_offset: f32§last_interaction_time: f64

When did the user last press a key or click on the TextEdit. Used to pause the cursor animation when typing.

Implementations§

source§

impl TextEditState

source

pub fn load(ctx: &Context, id: Id) -> Option<Self>

source

pub fn store(self, ctx: &Context, id: Id)

source

pub fn ccursor_range(&self) -> Option<CCursorRange>

👎Deprecated: Use self.cursor.char_range instead

The currently selected range of characters.

source

pub fn set_ccursor_range(&mut self, ccursor_range: Option<CCursorRange>)

👎Deprecated: Use self.cursor.set_char_range instead

Sets the currently selected range of characters.

source

pub fn set_cursor_range(&mut self, cursor_range: Option<CursorRange>)

👎Deprecated: Use self.cursor.set_range instead
source

pub fn undoer(&self) -> Undoer<(CCursorRange, String)>

source

pub fn set_undoer(&mut self, undoer: Undoer<(CCursorRange, String)>)

source

pub fn clear_undoer(&mut self)

source

pub fn cursor_range(&self, galley: &Galley) -> Option<CursorRange>

👎Deprecated: Use self.cursor.range instead

Trait Implementations§

source§

impl Clone for TextEditState

source§

fn clone(&self) -> TextEditState

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for TextEditState

source§

fn default() -> TextEditState

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

source§

type Error = Infallible

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

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

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> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,