From e6a93e960c3ac71a74f11555fd2d225c185f6e8c Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Wed, 12 Apr 2023 04:13:36 +0200 Subject: Rename `on_change` to `on_input` for `TextInput` --- examples/component/src/main.rs | 2 +- examples/integration_wgpu/src/controls.rs | 2 +- examples/lazy/src/main.rs | 2 +- examples/modal/src/main.rs | 4 +- examples/qr_code/src/main.rs | 2 +- examples/styling/src/main.rs | 2 +- examples/text_input/src/main.rs | 2 +- examples/toast/src/main.rs | 4 +- examples/todos/src/main.rs | 8 +- examples/tour/src/main.rs | 2 +- examples/websocket/src/main.rs | 2 +- native/src/widget/text_input.rs | 383 +++++++++++++++--------------- 12 files changed, 204 insertions(+), 211 deletions(-) diff --git a/examples/component/src/main.rs b/examples/component/src/main.rs index 8be3f076..21c2747c 100644 --- a/examples/component/src/main.rs +++ b/examples/component/src/main.rs @@ -142,7 +142,7 @@ mod numeric_input { .as_deref() .unwrap_or(""), ) - .on_change(Event::InputChanged) + .on_input(Event::InputChanged) .padding(10), button("+", Event::IncrementPressed), ] diff --git a/examples/integration_wgpu/src/controls.rs b/examples/integration_wgpu/src/controls.rs index 8c42513f..42623b15 100644 --- a/examples/integration_wgpu/src/controls.rs +++ b/examples/integration_wgpu/src/controls.rs @@ -102,7 +102,7 @@ impl Program for Controls { ) .push( text_input("Placeholder", text) - .on_change(Message::TextChanged), + .on_input(Message::TextChanged), ), ), ) diff --git a/examples/lazy/src/main.rs b/examples/lazy/src/main.rs index 6b6dca26..55b13bcf 100644 --- a/examples/lazy/src/main.rs +++ b/examples/lazy/src/main.rs @@ -215,7 +215,7 @@ impl Sandbox for App { scrollable(options).height(Length::Fill), row![ text_input("Add a new option", &self.input) - .on_change(Message::InputChanged) + .on_input(Message::InputChanged) .on_submit(Message::AddItem(self.input.clone())), button(text(format!("Toggle Order ({})", self.order))) .on_press(Message::ToggleOrder) diff --git a/examples/modal/src/main.rs b/examples/modal/src/main.rs index 1377f054..49038475 100644 --- a/examples/modal/src/main.rs +++ b/examples/modal/src/main.rs @@ -134,7 +134,7 @@ impl Application for App { column![ text("Email").size(12), text_input("abc@123.com", &self.email,) - .on_change(Message::Email) + .on_input(Message::Email) .on_submit(Message::Submit) .padding(5), ] @@ -142,7 +142,7 @@ impl Application for App { column![ text("Password").size(12), text_input("", &self.password) - .on_change(Message::Password) + .on_input(Message::Password) .on_submit(Message::Submit) .password() .padding(5), diff --git a/examples/qr_code/src/main.rs b/examples/qr_code/src/main.rs index 0486b068..867ebfa4 100644 --- a/examples/qr_code/src/main.rs +++ b/examples/qr_code/src/main.rs @@ -51,7 +51,7 @@ impl Sandbox for QRGenerator { let input = text_input("Type the data of your QR code here...", &self.data) - .on_change(Message::DataChanged) + .on_input(Message::DataChanged) .size(30) .padding(15); diff --git a/examples/styling/src/main.rs b/examples/styling/src/main.rs index 58f983df..e2015bac 100644 --- a/examples/styling/src/main.rs +++ b/examples/styling/src/main.rs @@ -91,7 +91,7 @@ impl Sandbox for Styling { ); let text_input = text_input("Type something...", &self.input_value) - .on_change(Message::InputChanged) + .on_input(Message::InputChanged) .padding(10) .size(20); diff --git a/examples/text_input/src/main.rs b/examples/text_input/src/main.rs index 977b5099..418593f4 100644 --- a/examples/text_input/src/main.rs +++ b/examples/text_input/src/main.rs @@ -74,7 +74,7 @@ impl Application for Example { let mut txt_input = text_input(placeholder, &self.data); if self.text_edit_enabled { - txt_input = txt_input.on_change(Message::TextInputChanged); + txt_input = txt_input.on_input(Message::TextInputChanged); } let btn = button("Enable/Disable").on_press(StartTimer); diff --git a/examples/toast/src/main.rs b/examples/toast/src/main.rs index 765afb8f..b4b4e007 100644 --- a/examples/toast/src/main.rs +++ b/examples/toast/src/main.rs @@ -120,14 +120,14 @@ impl Application for App { subtitle( "Title", text_input("", &self.editing.title) - .on_change(Message::Title) + .on_input(Message::Title) .on_submit(Message::Add) .into() ), subtitle( "Message", text_input("", &self.editing.body) - .on_change(Message::Body) + .on_input(Message::Body) .on_submit(Message::Add) .into() ), diff --git a/examples/todos/src/main.rs b/examples/todos/src/main.rs index a6670626..99cdb8f9 100644 --- a/examples/todos/src/main.rs +++ b/examples/todos/src/main.rs @@ -205,11 +205,11 @@ impl Application for Todos { .horizontal_alignment(alignment::Horizontal::Center); let input = text_input("What needs to be done?", input_value) - .on_change(Message::InputChanged) .id(INPUT_ID.clone()) + .on_input(Message::InputChanged) + .on_submit(Message::CreateTask) .padding(15) - .size(30) - .on_submit(Message::CreateTask); + .size(30); let controls = view_controls(tasks, *filter); let filtered_tasks = @@ -375,7 +375,7 @@ impl Task { let text_input = text_input("Describe your task...", &self.description) .id(Self::text_input_id(i)) - .on_change(TaskMessage::DescriptionEdited) + .on_input(TaskMessage::DescriptionEdited) .on_submit(TaskMessage::FinishEdition) .padding(10); diff --git a/examples/tour/src/main.rs b/examples/tour/src/main.rs index 3b4cfd2d..16ee19c0 100644 --- a/examples/tour/src/main.rs +++ b/examples/tour/src/main.rs @@ -571,7 +571,7 @@ impl<'a> Step { }; let mut text_input = text_input("Type something to continue...", value) - .on_change(StepMessage::InputChanged) + .on_input(StepMessage::InputChanged) .padding(10) .size(30); diff --git a/examples/websocket/src/main.rs b/examples/websocket/src/main.rs index 1fda7f18..920189f5 100644 --- a/examples/websocket/src/main.rs +++ b/examples/websocket/src/main.rs @@ -126,7 +126,7 @@ impl Application for WebSocket { let new_message_input = { let mut input = text_input("Type a message...", &self.new_message) - .on_change(Message::NewMessageChanged) + .on_input(Message::NewMessageChanged) .padding(10); let mut button = button( diff --git a/native/src/widget/text_input.rs b/native/src/widget/text_input.rs index 65897a68..0cbc65db 100644 --- a/native/src/widget/text_input.rs +++ b/native/src/widget/text_input.rs @@ -47,7 +47,7 @@ pub use iced_style::text_input::{Appearance, StyleSheet}; /// "This is the placeholder...", /// value, /// ) -/// .on_change(|_| Message::TextInputChanged) +/// .on_input(Message::TextInputChanged) /// .padding(10); /// ``` /// ![Text input drawn by `iced_wgpu`](https://github.com/iced-rs/iced/blob/7760618fb112074bc40b148944521f312152012a/docs/images/text_input.png?raw=true) @@ -65,7 +65,7 @@ where width: Length, padding: Padding, size: Option, - on_change: Option Message + 'a>>, + on_input: Option Message + 'a>>, on_paste: Option Message + 'a>>, on_submit: Option, icon: Option>, @@ -93,7 +93,7 @@ where width: Length::Fill, padding: Padding::new(5.0), size: None, - on_change: None, + on_input: None, on_paste: None, on_submit: None, icon: None, @@ -113,6 +113,23 @@ where self } + /// Sets the callback which is called when the text gets changed + /// If not specified, the widget will be disabled + pub fn on_input(mut self, callback: F) -> Self + where + F: 'a + Fn(String) -> Message, + { + self.on_input = Some(Box::new(callback)); + self + } + + /// Sets the message that should be produced when the [`TextInput`] is + /// focused and the enter key is pressed. + pub fn on_submit(mut self, message: Message) -> Self { + self.on_submit = Some(message); + self + } + /// Sets the message that should be produced when some text is pasted into /// the [`TextInput`]. pub fn on_paste( @@ -155,13 +172,6 @@ where self } - /// Sets the message that should be produced when the [`TextInput`] is - /// focused and the enter key is pressed. - pub fn on_submit(mut self, message: Message) -> Self { - self.on_submit = Some(message); - self - } - /// Sets the style of the [`TextInput`]. pub fn style( mut self, @@ -171,16 +181,6 @@ where self } - /// Sets the callback which is called when the text gets changed - /// If not specified, the widget will be disabled - pub fn on_change(mut self, callback: F) -> Self - where - F: 'a + Fn(String) -> Message, - { - self.on_change = Some(Box::new(callback)); - self - } - /// Draws the [`TextInput`] with the given [`Renderer`], overriding its /// [`Value`] if provided. /// @@ -204,10 +204,10 @@ where &self.placeholder, self.size, &self.font, + self.on_input.is_none(), self.is_secure, self.icon.as_ref(), &self.style, - self.on_change.is_none(), ) } } @@ -284,7 +284,7 @@ where self.size, &self.font, self.is_secure, - self.on_change.as_deref(), + self.on_input.as_deref(), self.on_paste.as_deref(), &self.on_submit, || tree.state.downcast_mut::(), @@ -311,10 +311,10 @@ where &self.placeholder, self.size, &self.font, + self.on_input.is_none(), self.is_secure, self.icon.as_ref(), &self.style, - self.on_change.is_none(), ) } @@ -500,7 +500,7 @@ pub fn update<'a, Message, Renderer>( size: Option, font: &Renderer::Font, is_secure: bool, - on_change: Option<&dyn Fn(String) -> Message>, + on_input: Option<&dyn Fn(String) -> Message>, on_paste: Option<&dyn Fn(String) -> Message>, on_submit: &Option, state: impl FnOnce() -> &'a mut State, @@ -509,14 +509,12 @@ where Message: Clone, Renderer: text::Renderer, { - let is_disabled = on_change.is_none(); - match event { Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)) | Event::Touch(touch::Event::FingerPressed { .. }) => { let state = state(); - let is_clicked = layout.bounds().contains(cursor_position); - let is_clicked = is_clicked && !is_disabled; + let is_clicked = + layout.bounds().contains(cursor_position) && on_input.is_some(); state.is_focused = if is_clicked { state.is_focused.or_else(|| { @@ -646,22 +644,22 @@ where let state = state(); if let Some(focus) = &mut state.is_focused { - if let Some(on_change) = on_change { - if state.is_pasting.is_none() - && !state.keyboard_modifiers.command() - && !c.is_control() - { - let mut editor = Editor::new(value, &mut state.cursor); + let Some(on_input) = on_input else { return event::Status::Ignored }; - editor.insert(c); + if state.is_pasting.is_none() + && !state.keyboard_modifiers.command() + && !c.is_control() + { + let mut editor = Editor::new(value, &mut state.cursor); - let message = (on_change)(editor.contents()); - shell.publish(message); + editor.insert(c); - focus.updated_at = Instant::now(); + let message = (on_input)(editor.contents()); + shell.publish(message); - return event::Status::Captured; - } + focus.updated_at = Instant::now(); + + return event::Status::Captured; } } } @@ -669,188 +667,183 @@ where let state = state(); if let Some(focus) = &mut state.is_focused { - if let Some(on_change) = on_change { - let modifiers = state.keyboard_modifiers; - focus.updated_at = Instant::now(); + let Some(on_input) = on_input else { return event::Status::Ignored }; - match key_code { - keyboard::KeyCode::Enter - | keyboard::KeyCode::NumpadEnter => { - if let Some(on_submit) = on_submit.clone() { - shell.publish(on_submit); - } - } - keyboard::KeyCode::Backspace => { - if platform::is_jump_modifier_pressed(modifiers) - && state.cursor.selection(value).is_none() - { - if is_secure { - let cursor_pos = state.cursor.end(value); - state.cursor.select_range(0, cursor_pos); - } else { - state.cursor.select_left_by_words(value); - } - } - - let mut editor = - Editor::new(value, &mut state.cursor); - editor.backspace(); - - let message = (on_change)(editor.contents()); - shell.publish(message); - } - keyboard::KeyCode::Delete => { - if platform::is_jump_modifier_pressed(modifiers) - && state.cursor.selection(value).is_none() - { - if is_secure { - let cursor_pos = state.cursor.end(value); - state - .cursor - .select_range(cursor_pos, value.len()); - } else { - state.cursor.select_right_by_words(value); - } - } + let modifiers = state.keyboard_modifiers; + focus.updated_at = Instant::now(); - let mut editor = - Editor::new(value, &mut state.cursor); - editor.delete(); - - let message = (on_change)(editor.contents()); - shell.publish(message); + match key_code { + keyboard::KeyCode::Enter + | keyboard::KeyCode::NumpadEnter => { + if let Some(on_submit) = on_submit.clone() { + shell.publish(on_submit); } - keyboard::KeyCode::Left => { - if platform::is_jump_modifier_pressed(modifiers) - && !is_secure - { - if modifiers.shift() { - state.cursor.select_left_by_words(value); - } else { - state.cursor.move_left_by_words(value); - } - } else if modifiers.shift() { - state.cursor.select_left(value) + } + keyboard::KeyCode::Backspace => { + if platform::is_jump_modifier_pressed(modifiers) + && state.cursor.selection(value).is_none() + { + if is_secure { + let cursor_pos = state.cursor.end(value); + state.cursor.select_range(0, cursor_pos); } else { - state.cursor.move_left(value); + state.cursor.select_left_by_words(value); } } - keyboard::KeyCode::Right => { - if platform::is_jump_modifier_pressed(modifiers) - && !is_secure - { - if modifiers.shift() { - state.cursor.select_right_by_words(value); - } else { - state.cursor.move_right_by_words(value); - } - } else if modifiers.shift() { - state.cursor.select_right(value) + + let mut editor = Editor::new(value, &mut state.cursor); + editor.backspace(); + + let message = (on_input)(editor.contents()); + shell.publish(message); + } + keyboard::KeyCode::Delete => { + if platform::is_jump_modifier_pressed(modifiers) + && state.cursor.selection(value).is_none() + { + if is_secure { + let cursor_pos = state.cursor.end(value); + state + .cursor + .select_range(cursor_pos, value.len()); } else { - state.cursor.move_right(value); + state.cursor.select_right_by_words(value); } } - keyboard::KeyCode::Home => { + + let mut editor = Editor::new(value, &mut state.cursor); + editor.delete(); + + let message = (on_input)(editor.contents()); + shell.publish(message); + } + keyboard::KeyCode::Left => { + if platform::is_jump_modifier_pressed(modifiers) + && !is_secure + { if modifiers.shift() { - state - .cursor - .select_range(state.cursor.start(value), 0); + state.cursor.select_left_by_words(value); } else { - state.cursor.move_to(0); + state.cursor.move_left_by_words(value); } + } else if modifiers.shift() { + state.cursor.select_left(value) + } else { + state.cursor.move_left(value); } - keyboard::KeyCode::End => { + } + keyboard::KeyCode::Right => { + if platform::is_jump_modifier_pressed(modifiers) + && !is_secure + { if modifiers.shift() { - state.cursor.select_range( - state.cursor.start(value), - value.len(), - ); + state.cursor.select_right_by_words(value); } else { - state.cursor.move_to(value.len()); + state.cursor.move_right_by_words(value); } + } else if modifiers.shift() { + state.cursor.select_right(value) + } else { + state.cursor.move_right(value); } - keyboard::KeyCode::C - if state.keyboard_modifiers.command() => + } + keyboard::KeyCode::Home => { + if modifiers.shift() { + state + .cursor + .select_range(state.cursor.start(value), 0); + } else { + state.cursor.move_to(0); + } + } + keyboard::KeyCode::End => { + if modifiers.shift() { + state.cursor.select_range( + state.cursor.start(value), + value.len(), + ); + } else { + state.cursor.move_to(value.len()); + } + } + keyboard::KeyCode::C + if state.keyboard_modifiers.command() => + { + if let Some((start, end)) = + state.cursor.selection(value) { - if let Some((start, end)) = - state.cursor.selection(value) - { - clipboard.write( - value.select(start, end).to_string(), - ); - } + clipboard + .write(value.select(start, end).to_string()); } - keyboard::KeyCode::X - if state.keyboard_modifiers.command() => + } + keyboard::KeyCode::X + if state.keyboard_modifiers.command() => + { + if let Some((start, end)) = + state.cursor.selection(value) { - if let Some((start, end)) = - state.cursor.selection(value) - { - clipboard.write( - value.select(start, end).to_string(), - ); - } + clipboard + .write(value.select(start, end).to_string()); + } + + let mut editor = Editor::new(value, &mut state.cursor); + editor.delete(); + + let message = (on_input)(editor.contents()); + shell.publish(message); + } + keyboard::KeyCode::V => { + if state.keyboard_modifiers.command() { + let content = match state.is_pasting.take() { + Some(content) => content, + None => { + let content: String = clipboard + .read() + .unwrap_or_default() + .chars() + .filter(|c| !c.is_control()) + .collect(); + + Value::new(&content) + } + }; let mut editor = Editor::new(value, &mut state.cursor); - editor.delete(); - let message = (on_change)(editor.contents()); - shell.publish(message); - } - keyboard::KeyCode::V => { - if state.keyboard_modifiers.command() { - let content = match state.is_pasting.take() { - Some(content) => content, - None => { - let content: String = clipboard - .read() - .unwrap_or_default() - .chars() - .filter(|c| !c.is_control()) - .collect(); - - Value::new(&content) - } - }; - - let mut editor = - Editor::new(value, &mut state.cursor); - - editor.paste(content.clone()); - - let message = if let Some(paste) = &on_paste { - (paste)(editor.contents()) - } else { - (on_change)(editor.contents()) - }; - shell.publish(message); - - state.is_pasting = Some(content); + editor.paste(content.clone()); + + let message = if let Some(paste) = &on_paste { + (paste)(editor.contents()) } else { - state.is_pasting = None; - } - } - keyboard::KeyCode::A - if state.keyboard_modifiers.command() => - { - state.cursor.select_all(value); - } - keyboard::KeyCode::Escape => { - state.is_focused = None; - state.is_dragging = false; - state.is_pasting = None; + (on_input)(editor.contents()) + }; + shell.publish(message); - state.keyboard_modifiers = - keyboard::Modifiers::default(); - } - keyboard::KeyCode::Tab - | keyboard::KeyCode::Up - | keyboard::KeyCode::Down => { - return event::Status::Ignored; + state.is_pasting = Some(content); + } else { + state.is_pasting = None; } - _ => {} } + keyboard::KeyCode::A + if state.keyboard_modifiers.command() => + { + state.cursor.select_all(value); + } + keyboard::KeyCode::Escape => { + state.is_focused = None; + state.is_dragging = false; + state.is_pasting = None; + + state.keyboard_modifiers = + keyboard::Modifiers::default(); + } + keyboard::KeyCode::Tab + | keyboard::KeyCode::Up + | keyboard::KeyCode::Down => { + return event::Status::Ignored; + } + _ => {} } return event::Status::Captured; @@ -917,10 +910,10 @@ pub fn draw( placeholder: &str, size: Option, font: &Renderer::Font, + is_disabled: bool, is_secure: bool, icon: Option<&Icon>, style: &::Style, - is_disabled: bool, ) where Renderer: text::Renderer, Renderer::Theme: StyleSheet, -- cgit