forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add brief platform documentation for UI Automation
This is a short document targeted at engineers working on accessibility who aren't familiar with UIA. The intent is to identify the most important points to consider when looking at UIA-specific test results and to provide links to deeper documentation on MSDN. This CL also fixes up incorrectly marked-up links I noticed on the Android accessibility documentation page. Bug: None Change-Id: Iccfaf19eeae1659384244ac3f0a27e4596422c1d Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2957347 Reviewed-by: Daniel Libby <[email protected]> Reviewed-by: Dominic Mazzoni <[email protected]> Commit-Queue: Kevin Babbitt <[email protected]> Cr-Commit-Position: refs/heads/master@{#892172}
- Loading branch information
Showing
3 changed files
with
66 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# UI Automation | ||
|
||
[UI Automation (UIA)](https://docs.microsoft.com/en-us/windows/win32/winauto/entry-uiauto-win32) | ||
is the modern accessibility API on Windows. | ||
|
||
## Key Features | ||
|
||
### Clients and Providers | ||
|
||
UI Automation exposes two different sets of interfaces. One is intended for | ||
clients such as assistive technologies and automation frameworks. The other is | ||
intended for providers such as UI widget frameworks and applications that render | ||
their own content. Chromium implements the UI Automation provider APIs. | ||
|
||
Clients and providers do not talk directly to one another. Instead, the | ||
operating system gathers data from providers to present a unified tree view | ||
across all open applications to the client. | ||
|
||
Further reading: | ||
|
||
* [UI Automation Provider Programmer's Guide](https://docs.microsoft.com/en-us/windows/win32/winauto/uiauto-providerportal) | ||
* [UI Automation Client Programmer's Guide](https://docs.microsoft.com/en-us/windows/win32/winauto/uiauto-clientportal) | ||
|
||
### Views of the UI Automation tree | ||
|
||
Clients have the ability to filter the UI Automation tree to various subsets of | ||
nodes. Tools such as Windows Narrator take advantage of this capability to skip | ||
over structural details that might be interesting to an automation framework but | ||
aren't relevant to a screen reader. | ||
|
||
Providers can set two properties on a node to determine which views it appears | ||
in: IsControlElement and IsContentElement. Getting the value of these properties | ||
right is critical to ensuring assistive technologies can get the information | ||
they need. Despite the names, there are many cases where nodes that might not be | ||
considered a "control" should appear in the Control view of the tree. A good | ||
litmus test is: if there's a reason a screen reader might be interested in a | ||
node, it should appear in the control view. | ||
|
||
Further reading: | ||
|
||
* [UI Automation Tree Overview](https://docs.microsoft.com/en-us/windows/win32/winauto/uiauto-treeoverview) | ||
|
||
### TextPattern | ||
|
||
In addition to the tree view, UI Automation exposes a linear reading view | ||
through an API known as TextPattern. This API allows a screen reader to navigate | ||
text in more natural ways - characters, words, sentences, paragraphs, pages - | ||
without worrying about the underlying tree structure. Windows Narrator relies | ||
heavily on TextPattern for reading. | ||
|
||
Further reading: | ||
|
||
* [Text and TextRange Control Patterns](https://docs.microsoft.com/en-us/windows/win32/winauto/uiauto-implementingtextandtextrange) |