Add the accessible-position-in-set property

Author: DataTriny

api/cpp/include/slint-testing.h

@@ -3,6 +3,7 @@
 
 #include "slint.h"
 #include "slint_testing_internal.h"
+#include <cstdint>
 #include <optional>
 #include <string_view>
 #include <type_traits>
@@ -355,6 +356,19 @@ class ElementHandle
         return std::nullopt;
     }
 
+    /// Returns the accessible-position-in-set of that element, if any.
+    std::optional<uintptr_t> accessible_position_in_set() const
+    {
+        if (auto result = get_accessible_string_property(
+                    cbindgen_private::AccessibleStringProperty::PositionInSet)) {
+            uintptr_t value = 0;
+            if (cbindgen_private::slint_string_to_usize(&*result, &value)) {
+                return value;
+            }
+        }
+        return std::nullopt;
+    }
+
     /// Sets the accessible-value of that element.
     ///
     /// Setting the value will invoke the `accessible-action-set-value` callback.

api/cpp/lib.rs

@@ -152,6 +152,17 @@ pub extern "C" fn slint_string_to_float(string: &SharedString, value: &mut f32)
     }
 }
 
+#[no_mangle]
+pub extern "C" fn slint_string_to_usize(string: &SharedString, value: &mut usize) -> bool {
+    match string.as_str().parse::<usize>() {
+        Ok(v) => {
+            *value = v;
+            true
+        }
+        Err(_) => false,
+    }
+}
+
 #[no_mangle]
 pub extern "C" fn slint_debug(string: &SharedString) {
     i_slint_core::debug_log!("{string}");

docs/reference/src/language/builtins/elements.md

@@ -78,6 +78,7 @@ Use the following `accessible-` properties to make your items interact well with
 -   **`accessible-placeholder-text`** (_in_ _string_): A placeholder text to use when the item's value is empty. Applies to text elements.
 -   **`accessible-selectable`** (_in_ _bool_): Whether the element can be selected or not.
 -   **`accessible-selected`** (_in_ _bool_): Whether the element is selected or not. This maps to the "is-selected" state of listview items.
+-   **`accessible-position-in-set`** (_in_ _int_): The index (starting from 1) of this element in a group of similar elements. Applies to list items, radio buttons and other elements.
 
 You can also use the following callbacks that are going to be called by the accessibility framework:
 

internal/backends/testing/search_api.rs

@@ -621,6 +621,17 @@ impl ElementHandle {
             .and_then(|item| item.parse().ok())
     }
 
+    /// Returns the value of the element's `accessible-position-in-set` property, if present.
+    pub fn accessible_position_in_set(&self) -> Option<usize> {
+        if self.element_index != 0 {
+            return None;
+        }
+        self.item.upgrade().and_then(|item| {
+            item.accessible_string_property(AccessibleStringProperty::PositionInSet)
+                .and_then(|s| s.parse().ok())
+        })
+    }
+
     /// Returns the size of the element in logical pixels. This corresponds to the value of the `width` and
     /// `height` properties in Slint code. Returns a zero size if the element is not valid.
     pub fn size(&self) -> i_slint_core::api::LogicalSize {

internal/backends/winit/accesskit.rs

@@ -489,6 +489,13 @@ impl NodeCollection {
             );
         }
 
+        if let Some(position_in_set) = item
+            .accessible_string_property(AccessibleStringProperty::PositionInSet)
+            .and_then(|s| s.parse::<usize>().ok())
+        {
+            builder.set_position_in_set(position_in_set);
+        }
+
         let supported = item.supported_accessibility_actions();
         if supported.contains(SupportedAccessibilityAction::Default) {
             builder.add_action(accesskit::Action::Default);

internal/compiler/typeregister.rs

@@ -206,6 +206,7 @@ pub fn reserved_accessibility_properties() -> impl Iterator<Item = (&'static str
         ("accessible-action-set-value", strarg_callback_type()),
         ("accessible-selectable", Type::Bool),
         ("accessible-selected", Type::Bool),
+        ("accessible-position-in-set", Type::Int32),
     ]
     .into_iter()
 }

internal/compiler/widgets/cosmic/components.slint

@@ -106,6 +106,7 @@ export component ListItem {
     accessible-label: root.item.text;
     accessible-selectable: true;
     accessible-selected: root.is-selected;
+    accessible-position-in-set: root.index + 1;
 
     states [
         is-selected when root.is-selected : {

internal/compiler/widgets/cupertino/components.slint

@@ -62,6 +62,7 @@ export component ListItem {
     accessible-label: root.item.text;
     accessible-selectable: true;
     accessible-selected: root.is-selected;
+    accessible-position-in-set: root.index + 1;
 
     states [
         has-focus when root.has-focus : {

internal/compiler/widgets/fluent/components.slint

@@ -50,6 +50,7 @@ export component ListItem {
     accessible-label: root.item.text;
     accessible-selectable: true;
     accessible-selected: root.is-selected;
+    accessible-position-in-set: root.index + 1;
 
     states [
         pressed when root.pressed : {

internal/compiler/widgets/material/components.slint

@@ -108,6 +108,7 @@ export component ListItem {
     accessible-label: root.item.text;
     accessible-selectable: true;
     accessible-selected: root.is-selected;
+    accessible-position-in-set: root.index + 1;
 
     states [
         pressed when root.pressed: {