Skip to content

Commit

Permalink
docs: Document how click points work
Browse files Browse the repository at this point in the history
Including the "multiple click points" feature added in
<os-autoinst/os-autoinst#2315>.
  • Loading branch information
ssssam committed Jan 3, 2024
1 parent 7e1bd8d commit c54769a
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/GettingStarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ tags.
"height" : INTEGER,
"type" : ( "match" | "ocr" | "exclude" ),
"match" : INTEGER, // 0-100. similarity percentage
"click_point" : CLICK_POINT, // Optional click point
},
...
],
Expand Down Expand Up @@ -241,6 +242,23 @@ There are three kinds of areas:
the concerning area.
In the needle view exclude areas are displayed as gray boxes.

==== Click Points ====
Each regular match area in a needle can optionally contain a *click point*.
This is used with the `testapi::assert_and_click` function match GUI elements
such as buttons and then click inside the matched area.

[source,json]
-------------------------------------------------------------------
{
"xpos" : INTEGER, // Relative coordinates inside the match area
"ypos" : INTEGER,
"id" : STRING, // Optional
}
-------------------------------------------------------------------

Each click point can have an `id`, and if a needle contains multiple click points
you must pass the ID to `testapi::assert_and_click` to select which click point
to use.

=== Access management

Expand Down

0 comments on commit c54769a

Please sign in to comment.