TextInput: Add focus-policy

ChangeLog: TextInput: Added `focus-policy` property.

Author: tronical

docs/astro/src/content/docs/reference/keyboard-input/focusscope.mdx

@@ -62,7 +62,7 @@ Is `true` when the element has keyboard focus.
 
 ### focus-policy
 <SlintProperty propName="focus-policy" typeName="enum" enumName="FocusPolicy">
-The focus policy of the scope.
+The focus policy of the scope. Use this to control if the `TextInput` should claim focus on click or tab navigation.
 </SlintProperty>
 
 ## Functions

docs/astro/src/content/docs/reference/keyboard-input/textinput.mdx

@@ -78,6 +78,11 @@ The design metrics of the font scaled to the font pixel size used by the element
 `TextInput` sets this to `true` when it's focused. Only then it receives <Link type="KeyEvent"/>s.
 </SlintProperty>
 
+### focus-policy
+<SlintProperty propName="focus-policy" typeName="enum" enumName="FocusPolicy">
+The focus policy of the `TextInput`. Use this to control if the `TextInput` should claim focus on click or tab navigation.
+</SlintProperty>
+
 ### horizontal-alignment
 <SlintProperty propName="horizontal-alignment" typeName="enum" enumName="TextHorizontalAlignment">
 The horizontal alignment of the text.

internal/compiler/builtins.slint

@@ -323,6 +323,7 @@ export component TextInput {
     // Internal, undocumented property, only exposed for tests.
     out property <int> anchor-position-byte-offset;
     out property <bool> has-focus;
+    in property <FocusPolicy> focus-policy;
     callback accepted;
     callback edited;
     callback cursor_position_changed(position: Point);

internal/core/items/text.rs

@@ -19,6 +19,7 @@ use crate::input::{
     KeyEvent, KeyboardModifiers, MouseEvent, StandardShortcut, TextShortcut,
 };
 use crate::item_rendering::{CachedRenderingData, ItemRenderer, RenderText};
+use crate::items::FocusPolicy;
 use crate::layout::{LayoutInfo, Orientation};
 use crate::lengths::{
     LogicalLength, LogicalPoint, LogicalRect, LogicalSize, ScaleFactor, SizeLengths,
@@ -520,6 +521,7 @@ pub struct TextInput {
     pub single_line: Property<bool>,
     pub read_only: Property<bool>,
     pub preedit_text: Property<SharedString>,
+    pub focus_policy: Property<FocusPolicy>,
     /// A selection within the preedit (cursor and anchor)
     preedit_selection: Property<PreEditSelection>,
     pub cached_rendering_data: CachedRenderingData,
@@ -610,6 +612,11 @@ impl Item for TextInput {
         }
         match event {
             MouseEvent::Pressed { position, button: PointerEventButton::Left, click_count } => {
+                #[cfg(not(target_os = "android"))]
+                if !self.ensure_click_focus_and_ime(window_adapter, self_rc) {
+                    return InputEventResult::EventIgnored;
+                }
+
                 let clicked_offset =
                     self.byte_offset_for_position(*position, window_adapter, self_rc) as i32;
                 self.as_ref().pressed.set((click_count % 3) + 1);
@@ -618,9 +625,6 @@ impl Item for TextInput {
                     self.as_ref().anchor_position_byte_offset.set(clicked_offset);
                 }
 
-                #[cfg(not(target_os = "android"))]
-                self.ensure_focus_and_ime(window_adapter, self_rc);
-
                 match click_count % 3 {
                     0 => self.set_cursor_position(
                         clicked_offset,
@@ -638,13 +642,17 @@ impl Item for TextInput {
             }
             MouseEvent::Pressed { button: PointerEventButton::Middle, .. } => {
                 #[cfg(not(target_os = "android"))]
-                self.ensure_focus_and_ime(window_adapter, self_rc);
+                if !self.ensure_click_focus_and_ime(window_adapter, self_rc) {
+                    return InputEventResult::EventIgnored;
+                }
             }
             MouseEvent::Released { button: PointerEventButton::Left, .. } => {
                 self.as_ref().pressed.set(0);
                 self.copy_clipboard(window_adapter, Clipboard::SelectionClipboard);
                 #[cfg(target_os = "android")]
-                self.ensure_focus_and_ime(window_adapter, self_rc);
+                if !self.ensure_click_focus_and_ime(window_adapter, self_rc) {
+                    return InputEventResult::EventIgnored;
+                }
             }
             MouseEvent::Released { position, button: PointerEventButton::Middle, .. } => {
                 let clicked_offset =
@@ -936,6 +944,20 @@ impl Item for TextInput {
         window_adapter: &Rc<dyn WindowAdapter>,
         self_rc: &ItemRc,
     ) -> FocusEventResult {
+        let reason = match event {
+            FocusEvent::FocusIn(reason) | FocusEvent::FocusOut(reason) => *reason,
+        };
+
+        match (reason, self.focus_policy()) {
+            (FocusReason::TabNavigation, FocusPolicy::ClickOnly) => {
+                return FocusEventResult::FocusIgnored
+            }
+            (FocusReason::PointerClick, FocusPolicy::TabOnly) => {
+                return FocusEventResult::FocusIgnored
+            }
+            _ => (),
+        }
+
         match event {
             FocusEvent::FocusIn(_reason) => {
                 if !self.enabled() {
@@ -1827,12 +1849,16 @@ impl TextInput {
 
     /// When pressing the mouse (or releasing the finger, on android) we should take the focus if we don't have it already.
     /// Setting the focus will show the virtual keyboard, otherwise we should make sure that the keyboard is shown if it was hidden by the user
-    fn ensure_focus_and_ime(
+    /// Returns true if the focus was set, false if the focus policy is configured to not focus on click.
+    fn ensure_click_focus_and_ime(
         self: Pin<&Self>,
         window_adapter: &Rc<dyn WindowAdapter>,
         self_rc: &ItemRc,
-    ) {
+    ) -> bool {
         if !self.has_focus() {
+            if self.focus_policy() == FocusPolicy::TabOnly {
+                return false;
+            }
             WindowInner::from_pub(window_adapter.window()).set_focus_item(
                 self_rc,
                 true,
@@ -1845,6 +1871,7 @@ impl TextInput {
                 ));
             }
         }
+        true
     }
 
     fn add_undo_item(self: Pin<&Self>, item: UndoItem) {