Skip to content

feat(at-spi): add accessible names for QML interactive controls - #797

Draft
MyLeeJiEun wants to merge 1 commit into
linuxdeepin:masterfrom
MyLeeJiEun:fix/at-spi-completion-2026-08-19
Draft

feat(at-spi): add accessible names for QML interactive controls#797
MyLeeJiEun wants to merge 1 commit into
linuxdeepin:masterfrom
MyLeeJiEun:fix/at-spi-completion-2026-08-19

Conversation

@MyLeeJiEun

@MyLeeJiEun MyLeeJiEun commented Aug 19, 2026 •
edited by sourcery-ai Bot
Loading

Copy link
Copy Markdown
Contributor

Summary

为 dde-launchpad 补全 AT-SPI 支持：为 QML 交互控件添加 Accessible.name/Accessible.role，并对纯装饰背景设置 Accessible.ignored，建立稳定、与语言无关的 AT-SPI 名称契约。

QML AT-SPI 名称覆盖率由 2.2% → 88.2%（67/76 交互控件已命名，≥80% 门禁阈值）。

Changes

  • 标准交互控件（Menu / MenuItem / Button / ToolButton / Switch / TextInput / ListView / GridView / ScrollBar / ItemDelegate / PageIndicator）：添加英文 PascalCase Accessible.name，作为不随语言环境变化的稳定 AT 定位锚点（菜单项文本为 qsTr，默认会随 locale 变化，故需显式英文名）。
  • 自定义容器组件（GridViewContainer / SideBar / WindowedFrame / FullscreenFrame / BottomBar / FolderGridViewPopup / AlphabetCategoryPopup / AppList / AnalysisView / FrequentlyUsedView / RecentlyInstalledView / FreeSortListView / SearchResultView）：添加 Accessible.name + Accessible.role（Pane / ToolBar / Dialog）。
  • 纯装饰背景（ItemBackground = D.BoxPanel、DebugBounding）：设置 Accessible.ignored: true，从 AT-SPI 树中排除纯视觉元素。
  • 修正既有非合规名称 Exit fullscreen → ExitFullscreen（含空格会导致 AT-SPI 解析不稳定）。
  • 同步 5 个文件的版权年份至 2026；新增 tests/at/spi/expected_names.yaml 回归基线并在 REUSE.toml 声明。

Scope / Notes

  • 纯 QML 补全，C++ 侧无可补全的 QWidget UI（仅模型/集成代码），故为 QML-only 路径。
  • 增量补全：仅新增 AT-SPI 属性，未改动既有逻辑/格式/命名。
  • IconItemDelegate 的 6 个实例及其内部 Button 未新增名称：该组件根 Control 已设 Accessible.name: iconItemLabel.text（应用显示名），实例会继承该名称；对其再加静态名会覆盖正确的应用名。这是扫描器的静态误报（扫描器不追踪组件根属性继承）。
  • A-Z 分类弹窗的 ToolButton 未新增名称：其 text: modelData（字母本身，与语言无关）已作为 AT 名称由 Qt 默认导出，加静态名反而会覆盖字母名。
  • 因运行环境缺少 DTK/dde-shell 等构建依赖，无法完成全量 cmake 构建；已通过 libclang/tokenizer 重新扫描（76 元素，无解析错误）、质量门禁、括号配平校验确认 QML 结构有效。
  • expected_names.yaml 含 67 个 QML 元素，作为后续质量门禁的回归基线。

Quality Gate

  • QML 覆盖率：88.2%（阈值 80%）✅
  • 命名规范：0 问题 ✅
  • 名称唯一性：0 冲突 ✅
  • 回归（相对 expected_names.yaml，名称级）：0 回归 ✅

关联 Multica 任务：DDE-139 dde-launchpad: AT-SPI 补全

Summary by Sourcery

Expand QML accessibility metadata to provide stable AT-SPI coverage for interactive controls while removing purely decorative elements from accessibility traversal.

New Features:

  • Add stable, language-independent accessibility identifiers and roles across QML interactive controls and containers to improve AT-SPI discoverability.
  • Exclude decorative backgrounds from the accessibility tree.

Bug Fixes:

  • Correct the fullscreen exit accessibility name to use a stable identifier without spaces.

Tests:

  • Add an AT-SPI expected-name regression baseline covering the named QML elements and accessibility roles.

Chores:

  • Declare licensing metadata for the new accessibility regression baseline and update copyright years in affected files.

@deepin-ci-robot

deepin-ci-robot commented Aug 19, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: MyLeeJiEun

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@deepin-ci-robot

deepin-ci-robot commented Aug 19, 2026

Copy link
Copy Markdown

Hi @MyLeeJiEun. Thanks for your PR.

I'm waiting for a linuxdeepin member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@sourcery-ai

sourcery-ai Bot commented Aug 19, 2026

Copy link
Copy Markdown

Reviewer's Guide

Adds stable, language-independent AT-SPI accessibility metadata to QML interactive controls in dde-launchpad, introduces an expected-names regression baseline, and updates relevant copyright/REUSE metadata.

File-Level Changes

Change Details Files
Introduce explicit Accessible.name/Accessible.role for key QML interactive and container components to create stable AT-SPI anchors.
  • Set PascalCase Accessible.name on standard controls such as Menu, MenuItem, ToolButton, Button, Switch, TextInput, ListView/GridView, ScrollBar, ItemDelegate, PageIndicator, etc.
  • Assign Accessible.role (Pane, ToolBar, Dialog) to higher-level container components like GridViewContainer, SideBar, AppList, AnalysisView, SearchResultView, FrequentlyUsedView, RecentlyInstalledView, AlphabetCategoryPopup, FolderGridViewPopup and various Windowed/Fullscreen frames.
  • Correct an existing non-compliant accessible name from a spaced string to a single PascalCase identifier to improve AT-SPI parsing stability.
 qml/windowed/AppListView.qml
qml/FullscreenFrame.qml
qml/windowed/WindowedFrame.qml
qml/AppItemMenu.qml
qml/Main.qml
qml/windowed/AnalysisView.qml
shell-launcher-applet/package/launcheritem.qml
qml/DebugDialog.qml
qml/windowed/FreeSortListView.qml
qml/windowed/SearchResultView.qml
qml/windowed/SideBar.qml
qml/FolderGridViewPopup.qml
qml/windowed/FrequentlyUsedView.qml
qml/windowed/RecentlyInstalledView.qml
qml/DummyAppItemMenu.qml
qml/windowed/AlphabetCategoryPopup.qml
qml/windowed/AppList.qml
qml/GridViewContainer.qml
qml/windowed/GridViewContainer.qml
Mark purely decorative/diagnostic QML elements as ignored for accessibility to clean up the AT-SPI tree.
  • Set Accessible.ignored: true on ItemBackground wrappers used as purely visual button backgrounds.
  • Set Accessible.ignored: true on DebugBounding elements that only draw debug outlines.
  • Ensure IconItemDelegate and related backgrounds are excluded from AT-SPI when they’re visual-only.
 qml/windowed/AppListView.qml
qml/FullscreenFrame.qml
qml/windowed/BottomBar.qml
qml/windowed/AnalysisView.qml
qml/IconItemDelegate.qml
qml/windowed/IconItemDelegate.qml
qml/windowed/SideBar.qml
qml/windowed/FreeSortListView.qml
qml/windowed/SearchResultView.qml
Introduce a regression baseline for AT-SPI names and update licensing metadata.
  • Add tests/at/spi/expected_names.yaml listing 67 QML elements with their expected Accessible.name/Accessible.role for future quality gating.
  • Annotate the new expected_names.yaml in REUSE.toml with SPDX copyright and license information.
  • Update SPDX-FileCopyrightText years to 2026 in several QML files to keep licensing headers current.
 tests/at/spi/expected_names.yaml
REUSE.toml
qml/windowed/BottomBar.qml
qml/Main.qml
qml/DebugDialog.qml
qml/DummyAppItemMenu.qml
qml/windowed/AlphabetCategoryPopup.qml
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@MyLeeJiEun
MyLeeJiEun force-pushed the fix/at-spi-completion-2026-08-19 branch 2 times, most recently from c5d3713 to 8dd4e05 Compare August 26, 2026 06:29
@MyLeeJiEun

MyLeeJiEun commented Aug 27, 2026

Copy link
Copy Markdown
Contributor Author

/retest

@deepin-ci-robot

deepin-ci-robot commented Aug 27, 2026

Copy link
Copy Markdown

@MyLeeJiEun: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@MyLeeJiEun

MyLeeJiEun commented Aug 27, 2026

Copy link
Copy Markdown
Contributor Author

/ok-to-test

@deepin-ci-robot

deepin-ci-robot commented Aug 27, 2026

Copy link
Copy Markdown

@MyLeeJiEun: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/ok-to-test

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

BLumia
BLumia reviewed Aug 27, 2026
View reviewed changes

@BLumia BLumia left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

有点滥用无障碍了，如果长期而言完全不打算做无障碍支持，只打算利用 AT-SPI 做自动化测试的话倒是无所谓，但需要确认是不是这个情况。

无障碍的 Accessible.name 名称是朗读给使用屏幕阅读器的用户用的，应当是人类可读的实际控件描述。

@MyLeeJiEun
MyLeeJiEun force-pushed the fix/at-spi-completion-2026-08-19 branch from bd67f98 to e7ebac3 Compare August 27, 2026 13:54
@MyLeeJiEun
feat(at-spi): add Accessible.id locators for QML interactive controls
485f502 
Add Accessible.id (AT-SPI AccessibleId) as test-locator anchors for
interactive QML elements (menus, menu items, buttons, switches, text
input, lists, grids, scrollbars, item delegates, page indicators, view
containers, the exit-fullscreen/fullscreen toggle buttons, and the DTK
WarningButton/SearchEdit/SwipeView controls). Add Accessible.role
(Pane/ToolBar/Dialog) for screen-reader semantics on view containers,
and mark pure decorative backgrounds (ItemBackground, DebugBounding) as
Accessible.ignored.

Pre-existing Accessible.name entries are preserved unchanged for
screen-reader semantics: "Exit fullscreen" (FullscreenFrame.qml),
"Fullscreen" (BottomBar.qml), and iconItemLabel.text (IconItemDelegate
in both fullscreen and windowed modes) — the name field is NOT a test
locator. The exit-fullscreen and fullscreen toggle buttons additionally
receive Accessible.id this round (ExitFullscreenBtn / FullscreenBtn),
with their pre-existing Accessible.name left intact.

Rebuild tests/at/spi/expected_names.yaml via scan_qml.py + merge_names.py
using the accessible_id field (68 elements). QML coverage: 88.3%.

为 dde-launchpad 的 QML 交互控件补全 Accessible.id（AT-SPI
AccessibleId）作为测试定位锚点（菜单、菜单项、按钮、开关、文本输入、
列表、网格、滚动条、item delegate、页指示器、视图容器、退出全屏/全屏
切换按钮，以及 DTK WarningButton/SearchEdit/SwipeView 控件），并为视图
容器设置 Accessible.role（Pane/ToolBar/Dialog）读屏语义，对纯装饰背景
（ItemBackground、DebugBounding）设置 Accessible.ignored。

补全前已存在的 Accessible.name 一律保留不动（"Exit fullscreen"、
"Fullscreen"、iconItemLabel.text），仅作读屏语义、不作测试定位锚点。
其中退出全屏 / 全屏切换按钮本轮追加 Accessible.id（ExitFullscreenBtn /
FullscreenBtn），原有 Accessible.name 保留不动。

通过 scan_qml.py + merge_names.py 重建 expected_names.yaml
（accessible_id 口径，68 元素）。QML 覆盖率 88.3%。

Log: 为 dde-launchpad 补全 AT-SPI 定位锚点支持
Influence: 提升无障碍辅助工具与自动化测试对启动器控件的定位能力
@MyLeeJiEun
MyLeeJiEun force-pushed the fix/at-spi-completion-2026-08-19 branch from e7ebac3 to 485f502 Compare August 27, 2026 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BLumia BLumia BLumia left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

needs-ok-to-test

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@MyLeeJiEun @deepin-ci-robot @BLumia